jira-ruby 2.3.0 → 3.0.0.beta2

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,5 +1,5 @@
 module ClientsHelper
-  def with_each_client
+  def with_each_client(&)
     clients = {}
 
     oauth_client = JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar')
@@ -7,10 +7,8 @@ module ClientsHelper
     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
+    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

@@ -2,7 +2,7 @@ require 'cgi'
 
 def get_mock_from_path(method, options = {})
   prefix = if defined? belongs_to
-             belongs_to.path_component + '/'
+             "#{belongs_to.path_component}/"
            else
              ''
            end
@@ -15,8 +15,8 @@ def get_mock_from_path(method, options = {})
           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
+  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 +33,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,22 +47,22 @@ 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
+  it 'gets the collection' do
     stub_request(:get, site_url + described_class.collection_path(client))
       .to_return(status: 200, body: get_mock_from_path(:get))
     collection = build_receiver.all
@@ -73,13 +73,10 @@ 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
+  it 'gets the collection' do
     stub_request(
       :get,
-      site_url +
-        client.options[:rest_base_path] +
-        '/search?jql=' +
-        CGI.escape(jql_query_string)
+      "#{site_url}#{client.options[:rest_base_path]}/search?jql=#{CGI.escape(jql_query_string)}"
     ).to_return(status: 200, body: get_mock_response('issue.json'))
 
     collection = build_receiver.jql(jql_query_string)
@@ -94,7 +91,7 @@ shared_examples 'a resource with a singular GET endpoint' 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))
+      .to_return(status: 200, body: get_mock_from_path(:get, key:))
     subject = client.send(class_basename).find(key, options)
 
     expect(subject).to have_attributes(expected_attributes)
@@ -104,7 +101,7 @@ shared_examples 'a resource with a singular GET endpoint' 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))
+      .to_return(status: 200, body: get_mock_from_path(:get, key:))
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
@@ -114,10 +111,10 @@ shared_examples 'a resource with a singular GET endpoint' do
 
   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
+      .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
 
@@ -148,9 +145,9 @@ 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))
+      .to_return(status: 200, body: get_mock_from_path(:get, 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))
+      .to_return(status: 200, body: get_mock_from_path(:put, key:, 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
@@ -163,15 +160,15 @@ 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))
+      .to_return(status: 200, body: get_mock_from_path(:get, 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'))
+      .to_return(status: 400, body: get_mock_from_path(:put, key:, 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

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,169 +58,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.6.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.6.5
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.3
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.3.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.0'
 description: API for JIRA
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
+- ".github/workflows/CI.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
-- example.rb
-- http-basic-example.rb
 - jira-ruby.gemspec
 - lib/jira-ruby.rb
 - lib/jira/base.rb
@@ -257,8 +120,8 @@ files:
 - lib/jira/resource/resolution.rb
 - lib/jira/resource/serverinfo.rb
 - lib/jira/resource/sprint.rb
-- lib/jira/resource/sprint_report.rb
 - lib/jira/resource/status.rb
+- lib/jira/resource/status_category.rb
 - lib/jira/resource/suggested_issue.rb
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
@@ -266,9 +129,9 @@ files:
 - lib/jira/resource/watcher.rb
 - lib/jira/resource/webhook.rb
 - lib/jira/resource/worklog.rb
-- lib/jira/tasks.rb
 - lib/jira/version.rb
 - lib/tasks/generate.rake
+- spec/data/files/short.txt
 - spec/integration/attachment_spec.rb
 - spec/integration/comment_spec.rb
 - spec/integration/component_spec.rb
@@ -280,12 +143,13 @@ files:
 - spec/integration/project_spec.rb
 - spec/integration/rapidview_spec.rb
 - spec/integration/resolution_spec.rb
+- spec/integration/status_category_spec.rb
 - spec/integration/status_spec.rb
 - spec/integration/transition_spec.rb
 - 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
@@ -293,7 +157,6 @@ files:
 - spec/jira/has_many_proxy_spec.rb
 - spec/jira/http_client_spec.rb
 - spec/jira/http_error_spec.rb
-- spec/jira/jwt_uri_builder_spec.rb
 - spec/jira/oauth_client_spec.rb
 - spec/jira/request_client_spec.rb
 - spec/jira/resource/agile_spec.rb
@@ -309,6 +172,7 @@ files:
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/sprint_spec.rb
+- spec/jira/resource/status_spec.rb
 - spec/jira/resource/user_factory_spec.rb
 - spec/jira/resource/worklog_spec.rb
 - spec/mock_responses/board/1.json
@@ -354,10 +218,13 @@ files:
 - spec/mock_responses/rapidview/SAMPLEPROJECT.json
 - spec/mock_responses/resolution.json
 - spec/mock_responses/resolution/1.json
+- spec/mock_responses/sprint/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
+- spec/mock_responses/statuscategory.json
+- spec/mock_responses/statuscategory/1.json
+- spec/mock_responses/user_accountId=1234567890abcdef01234567.json
 - spec/mock_responses/version.post.json
 - spec/mock_responses/version/10000.invalid.put.json
 - spec/mock_responses/version/10000.json
@@ -369,13 +236,15 @@ 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:
 - MIT
 metadata:
   source_code_uri: https://github.com/sumoheavy/jira-ruby
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -383,116 +252,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API
-test_files:
-- spec/integration/attachment_spec.rb
-- spec/integration/comment_spec.rb
-- spec/integration/component_spec.rb
-- spec/integration/field_spec.rb
-- spec/integration/issue_spec.rb
-- spec/integration/issuelinktype_spec.rb
-- spec/integration/issuetype_spec.rb
-- spec/integration/priority_spec.rb
-- spec/integration/project_spec.rb
-- spec/integration/rapidview_spec.rb
-- spec/integration/resolution_spec.rb
-- spec/integration/status_spec.rb
-- spec/integration/transition_spec.rb
-- spec/integration/user_spec.rb
-- spec/integration/version_spec.rb
-- spec/integration/watcher_spec.rb
-- spec/integration/webhook.rb
-- spec/integration/worklog_spec.rb
-- spec/jira/base_factory_spec.rb
-- spec/jira/base_spec.rb
-- spec/jira/client_spec.rb
-- spec/jira/has_many_proxy_spec.rb
-- spec/jira/http_client_spec.rb
-- spec/jira/http_error_spec.rb
-- spec/jira/jwt_uri_builder_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/board_spec.rb
-- spec/jira/resource/createmeta_spec.rb
-- spec/jira/resource/field_spec.rb
-- spec/jira/resource/filter_spec.rb
-- spec/jira/resource/issue_picker_suggestions_spec.rb
-- spec/jira/resource/issue_spec.rb
-- spec/jira/resource/issuelink_spec.rb
-- spec/jira/resource/jira_picker_suggestions_issue_spec.rb
-- spec/jira/resource/project_factory_spec.rb
-- spec/jira/resource/project_spec.rb
-- spec/jira/resource/sprint_spec.rb
-- spec/jira/resource/user_factory_spec.rb
-- spec/jira/resource/worklog_spec.rb
-- spec/mock_responses/board/1.json
-- spec/mock_responses/board/1_issues.json
-- spec/mock_responses/component.post.json
-- spec/mock_responses/component/10000.invalid.put.json
-- spec/mock_responses/component/10000.json
-- spec/mock_responses/component/10000.put.json
-- spec/mock_responses/empty_issues.json
-- spec/mock_responses/field.json
-- spec/mock_responses/field/1.json
-- spec/mock_responses/issue.json
-- spec/mock_responses/issue.post.json
-- 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/attachments/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
-- spec/mock_responses/issue/10002/comment/10000.put.json
-- spec/mock_responses/issue/10002/transitions.json
-- spec/mock_responses/issue/10002/transitions.post.json
-- spec/mock_responses/issue/10002/watchers.json
-- spec/mock_responses/issue/10002/worklog.json
-- spec/mock_responses/issue/10002/worklog.post.json
-- spec/mock_responses/issue/10002/worklog/10000.json
-- spec/mock_responses/issue/10002/worklog/10000.put.json
-- spec/mock_responses/issueLinkType.json
-- spec/mock_responses/issueLinkType/10000.json
-- spec/mock_responses/issuetype.json
-- spec/mock_responses/issuetype/5.json
-- spec/mock_responses/jira/rest/webhooks/1.0/webhook.json
-- spec/mock_responses/jira/rest/webhooks/1.0/webhook/2.json
-- spec/mock_responses/priority.json
-- spec/mock_responses/priority/1.json
-- spec/mock_responses/project.json
-- spec/mock_responses/project/SAMPLEPROJECT.issues.json
-- spec/mock_responses/project/SAMPLEPROJECT.json
-- spec/mock_responses/rapidview.json
-- spec/mock_responses/rapidview/SAMPLEPROJECT.issues.full.json
-- spec/mock_responses/rapidview/SAMPLEPROJECT.issues.json
-- 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
-- spec/mock_responses/version.post.json
-- spec/mock_responses/version/10000.invalid.put.json
-- spec/mock_responses/version/10000.json
-- spec/mock_responses/version/10000.put.json
-- spec/mock_responses/webhook.json
-- spec/mock_responses/webhook/webhook.json
-- spec/spec_helper.rb
-- spec/support/clients_helper.rb
-- spec/support/matchers/have_attributes.rb
-- spec/support/matchers/have_many.rb
-- spec/support/matchers/have_one.rb
-- spec/support/shared_examples/integration.rb
+test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-    - 2.4
-    - 2.5
-    - 2.6
-    - 2.7
-before_script:
-    - rake jira:generate_public_cert
-script: bundle exec rake spec