jira-ruby 2.3.0 → 3.0.0.beta1

data/spec/jira/http_client_spec.rb

@@ -5,7 +5,7 @@ describe JIRA::HttpClient do
     options = JIRA::Client::DEFAULT_OPTIONS
               .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
               .merge(basic_auth_credentials)
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_cookie_client) do
@@ -13,12 +13,12 @@ describe JIRA::HttpClient do
               .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
               .merge(use_cookies: true)
               .merge(basic_auth_credentials)
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:custom_ssl_version_client) do
     options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(ssl_version: :TLSv1_2)
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_cookie_client_with_context_path) do
@@ -26,7 +26,7 @@ describe JIRA::HttpClient do
       use_cookies: true,
       context_path: '/context'
     )
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_cookie_client_with_additional_cookies) do
@@ -37,7 +37,7 @@ describe JIRA::HttpClient do
                 additional_cookies: ['sessionToken=abc123', 'internal=true']
               )
               .merge(basic_auth_credentials)
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_client_cert_client) do
@@ -46,13 +46,13 @@ describe JIRA::HttpClient do
       cert: 'public certificate contents',
       key: 'private key contents'
     )
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_client_with_no_auth_credentials) do
     options = JIRA::Client::DEFAULT_OPTIONS
               .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
   end
 
   let(:basic_auth_credentials) do
@@ -66,7 +66,14 @@ describe JIRA::HttpClient do
       proxy_username: 'proxyUsername',
       proxy_password: 'proxyPassword'
     )
-    JIRA::HttpClient.new(options)
+    described_class.new(options)
+  end
+
+  let(:basic_client_with_max_retries) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+      max_retries: 2
+    )
+    described_class.new(options)
   end
 
   let(:response) do
@@ -81,6 +88,35 @@ describe JIRA::HttpClient do
     response
   end
 
+  context 'simple client' do
+    let(:client) do
+      options_local = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+        proxy_address: 'proxyAddress',
+        proxy_port: 42,
+        proxy_username: 'proxyUsername',
+        proxy_password: 'proxyPassword'
+      )
+      described_class.new(options_local)
+    end
+
+    describe 'HttpClient#basic_auth_http_conn' do
+      subject(:http_conn) { basic_client.basic_auth_http_conn }
+
+      it 'creates an instance of Net:HTTP for a basic auth client' do
+        expect(http_conn.class).to eq(Net::HTTP)
+      end
+
+      it 'the connection created has no proxy' do
+        http_conn
+
+        expect(http_conn.proxy_address).to be_nil
+        expect(http_conn.proxy_port).to be_nil
+        expect(http_conn.proxy_user).to be_nil
+        expect(http_conn.proxy_pass).to be_nil
+      end
+    end
+  end
+
   it 'creates an instance of Net:HTTP for a basic auth client' do
     expect(basic_client.basic_auth_http_conn.class).to eq(Net::HTTP)
   end
@@ -111,7 +147,8 @@ describe JIRA::HttpClient do
     basic_auth_http_conn = double
     request = double
     allow(basic_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
-    expect(request).to receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).exactly(5).times.and_return(request)
+    expect(request).to receive(:basic_auth).with(basic_client.options[:username],
+                                                 basic_client.options[:password]).exactly(5).times.and_return(request)
     expect(basic_auth_http_conn).to receive(:request).exactly(5).times.with(request).and_return(response)
     %i[delete get head].each do |method|
       expect(Net::HTTP.const_get(method.to_s.capitalize)).to receive(:new).with('/path', headers).and_return(request)
@@ -130,7 +167,8 @@ describe JIRA::HttpClient do
     basic_auth_http_conn = double
     request = double
     allow(basic_cookie_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
-    expect(request).to receive(:basic_auth).with(basic_cookie_client.options[:username], basic_cookie_client.options[:password]).exactly(5).times.and_return(request)
+    expect(request).to receive(:basic_auth).with(basic_cookie_client.options[:username],
+                                                 basic_cookie_client.options[:password]).exactly(5).times.and_return(request)
     expect(cookie_response).to receive(:get_fields).with('set-cookie').exactly(5).times
     expect(basic_auth_http_conn).to receive(:request).exactly(5).times.with(request).and_return(cookie_response)
     %i[delete get head].each do |method|
@@ -151,7 +189,8 @@ describe JIRA::HttpClient do
     basic_auth_http_conn = double
     request = double
     allow(client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
-    expect(request).to receive(:basic_auth).with(client.options[:username], client.options[:password]).exactly(5).times.and_return(request)
+    expect(request).to receive(:basic_auth).with(client.options[:username],
+                                                 client.options[:password]).exactly(5).times.and_return(request)
     expect(request).to receive(:add_field).with('Cookie', 'sessionToken=abc123; internal=true').exactly(5).times
     expect(cookie_response).to receive(:get_fields).with('set-cookie').exactly(5).times
     expect(basic_auth_http_conn).to receive(:request).exactly(5).times.with(request).and_return(cookie_response)
@@ -174,7 +213,8 @@ describe JIRA::HttpClient do
     expect(Net::HTTP::Get).to receive(:new).with('/foo', headers).and_return(http_request)
 
     expect(basic_auth_http_conn).to receive(:request).with(http_request).and_return(response)
-    expect(http_request).to receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).and_return(http_request)
+    expect(http_request).to receive(:basic_auth).with(basic_client.options[:username],
+                                                      basic_client.options[:password]).and_return(http_request)
     allow(basic_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
     basic_client.make_request(:get, '/foo', body, headers)
   end
@@ -187,7 +227,8 @@ describe JIRA::HttpClient do
     expect(Net::HTTP::Get).to receive(:new).with('/foo', headers).and_return(http_request)
 
     expect(basic_auth_http_conn).to receive(:request).with(http_request).and_return(response)
-    expect(http_request).to receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).and_return(http_request)
+    expect(http_request).to receive(:basic_auth).with(basic_client.options[:username],
+                                                      basic_client.options[:password]).and_return(http_request)
     allow(basic_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
     basic_client.make_request(:get, 'http://mydomain.com/foo', body, headers)
   end
@@ -254,19 +295,29 @@ describe JIRA::HttpClient do
     expect(proxy_configuration.proxy_pass).to be_nil
   end
 
-  it 'sets up a proxied http connection when using proxy options' do
-    uri = double
-    host = double
-    port = double
+  context 'client has proxy settings' do
+    subject(:proxy_conn) { proxy_client.basic_auth_http_conn }
+
+    let(:proxy_client) do
+      options_local = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+        proxy_address: 'proxyAddress',
+        proxy_port: 42,
+        proxy_username: 'proxyUsername',
+        proxy_password: 'proxyPassword'
+      )
+      described_class.new(options_local)
+    end
 
-    expect(uri).to receive(:host).and_return(host)
-    expect(uri).to receive(:port).and_return(port)
+    describe 'HttpClient#basic_auth_http_conn' do
+      it 'creates a Net:HTTP instance for a basic auth client setting up a proxied http connection' do
+        expect(proxy_conn.class).to eq(Net::HTTP)
 
-    proxy_configuration = proxy_client.http_conn(uri).class
-    expect(proxy_configuration.proxy_address).to eq(proxy_client.options[:proxy_address])
-    expect(proxy_configuration.proxy_port).to eq(proxy_client.options[:proxy_port])
-    expect(proxy_configuration.proxy_user).to eq(proxy_client.options[:proxy_username])
-    expect(proxy_configuration.proxy_pass).to eq(proxy_client.options[:proxy_password])
+        expect(proxy_conn.proxy_address).to eq(proxy_client.options[:proxy_address])
+        expect(proxy_conn.proxy_port).to eq(proxy_client.options[:proxy_port])
+        expect(proxy_conn.proxy_user).to eq(proxy_client.options[:proxy_username])
+        expect(proxy_conn.proxy_pass).to eq(proxy_client.options[:proxy_password])
+      end
+    end
   end
 
   it 'can use client certificates' do
@@ -286,10 +337,25 @@ describe JIRA::HttpClient do
   end
 
   it 'can use a certificate authority file' do
-    client = JIRA::HttpClient.new(JIRA::Client::DEFAULT_OPTIONS.merge(ca_file: '/opt/custom.ca.pem'))
+    client = described_class.new(JIRA::Client::DEFAULT_OPTIONS.merge(ca_file: '/opt/custom.ca.pem'))
     expect(client.http_conn(client.uri).ca_file).to eql('/opt/custom.ca.pem')
   end
 
+  it 'allows overriding max_retries' do
+    http_conn = double
+    uri = double
+    host = double
+    port = double
+    expect(uri).to receive(:host).and_return(host)
+    expect(uri).to receive(:port).and_return(port)
+    expect(Net::HTTP).to receive(:new).with(host, port).and_return(http_conn)
+    expect(http_conn).to receive(:use_ssl=).with(basic_client.options[:use_ssl]).and_return(http_conn)
+    expect(http_conn).to receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode]).and_return(http_conn)
+    expect(http_conn).to receive(:read_timeout=).with(basic_client.options[:read_timeout]).and_return(http_conn)
+    expect(http_conn).to receive(:max_retries=).with(basic_client_with_max_retries.options[:max_retries]).and_return(http_conn)
+    expect(basic_client_with_max_retries.http_conn(uri)).to eq(http_conn)
+  end
+
   it 'returns a http connection' do
     http_conn = double
     uri = double
@@ -307,7 +373,7 @@ describe JIRA::HttpClient do
     let(:data) { {} }
     let(:headers) { { 'X-Atlassian-Token' => 'no-check' } }
     let(:basic_auth_http_conn) { double }
-    let(:request) { double('Http Request', path: path) }
+    let(:request) { double('Http Request', path:) }
     let(:response) { double('response') }
 
     before do
@@ -318,7 +384,8 @@ describe JIRA::HttpClient do
     end
 
     it 'performs a basic http client request' do
-      expect(request).to receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).and_return(request)
+      expect(request).to receive(:basic_auth).with(basic_client.options[:username],
+                                                   basic_client.options[:password]).and_return(request)
 
       subject
     end

data/spec/jira/http_error_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe JIRA::HTTPError do
+  subject { described_class.new(response) }
+
   let(:response) do
     response = double('response')
     allow(response).to receive(:code).and_return(401)
@@ -8,8 +10,6 @@ describe JIRA::HTTPError do
     response
   end
 
-  subject { described_class.new(response) }
-
   it 'takes the response object as an argument' do
     expect(subject.response).to eq(response)
   end

data/spec/jira/oauth_client_spec.rb

@@ -4,7 +4,7 @@ describe JIRA::OauthClient do
   let(:oauth_client) do
     options = { consumer_key: 'foo', consumer_secret: 'bar' }
     options = JIRA::Client::DEFAULT_OPTIONS.merge(options)
-    JIRA::OauthClient.new(options)
+    described_class.new(options)
   end
 
   let(:response) do
@@ -124,7 +124,6 @@ describe JIRA::OauthClient do
       it 'performs a request' do
         expect(access_token).to receive(:send).with(:get, '/foo', headers).and_return(response)
 
-
         oauth_client.request(:get, '/foo', body, headers)
       end
 
@@ -136,7 +135,8 @@ describe JIRA::OauthClient do
 
         it 'signs the access_token and performs the request' do
           expect(access_token).to receive(:sign!).with(an_instance_of(Net::HTTP::Post::Multipart))
-          expect(oauth_client.consumer).to receive_message_chain(:http, :request).with(an_instance_of(Net::HTTP::Post::Multipart))
+          expect(oauth_client.consumer).to receive_message_chain(:http,
+                                                                 :request).with(an_instance_of(Net::HTTP::Post::Multipart))
 
           subject
         end
@@ -147,7 +147,7 @@ describe JIRA::OauthClient 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)
+        described_class.new(options)
       end
 
       it 'responds to the http methods adding oauth_token parameter' do
@@ -169,11 +169,13 @@ describe JIRA::OauthClient do
         mock_access_token = double
         allow(oauth__2legged_client).to receive(:access_token).and_return(mock_access_token)
         %i[delete get head].each do |method|
-          expect(mock_access_token).to receive(method).with('/path?any_param=toto&oauth_token=', headers).and_return(response)
+          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
         %i[post put].each do |method|
-          expect(mock_access_token).to receive(method).with('/path?any_param=toto&oauth_token=', '', headers).and_return(response)
+          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

data/spec/jira/request_client_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe JIRA::RequestClient do
-  let(:request_client) { JIRA::RequestClient.new }
+  let(:request_client) { described_class.new }
 
   describe '#request' do
     subject(:request) { request_client.request(:get, '/foo', '', {}) }
@@ -15,7 +15,7 @@ describe JIRA::RequestClient do
       end
 
       it 'raises an exception' do
-        expect{ subject }.to raise_exception(JIRA::HTTPError)
+        expect { subject }.to raise_exception(JIRA::HTTPError)
       end
     end
   end
@@ -34,8 +34,8 @@ describe JIRA::RequestClient do
       end
 
       it 'raises an exception' do
-        expect{ subject }.to raise_exception(JIRA::HTTPError)
+        expect { subject }.to raise_exception(JIRA::HTTPError)
       end
     end
   end
-end
+end

data/spec/jira/resource/agile_spec.rb

@@ -9,34 +9,34 @@ describe JIRA::Resource::Agile do
   let(:response) { double }
 
   describe '#all' do
-    it 'should query url without parameters' do
+    it 'queries url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.all(client)
+      described_class.all(client)
     end
   end
 
   describe '#get_backlog_issues' do
-    it 'should query the url without parameters' do
+    it 'queries the url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/backlog?maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_backlog_issues(client, 1)
+      described_class.get_backlog_issues(client, 1)
     end
   end
 
   describe '#get_board_issues' do
-    it 'should query correct url without parameters' do
+    it 'queries correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
       expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
-      issues = JIRA::Resource::Agile.get_board_issues(client, 1)
+      issues = described_class.get_board_issues(client, 1)
       expect(issues).to be_an(Array)
-      expect(issues.size).to eql(9)
+      expect(issues.size).to be(9)
 
       issues.each do |issue|
         expect(issue.class).to eq(JIRA::Resource::Issue)
@@ -44,16 +44,16 @@ describe JIRA::Resource::Agile do
       end
     end
 
-    it 'should query correct url with parameters' do
+    it 'queries correct url with parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?startAt=50').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
       expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
-      issues = JIRA::Resource::Agile.get_board_issues(client, 1, startAt: 50)
+      issues = described_class.get_board_issues(client, 1, startAt: 50)
       expect(issues).to be_an(Array)
-      expect(issues.size).to eql(9)
+      expect(issues.size).to be(9)
 
       issues.each do |issue|
         expect(issue.class).to eq(JIRA::Resource::Issue)
@@ -63,73 +63,73 @@ describe JIRA::Resource::Agile do
   end
 
   describe '#get_sprints' do
-    it 'should query correct url without parameters' do
+    it 'queries correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_sprints(client, 1)
+      described_class.get_sprints(client, 1)
     end
 
-    it 'should query correct url with parameters' do
+    it 'queries correct url with parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?startAt=50&maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_sprints(client, 1, startAt: 50)
+      described_class.get_sprints(client, 1, startAt: 50)
     end
 
-    it 'should work with pagination starting at 0' do
+    it 'works with pagination starting at 0' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=1&startAt=0').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_sprints(client, 1, maxResults: 1, startAt: 0)
+      described_class.get_sprints(client, 1, maxResults: 1, startAt: 0)
     end
 
-    it 'should work with pagination not starting at 0' do
+    it 'works with pagination not starting at 0' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=1&startAt=1').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_sprints(client, 1, maxResults: 1, startAt: 1)
+      described_class.get_sprints(client, 1, maxResults: 1, startAt: 1)
     end
   end
 
   describe '#get_sprint_issues' do
-    it 'should query correct url without parameters' do
+    it 'queries correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/sprint/1/issue?maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('sprint/1_issues.json'))
 
-      JIRA::Resource::Agile.get_sprint_issues(client, 1)
+      described_class.get_sprint_issues(client, 1)
     end
 
-    it 'should query correct url with parameters' do
+    it 'queries correct url with parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/sprint/1/issue?startAt=50&maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('sprint/1_issues.json'))
 
-      JIRA::Resource::Agile.get_sprint_issues(client, 1, startAt: 50)
+      described_class.get_sprint_issues(client, 1, startAt: 50)
     end
   end
 
   describe '#get_projects_full' do
-    it 'should query correct url without parameters' do
+    it 'queries correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/project/full').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_projects_full(client, 1)
+      described_class.get_projects_full(client, 1)
     end
   end
 
   describe '#get_projects' do
-    it 'should query correct url without parameters' do
+    it 'queries correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/project?maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_projects(client, 1)
+      described_class.get_projects(client, 1)
     end
 
-    it 'should query correct url with parameters' do
+    it 'queries correct url with parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/project?startAt=50&maxResults=100').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
 
-      JIRA::Resource::Agile.get_projects(client, 1, startAt: 50)
+      described_class.get_projects(client, 1, startAt: 50)
     end
   end
 end