jira-ruby 1.2.0 → 2.3.0

data/spec/jira/request_client_spec.rb

@@ -1,14 +1,41 @@
 require 'spec_helper'
 
 describe JIRA::RequestClient do
+  let(:request_client) { JIRA::RequestClient.new }
 
-  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 {
-      rc.request(:get, '/foo', '', {})
-    }.to raise_exception(JIRA::HTTPError)
+  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/agile_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Agile do
+  let(:client) do
+    client = double(options: { rest_base_path: '/jira/rest/api/2', context_path: '/jira' })
+    allow(client).to receive(:Issue).and_return(JIRA::Resource::IssueFactory.new(client))
+    client
+  end
+  let(:response) { double }
+
+  describe '#all' do
+    it 'should query 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)
+    end
+  end
+
+  describe '#get_backlog_issues' do
+    it 'should query 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)
+    end
+  end
+
+  describe '#get_board_issues' do
+    it 'should query 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)
+      expect(issues).to be_an(Array)
+      expect(issues.size).to eql(9)
+
+      issues.each do |issue|
+        expect(issue.class).to eq(JIRA::Resource::Issue)
+        expect(issue.expanded?).to be_falsey
+      end
+    end
+
+    it 'should query 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)
+      expect(issues).to be_an(Array)
+      expect(issues.size).to eql(9)
+
+      issues.each do |issue|
+        expect(issue.class).to eq(JIRA::Resource::Issue)
+        expect(issue.expanded?).to be_falsey
+      end
+    end
+  end
+
+  describe '#get_sprints' do
+    it 'should query 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)
+    end
+
+    it 'should query 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)
+    end
+
+    it 'should work 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)
+    end
+
+    it 'should work 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)
+    end
+  end
+
+  describe '#get_sprint_issues' do
+    it 'should query 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)
+    end
+
+    it 'should query 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)
+    end
+  end
+
+  describe '#get_projects_full' do
+    it 'should query 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)
+    end
+  end
+
+  describe '#get_projects' do
+    it 'should query 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)
+    end
+
+    it 'should query 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)
+    end
+  end
+end

data/spec/jira/resource/attachment_spec.rb

@@ -1,20 +1,138 @@
 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) { double() }
-
-  describe "relationships" do
-    subject {
-      JIRA::Resource::Attachment.new(client, :attrs => {
-        'author' => {'foo' => 'bar'}
-      })
-    }
+  let(:client) do
+    double(
+      'client',
+      options: {
+        rest_base_path: '/jira/rest/api/2'
+      },
+      request_client: double(
+        options: {
+          username: 'username',
+          password: 'password'
+        }
+      )
+    )
+  end
 
-    it "has the correct relationships" do
+  describe 'relationships' do
+    it 'has an author' do
       expect(subject).to have_one(:author, JIRA::Resource::User)
+    end
+
+    it 'has the correct author name' do
       expect(subject.author.foo).to eq('bar')
     end
   end
 
+  describe '.meta' do
+    subject { JIRA::Resource::Attachment.meta(client) }
+
+    let(:response) do
+      double(
+          '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)
+
+      subject
+    end
+
+    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)
+      end
+    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
+      )
+    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
+      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,
+            "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
+      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/board_spec.rb

@@ -0,0 +1,224 @@
+require 'spec_helper'
+require 'active_support/core_ext/hash'
+
+describe JIRA::Resource::Board do
+  class JIRAResourceDelegation < SimpleDelegator # :nodoc:
+  end
+
+  let(:client) do
+    double(options: {
+             rest_base_path: '/jira/rest/api/2',
+             context_path: ''
+           })
+  end
+
+  let(:board) do
+    response = double
+    api_json_board = "{
+      \"id\": 84,
+      \"self\": \"http://www.example.com/jira/rest/agile/1.0/board/84\",
+      \"name\": \"scrum board\",
+      \"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)
+
+    expect(client).to receive(:Board).and_return(JIRA::Resource::BoardFactory.new(client))
+    JIRA::Resource::Board.find(client, '84')
+  end
+
+  it 'should find all boards' do
+    response = double
+    api_json = <<eos
+    {
+         "maxResults": 50,
+         "startAt": 0,
+         "isLast": true,
+         "values": [
+            {
+                "id": 84,
+                "name": "scrum board",
+                "type": "scrum"
+            },
+            {
+                "id": 92,
+                "name": "kanban board",
+                "type": "kanban"
+            }
+        ]
+    }
+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)
+    expect(boards.count).to eq(2)
+  end
+
+  it 'should find one board by id' do
+    expect(board).to be_a(JIRA::Resource::Board)
+  end
+
+  describe '#issues' do
+    it 'should find all issues' do
+      issues_response = double
+
+      api_json_issues = <<eos
+    {
+        "expand": "names,schema",
+        "startAt": 0,
+        "maxResults": 50,
+        "total": 1,
+        "issues": [
+            {
+                "id": "10001",
+                "fields": {
+                    "sprint": {
+                        "id": 37,
+                        "state": "future",
+                        "name": "sprint 2"
+                    },
+                    "description": "example bug report"
+                }
+            }
+        ]
+    }
+eos
+
+      allow(issues_response).to receive(:body).and_return(api_json_issues)
+      allow(board).to receive(:id).and_return(84)
+      expect(client).to receive(:get).with('/rest/agile/1.0/board/84/issue')
+                                     .and_return(issues_response)
+      expect(client).to receive(:Issue).and_return(JIRA::Resource::IssueFactory.new(client))
+
+      expect(board.issues.size).to be(1)
+    end
+
+    describe 'pagination' do
+      subject { described_class.new(client) }
+      let(:client) { JIRA::Client.new }
+
+      before do
+        allow(subject).to receive(:id).and_return('123')
+      end
+
+      context 'when there are multiple pages of results' do
+        let(:result_1) do
+          OpenStruct.new(body: {
+            'startAt' => 0,
+            'maxResults' => 1,
+            'total' => 2,
+            'issues' => []
+          }.to_json)
+        end
+        let(:result_2) do
+          OpenStruct.new(body: {
+            'startAt' => 1,
+            'maxResults' => 1,
+            'total' => 2,
+            'issues' => []
+          }.to_json)
+        end
+
+        it 'makes multiple requests and increments the startAt param' do
+          expect(client).to receive(:get).and_return(result_1)
+          expect(client).to receive(:get).and_return(result_2)
+          subject.issues
+        end
+      end
+
+      context 'when there is only one page of results' do
+        let(:result_1) do
+          OpenStruct.new(body: {
+            'startAt' => 0,
+            'maxResults' => 2,
+            'total' => 2,
+            'issues' => []
+          }.to_json)
+        end
+
+        it 'only requires one request' do
+          expect(client).to receive(:get).once.and_return(result_1)
+          subject.issues
+        end
+      end
+    end
+  end
+
+  it 'should get all sprints for a board' do
+    response = double
+
+    api_json = <<-eos
+    {
+        "values": [
+            {
+                "id": 37,
+                "state": "closed",
+                "name": "sprint 1"
+            },
+            {
+                "id": 72,
+                "state": "future",
+                "name": "sprint 2"
+            }
+        ]
+    }
+    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)
+    expect(client).to receive(:Sprint).twice.and_return(JIRA::Resource::SprintFactory.new(client))
+    expect(board.sprints.size).to be(2)
+  end
+
+  it 'should get board configuration for a board' do
+    response = double
+
+    api_json = <<-eos
+      {
+        "id":1,
+        "name":"My Board",
+        "type":"kanban",
+        "self":"https://mycompany.atlassian.net/rest/agile/1.0/board/1/configuration",
+        "location":{
+          "type":"project",
+          "key":"MYPROJ",
+          "id":"10000",
+          "self":"https://mycompany.atlassian.net/rest/api/2/project/10000",
+          "name":"My Project"
+        },
+        "filter":{
+          "id":"10000",
+          "self":"https://mycompany.atlassian.net/rest/api/2/filter/10000"
+        },
+        "subQuery":{
+          "query":"resolution = EMPTY OR resolution != EMPTY AND resolutiondate >= -5d"
+        },
+        "columnConfig":{
+          "columns":[
+            {
+              "name":"Backlog",
+              "statuses":[
+                {
+                  "id":"10000",
+                  "self":"https://mycompany.atlassian.net/rest/api/2/status/10000"
+                }
+              ]
+            }
+          ],
+          "constraintType":"issueCount"
+        },
+        "ranking":{
+          "rankCustomFieldId":10011
+        }
+      }
+    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)
+  end
+end