Client JQL query support

Author: terabyte

example.rb

@@ -52,6 +52,12 @@
 #   puts "#{issue.id} - #{issue.fields['summary']}"
 # end
 #
+# # List issues by JQL query
+# # ------------------------
+# client.Issue.jql('PROJECT = "SAMPLEPROJECT"').each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
 # # Delete an issue
 # # ---------------
 # issue = client.Issue.find('SAMPLEPROJECT-2')

http-basic-example.rb

@@ -49,6 +49,12 @@
 #   puts "#{issue.id} - #{issue.fields['summary']}"
 # end
 #
+# # List issues by JQL query
+# # ------------------------
+# client.Issue.jql('PROJECT = "SAMPLEPROJECT"').each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
 # # Delete an issue
 # # ---------------
 # issue = client.Issue.find('SAMPLEPROJECT-2')

lib/jira/base_factory.rb

@@ -38,7 +38,7 @@ def self.delegate_to_target_class(*method_names)
     # The priciple purpose of this class is to delegate methods to the corresponding
     # non-factory class and automatically prepend the client argument to the argument
     # list.
-    delegate_to_target_class :all, :find, :collection_path, :singular_path
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql
 
     # This method needs special handling as it has a default argument value
     def build(attrs={})

lib/jira/resource/issue.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module JIRA
   module Resource
 
@@ -37,6 +39,15 @@ def self.all(client)
         end
       end
 
+      def self.jql(client, jql)
+        url = client.options[:rest_base_path] + "/search?jql=" + CGI.escape(jql)
+        response = client.get(url)
+        json = parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
       def respond_to?(method_name)
         if attrs.keys.include?('fields') && attrs['fields'].keys.include?(method_name.to_s)
           true

spec/integration/issue_spec.rb

@@ -74,5 +74,21 @@
 
     end
 
+    describe "GET jql issues" do # JIRA::Resource::Issue.jql uses the search endpoint
+      jql_query_string = "PROJECT = 'SAMPLEPROJECT'"
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:jql_query_string) { jql_query_string }
+
+      let(:expected_attributes) {
+        {
+          "id"=>"10014",
+          "self"=>"http://localhost:2990/jira/rest/api/2/issue/10014",
+          "key"=>"SAMPLEPROJECT-13"
+        }
+      }
+      it_should_behave_like "a resource with JQL inputs and a collection GET endpoint"
+    end
+
   end
 end

spec/support/shared_examples/integration.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 def get_mock_from_path(method, options = {})
   if defined? belongs_to
     prefix = belongs_to.path_component + '/'
@@ -79,6 +81,20 @@ def build_receiver
 
 end
 
+shared_examples "a resource with JQL inputs and a collection GET endpoint" do
+
+  it "should get the collection" do
+    stub_request(:get, site_url + client.options[:rest_base_path] + '/search?jql=' + CGI.escape(jql_query_string)).
+                 to_return(:status => 200, :body => get_mock_response('issue.json'))
+    collection = build_receiver.jql(jql_query_string)
+    collection.length.should == expected_collection_length
+
+    first = collection.first
+    first.should have_attributes(expected_attributes)
+  end
+
+end
+
 shared_examples "a resource with a singular GET endpoint" do
 
   it "GETs a single resource" do