jira-ruby 2.3.0 → 3.0.0.beta2

data/spec/jira/resource/agile_spec.rb

@@ -9,127 +9,127 @@ 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)
-        expect(issue.expanded?).to be_falsey
+        expect(issue).not_to be_expanded
       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)
-        expect(issue.expanded?).to be_falsey
+        expect(issue).not_to be_expanded
       end
     end
   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

data/spec/jira/resource/attachment_spec.rb

@@ -2,13 +2,15 @@ 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' } }
+    described_class.new(
+      client,
+      issue: JIRA::Resource::Issue.new(client, attrs: { 'id' => issue_id }),
+      attrs: { 'author' => { 'foo' => 'bar' }, 'id' => attachment_id }
     )
   end
 
+  let(:issue_id) { 27_676 }
+  let(:attachment_id) { 30_076 }
   let(:client) do
     double(
       'client',
@@ -35,22 +37,26 @@ describe JIRA::Resource::Attachment do
   end
 
   describe '.meta' do
-    subject { JIRA::Resource::Attachment.meta(client) }
+    subject { described_class.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)
+    context 'when returning meta information' do
+      it 'returns meta information about attachment upload' do
+        expect(client).to receive(:get).with('/jira/rest/api/2/attachment/meta').and_return(response)
+
+        result = subject
 
-      subject
+        expect(result).to be_a(Hash)
+      end
     end
 
-    context 'the factory delegates correctly' do
+    context 'when the factory delegates correctly' do
       subject { JIRA::Resource::AttachmentFactory.new(client) }
 
       it 'delegates #meta to to target class' do
@@ -59,79 +65,186 @@ describe JIRA::Resource::Attachment do
     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,
-            "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
+  context 'when there is an attachment on an issue' do
+    subject(:attachment) do
+      described_class.new(
+        client,
+        issue: JIRA::Resource::Issue.new(client),
+        attrs: { 'author' => { 'foo' => 'bar' }, 'content' => attachment_url }
       )
     end
-    let(:issue) { JIRA::Resource::Issue.new(client) }
+
+    let(:attachment_url) { 'https://localhost:2990/secure/attachment/32323/myfile.txt' }
+    let(:client) do
+      JIRA::Client.new(username: 'username', password: 'password', auth_type: :basic, use_ssl: false)
+    end
+    let(:attachment_file_contents) { 'file contents' }
+    let(:issue_id) { 3232 }
+    let(:issue) { JIRA::Resource::Issue.new(client, attrs: { 'id' => issue_id }) }
 
     before do
-      allow(client).to receive(:post_multipart).and_return(response)
+      stub_request(:get, attachment_url).to_return(body: attachment_file_contents)
     end
 
-    it 'successfully update the attachment' do
-      subject
+    describe '.download_file' do
+      context 'when passing file object to block' do
+        it 'passes file object to block' do
+          expect(URI).to receive(:parse).with(attachment_url).and_call_original
 
-      expect(attachment.filename).to eq 'picture.jpg'
-      expect(attachment.mimeType).to eq 'image/jpeg'
-      expect(attachment.size).to eq 23_123
+          attachment.download_file do |file|
+            expect(file.read).to eq(attachment_file_contents)
+          end
+        end
+      end
     end
-  end
 
-  describe '#save!' do
-    subject { attachment.save!('file' => path_to_file) }
+    describe '.download_contents' do
+      it 'downloads the file contents as a string' do
+        expect(URI).to receive(:parse).with(attachment_url).and_call_original
+
+        expect(attachment.download_contents).to eq(attachment_file_contents)
+      end
+    end
+  end
 
-    let(:path_to_file) { './spec/mock_responses/issue.json' }
+  context 'when there is a local file' do
+    let(:file_name) { 'short.txt' }
+    let(:file_size) { 11 }
+    let(:file_mime_type) { 'text/plain' }
+    let(:path_to_file) { "./spec/data/files/#{file_name}" }
     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'
+            id: 10_001,
+            self: 'http://www.example.com/jira/rest/api/2.0/attachments/10000',
+            filename: file_name,
+            created: '2017-07-19T12:23:06.572+0000',
+            size: file_size,
+            mimeType: file_mime_type
           }
         ].to_json
       )
     end
-    let(:issue) { JIRA::Resource::Issue.new(client) }
+    let(:issue) { JIRA::Resource::Issue.new(client, attrs: { 'id' => issue_id }) }
 
-    before do
-      allow(client).to receive(:post_multipart).and_return(response)
-    end
+    describe '#save' do
+      subject { attachment.save('file' => path_to_file) }
+
+      before do
+        allow(client).to receive(:post_multipart).and_return(response)
+      end
 
-    it 'successfully update the attachment' do
-      subject
+      it 'successfully update the attachment' do
+        expect(client).to receive(:post_multipart).and_return(response).with("/jira/rest/api/2/issue/#{issue.id}/attachments/#{attachment.id}", anything, anything)
+
+        subject
+
+        expect(attachment.filename).to eq file_name
+        expect(attachment.mimeType).to eq file_mime_type
+        expect(attachment.size).to eq file_size
+      end
+
+      context 'when using custom client headers' do
+        subject(:bearer_attachment) do
+          described_class.new(
+            bearer_client,
+            issue: JIRA::Resource::Issue.new(bearer_client),
+            attrs: { 'author' => { 'foo' => 'bar' } }
+          )
+        end
 
-      expect(attachment.filename).to eq 'picture.jpg'
-      expect(attachment.mimeType).to eq 'image/jpeg'
-      expect(attachment.size).to eq 23_123
+        let(:default_headers_given) do
+          {
+            'authorization' => 'Bearer 83CF8B609DE60036A8277BD0E96135751BBC07EB234256D4B65B893360651BF2'
+          }
+        end
+        let(:bearer_client) do
+          JIRA::Client.new(username: 'username', password: 'password', auth_type: :basic, use_ssl: false,
+                           default_headers: default_headers_given)
+        end
+        let(:merged_headers) do
+          {
+            'Accept' => 'application/json',
+            'X-Atlassian-Token' => 'nocheck'
+          }.merge(default_headers_given)
+        end
+
+        it 'passes the custom headers' do
+          expect(bearer_client.request_client).to receive(:request_multipart)
+            .with(anything, anything, merged_headers)
+            .and_return(response)
+
+          bearer_attachment.save('file' => path_to_file)
+        end
+      end
     end
 
-    context 'when passing in a symbol as file key' do
-      subject { attachment.save!(file: path_to_file) }
+    describe '#save!' do
+      subject { attachment.save!('file' => path_to_file) }
+
+      before do
+        allow(client).to receive(:post_multipart).and_return(response)
+      end
 
       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
+        expect(attachment.filename).to eq file_name
+        expect(attachment.mimeType).to eq file_mime_type
+        expect(attachment.size).to eq file_size
+      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 file_name
+          expect(attachment.mimeType).to eq file_mime_type
+          expect(attachment.size).to eq file_size
+        end
+      end
+
+      context 'when using custom client headers' do
+        subject(:bearer_attachment) do
+          described_class.new(
+            bearer_client,
+            issue: JIRA::Resource::Issue.new(bearer_client),
+            attrs: { 'author' => { 'foo' => 'bar' } }
+          )
+        end
+
+        let(:default_headers_given) { { 'authorization' => 'Bearer 83CF8B609DE60036A8277BD0E96135751BBC07EB234256D4B65B893360651BF2' } }
+        let(:bearer_client) do
+          JIRA::Client.new(username: 'username', password: 'password', auth_type: :basic, use_ssl: false,
+                           default_headers: default_headers_given)
+        end
+        let(:merged_headers) do
+          {
+            'Accept' => 'application/json',
+            'X-Atlassian-Token' => 'nocheck'
+          }.merge(default_headers_given)
+        end
+
+        it 'passes the custom headers' do
+          expect(bearer_client.request_client).to receive(:request_multipart)
+            .with(anything, anything, merged_headers)
+            .and_return(response)
+
+          bearer_attachment.save!('file' => path_to_file)
+        end
+      end
+    end
+  end
+
+  context 'when an attachment is on an issue' do
+    describe '#delete' do
+      it 'removes the attachment' do
+        expect(client).to receive(:delete).with("/jira/rest/api/2/issue/#{issue_id}/attachments/#{attachment_id}")
+
+        attachment.delete
       end
     end
   end

data/spec/jira/resource/board_spec.rb

@@ -21,16 +21,16 @@ describe JIRA::Resource::Board do
       \"type\": \"scrum\"
     }"
     allow(response).to receive(:body).and_return(api_json_board)
-    expect(client).to receive(:get).with('/rest/agile/1.0/board/84')
-                                   .and_return(response)
+    allow(client).to receive(:get).with('/rest/agile/1.0/board/84')
+                                  .and_return(response)
 
-    expect(client).to receive(:Board).and_return(JIRA::Resource::BoardFactory.new(client))
-    JIRA::Resource::Board.find(client, '84')
+    allow(client).to receive(:Board).and_return(JIRA::Resource::BoardFactory.new(client))
+    described_class.find(client, '84')
   end
 
-  it 'should find all boards' do
+  it 'finds all boards' do
     response = double
-    api_json = <<eos
+    api_json = <<EOS
     {
          "maxResults": 50,
          "startAt": 0,
@@ -48,24 +48,24 @@ describe JIRA::Resource::Board do
             }
         ]
     }
-eos
+EOS
     allow(response).to receive(:body).and_return(api_json)
     expect(client).to receive(:get).with('/rest/agile/1.0/board')
                                    .and_return(response)
     expect(client).to receive(:Board).twice.and_return(JIRA::Resource::BoardFactory.new(client))
-    boards = JIRA::Resource::Board.all(client)
+    boards = described_class.all(client)
     expect(boards.count).to eq(2)
   end
 
-  it 'should find one board by id' do
-    expect(board).to be_a(JIRA::Resource::Board)
+  it 'finds one board by id' do
+    expect(board).to be_a(described_class)
   end
 
   describe '#issues' do
-    it 'should find all issues' do
+    it 'finds all issues' do
       issues_response = double
 
-      api_json_issues = <<eos
+      api_json_issues = <<EOS
     {
         "expand": "names,schema",
         "startAt": 0,
@@ -85,7 +85,7 @@ eos
             }
         ]
     }
-eos
+EOS
 
       allow(issues_response).to receive(:body).and_return(api_json_issues)
       allow(board).to receive(:id).and_return(84)
@@ -98,6 +98,7 @@ eos
 
     describe 'pagination' do
       subject { described_class.new(client) }
+
       let(:client) { JIRA::Client.new }
 
       before do
@@ -106,7 +107,7 @@ eos
 
       context 'when there are multiple pages of results' do
         let(:result_1) do
-          OpenStruct.new(body: {
+          double(body: {
             'startAt' => 0,
             'maxResults' => 1,
             'total' => 2,
@@ -114,7 +115,7 @@ eos
           }.to_json)
         end
         let(:result_2) do
-          OpenStruct.new(body: {
+          double(body: {
             'startAt' => 1,
             'maxResults' => 1,
             'total' => 2,
@@ -131,7 +132,7 @@ eos
 
       context 'when there is only one page of results' do
         let(:result_1) do
-          OpenStruct.new(body: {
+          double(body: {
             'startAt' => 0,
             'maxResults' => 2,
             'total' => 2,
@@ -147,10 +148,10 @@ eos
     end
   end
 
-  it 'should get all sprints for a board' do
+  it 'gets all sprints for a board' do
     response = double
 
-    api_json = <<-eos
+    api_json = <<-EOS
     {
         "values": [
             {
@@ -165,7 +166,7 @@ eos
             }
         ]
     }
-    eos
+    EOS
     allow(response).to receive(:body).and_return(api_json)
     allow(board).to receive(:id).and_return(84)
     expect(client).to receive(:get).with('/rest/agile/1.0/board/84/sprint?').and_return(response)
@@ -173,10 +174,10 @@ eos
     expect(board.sprints.size).to be(2)
   end
 
-  it 'should get board configuration for a board' do
+  it 'gets board configuration for a board' do
     response = double
 
-    api_json = <<-eos
+    api_json = <<-EOS
       {
         "id":1,
         "name":"My Board",
@@ -214,11 +215,11 @@ eos
           "rankCustomFieldId":10011
         }
       }
-    eos
+    EOS
     allow(response).to receive(:body).and_return(api_json)
     allow(board).to receive(:id).and_return(84)
     expect(client).to receive(:get).with('/rest/agile/1.0/board/84/configuration').and_return(response)
     expect(client).to receive(:BoardConfiguration).and_return(JIRA::Resource::BoardConfigurationFactory.new(client))
-    expect(board.configuration).not_to be(nil)
+    expect(board.configuration).not_to be_nil
   end
 end