jira-ruby 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b066da05cd7aa4ef9d974970eeeaecff4934c1d5
-  data.tar.gz: 25cad58db8476f90d18437d0508e2a1f6b9fb5a9
+  metadata.gz: 8705a4ea4d0393dbb5868ad95f420a45f58cea68
+  data.tar.gz: c8abf36c5a0a0d7cf4b2bd7f592d8cc5b32b7f64
 SHA512:
-  metadata.gz: 1847cdcd17d471c02628540c313ed61d14cd260cd7217f79228b7ddead56ff0e5425afaf983cca7d08763dddf6544d60348f27f03a7377fb35a5ccae25c48383
-  data.tar.gz: 041a206f7eaf3c564150d85bb330a3b2e8e9a6d4f1362c5da982c7e11d30da4e2b0d285081762b3e37ae06330ad8476728dd1bde70352d4b2f60cb523164e427
+  metadata.gz: 65f8792ced5b13ce0d3c2e629d7600ce1802cf1479c99f2aed61fc782748819482ef3a45e19affeebff6e23c9d57a8078f86901a8d43e557ba528c05644b052f
+  data.tar.gz: 72c988b648ae5a272a93b9cb4e655e90cadc4643fb2f6d51329d2dbd7d343d82599fbde0782d7100b58555923b9313a6edbb9a3419bf68a31f30e1f1eaf20d6a

data/.gitignore

@@ -8,3 +8,4 @@ pkg/*
 *.pem
 .DS_STORE
 doc
+.ruby-version

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-    - 2.3.1
+    - 2.3
+    - 2.4
     - ruby-head
 before_script:
     - rake jira:generate_public_cert
-script: bundle exec rake spec
+script: bundle exec rake spec

data/README.md

@@ -87,6 +87,8 @@ key.
 > After you have entered all the information click OK and ensure OAuth authentication is
 > enabled.
 
+For 2 legged oauth in server mode only, not in cloud based JIRA, make sure to `Allow 2-Legged OAuth`
+
 ## Configuring JIRA to use HTTP Basic Auth
 
 Follow the same steps described above to set up a new Application Link in JIRA,
@@ -389,3 +391,33 @@ class App < Sinatra::Base
   end
 end
 ```
+
+## Using the API Gem in a 2 legged context
+
+Here's an example on how to use 2 legged OAuth:
+```ruby
+require 'rubygems'
+require 'pp'
+require 'jira-ruby'
+
+options = {
+            :site               => 'http://localhost:2990',
+            :context_path       => '/jira',
+            :signature_method   => 'RSA-SHA1',
+            :private_key_file   => "rsakey.pem",
+            :rest_base_path     => "/rest/api/2",
+            :auth_type => :oauth_2legged,
+            :consumer_key       => "jira-ruby-example"
+          }
+
+client = JIRA::Client.new(options)
+
+client.set_access_token("","")
+
+# Show all projects
+projects = client.Project.all
+
+projects.each do |project|
+  puts "Project -> key: #{project.key}, name: #{project.name}"
+end
+```

data/example.rb

@@ -99,7 +99,16 @@ client.Issue.jql(a_normal_jql_search, max_results: 500)
 # # Create an issue
 # # ---------------
 # issue = client.Issue.build
-# issue.save({"fields"=>{"summary"=>"blarg from in example.rb","project"=>{"id"=>"10001"},"issuetype"=>{"id"=>"3"}}})
+# labels = ['label1', 'label2']
+# issue.save({
+#   "fields" => {
+#     "summary"   => "blarg from in example.rb",
+#     "project"   => {"key" => "SAMPLEPROJECT"},
+#     "issuetype" => {"id" => "3"},
+#     "labels"    => labels,
+#     "priority"  => {"id" => "1"}
+#   }
+# })
 # issue.fetch
 # pp issue
 #

data/lib/jira/base.rb

@@ -447,7 +447,7 @@ module JIRA
     # [07/Jun/2015:15:17:18 +0400] "PUT /jira/rest/api/2/issue/10111 HTTP/1.1" 204 -
     def patched_url
       result = url
-      return result if result.start_with?('/')
+      return result if result.start_with?('/', 'http')
       "/#{result}"
     end
 

data/lib/jira/client.rb

@@ -52,6 +52,7 @@ module JIRA
       :rest_base_path     => "/rest/api/2",
       :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
       :use_ssl            => true,
+      :use_client_cert    => false,
       :auth_type          => :oauth,
       :http_debug         => false
     }
@@ -61,8 +62,15 @@ module JIRA
       @options = options
       @options[:rest_base_path] = @options[:context_path] + @options[:rest_base_path]
 
+      if options[:use_client_cert]
+        raise ArgumentError, 'Options: :cert_path must be set when :use_client_cert is true' unless @options[:cert_path]
+        raise ArgumentError, 'Options: :key_path must be set when :use_client_cert is true' unless @options[:key_path]
+        @options[:cert] = OpenSSL::X509::Certificate.new(File.read(@options[:cert_path]))
+        @options[:key] = OpenSSL::PKey::RSA.new(File.read(@options[:key_path]))
+      end
+
       case options[:auth_type]
-      when :oauth
+      when :oauth, :oauth_2legged
         @request_client = OauthClient.new(@options)
         @consumer = @request_client.consumer
       when :basic
@@ -75,7 +83,7 @@ module JIRA
         @options.delete(:username)
         @options.delete(:password)
       else
-        raise ArgumentError, 'Options: ":auth_type" must be ":oauth", ":cookie" or ":basic"'
+        raise ArgumentError, 'Options: ":auth_type" must be ":oauth",":oauth_2legged", ":cookie" or ":basic"'
       end
 
       @http_debug = @options[:http_debug]

data/lib/jira/http_client.rb

@@ -50,6 +50,10 @@ module JIRA
       end
       http_conn = http_class.new(uri.host, uri.port)
       http_conn.use_ssl = @options[:use_ssl]
+      if @options[:use_client_cert]
+        http_conn.cert = @options[:cert]
+        http_conn.key = @options[:key]
+      end
       http_conn.verify_mode = @options[:ssl_verify_mode]
       http_conn.read_timeout = @options[:read_timeout]
       http_conn

data/lib/jira/oauth_client.rb

@@ -74,6 +74,18 @@ module JIRA
     end
 
     def make_request(http_method, path, body='', headers={})
+      # When using oauth_2legged we need to add an empty oauth_token parameter to every request.
+      if @options[:auth_type] == :oauth_2legged
+        oauth_params_str = "oauth_token="
+        uri = URI.parse(path)
+        if uri.query.to_s == ""
+          uri.query = oauth_params_str
+        else
+          uri.query = uri.query + "&" + oauth_params_str
+        end
+        path = uri.to_s
+      end
+
       case http_method
       when :delete, :get, :head
         response = access_token.send http_method, path, headers

data/lib/jira/resource/issue.rb

@@ -43,12 +43,21 @@ module JIRA
                             :nested_under => ['fields', 'watches']
 
       def self.all(client)
-        url = client.options[:rest_base_path] + "/search?expand=transitions.fields"
-        response = client.get(url)
-        json = parse_json(response.body)
-        json['issues'].map do |issue|
-          client.Issue.build(issue)
+        start_at = 0
+        max_results = 1000
+        result = []
+        loop do
+          url = client.options[:rest_base_path] +
+                "/search?expand=transitions.fields&maxResults=#{max_results}&startAt=#{start_at}"
+          response = client.get(url)
+          json = parse_json(response.body)
+          json['issues'].map do |issue|
+            result.push(client.Issue.build(issue))
+          end
+          break if json['issues'].size == 0
+          start_at += json['issues'].size
         end
+        result
       end
 
       def self.jql(client, jql, options = {fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true})

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '1.4.3'
+  VERSION = '1.5.0'
 end

data/spec/integration/issue_spec.rb

@@ -46,8 +46,11 @@ describe JIRA::Resource::Issue do
         }
       }
       before(:each) do
-        stub_request(:get, site_url + "/jira/rest/api/2/search?expand=transitions.fields").
+        stub_request(:get, site_url + "/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0").
                     to_return(:status => 200, :body => get_mock_response('issue.json'))
+
+        stub_request(:get, site_url + "/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=11").
+                    to_return(:status => 200, :body => get_mock_response('empty_issues.json'))
       end
       it_should_behave_like "a resource with a collection GET endpoint"
     end

data/spec/jira/client_spec.rb

@@ -74,6 +74,36 @@ RSpec.shared_examples 'HttpClient tests' do
   end
 end
 
+RSpec.shared_examples 'OAuth Common Tests' do
+  include_examples 'Client Common Tests'
+
+  specify { expect(subject.request_client).to be_a JIRA::OauthClient }
+
+  it 'allows setting an access token' do
+    token = double
+    expect(OAuth::AccessToken).to receive(:new).with(subject.consumer, '', '').and_return(token)
+
+    expect(subject.authenticated?).to be_falsey
+    access_token = subject.set_access_token('', '')
+    expect(access_token).to eq(token)
+    expect(subject.access_token).to eq(token)
+    expect(subject.authenticated?).to be_truthy
+  end
+
+  describe 'that call a oauth client' do
+    specify 'which makes a request' do
+      [:delete, :get, :head].each do |method|
+        expect(subject.request_client).to receive(:make_request).with(method, '/path', nil, headers).and_return(successful_response)
+        subject.send(method, '/path', {})
+      end
+      [:post, :put].each do |method|
+        expect(subject.request_client).to receive(:make_request).with(method, '/path', '', merged_headers).and_return(successful_response)
+        subject.send(method, '/path', '', {})
+      end
+    end
+  end
+end
+
 describe JIRA::Client do
   let(:request) { subject.request_client.class }
   let(:successful_response) do
@@ -178,51 +208,16 @@ describe JIRA::Client do
     end
   end
 
-  context 'oath2 authentication' do
+  context 'oauth authentication' do
     subject { JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar') }
 
-    include_examples 'Client Common Tests'
-
-    specify { expect(subject.request_client).to be_a JIRA::OauthClient }
-
-    it 'allows setting an access token' do
-      token = double
-      expect(OAuth::AccessToken).to receive(:new).with(subject.consumer, 'foo', 'bar').and_return(token)
-
-      expect(subject.authenticated?).to be_falsey
-      access_token = subject.set_access_token('foo', 'bar')
-      expect(access_token).to eq(token)
-      expect(subject.access_token).to eq(token)
-      expect(subject.authenticated?).to be_truthy
-    end
+    include_examples 'OAuth Common Tests'
+  end
 
-    it 'allows initializing the access token' do
-      request_token = OAuth::RequestToken.new(subject.consumer)
-      allow(subject.consumer).to receive(:get_request_token).and_return(request_token)
-      mock_access_token = double
-      expect(request_token).to receive(:get_access_token).with(:oauth_verifier => 'abc123').and_return(mock_access_token)
-      subject.init_access_token(:oauth_verifier => 'abc123')
-      expect(subject.access_token).to eq(mock_access_token)
-    end
+  context 'with oauth_2legged' do
+    subject { JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar', auth_type: :oauth_2legged) }
 
-    specify 'that has specific default options' do
-      [:signature_method, :private_key_file].each do |key|
-        expect(subject.options[key]).to eq(JIRA::Client::DEFAULT_OPTIONS[key])
-      end
-    end
-
-    describe 'that call a oauth client' do
-      specify 'which makes a request' do
-        [:delete, :get, :head].each do |method|
-          expect(subject.request_client).to receive(:make_request).with(method, '/path', nil, headers).and_return(successful_response)
-          subject.send(method, '/path', {})
-        end
-        [:post, :put].each do |method|
-          expect(subject.request_client).to receive(:make_request).with(method, '/path', '', merged_headers).and_return(successful_response)
-          subject.send(method, '/path', '', {})
-        end
-      end
-    end
+    include_examples 'OAuth Common Tests'
   end
 end
 

data/spec/jira/http_client_spec.rb

@@ -28,6 +28,15 @@ describe JIRA::HttpClient do
     JIRA::HttpClient.new(options)
   end
 
+  let(:basic_client_cert_client) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+      :use_client_cert => true,
+      :cert => 'public certificate contents',
+      :key => 'private key contents'
+    )
+    JIRA::HttpClient.new(options)
+  end
+
   let(:response) do
     response = double("response")
     allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(true)
@@ -170,6 +179,22 @@ describe JIRA::HttpClient do
     expect(basic_client.http_conn(uri)).to eq(http_conn)
   end
 
+  it 'can use client certificates' do
+    http_conn = double
+    uri = double
+    host = double
+    port = double
+    expect(Net::HTTP).to receive(:new).with(host, port).and_return(http_conn)
+    expect(uri).to receive(:host).and_return(host)
+    expect(uri).to receive(:port).and_return(port)
+    expect(http_conn).to receive(:use_ssl=).with(basic_client.options[:use_ssl])
+    expect(http_conn).to receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode])
+    expect(http_conn).to receive(:read_timeout=).with(basic_client.options[:read_timeout])
+    expect(http_conn).to receive(:cert=).with(basic_client_cert_client.options[:cert])
+    expect(http_conn).to receive(:key=).with(basic_client_cert_client.options[:key])
+    expect(basic_client_cert_client.http_conn(uri)).to eq(http_conn)
+  end
+
   it "returns a http connection" do
     http_conn = double()
     uri = double()

data/spec/jira/oauth_client_spec.rb

@@ -107,5 +107,41 @@ describe JIRA::OauthClient do
         oauth_client.request(:get, '/foo', body, headers)
       end
     end
+
+    describe "auth type is oauth_2legged" do
+      let(:oauth__2legged_client) do
+        options = { :consumer_key => 'foo', :consumer_secret => 'bar', :auth_type => :oauth_2legged }
+        options = JIRA::Client::DEFAULT_OPTIONS.merge(options)
+        JIRA::OauthClient.new(options)
+      end
+
+      it "responds to the http methods adding oauth_token parameter" do
+        headers = double()
+        mock_access_token = double()
+        allow(oauth__2legged_client).to receive(:access_token).and_return(mock_access_token)
+        [:delete, :get, :head].each do |method|
+          expect(mock_access_token).to receive(method).with('/path?oauth_token=', headers).and_return(response)
+          oauth__2legged_client.make_request(method, '/path', '', headers)
+        end
+        [:post, :put].each do |method|
+          expect(mock_access_token).to receive(method).with('/path?oauth_token=', '', headers).and_return(response)
+          oauth__2legged_client.make_request(method, '/path', '', headers)
+        end
+      end
+
+      it "responds to the http methods adding oauth_token parameter to any existing parameters" do
+        headers = double()
+        mock_access_token = double()
+        allow(oauth__2legged_client).to receive(:access_token).and_return(mock_access_token)
+        [:delete, :get, :head].each do |method|
+          expect(mock_access_token).to receive(method).with('/path?any_param=toto&oauth_token=', headers).and_return(response)
+          oauth__2legged_client.make_request(method, '/path?any_param=toto', '', headers)
+        end
+        [:post, :put].each do |method|
+          expect(mock_access_token).to receive(method).with('/path?any_param=toto&oauth_token=', '', headers).and_return(response)
+          oauth__2legged_client.make_request(method, '/path?any_param=toto', '', headers)
+        end
+      end
+    end
   end
 end

data/spec/jira/resource/issue_spec.rb

@@ -37,11 +37,16 @@ describe JIRA::Resource::Issue do
 
   it "should find all issues" do
     response = double()
+    empty_response = double()
     issue = double()
 
     allow(response).to receive(:body).and_return('{"issues":[{"id":"1","summary":"Bugs Everywhere"}]}')
-    expect(client).to receive(:get).with('/jira/rest/api/2/search?expand=transitions.fields').
+    expect(client).to receive(:get).with('/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0').
       and_return(response)
+    allow(empty_response).to receive(:body).and_return('{"issues":[]}')
+    expect(client).to receive(:get).with('/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=1').
+      and_return(empty_response)
+      
     expect(client).to receive(:Issue).and_return(issue)
     expect(issue).to receive(:build).with({"id"=>"1","summary"=>"Bugs Everywhere"})
 

data/spec/mock_responses/empty_issues.json

@@ -0,0 +1,8 @@
+{
+  "expand": "schema,names",
+  "startAt": 11,
+  "maxResults": 1000,
+  "total": 0,
+  "issues": [
+  ]
+}

data/spec/mock_responses/issue.json

@@ -1,7 +1,7 @@
 {
   "expand": "schema,names",
   "startAt": 0,
-  "maxResults": 50,
+  "maxResults": 1000,
   "total": 11,
   "issues": [
     {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -200,7 +200,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -292,6 +291,7 @@ files:
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
 - spec/mock_responses/component/10000.put.json
+- spec/mock_responses/empty_issues.json
 - spec/mock_responses/field.json
 - spec/mock_responses/field/1.json
 - spec/mock_responses/issue.json
@@ -365,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jira-ruby
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API
@@ -413,6 +413,7 @@ test_files:
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
 - spec/mock_responses/component/10000.put.json
+- spec/mock_responses/empty_issues.json
 - spec/mock_responses/field.json
 - spec/mock_responses/field/1.json
 - spec/mock_responses/issue.json

data/.ruby-version

@@ -1 +0,0 @@
-2.3.3