jira-ruby 2.1.3

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

data/spec/jira/resource/createmeta_spec.rb

@@ -0,0 +1,258 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Createmeta do
+  let(:client) do
+    double(
+      'client',
+      options: {
+        rest_base_path: '/jira/rest/api/2'
+      }
+    )
+  end
+
+  let(:response) do
+    double(
+      'response',
+      body: '{"expand":"projects","projects":[{"self":"http://localhost:2029/rest/api/2/project/TST","id":"10200","key":"test_key","name":"Test Name"}]}'
+    )
+  end
+
+  describe 'general' do
+    it 'should query correct url without parameters' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta').and_return(response)
+      JIRA::Resource::Createmeta.all(client)
+    end
+
+    it 'should query correct url with `expand` parameter' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?expand=projects.issuetypes.fields').and_return(response)
+      JIRA::Resource::Createmeta.all(client, expand: 'projects.issuetypes.fields')
+    end
+
+    it 'should query correct url with `foo` parameter' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?foo=bar').and_return(response)
+      JIRA::Resource::Createmeta.all(client, foo: 'bar')
+    end
+
+    it 'should return an array of createmeta objects' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta').and_return(response)
+      createmetas = JIRA::Resource::Createmeta.all(client)
+      expect(createmetas).to be_an Array
+      createmeta = createmetas.first
+      expect(createmeta.id).to eq '10200'
+      expect(createmeta.key).to eq 'test_key'
+      expect(createmeta.name).to eq 'Test Name'
+    end
+  end
+
+  describe 'projectKeys' do
+    it 'should query correct url when only one `projectKeys` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectKeys: 'PROJECT_1'
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1%2CPROJECT_2').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectKeys: %w[PROJECT_1 PROJECT_2]
+      )
+    end
+
+    it 'should query correct url when only one `projectKeys` given as Project' do
+      prj = JIRA::Resource::Project.new(client)
+      allow(prj).to receive(:key).and_return('PRJ')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PRJ').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectKeys: prj
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as Project' do
+      prj_1 = JIRA::Resource::Project.new(client)
+      allow(prj_1).to receive(:key).and_return('PRJ_1')
+      prj_2 = JIRA::Resource::Project.new(client)
+      allow(prj_2).to receive(:key).and_return('PRJ_2')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PRJ_2%2CPRJ_1').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectKeys: [prj_2, prj_1]
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as different types' do
+      prj_5 = JIRA::Resource::Project.new(client)
+      allow(prj_5).to receive(:key).and_return('PRJ_5')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1%2CPRJ_5').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectKeys: ['PROJECT_1', prj_5]
+      )
+    end
+  end
+
+  describe 'projectIds' do
+    it 'should query correct url when only one `projectIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectIds: '10101'
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101%2C20202').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectIds: %w[10101 20202]
+      )
+    end
+
+    it 'should query correct url when only one `projectIds` given as Project' do
+      prj = JIRA::Resource::Project.new(client)
+      allow(prj).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectIds: prj
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as Project' do
+      prj_1 = JIRA::Resource::Project.new(client)
+      allow(prj_1).to receive(:id).and_return('30303')
+      prj_2 = JIRA::Resource::Project.new(client)
+      allow(prj_2).to receive(:id).and_return('50505')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=50505%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectIds: [prj_2, prj_1]
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as different types' do
+      prj_5 = JIRA::Resource::Project.new(client)
+      allow(prj_5).to receive(:id).and_return('60606')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101%2C60606').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        projectIds: ['10101', prj_5]
+      )
+    end
+  end
+
+  describe 'issuetypeNames' do
+    it 'should query correct url when only one `issuetypeNames` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeNames: 'Feature'
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature%2CBug').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeNames: %w[Feature Bug]
+      )
+    end
+
+    it 'should query correct url when only one `issuetypeNames` given as Issuetype' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:name).and_return('Epic')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Epic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeNames: issue_type
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as Issuetype' do
+      issue_type_1 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_1).to receive(:name).and_return('Epic')
+      issue_type_2 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_2).to receive(:name).and_return('Sub-Task')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Sub-Task%2CEpic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeNames: [issue_type_2, issue_type_1]
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as different types' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:name).and_return('Epic')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature%2CEpic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeNames: ['Feature', issue_type]
+      )
+    end
+  end
+
+  describe 'issuetypeIds' do
+    it 'should query correct url when only one `issuetypeIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeIds: '10101'
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101%2C20202').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeIds: %w[10101 20202]
+      )
+    end
+
+    it 'should query correct url when only one `issuetypeIds` given as Issuetype' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeIds: issue_type
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as Issuetype' do
+      issue_type_1 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_1).to receive(:id).and_return('30303')
+      issue_type_2 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_2).to receive(:id).and_return('50505')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=50505%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeIds: [issue_type_2, issue_type_1]
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as different types' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        issuetypeIds: ['10101', issue_type]
+      )
+    end
+  end
+end