jira-ruby 2.3.0 → 3.2.0

data/spec/jira/resource/user_factory_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
 describe JIRA::Resource::UserFactory do
+  subject { described_class.new(client) }
+
   let(:client) do
-    instance_double('Client', options: { rest_base_path: '/jira/rest/api/2' })
+    instance_double(Client, options: { rest_base_path: '/jira/rest/api/2' })
   end
 
-  subject { JIRA::Resource::UserFactory.new(client) }
-
   describe '#myself' do
     let(:response) do
       instance_double(
-        'Response', body: get_mock_response('user_username=admin.json')
+        Response, body: get_mock_response('user_accountId=1234567890abcdef01234567.json')
       )
     end
 
     let(:user) { subject.myself }
 
-    before(:each) do
+    before do
       allow(client).to receive(:get).with(
         '/jira/rest/api/2/myself'
       ).and_return(response)

data/spec/jira/resource/worklog_spec.rb

@@ -5,10 +5,10 @@ describe JIRA::Resource::Worklog do
 
   describe 'relationships' do
     subject do
-      JIRA::Resource::Worklog.new(client, issue_id: '99999', attrs: {
-                                    'author' => { 'foo' => 'bar' },
-                                    'updateAuthor' => { 'foo' => 'bar' }
-                                  })
+      described_class.new(client, issue_id: '99999', attrs: {
+                            'author' => { 'foo' => 'bar' },
+                            'updateAuthor' => { 'foo' => 'bar' }
+                          })
     end
 
     it 'has the correct relationships' do

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

@@ -3,6 +3,7 @@
   "startAt": 0,
   "maxResults": 1000,
   "total": 9,
+  "isLast": true,
   "issues": [
     {
       "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
@@ -59,4 +60,4 @@
       "key": "SBT-19"
     }
   ]
-}
+}

data/spec/mock_responses/issue/10002/properties/foo.json

@@ -0,0 +1,4 @@
+{
+  "key": "foo",
+  "value": "bar"
+}

data/spec/mock_responses/issue/10002/properties/xyz.json

@@ -0,0 +1,4 @@
+{
+  "key": "xyz",
+  "value": "supercalifragilistic"
+}

data/spec/mock_responses/issue/10002/properties/xyz.put.json

@@ -0,0 +1,4 @@
+{
+  "key": "xyz",
+  "value": "expialidocious"
+}

data/spec/mock_responses/issue/10002/properties.json

@@ -0,0 +1,12 @@
+{
+  "keys": [
+    {
+      "key": "xyz",
+      "self": "http://localhost:2990/jira/rest/api/2/issue/10002/properties/xyz"
+    },
+    {
+      "key": "foo",
+      "self": "http://localhost:2990/jira/rest/api/2/issue/10002/properties/foo"
+    }
+  ]
+}

data/spec/mock_responses/issue.json

@@ -3,6 +3,7 @@
   "startAt": 0,
   "maxResults": 1000,
   "total": 11,
+  "isLast": true,
   "issues": [
     {
       "expand": "editmeta,renderedFields,transitions,changelog",

data/spec/mock_responses/rapidview/SAMPLEPROJECT.issues.full.json

@@ -2,6 +2,7 @@
     "expand": "schema,names",
     "startAt": 0,
     "maxResults": 50,
+    "isLast": true,
     "total": 2,
     "issues": [
         {
@@ -273,4 +274,4 @@
             }
         }
     ]
-}
+}

data/spec/mock_responses/rapidview/SAMPLEPROJECT.issues.json

@@ -101,6 +101,7 @@
   },
   "canManageSprints": true,
   "maxIssuesExceeded": false,
+  "isLast": true,
   "queryResultLimit": 2147483647,
   "versionData": {
     "versionsPerProject": {
@@ -108,4 +109,4 @@
     },
     "canCreateVersion": true
   }
-}
+}

data/spec/mock_responses/sprint/1.json

@@ -0,0 +1,13 @@
+{
+    "id": 1,
+    "self": "https://localhost:2990/jira/rest/agile/1.0/sprint/1",
+    "state": "closed",
+    "name": "SP Sprint 1",
+    "startDate": "2024-01-01T03:20:00.000Z",
+    "endDate": "2024-01-15T03:20:00.000Z",
+    "completeDate": "2024-01-16T03:48:00.000Z",
+    "createdDate": "2024-01-01T00:00:00.000Z",
+    "originBoardId": 1,
+    "goal": "",
+    "rapidview_id": 1
+}

data/spec/mock_responses/status/1.json

@@ -3,5 +3,12 @@
   "description": "The issue is open and ready for the assignee to start work on it.",
   "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
   "name": "Open",
-  "id": "1"
+  "id": "1",
+  "statusCategory": {
+    "self": "http://localhost:2990/jira/rest/api/2/statuscategory/2",
+    "id": 2,
+    "key": "new",
+    "colorName": "blue-gray",
+    "name": "To Do"
+  }
 }

data/spec/mock_responses/status.json

@@ -4,34 +4,69 @@
     "description": "The issue is open and ready for the assignee to start work on it.",
     "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
     "name": "Open",
-    "id": "1"
+    "id": "1",
+    "statusCategory": {
+      "self": "http://localhost:2990/jira/rest/api/2/statuscategory/2",
+      "id": 2,
+      "key": "new",
+      "colorName": "blue-gray",
+      "name": "To Do"
+    }
   },
   {
     "self": "http://localhost:2990/jira/rest/api/2/status/3",
     "description": "This issue is being actively worked on at the moment by the assignee.",
     "iconUrl": "http://localhost:2990/jira/images/icons/status_inprogress.gif",
     "name": "In Progress",
-    "id": "3"
+    "id": "3",
+    "statusCategory": {
+      "self": "http://localhost:2990/jira/rest/api/2/statuscategory/4",
+      "id": 4,
+      "key": "indeterminate",
+      "colorName": "yellow",
+      "name": "In Progress"
+    }
   },
   {
     "self": "http://localhost:2990/jira/rest/api/2/status/4",
     "description": "This issue was once resolved, but the resolution was deemed incorrect. From here issues are either marked assigned or resolved.",
     "iconUrl": "http://localhost:2990/jira/images/icons/status_reopened.gif",
     "name": "Reopened",
-    "id": "4"
+    "id": "4",
+    "statusCategory": {
+      "self": "http://localhost:2990/jira/rest/api/2/statuscategory/2",
+      "id": 2,
+      "key": "new",
+      "colorName": "blue-gray",
+      "name": "To Do"
+    }
   },
   {
     "self": "http://localhost:2990/jira/rest/api/2/status/5",
     "description": "A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.",
     "iconUrl": "http://localhost:2990/jira/images/icons/status_resolved.gif",
     "name": "Resolved",
-    "id": "5"
+    "id": "5",
+    "statusCategory": {
+      "self": "http://localhost:2990/jira/rest/api/2/statuscategory/3",
+      "id": 3,
+      "key": "done",
+      "colorName": "green",
+      "name": "Done"
+    }
   },
   {
     "self": "http://localhost:2990/jira/rest/api/2/status/6",
     "description": "The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.",
     "iconUrl": "http://localhost:2990/jira/images/icons/status_closed.gif",
     "name": "Closed",
-    "id": "6"
+    "id": "6",
+    "statusCategory": {
+      "self": "http://localhost:2990/jira/rest/api/2/statuscategory/3",
+      "id": 3,
+      "key": "done",
+      "colorName": "green",
+      "name": "Done"
+    }
   }
 ]

data/spec/mock_responses/statuscategory/1.json

@@ -0,0 +1,7 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/statuscategory/1",
+  "id": 1,
+  "key": "undefined",
+  "colorName": "medium-gray",
+  "name": "No Category"
+}

data/spec/mock_responses/statuscategory.json

@@ -0,0 +1,30 @@
+[
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/statuscategory/1",
+    "id": 1,
+    "key": "undefined",
+    "colorName": "medium-gray",
+    "name": "No Category"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/statuscategory/2",
+    "id": 2,
+    "key": "new",
+    "colorName": "blue-gray",
+    "name": "To Do"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/statuscategory/4",
+    "id": 4,
+    "key": "indeterminate",
+    "colorName": "yellow",
+    "name": "In Progress"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/statuscategory/3",
+    "id": 3,
+    "key": "done",
+    "colorName": "green",
+    "name": "Done"
+  }
+]

data/spec/mock_responses/{user_username=admin.json → user_accountId=1234567890abcdef01234567.json}

@@ -1,5 +1,6 @@
 {
-  "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+  "id": "1234567890abcdef01234567",
+  "self": "http://localhost:2990/jira/rest/api/2/user?accountId=1234567890abcdef01234567",
   "name": "admin",
   "emailAddress": "admin@example.com",
   "avatarUrls": {

data/spec/spec_helper.rb

@@ -17,5 +17,6 @@ def get_mock_response(file, value_if_file_not_found = false)
   File.read(File.join(File.dirname(__FILE__), 'mock_responses/', file))
 rescue Errno::ENOENT => e
   raise e if value_if_file_not_found == false
+
   value_if_file_not_found
 end

data/spec/support/clients_helper.rb

@@ -1,16 +1,14 @@
 module ClientsHelper
-  def with_each_client
+  def with_each_client(opts = {}, &)
     clients = {}
 
-    oauth_client = JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar')
+    oauth_client = JIRA::Client.new({ consumer_key: 'foo', consumer_secret: 'bar' }.merge(opts))
     oauth_client.set_access_token('abc', '123')
     clients['http://localhost:2990'] = oauth_client
 
-    basic_client = JIRA::Client.new(username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false)
-    clients['http://foo:bar@localhost:2990'] = basic_client
+    basic_client = JIRA::Client.new({ username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false }.merge(opts))
+    clients['http://localhost:2990'] = basic_client
 
-    clients.each do |site_url, client|
-      yield site_url, client
-    end
+    clients.each(&)
   end
 end

data/spec/support/mock_client.rb

@@ -0,0 +1,9 @@
+class Client
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  def get(url) end
+end

data/spec/support/mock_response.rb

@@ -0,0 +1,8 @@
+class Response
+  attr_reader :body, :status
+
+  def initialize(body, status = nil)
+    @body = body
+    @status = status
+  end
+end

data/spec/support/shared_examples/integration.rb

@@ -1,22 +1,20 @@
 require 'cgi'
 
-def get_mock_from_path(method, options = {})
-  prefix = if defined? belongs_to
-             belongs_to.path_component + '/'
-           else
-             ''
-           end
-
-  url = if options[:url]
-          options[:url]
-        elsif options[:key]
-          described_class.singular_path(client, options[:key], prefix)
-        else
-          described_class.collection_path(client, prefix)
-        end
-  file_path = url.sub(client.options[:rest_base_path], '')
-  file_path = file_path + '.' + options[:suffix] if options[:suffix]
-  file_path = file_path + '.' + method.to_s unless method == :get
+def build_url(options = {})
+  prefix = defined?(belongs_to) ? "#{belongs_to.path_component}/" : '/'
+  path = if options.key?(:key)
+           described_class.singular_path(client, options[:key], prefix)
+         else
+           described_class.collection_path(client, prefix)
+         end
+  site_url + path
+end
+
+def get_mock_from_url(method, url, options = {})
+  # Remove site_url and rest api portion of the url
+  file_path = url.sub(site_url + client.options[:rest_base_path], '')
+  file_path = "#{file_path}.#{options[:suffix]}" if options[:suffix]
+  file_path = "#{file_path}.#{method}" unless method == :get
   value_if_not_found = options.key?(:value_if_not_found) ? options[:value_if_not_found] : false
   get_mock_response("#{file_path}.json", value_if_not_found)
 end
@@ -33,7 +31,7 @@ end
 
 def prefix
   prefix = '/'
-  prefix = belongs_to.path_component + '/' if defined? belongs_to
+  prefix = "#{belongs_to.path_component}/" if defined? belongs_to
   prefix
 end
 
@@ -47,24 +45,24 @@ end
 
 shared_examples 'a resource' do
   it 'gracefully handles non-json responses' do
-    if defined? target
-      subject = target
-    else
-      subject = client.send(class_basename).build(described_class.key_attribute.to_s => '99999')
-    end
+    subject = if defined? target
+                target
+              else
+                client.send(class_basename).build(described_class.key_attribute.to_s => '99999')
+              end
     stub_request(:put, site_url + subject.url)
       .to_return(status: 405, body: '<html><body>Some HTML</body></html>')
     expect(subject.save('foo' => 'bar')).to be_falsey
-    expect(lambda do
+    expect do
       expect(subject.save!('foo' => 'bar')).to be_falsey
-    end).to raise_error(JIRA::HTTPError)
+    end.to raise_error(JIRA::HTTPError)
   end
 end
 
 shared_examples 'a resource with a collection GET endpoint' do
-  it 'should get the collection' do
-    stub_request(:get, site_url + described_class.collection_path(client))
-      .to_return(status: 200, body: get_mock_from_path(:get))
+  it 'gets the collection' do
+    req_url = build_url
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
     collection = build_receiver.all
 
     expect(collection.length).to eq(expected_collection_length)
@@ -73,14 +71,9 @@ shared_examples 'a resource with a collection GET endpoint' do
 end
 
 shared_examples 'a resource with JQL inputs and a collection GET endpoint' do
-  it 'should get the collection' do
-    stub_request(
-      :get,
-      site_url +
-        client.options[:rest_base_path] +
-        '/search?jql=' +
-        CGI.escape(jql_query_string)
-    ).to_return(status: 200, body: get_mock_response('issue.json'))
+  it 'gets the collection' do
+    req_url = "#{site_url}#{client.options[:rest_base_path]}/search/jql?jql=#{CGI.escape(jql_query_string)}"
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_response('issue.json'))
 
     collection = build_receiver.jql(jql_query_string)
 
@@ -93,8 +86,8 @@ shared_examples 'a resource with a singular GET endpoint' do
   it 'GETs a single resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.find()
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
-      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
+    req_url = build_url(key:)
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
     subject = client.send(class_basename).find(key, options)
 
     expect(subject).to have_attributes(expected_attributes)
@@ -103,8 +96,8 @@ shared_examples 'a resource with a singular GET endpoint' do
   it 'builds and fetches a single resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.build('key' => 'ABC123')
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
-      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
+    req_url = build_url(key:)
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
@@ -113,11 +106,11 @@ shared_examples 'a resource with a singular GET endpoint' do
   end
 
   it 'handles a 404' do
-    stub_request(:get, site_url + described_class.singular_path(client, '99999', prefix))
-      .to_return(status: 404, body: '{"errorMessages":["' + class_basename + ' Does Not Exist"],"errors": {}}')
-    expect(lambda do
+    stub_request(:get, build_url(key: '99999'))
+      .to_return(status: 404, body: "{\"errorMessages\":[\"#{class_basename} Does Not Exist\"],\"errors\": {}}")
+    expect do
       client.send(class_basename).find('99999', options)
-    end).to raise_exception(JIRA::HTTPError)
+    end.to raise_exception(JIRA::HTTPError)
   end
 end
 
@@ -125,8 +118,8 @@ shared_examples 'a resource with a DELETE endpoint' do
   it 'deletes a resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.delete()
-    stub_request(:delete, site_url + described_class.singular_path(client, key, prefix))
-      .to_return(status: 204, body: nil)
+    req_url = build_url(key:)
+    stub_request(:delete, req_url).to_return(status: 204, body: nil)
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     expect(subject.delete).to be_truthy
@@ -135,8 +128,8 @@ end
 
 shared_examples 'a resource with a POST endpoint' do
   it 'saves a new resource' do
-    stub_request(:post, site_url + described_class.collection_path(client, prefix))
-      .to_return(status: 201, body: get_mock_from_path(:post))
+    req_url = build_url
+    stub_request(:post, req_url).to_return(status: 201, body: get_mock_from_url(:post, req_url))
     subject = build_receiver.build
     expect(subject.save(attributes_for_post)).to be_truthy
     expected_attributes_from_post.each do |method_name, value|
@@ -147,10 +140,10 @@ end
 
 shared_examples 'a resource with a PUT endpoint' do
   it 'saves an existing component' do
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
-      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
-    stub_request(:put, site_url + described_class.singular_path(client, key, prefix))
-      .to_return(status: 200, body: get_mock_from_path(:put, key: key, value_if_not_found: nil))
+    req_url = build_url(key:)
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
+    stub_request(:put, req_url)
+      .to_return(status: 200, body: get_mock_from_url(:put, req_url, value_if_not_found: nil))
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
     expect(subject.save(attributes_for_put)).to be_truthy
@@ -162,16 +155,16 @@ end
 
 shared_examples 'a resource with a PUT endpoint that rejects invalid fields' do
   it 'fails to save with an invalid field' do
-    stub_request(:get, site_url + described_class.singular_path(client, key))
-      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
-    stub_request(:put, site_url + described_class.singular_path(client, key))
-      .to_return(status: 400, body: get_mock_from_path(:put, key: key, suffix: 'invalid'))
+    req_url = build_url(key:)
+    stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
+    stub_request(:put, req_url)
+      .to_return(status: 400, body: get_mock_from_url(:put, req_url, suffix: 'invalid'))
     subject = client.send(class_basename).build(described_class.key_attribute.to_s => key)
     subject.fetch
 
     expect(subject.save('fields' => { 'invalid' => 'field' })).to be_falsey
-    expect(lambda do
+    expect do
       subject.save!('fields' => { 'invalid' => 'field' })
-    end).to raise_error(JIRA::HTTPError)
+    end.to raise_error(JIRA::HTTPError)
   end
 end