jira-ruby 1.2.0 → 1.3.0

data/spec/jira/http_client_spec.rb

@@ -12,6 +12,22 @@ describe JIRA::HttpClient do
     JIRA::HttpClient.new(options)
   end
 
+  let(:basic_cookie_client_with_context_path) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+      :use_cookies => true,
+      :context_path => '/context'
+    )
+    JIRA::HttpClient.new(options)
+  end
+
+  let(:basic_cookie_client_with_additional_cookies) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+      :use_cookies => true,
+      :additional_cookies => ['sessionToken=abc123', 'internal=true']
+    )
+    JIRA::HttpClient.new(options)
+  end
+
   let(:response) do
     response = double("response")
     allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(true)
@@ -28,6 +44,26 @@ describe JIRA::HttpClient do
     expect(basic_client.basic_auth_http_conn.class).to eq(Net::HTTP)
   end
 
+  it "makes a correct HTTP request for make_cookie_auth_request" do
+    request = double()
+    basic_auth_http_conn = double()
+
+    headers = {"Content-Type" => "application/json"}
+    expected_path = '/context/rest/auth/1/session'
+    expected_body = '{"username":"","password":""}'
+
+    allow(basic_cookie_client_with_context_path).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
+    expect(basic_auth_http_conn).to receive(:request).with(request).and_return(response)
+
+    allow(request).to receive(:basic_auth)
+    allow(response).to receive(:get_fields).with('set-cookie')
+
+    expect(request).to receive(:body=).with(expected_body)
+    expect(Net::HTTP.const_get(:post.to_s.capitalize)).to receive(:new).with(expected_path, headers).and_return(request)
+
+    basic_cookie_client_with_context_path.make_cookie_auth_request
+  end
+
   it "responds to the http methods" do
     body = ''
     headers = double()
@@ -67,6 +103,27 @@ describe JIRA::HttpClient do
     end
   end
 
+  it "sets additional cookies when they are provided" do
+    client = basic_cookie_client_with_additional_cookies
+    body = ''
+    headers = double()
+    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(: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)
+    [:delete, :get, :head].each do |method|
+      expect(Net::HTTP.const_get(method.to_s.capitalize)).to receive(:new).with('/path', headers).and_return(request)
+      expect(client.make_request(method, '/path', nil, headers)).to eq(cookie_response)
+    end
+    [:post, :put].each do |method|
+      expect(Net::HTTP.const_get(method.to_s.capitalize)).to receive(:new).with('/path', headers).and_return(request)
+      expect(request).to receive(:body=).with(body).and_return(request)
+      expect(client.make_request(method, '/path', body, headers)).to eq(cookie_response)
+    end
+  end
 
   it "performs a basic http client request" do
     body = nil

data/spec/jira/resource/agile_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Agile do
+  let(:client) { double(options: {rest_base_path: '/jira/rest/api/2', context_path: '/jira'}) }
+  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_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
+  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

@@ -2,13 +2,26 @@ require 'spec_helper'
 
 describe JIRA::Resource::Attachment do
 
-  let(:client) { double() }
+  let(:client) {
+    double(
+      'client',
+      :options => {
+        :rest_base_path => '/jira/rest/api/2'
+      },
+      :request_client => double(
+        :options => {
+          :username => 'username',
+          :password => 'password'
+        }
+      )
+    )
+  }
 
   describe "relationships" do
     subject {
-      JIRA::Resource::Attachment.new(client, :attrs => {
-        'author' => {'foo' => 'bar'}
-      })
+      JIRA::Resource::Attachment.new(client,
+                                     :issue => JIRA::Resource::Issue.new(client),
+                                     :attrs => { 'author' => {'foo' => 'bar'} })
     }
 
     it "has the correct relationships" do
@@ -17,4 +30,47 @@ describe JIRA::Resource::Attachment do
     end
   end
 
+  describe '#meta' do
+    let(:response) {
+      double(
+        'response',
+        :body => '{"enabled":true,"uploadLimit":10485760}'
+      )
+    }
+
+    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)
+    end
+  end
+
+  describe '#save!' do
+    it 'successfully update the attachment' do
+      basic_auth_http_conn = double()
+      response = double(
+        body: [
+          {
+            "id": 10001,
+            "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
+            "filename": "picture.jpg",
+            "created": "2017-07-19T12:23:06.572+0000",
+            "size": 23123,
+            "mimeType": "image/jpeg",
+          }
+        ].to_json
+      )
+
+      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)
+
+      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)
+
+      expect(attachment.filename).to eq 'picture.jpg'
+      expect(attachment.mimeType).to eq 'image/jpeg'
+      expect(attachment.size).to eq 23123
+    end
+  end
 end

data/spec/mock_responses/board/1.json

@@ -0,0 +1,33 @@
+{
+  "maxResults": 50,
+  "startAt": 0,
+  "isLast": true,
+  "values": [
+    {
+      "id": 1,
+      "self": "https://test.com/jira/rest/agile/1.0/sprint/1",
+      "state": "closed",
+      "name": "Test Sprint 1",
+      "startDate": "2016-05-03T01:45:17.624-04:00",
+      "endDate": "2016-05-06T13:30:00.000-04:00",
+      "completeDate": "2016-05-08T04:05:31.959-04:00",
+      "originBoardId": 1
+    },
+    {
+      "id": 2,
+      "self": "https://test.com/jira/rest/agile/1.0/sprint/2",
+      "state": "active",
+      "name": "Test Sprint 2",
+      "startDate": "2016-12-12T04:42:46.184-05:00",
+      "endDate": "2017-01-02T13:56:00.000-05:00",
+      "originBoardId": 1
+    },
+    {
+      "id": 3,
+      "self": "https://test.com/jira/rest/agile/1.0/sprint/2",
+      "state": "future",
+      "name": "Test Sprint 2",
+      "originBoardId": 1
+    }
+  ]
+}

data/spec/mock_responses/sprint/1_issues.json

@@ -0,0 +1,125 @@
+{
+  "expand": "schema,names",
+  "startAt": 0,
+  "maxResults": 50,
+  "total": 1,
+  "issues": [
+    {
+      "expand": "",
+      "id": "10001",
+      "self": "http://www.example.com/jira/rest/agile/1.0/board/92/issue/10001",
+      "key": "HSP-1",
+      "fields": {
+        "flagged": true,
+        "sprint": {
+          "id": 37,
+          "self": "http://www.example.com/jira/rest/agile/1.0/sprint/13",
+          "state": "future",
+          "name": "sprint 2"
+        },
+        "closedSprints": [
+          {
+            "id": 37,
+            "self": "http://www.example.com/jira/rest/agile/1.0/sprint/23",
+            "state": "closed",
+            "name": "sprint 1",
+            "startDate": "2015-04-11T15:22:00.000+10:00",
+            "endDate": "2015-04-20T01:22:00.000+10:00",
+            "completeDate": "2015-04-20T11:04:00.000+10:00"
+          }
+        ],
+        "description": "example bug report",
+        "project": {
+          "self": "http://www.example.com/jira/rest/api/2/project/EX",
+          "id": "10000",
+          "key": "EX",
+          "name": "Example",
+          "avatarUrls": {
+            "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
+            "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
+            "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
+            "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
+          },
+          "projectCategory": {
+            "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
+            "id": "10000",
+            "name": "FIRST",
+            "description": "First Project Category"
+          }
+        },
+        "comment": [
+          {
+            "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
+            "id": "10000",
+            "author": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
+            "updateAuthor": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "created": "2016-06-22T11:49:57.797+0200",
+            "updated": "2016-06-22T11:49:57.800+0200",
+            "visibility": {
+              "type": "role",
+              "value": "Administrators"
+            }
+          }
+        ],
+        "epic": {
+          "id": 37,
+          "self": "http://www.example.com/jira/rest/agile/1.0/epic/23",
+          "name": "epic 1",
+          "summary": "epic 1 summary",
+          "color": {
+            "key": "color_4"
+          },
+          "done": true
+        },
+        "worklog": [
+          {
+            "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
+            "author": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "updateAuthor": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "comment": "I did some work here.",
+            "updated": "2016-06-22T11:49:57.804+0200",
+            "visibility": {
+              "type": "group",
+              "value": "jira-developers"
+            },
+            "started": "2016-06-22T11:49:57.804+0200",
+            "timeSpent": "3h 20m",
+            "timeSpentSeconds": 12000,
+            "id": "100028",
+            "issueId": "10002"
+          }
+        ],
+        "updated": 1,
+        "timetracking": {
+          "originalEstimate": "10m",
+          "remainingEstimate": "3m",
+          "timeSpent": "6m",
+          "originalEstimateSeconds": 600,
+          "remainingEstimateSeconds": 200,
+          "timeSpentSeconds": 400
+        }
+      }
+    }
+  ]
+}

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
+- test IO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -44,6 +45,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -190,7 +205,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - example.rb
 - http-basic-example.rb
@@ -258,6 +273,7 @@ files:
 - spec/jira/http_error_spec.rb
 - spec/jira/oauth_client_spec.rb
 - spec/jira/request_client_spec.rb
+- spec/jira/resource/agile_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/createmeta_spec.rb
 - spec/jira/resource/field_spec.rb
@@ -268,7 +284,7 @@ files:
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/user_factory_spec.rb
 - spec/jira/resource/worklog_spec.rb
-- spec/mock_responses/attachment/10000.json
+- spec/mock_responses/board/1.json
 - spec/mock_responses/component.post.json
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
@@ -280,6 +296,7 @@ files:
 - spec/mock_responses/issue/10002.invalid.put.json
 - spec/mock_responses/issue/10002.json
 - spec/mock_responses/issue/10002.put.missing_field_update.json
+- spec/mock_responses/issue/10002/attachment/10000.json
 - spec/mock_responses/issue/10002/comment.json
 - spec/mock_responses/issue/10002/comment.post.json
 - spec/mock_responses/issue/10002/comment/10000.json
@@ -307,6 +324,7 @@ files:
 - spec/mock_responses/rapidview/SAMPLEPROJECT.json
 - spec/mock_responses/resolution.json
 - spec/mock_responses/resolution/1.json
+- spec/mock_responses/sprint/1_issues.json
 - spec/mock_responses/status.json
 - spec/mock_responses/status/1.json
 - spec/mock_responses/user_username=admin.json
@@ -372,6 +390,7 @@ test_files:
 - spec/jira/http_error_spec.rb
 - spec/jira/oauth_client_spec.rb
 - spec/jira/request_client_spec.rb
+- spec/jira/resource/agile_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/createmeta_spec.rb
 - spec/jira/resource/field_spec.rb
@@ -382,7 +401,7 @@ test_files:
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/user_factory_spec.rb
 - spec/jira/resource/worklog_spec.rb
-- spec/mock_responses/attachment/10000.json
+- spec/mock_responses/board/1.json
 - spec/mock_responses/component.post.json
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
@@ -394,6 +413,7 @@ test_files:
 - spec/mock_responses/issue/10002.invalid.put.json
 - spec/mock_responses/issue/10002.json
 - spec/mock_responses/issue/10002.put.missing_field_update.json
+- spec/mock_responses/issue/10002/attachment/10000.json
 - spec/mock_responses/issue/10002/comment.json
 - spec/mock_responses/issue/10002/comment.post.json
 - spec/mock_responses/issue/10002/comment/10000.json
@@ -421,6 +441,7 @@ test_files:
 - spec/mock_responses/rapidview/SAMPLEPROJECT.json
 - spec/mock_responses/resolution.json
 - spec/mock_responses/resolution/1.json
+- spec/mock_responses/sprint/1_issues.json
 - spec/mock_responses/status.json
 - spec/mock_responses/status/1.json
 - spec/mock_responses/user_username=admin.json