jira-ruby 3.0.0.beta1 → 3.0.0.beta2

data/spec/jira/resource/field_spec.rb

@@ -1,56 +1,55 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Field do
-  let(:cache) { OpenStruct.new }
-
   let(:client) do
     client = double(options: { rest_base_path: '/jira/rest/api/2' })
     field = JIRA::Resource::FieldFactory.new(client)
     allow(client).to receive(:Field).and_return(field)
-    allow(client).to receive(:cache).and_return(cache)
+    allow(client).to receive(:field_map_cache).and_return(nil)
+    allow(client).to receive(:field_map_cache=)
     # info about all fields on the client
     allow(client.Field).to receive(:all).and_return([
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'customfield_10666', 'name' => 'Priority', 'custom' => true, 'orderable' => true, 'navigable' => true,
-                                                                          'searchable' => true, 'clauseNames' => ['cf[10666]', 'Priority'], 'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_666 } }),
+                                                                                   'searchable' => true, 'clauseNames' => ['cf[10666]', 'Priority'], 'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_666 } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'issuekey', 'name' => 'Key', 'custom' => false, 'orderable' => false,
-                                                                          'navigable' => true, 'searchable' => false, 'clauseNames' => %w[id issue issuekey key] }),
+                                                                                   'navigable' => true, 'searchable' => false, 'clauseNames' => %w[id issue issuekey key] }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'priority', 'name' => 'Priority', 'custom' => false, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['priority'], 'schema' => { 'type' => 'priority', 'system' => 'priority' } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['priority'], 'schema' => { 'type' => 'priority', 'system' => 'priority' } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'summary', 'name' => 'Summary', 'custom' => false, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['summary'], 'schema' => { 'type' => 'string', 'system' => 'summary' } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['summary'], 'schema' => { 'type' => 'string', 'system' => 'summary' } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'issuetype', 'name' => 'Issue Type', 'custom' => false, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => %w[issuetype type], 'schema' => { 'type' => 'issuetype', 'system' => 'issuetype' } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => %w[issuetype type], 'schema' => { 'type' => 'issuetype', 'system' => 'issuetype' } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'customfield_10111', 'name' => 'SingleWord', 'custom' => true, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10111]', 'SingleWord'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_111 } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10111]', 'SingleWord'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_111 } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'customfield_10222', 'name' => 'Multi Word', 'custom' => true, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10222]', 'Multi Word'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_222 } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10222]', 'Multi Word'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_222 } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'customfield_10333', 'name' => 'Why/N@t', 'custom' => true, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10333]', 'Why/N@t'],          'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_333 } }),
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10333]', 'Why/N@t'],          'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_333 } }),
                                                       described_class.new(client,
                                                                           attrs: { 'id' => 'customfield_10444', 'name' => 'SingleWord', 'custom' => true, 'orderable' => true,
-                                                                          'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10444]', 'SingleWord'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_444 } })
+                                                                                   'navigable' => true, 'searchable' => true, 'clauseNames' => ['cf[10444]', 'SingleWord'],       'schema' => { 'type' => 'string', 'custom' => 'com.atlassian.jira.plugin.system.customfieldtypes:select', 'customId' => 10_444 } })
                                                     ])
     client
   end
 
   describe 'field_mappings' do
-    shared_context 'mapped or not' do
+    shared_context 'with or without mapping' do
       subject do
         described_class.new(client, attrs: {
                               'priority' => 1,
-                                    'customfield_10111' => 'data_in_custom_field',
-                                    'customfield_10222' => 'multi word custom name',
-                                    'customfield_10333' => 'complex custom name',
-                                    'customfield_10444' => 'duplicated custom name',
-                                    'customfield_10666' => 'duplicate of a system name'
+                              'customfield_10111' => 'data_in_custom_field',
+                              'customfield_10222' => 'multi word custom name',
+                              'customfield_10333' => 'complex custom name',
+                              'customfield_10444' => 'duplicated custom name',
+                              'customfield_10666' => 'duplicate of a system name'
                             })
       end
 
@@ -65,12 +64,12 @@ describe JIRA::Resource::Field do
       it 'is not confused by common attribute keys' do
         expect { subject.name }.to raise_error(NoMethodError)
         expect { subject.custom }.to raise_error(NoMethodError)
-        expect(subject.id).to eq(nil)   # picks up ID from the parent -
+        expect(subject.id).to be_nil   # picks up ID from the parent -
       end
     end
 
-    context 'before fields are mapped' do
-      include_context 'mapped or not'
+    context 'when fields are not yet mapped' do
+      include_context 'with or without mapping'
 
       it 'can find a standard field by id' do
         expect(subject.priority).to eq(1)
@@ -87,12 +86,12 @@ describe JIRA::Resource::Field do
       it 'is not confused by common attribute keys and raises error' do
         expect { subject.name }.to raise_error(NoMethodError)
         expect { subject.custom }.to raise_error(NoMethodError)
-        expect(subject.id).to eq(nil)   # picks up ID from the parent -
+        expect(subject.id).to be_nil   # picks up ID from the parent -
       end
     end
 
-    context 'after fields are mapped' do
-      include_context 'mapped or not'
+    context 'when fields have been mapped' do
+      include_context 'with or without mapping'
 
       it 'warns of duplicate fields' do
         expect { client.Field.map_fields }.to output(/renaming as Priority_10666/).to_stderr

data/spec/jira/resource/issue_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Issue do
   let(:client) do
     client = double(options: { rest_base_path: '/jira/rest/api/2' })
     allow(client).to receive(:Field).and_return(JIRA::Resource::FieldFactory.new(client))
-    allow(client).to receive(:cache).and_return(OpenStruct.new)
+    allow(client).to receive(:field_map_cache).and_return(nil)
     client
   end
 
@@ -25,7 +25,7 @@ describe JIRA::Resource::Issue do
       end
 
       it 'responds to key' do
-        expect(@decorated.respond_to?(:key)).to eq(true)
+        expect(@decorated.respond_to?(:key)).to be(true)
       end
 
       it 'does not raise an error' do
@@ -51,7 +51,7 @@ describe JIRA::Resource::Issue do
     expect(client).to receive(:Issue).and_return(issue)
     expect(issue).to receive(:build).with({ 'id' => '1', 'summary' => 'Bugs Everywhere' })
 
-    issues = described_class.all(client)
+    described_class.all(client)
   end
 
   it 'finds an issue by key or id' do
@@ -113,7 +113,7 @@ describe JIRA::Resource::Issue do
 
   it 'searches an issue with a jql query string and maxResults equals zero and should return the count of tickets' do
     response = double
-    issue = double
+    double
 
     allow(response).to receive(:body).and_return('{"total": 1, "issues": []}')
     expect(client).to receive(:get)
@@ -175,20 +175,20 @@ describe JIRA::Resource::Issue do
     subject do
       described_class.new(client, attrs: {
                             'id' => '123',
-                                  'fields' => {
-                                    'reporter' => { 'foo' => 'bar' },
-                                    'assignee' => { 'foo' => 'bar' },
-                                    'project' => { 'foo' => 'bar' },
-                                    'priority' => { 'foo' => 'bar' },
-                                    'issuetype' => { 'foo' => 'bar' },
-                                    'status' => { 'foo' => 'bar' },
-                                    'resolution' => { 'foo' => 'bar' },
-                                    'components' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
-                                    'versions' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
-                                    'comment' => { 'comments' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] },
-                                    'attachment' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
-                                    'worklog' => { 'worklogs' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] }
-                                  }
+                            'fields' => {
+                              'reporter' => { 'foo' => 'bar' },
+                              'assignee' => { 'foo' => 'bar' },
+                              'project' => { 'foo' => 'bar' },
+                              'priority' => { 'foo' => 'bar' },
+                              'issuetype' => { 'foo' => 'bar' },
+                              'status' => { 'foo' => 'bar' },
+                              'resolution' => { 'foo' => 'bar' },
+                              'components' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
+                              'versions' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
+                              'comment' => { 'comments' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] },
+                              'attachment' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
+                              'worklog' => { 'worklogs' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] }
+                            }
                           })
     end
 

data/spec/jira/resource/project_spec.rb

@@ -11,8 +11,8 @@ describe JIRA::Resource::Project do
     subject do
       described_class.new(client, attrs: {
                             'lead' => { 'foo' => 'bar' },
-                                    'issueTypes' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
-                                    'versions' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }]
+                            'issueTypes' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
+                            'versions' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }]
                           })
     end
 
@@ -36,7 +36,7 @@ describe JIRA::Resource::Project do
     end
 
     it 'returns issues' do
-      response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"}}]}' # rubocop:disable Layout/LineLength
+      response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"}}]}'
       response = double('response',
                         body: response_body)
       issue_factory = double('issue factory')
@@ -52,7 +52,7 @@ describe JIRA::Resource::Project do
 
     context 'with changelog' do
       it 'returns issues' do
-        response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"},"changelog":{}}]}' # rubocop:disable Layout/LineLength
+        response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"},"changelog":{}}]}'
         response = double('response',
                           body: response_body)
         issue_factory = double('issue factory')
@@ -73,7 +73,7 @@ describe JIRA::Resource::Project do
     let(:project_key) { SecureRandom.hex }
     let(:response) { double('response', body: '[{}]') }
 
-    context 'pagination' do
+    context 'with pagination' do
       before do
         user_factory = double('user factory')
         expect(client).to receive(:User).and_return(user_factory)
@@ -113,7 +113,7 @@ describe JIRA::Resource::Project do
         max_results = rand(1000)
 
         expect(client).to receive(:get)
-          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}&startAt=#{start_at}&maxResults=#{max_results}") # rubocop:disable Layout/LineLength
+          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}&startAt=#{start_at}&maxResults=#{max_results}")
           .and_return(response)
 
         project.users(start_at:, max_results:)

data/spec/jira/resource/sprint_spec.rb

@@ -43,7 +43,9 @@ describe JIRA::Resource::Sprint do
         let(:given_attrs) { { start_date: '2016-06-10' } }
 
         it 'calls save on the super class with the given attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(given_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, given_attrs.to_json).and_return(mock_response)
 
           sprint.save(given_attrs)
         end
@@ -51,7 +53,9 @@ describe JIRA::Resource::Sprint do
 
       context 'when attributes are not specified' do
         it 'calls save on the super class with the instance attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, instance_attrs.to_json).and_return(mock_response)
 
           sprint.save
         end
@@ -59,7 +63,9 @@ describe JIRA::Resource::Sprint do
 
       context 'when providing the path argument' do
         it 'ignores it' do
-          expect_any_instance_of(JIRA::Base).to receive(:save).with(instance_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, instance_attrs.to_json).and_return(mock_response)
 
           sprint.save({}, 'mavenlink.com')
         end
@@ -77,7 +83,9 @@ describe JIRA::Resource::Sprint do
         let(:given_attrs) { { start_date: '2016-06-10' } }
 
         it 'calls save! on the super class with the given attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(given_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, given_attrs.to_json).and_return(mock_response)
 
           sprint.save!(given_attrs)
         end
@@ -85,7 +93,9 @@ describe JIRA::Resource::Sprint do
 
       context 'when attributes are not specified' do
         it 'calls save! on the super class with the instance attributes & agile url' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, instance_attrs.to_json).and_return(mock_response)
 
           sprint.save!
         end
@@ -93,14 +103,16 @@ describe JIRA::Resource::Sprint do
 
       context 'when providing the path argument' do
         it 'ignores it' do
-          expect_any_instance_of(JIRA::Base).to receive(:save!).with(instance_attrs, agile_sprint_path)
+          mock_response = double('response', body: '{"id":"123"}')
+
+          expect(client).to receive(:post).with(agile_sprint_path, instance_attrs.to_json).and_return(mock_response)
 
           sprint.save!({}, 'mavenlink.com')
         end
       end
     end
 
-    context 'an issue exists' do
+    context 'when an issue exists' do
       let(:issue_id) { 1001 }
       let(:post_issue_path) do
         described_class.agile_path(client, sprint.id)
@@ -126,7 +138,7 @@ describe JIRA::Resource::Sprint do
       end
     end
 
-    context 'multiple issues exists' do
+    context 'when multiple issues exist' do
       let(:issue_ids) { [1001, 1012] }
       let(:post_issue_path) do
         described_class.agile_path(client, sprint.id)

data/spec/jira/resource/status_spec.rb

@@ -4,7 +4,7 @@ describe JIRA::Resource::Status do
   let(:client) do
     client = double(options: { rest_base_path: '/jira/rest/api/2' })
     allow(client).to receive(:Field).and_return(JIRA::Resource::FieldFactory.new(client))
-    allow(client).to receive(:cache).and_return(OpenStruct.new)
+    allow(client).to receive(:field_map_cache).and_return(nil)
     client
   end
 

data/spec/jira/resource/user_factory_spec.rb

@@ -4,13 +4,13 @@ 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
 
   describe '#myself' do
     let(:response) do
       instance_double(
-        'Response', body: get_mock_response('user_accountId=1234567890abcdef01234567.json')
+        Response, body: get_mock_response('user_accountId=1234567890abcdef01234567.json')
       )
     end
 

data/spec/jira/resource/worklog_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Worklog do
     subject do
       described_class.new(client, issue_id: '99999', attrs: {
                             'author' => { 'foo' => 'bar' },
-                                    'updateAuthor' => { 'foo' => 'bar' }
+                            'updateAuthor' => { 'foo' => 'bar' }
                           })
     end
 

data/spec/support/clients_helper.rb

@@ -1,5 +1,5 @@
 module ClientsHelper
-  def with_each_client(&block)
+  def with_each_client(&)
     clients = {}
 
     oauth_client = JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar')
@@ -9,6 +9,6 @@ module ClientsHelper
     basic_client = JIRA::Client.new(username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false)
     clients['http://localhost:2990'] = basic_client
 
-    clients.each(&block)
+    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

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,7 +67,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: API for JIRA
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,6 +79,7 @@ files:
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -150,7 +149,7 @@ files:
 - spec/integration/user_spec.rb
 - spec/integration/version_spec.rb
 - spec/integration/watcher_spec.rb
-- spec/integration/webhook.rb
+- spec/integration/webhook_spec.rb
 - spec/integration/worklog_spec.rb
 - spec/jira/base_factory_spec.rb
 - spec/jira/base_spec.rb
@@ -237,6 +236,8 @@ files:
 - spec/support/matchers/have_attributes.rb
 - spec/support/matchers/have_many.rb
 - spec/support/matchers/have_one.rb
+- spec/support/mock_client.rb
+- spec/support/mock_response.rb
 - spec/support/shared_examples/integration.rb
 homepage: http://www.sumoheavy.com
 licenses:
@@ -244,7 +245,6 @@ licenses:
 metadata:
   source_code_uri: https://github.com/sumoheavy/jira-ruby
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -255,12 +255,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API
 test_files: []