jira-ruby 1.8.0 → 2.2.0

data/spec/integration/watcher_spec.rb

@@ -33,21 +33,30 @@ describe JIRA::Resource::Watcher do
     end
 
     describe 'watchers' do
-      it 'should returns all the watchers' do
-        stub_request(:get,
-                     site_url + '/jira/rest/api/2/issue/10002')
+      before(:each) do
+        stub_request(:get, site_url + '/jira/rest/api/2/issue/10002')
           .to_return(status: 200, body: get_mock_response('issue/10002.json'))
 
-        stub_request(:get,
-                     site_url + '/jira/rest/api/2/issue/10002/watchers')
+        stub_request(:get, site_url + '/jira/rest/api/2/issue/10002/watchers')
           .to_return(status: 200, body: get_mock_response('issue/10002/watchers.json'))
 
+        stub_request(:post, site_url + '/jira/rest/api/2/issue/10002/watchers')
+          .to_return(status: 204, body: nil)
+      end
+
+      it 'should returns all the watchers' do
         issue = client.Issue.find('10002')
         watchers = client.Watcher.all(options = { issue: issue })
         expect(watchers.length).to eq(1)
       end
+
+      it 'should add a watcher' do
+        issue = client.Issue.find('10002')
+        watcher = JIRA::Resource::Watcher.new(client, issue: issue)
+        user_id = "tester"
+        watcher.save!(user_id)
+      end
     end
 
-    it_should_behave_like 'a resource'
   end
 end

data/spec/jira/base_spec.rb

@@ -369,6 +369,18 @@ describe JIRA::Base do
       expect(subject.url).to eq('http://foo/bar')
     end
 
+    it 'returns path as the URL if set and site options is specified' do
+      allow(client).to receive(:options) { { site: 'http://foo' } }
+      attrs['self'] = 'http://foo/bar'
+      expect(subject.url).to eq('/bar')
+    end
+
+    it 'returns path as the URL if set and site options is specified and ends with a slash' do
+      allow(client).to receive(:options) { { site: 'http://foo/' } }
+      attrs['self'] = 'http://foo/bar'
+      expect(subject.url).to eq('/bar')
+    end
+
     it 'generates the URL from id if self not set' do
       attrs['self'] = nil
       attrs['id'] = '98765'

data/spec/jira/client_spec.rb

@@ -59,6 +59,19 @@ RSpec.shared_examples 'Client Common Tests' do
       expect(subject.Project.find('123')).to eq(find_result)
     end
   end
+
+  describe 'SSL client options' do
+    context 'without certificate and key' do
+      let(:options) { { use_client_cert: true } }
+      subject { JIRA::Client.new(options) }
+
+      it 'raises an ArgumentError' do
+        expect { subject }.to raise_exception(ArgumentError, 'Options: :cert_path or :ssl_client_cert must be set when :use_client_cert is true')
+        options[:ssl_client_cert] = '<cert></cert>'
+        expect { subject }.to raise_exception(ArgumentError, 'Options: :key_path or :ssl_client_key must be set when :use_client_cert is true')
+      end
+    end
+  end
 end
 
 RSpec.shared_examples 'HttpClient tests' do
@@ -266,4 +279,13 @@ describe JIRA::Client do
 
     include_examples 'OAuth Common Tests'
   end
+
+  context 'with unknown options' do
+    let(:options) { { 'username' => 'foo', 'password' => 'bar', auth_type: :basic } }
+    subject { JIRA::Client.new(options) }
+
+    it 'raises an ArgumentError' do
+      expect { subject }.to raise_exception(ArgumentError, 'Unknown option(s) given: ["username", "password"]')
+    end
+  end
 end

data/spec/jira/http_client_spec.rb

@@ -280,8 +280,8 @@ describe JIRA::HttpClient do
     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(http_conn).to receive(:cert=).with(basic_client_cert_client.options[:ssl_client_cert])
+    expect(http_conn).to receive(:key=).with(basic_client_cert_client.options[:ssl_client_key])
     expect(basic_client_cert_client.http_conn(uri)).to eq(http_conn)
   end
 
@@ -292,4 +292,37 @@ describe JIRA::HttpClient do
     expect(basic_client).to receive(:http_conn).and_return(http_conn)
     expect(basic_client.basic_auth_http_conn).to eq(http_conn)
   end
+
+  describe '#make_multipart_request' do
+    subject do
+      basic_client.make_multipart_request(path, data, headers)
+    end
+
+    let(:path) { '/foo' }
+    let(:data) { {} }
+    let(:headers) { { 'X-Atlassian-Token' => 'no-check' } }
+    let(:basic_auth_http_conn) { double }
+    let(:request) { double('Http Request', path: path) }
+    let(:response) { double('response') }
+
+    before do
+      allow(request).to receive(:basic_auth)
+      allow(Net::HTTP::Post::Multipart).to receive(:new).with(path, data, headers).and_return(request)
+      allow(basic_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
+      allow(basic_auth_http_conn).to receive(:request).with(request).and_return(response)
+    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)
+
+      subject
+    end
+
+    it 'makes a correct HTTP request' do
+      expect(basic_auth_http_conn).to receive(:request).with(request).and_return(response)
+      expect(response).to receive(:is_a?).with(Net::HTTPOK)
+
+      subject
+    end
+  end
 end

data/spec/jira/oauth_client_spec.rb

@@ -82,28 +82,45 @@ describe JIRA::OauthClient do
     end
 
     describe 'http' do
+      let(:headers) { double }
+      let(:access_token) { double }
+      let(:body) { nil }
+
+      before do
+        allow(oauth_client).to receive(:access_token).and_return(access_token)
+      end
+
       it 'responds to the http methods' do
-        headers = double
-        mock_access_token = double
-        allow(oauth_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', headers).and_return(response)
+          expect(access_token).to receive(method).with('/path', headers).and_return(response)
           oauth_client.make_request(method, '/path', '', headers)
         end
         %i[post put].each do |method|
-          expect(mock_access_token).to receive(method).with('/path', '', headers).and_return(response)
+          expect(access_token).to receive(method).with('/path', '', headers).and_return(response)
           oauth_client.make_request(method, '/path', '', headers)
         end
       end
 
       it 'performs a request' do
-        body = nil
-        headers = double
-        access_token = double
         expect(access_token).to receive(:send).with(:get, '/foo', headers).and_return(response)
-        allow(oauth_client).to receive(:access_token).and_return(access_token)
+
+
         oauth_client.request(:get, '/foo', body, headers)
       end
+
+      context 'for a multipart request' do
+        subject { oauth_client.make_multipart_request('/path', data, headers) }
+
+        let(:data) { {} }
+        let(:headers) { {} }
+
+        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))
+
+          subject
+        end
+      end
     end
 
     describe 'auth type is oauth_2legged' do
@@ -142,4 +159,4 @@ describe JIRA::OauthClient do
       end
     end
   end
-end
+end

data/spec/jira/request_client_spec.rb

@@ -1,14 +1,41 @@
 require 'spec_helper'
 
 describe JIRA::RequestClient do
-  it 'raises an exception for non success responses' do
-    response = double
-    allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(false)
-    rc = JIRA::RequestClient.new
-    expect(rc).to receive(:make_request).with(:get, '/foo', '', {}).and_return(response)
-
-    expect do
-      rc.request(:get, '/foo', '', {})
-    end.to raise_exception(JIRA::HTTPError)
+  let(:request_client) { JIRA::RequestClient.new }
+
+  describe '#request' do
+    subject(:request) { request_client.request(:get, '/foo', '', {}) }
+
+    context 'when doing a request fails' do
+      let(:response) { double }
+
+      before do
+        allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(false)
+        allow(request_client).to receive(:make_request).with(:get, '/foo', '', {}).and_return(response)
+      end
+
+      it 'raises an exception' do
+        expect{ subject }.to raise_exception(JIRA::HTTPError)
+      end
+    end
+  end
+
+  describe '#request_multipart' do
+    subject(:request) { request_client.request_multipart('/foo', data, {}) }
+
+    let(:data) { double }
+
+    context 'when doing a request fails' do
+      let(:response) { double }
+
+      before do
+        allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(false)
+        allow(request_client).to receive(:make_multipart_request).with('/foo', data, {}).and_return(response)
+      end
+
+      it 'raises an exception' do
+        expect{ subject }.to raise_exception(JIRA::HTTPError)
+      end
+    end
   end
-end
+end

data/spec/jira/resource/attachment_spec.rb

@@ -1,6 +1,14 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Attachment do
+  subject(:attachment) do
+    JIRA::Resource::Attachment.new(
+        client,
+        issue: JIRA::Resource::Issue.new(client),
+        attrs: { 'author' => { 'foo' => 'bar' } }
+    )
+  end
+
   let(:client) do
     double(
       'client',
@@ -17,42 +25,78 @@ describe JIRA::Resource::Attachment do
   end
 
   describe 'relationships' do
-    subject do
-      JIRA::Resource::Attachment.new(client,
-                                     issue: JIRA::Resource::Issue.new(client),
-                                     attrs: { 'author' => { 'foo' => 'bar' } })
+    it 'has an author' do
+      expect(subject).to have_one(:author, JIRA::Resource::User)
     end
 
-    it 'has the correct relationships' do
-      expect(subject).to have_one(:author, JIRA::Resource::User)
+    it 'has the correct author name' do
       expect(subject.author.foo).to eq('bar')
     end
   end
 
-  describe '#meta' do
+  describe '.meta' do
+    subject { JIRA::Resource::Attachment.meta(client) }
+
     let(:response) do
       double(
-        'response',
-        body: '{"enabled":true,"uploadLimit":10485760}'
+          'response',
+          body: '{"enabled":true,"uploadLimit":10485760}'
       )
     end
 
     it 'returns meta information about attachment upload' do
       expect(client).to receive(:get).with('/jira/rest/api/2/attachment/meta').and_return(response)
-      JIRA::Resource::Attachment.meta(client)
+
+      subject
     end
 
-    subject { JIRA::Resource::AttachmentFactory.new(client) }
+    context 'the factory delegates correctly' do
+      subject { JIRA::Resource::AttachmentFactory.new(client) }
 
-    it 'delegates #meta to to target class' do
-      expect(subject).to respond_to(:meta)
+      it 'delegates #meta to to target class' do
+        expect(subject).to respond_to(:meta)
+      end
     end
   end
 
-  describe '#save!' do
+  describe '#save' do
+    subject { attachment.save('file' => path_to_file) }
+    let(:path_to_file) { './spec/mock_responses/issue.json' }
+    let(:response) do
+      double(
+        body: [
+          {
+            "id": 10_001,
+            "self": 'http://www.example.com/jira/rest/api/2.0/attachments/10000',
+            "filename": 'picture.jpg',
+            "created": '2017-07-19T12:23:06.572+0000',
+            "size": 23_123,
+            "mimeType": 'image/jpeg'
+          }
+        ].to_json
+      )
+    end
+    let(:issue) { JIRA::Resource::Issue.new(client) }
+
+    before do
+      allow(client).to receive(:post_multipart).and_return(response)
+    end
+
     it 'successfully update the attachment' do
-      basic_auth_http_conn = double
-      response = double(
+      subject
+
+      expect(attachment.filename).to eq 'picture.jpg'
+      expect(attachment.mimeType).to eq 'image/jpeg'
+      expect(attachment.size).to eq 23_123
+    end
+  end
+
+  describe '#save!' do
+    subject { attachment.save!('file' => path_to_file) }
+
+    let(:path_to_file) { './spec/mock_responses/issue.json' }
+    let(:response) do
+      double(
         body: [
           {
             "id": 10_001,
@@ -64,18 +108,31 @@ describe JIRA::Resource::Attachment do
           }
         ].to_json
       )
+    end
+    let(:issue) { JIRA::Resource::Issue.new(client) }
 
-      allow(client.request_client).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
-      allow(basic_auth_http_conn).to receive(:request).and_return(response)
+    before do
+      allow(client).to receive(:post_multipart).and_return(response)
+    end
 
-      issue = JIRA::Resource::Issue.new(client)
-      path_to_file = './spec/mock_responses/issue.json'
-      attachment = JIRA::Resource::Attachment.new(client, issue: issue)
-      attachment.save!('file' => path_to_file)
+    it 'successfully update the attachment' do
+      subject
 
       expect(attachment.filename).to eq 'picture.jpg'
       expect(attachment.mimeType).to eq 'image/jpeg'
       expect(attachment.size).to eq 23_123
     end
+
+    context 'when passing in a symbol as file key' do
+      subject { attachment.save!(file: path_to_file) }
+
+      it 'successfully update the attachment' do
+        subject
+
+        expect(attachment.filename).to eq 'picture.jpg'
+        expect(attachment.mimeType).to eq 'image/jpeg'
+        expect(attachment.size).to eq 23_123
+      end
+    end
   end
 end

data/spec/jira/resource/issue_picker_suggestions_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe JIRA::Resource::IssuePickerSuggestions do
+  let(:client) do
+    double('client', options: {
+      rest_base_path: '/jira/rest/api/2'
+    })
+  end
+
+  describe 'relationships' do
+    subject do
+      JIRA::Resource::IssuePickerSuggestions.new(client, attrs: {
+        'sections' => [{ 'id' => 'hs'}, { 'id' => 'cs' }]
+      })
+    end
+
+    it 'has the correct relationships' do
+      expect(subject).to have_many(:sections, JIRA::Resource::IssuePickerSuggestionsIssue)
+      expect(subject.sections.length).to eq(2)
+    end
+  end
+
+  describe '#all' do
+    let(:response) { double }
+    let(:issue_picker_suggestions) { double }
+
+    before do
+      allow(response).to receive(:body).and_return('{"sections":[{"id": "cs"}]}')
+      allow(client).to receive(:IssuePickerSuggestions).and_return(issue_picker_suggestions)
+      allow(issue_picker_suggestions).to receive(:build)
+    end
+
+    it 'should autocomplete issues' do
+      allow(response).to receive(:body).and_return('{"sections":[{"id": "cs"}]}')
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query')
+                                     .and_return(response)
+
+      expect(client).to receive(:IssuePickerSuggestions).and_return(issue_picker_suggestions)
+      expect(issue_picker_suggestions).to receive(:build).with('sections' => [{ 'id' => 'cs' }])
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query')
+    end
+
+    it 'should autocomplete issues with current jql' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentJQL=project+%3D+PR')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_jql: 'project = PR')
+    end
+
+    it 'should autocomplete issues with current issue jey' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentIssueKey=PR-42')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_issue_key: 'PR-42')
+    end
+
+    it 'should autocomplete issues with current project id' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentProjectId=PR')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_project_id: 'PR')
+    end
+
+    it 'should autocomplete issues with show sub tasks' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&showSubTasks=true')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', show_sub_tasks: true)
+    end
+
+    it 'should autocomplete issues with show sub tasks parent' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&showSubTaskParent=true')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', show_sub_task_parent: true)
+    end
+  end
+end

data/spec/jira/resource/jira_picker_suggestions_issue_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe JIRA::Resource::IssuePickerSuggestionsIssue do
+  let(:client) { double('client') }
+
+  describe 'relationships' do
+    subject do
+      JIRA::Resource::IssuePickerSuggestionsIssue.new(client, attrs: {
+        'issues' => [{ 'id' => '1'}, { 'id' => '2' }]
+      })
+    end
+
+    it 'has the correct relationships' do
+      expect(subject).to have_many(:issues, JIRA::Resource::SuggestedIssue)
+      expect(subject.issues.length).to eq(2)
+    end
+  end
+end

data/spec/jira/resource/sprint_spec.rb

@@ -1,12 +1,25 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Sprint do
-  describe 'peristence' do
-    let(:sprint) { described_class.new(client) }
-    let(:client) { double('Client', options: { site: 'https://foo.bar.com' }) }
+  let(:client) do
+    client = double(options: { site: 'https://foo.bar.com', context_path: '/jira' })
+    allow(client).to receive(:Sprint).and_return(JIRA::Resource::SprintFactory.new(client))
+    client
+  end
+  let(:sprint) { described_class.new(client) }
+  let(:agile_sprint_path) { "#{sprint.client.options[:context_path]}/rest/agile/1.0/sprint/#{sprint.id}" }
 
+  describe '::find' do
+    let(:response) { double('Response', body: '{"some_detail":"some detail"}') }
+
+    it 'fetches the sprint from JIRA' do
+      expect(client).to receive(:get).with('/jira/rest/agile/1.0/sprint/111').and_return(response)
+      expect(JIRA::Resource::Sprint.find(client, '111')).to be_a(JIRA::Resource::Sprint)
+    end
+  end
+
+  describe 'peristence' do
     describe '#save' do
-      let(:agile_sprint_url) { "#{sprint.client.options[:site]}/rest/agile/1.0/sprint/#{sprint.id}" }
       let(:instance_attrs) { { start_date: '2016-06-01' } }
 
       before do
@@ -17,7 +30,7 @@ describe JIRA::Resource::Sprint do
         let(:given_attrs) { { start_date: '2016-06-10' } }
 
         it 'calls save on the super class with the given attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(given_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save).with(given_attrs, agile_sprint_path)
 
           sprint.save(given_attrs)
         end
@@ -25,7 +38,7 @@ describe JIRA::Resource::Sprint do
 
       context 'when attributes are not specified' do
         it 'calls save on the super class with the instance attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_path)
 
           sprint.save
         end
@@ -33,7 +46,7 @@ describe JIRA::Resource::Sprint do
 
       context 'when providing the path argument' do
         it 'ignores it' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_path)
 
           sprint.save({}, 'mavenlink.com')
         end
@@ -41,7 +54,6 @@ describe JIRA::Resource::Sprint do
     end
 
     describe '#save!' do
-      let(:agile_sprint_url) { "#{sprint.client.options[:site]}/rest/agile/1.0/sprint/#{sprint.id}" }
       let(:instance_attrs) { { start_date: '2016-06-01' } }
 
       before do
@@ -52,7 +64,7 @@ describe JIRA::Resource::Sprint do
         let(:given_attrs) { { start_date: '2016-06-10' } }
 
         it 'calls save! on the super class with the given attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(given_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save!).with(given_attrs, agile_sprint_path)
 
           sprint.save!(given_attrs)
         end
@@ -60,7 +72,7 @@ describe JIRA::Resource::Sprint do
 
       context 'when attributes are not specified' do
         it 'calls save! on the super class with the instance attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_path)
 
           sprint.save!
         end
@@ -68,7 +80,7 @@ describe JIRA::Resource::Sprint do
 
       context 'when providing the path argument' do
         it 'ignores it' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_url)
+          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_path)
 
           sprint.save!({}, 'mavenlink.com')
         end