jira-ruby 0.1.0 → 0.1.1

data/README.rdoc

@@ -15,8 +15,8 @@ API version 2).
 
   issue.comments.each {|comment| ... }
 
-  comment = issue.comments.build({'body':'My new comment'})
-  comment.save
+  comment = issue.comments.build
+  comment.save({'body':'My new comment'})
   comment.delete
 
 == Links to JIRA REST API documentation

data/Rakefile

@@ -6,7 +6,17 @@ require 'rake/rdoctask'
 
 Dir.glob('lib/tasks/*.rake').each { |r| import r }
 
-task :default => [:spec]
+task :default => [:test]
+
+task :test => [:prepare, :spec]
+
+describe "Prepare and run rspec tests"
+task :prepare do
+  rsa_key = File.expand_path('rsakey.pem')
+  if !File.exists?(rsa_key)
+    raise "rsakey.pem does not exist, tests will fail.  Run `rake jira:generate_public_cert` first"
+  end
+end
 
 desc "Run RSpec tests"
 RSpec::Core::RakeTask.new(:spec)

data/example.rb

@@ -52,6 +52,12 @@ pp issue
 #   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')

data/http-basic-example.rb

@@ -49,6 +49,12 @@ end
 #   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')

data/lib/jira/base_factory.rb

@@ -38,7 +38,7 @@ module JIRA
     # 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={})

data/lib/jira/client.rb

@@ -137,7 +137,7 @@ module JIRA
 
     # Sends the specified HTTP request to the REST API through the
     # appropriate method (oauth, basic).
-    def request(http_method, path, body = '', headers)
+    def request(http_method, path, body = '', headers={})
       @request_client.request(http_method, path, body, headers)
     end
 

data/lib/jira/http_client.rb

@@ -15,8 +15,8 @@ module JIRA
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
-    def make_request(http_method, path, body='', headers)
-      request = Net::HTTP.const_get(http_method.capitalize).new(path, headers)
+    def make_request(http_method, path, body='', headers={})
+      request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
       request.body = body unless body.nil?
       request.basic_auth(@options[:username], @options[:password])
       response = basic_auth_http_conn.request(request)

data/lib/jira/oauth_client.rb

@@ -71,7 +71,7 @@ module JIRA
       @access_token
     end
 
-    def make_request(http_method, path, body='', headers)
+    def make_request(http_method, path, body='', headers={})
       case http_method
       when :delete, :get, :head
         response = access_token.send http_method, path, headers

data/lib/jira/resource/issue.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module JIRA
   module Resource
 
@@ -37,6 +39,15 @@ module JIRA
         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

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/integration/issue_spec.rb

@@ -74,5 +74,21 @@ describe JIRA::Resource::Issue do
 
     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

data/spec/jira/http_client_spec.rb

@@ -23,16 +23,14 @@ describe JIRA::HttpClient do
     basic_auth_http_conn = mock()
     request = mock()
     basic_client.stub(:basic_auth_http_conn => basic_auth_http_conn)
-    request.should_receive(:basic_auth)
-           .with(basic_client.options[:username], basic_client.options[:password])
-           .exactly(5).times.and_return(request)
+    request.should_receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).exactly(5).times.and_return(request)
     basic_auth_http_conn.should_receive(:request).exactly(5).times.with(request).and_return(response)
     [:delete, :get, :head].each do |method|
-      Net::HTTP.const_get(method.capitalize).should_receive(:new).with('/path', headers).and_return(request)
+      Net::HTTP.const_get(method.to_s.capitalize).should_receive(:new).with('/path', headers).and_return(request)
       basic_client.make_request(method, '/path', nil, headers).should == response
     end
     [:post, :put].each do |method|
-      Net::HTTP.const_get(method.capitalize).should_receive(:new).with('/path', headers).and_return(request)
+      Net::HTTP.const_get(method.to_s.capitalize).should_receive(:new).with('/path', headers).and_return(request)
       request.should_receive(:body=).with(body).and_return(request)
       basic_client.make_request(method, '/path', body, headers).should == response
     end

data/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 @@ shared_examples "a resource with a collection GET endpoint" do
 
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000Z
+date: 2012-08-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70203258317280 !ruby/object:Gem::Requirement
+  requirement: &70287782974040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203258317280
+  version_requirements: *70287782974040
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70203258316860 !ruby/object:Gem::Requirement
+  requirement: &70287782973620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203258316860
+  version_requirements: *70287782973620
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70203258316440 !ruby/object:Gem::Requirement
+  requirement: &70287782973200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203258316440
+  version_requirements: *70287782973200
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70203258316020 !ruby/object:Gem::Requirement
+  requirement: &70287782972780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203258316020
+  version_requirements: *70287782972780
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70203258315600 !ruby/object:Gem::Requirement
+  requirement: &70287782972360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203258315600
+  version_requirements: *70287782972360
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70203258315180 !ruby/object:Gem::Requirement
+  requirement: &70287782971940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203258315180
+  version_requirements: *70287782971940
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70203258314760 !ruby/object:Gem::Requirement
+  requirement: &70287782971520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203258314760
+  version_requirements: *70287782971520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70203258314340 !ruby/object:Gem::Requirement
+  requirement: &70287782987480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203258314340
+  version_requirements: *70287782987480
 description: API for JIRA 5
 email: 
 executables: []