jira-ruby 2.3.0 → 3.0.0.beta1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0.beta1
 platform: ruby
 authors:
 - SUMO Heavy Industries
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,169 +59,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"
 - 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 +121,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 +130,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,6 +144,7 @@ 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
@@ -293,7 +158,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 +173,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 +219,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
@@ -375,6 +243,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/sumoheavy/jira-ruby
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -383,116 +252,15 @@ 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'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 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

data/example.rb

@@ -1,232 +0,0 @@
-require 'pp'
-require './lib/jira-ruby'
-
-CONSUMER_KEY = 'test'
-SITE         = 'https://test.jira.com'
-
-options = {
-  :private_key_file => "rsakey.pem",
-  :context_path     => '',
-  :consumer_key     => CONSUMER_KEY,
-  :site             => SITE
-}
-
-client = JIRA::Client.new(options)
-
-if ARGV.length == 0
-  # If not passed any command line arguments, open a browser and prompt the
-  # user for the OAuth verifier.
-  request_token = client.request_token
-  puts "Opening #{request_token.authorize_url}"
-  system "open #{request_token.authorize_url}"
-
-  puts "Enter the oauth_verifier: "
-  oauth_verifier = gets.strip
-
-  access_token = client.init_access_token(:oauth_verifier => oauth_verifier)
-  puts "Access token: #{access_token.token} secret: #{access_token.secret}"
-elsif ARGV.length == 2
-  # Otherwise assume the arguments are a previous access token and secret.
-  access_token = client.set_access_token(ARGV[0], ARGV[1])
-else
-  # Script must be passed 0 or 2 arguments
-  raise "Usage: #{$0} [ token secret ]"
-end
-
-# Show all projects
-projects = client.Project.all
-
-projects.each do |project|
-  puts "Project -> key: #{project.key}, name: #{project.name}"
-end
-issue = client.Issue.find('SAMPLEPROJECT-1')
-pp issue
-
-# # Handling fields by name, rather than by id
-# # ------------------------------------------
-# Cache the Field list from the server
-client.Field.map_fields
-# This allows use of friendlier names for custom fields
-# Say that 'Special Field' is customfield_12345
-# It becomes mapped to Special_Field which is usable as a method call
-#
-# Say that there is a second 'Special Field' is customfield_54321
-# Names are deduplicated so the second 'Special Field' becomes Special_Field_54321
-#
-# Names are massaged to get rid of special characters, and spaces
-# So 'Special & @ Field' becomes Special_____Field - not perfect, but usable
-old_way = issue.customfield_12345
-new_way = issue.Special_Field
-(old_way == new_way) && puts 'much easier'
-#
-# You can also specify fields to be returned in the response
-# This is especially useful in regards to shortening JQL query response times if performance becomes an issue
-client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :Special_field, :created])
-# Or you could always do it the old way - if you can remember the custom field numbers...
-client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :customfield_1234, :created])
-# You can also specify the maximum number of results to be returned in the response, i.e. 500
-client.Issue.jql(a_normal_jql_search, max_results: 500)
-
-# # Find a specific project by key
-# # ------------------------------
-# project = client.Project.find('SAMPLEPROJECT')
-# pp project
-# project.issues.each do |issue|
-#   puts "#{issue.id} - #{issue.fields['summary']}"
-# end
-#
-# # List all Issues
-# # ---------------
-# client.Issue.all.each do |issue|
-#   puts "#{issue.id} - #{issue.fields['summary']}"
-# end
-#
-# # List issues by JQL query
-# # ------------------------
-# client.Issue.jql('PROJECT = "SAMPLEPROJECT"', [comments, summary]).each do |issue|
-#   puts "#{issue.id} - #{issue.fields['summary']}"
-# end
-#
-# # Delete an issue
-# # ---------------
-# issue = client.Issue.find('SAMPLEPROJECT-2')
-# if issue.delete
-#   puts "Delete of issue SAMPLEPROJECT-2 sucessful"
-# else
-#   puts "Delete of issue SAMPLEPROJECT-2 failed"
-# end
-#
-# # Create an issue
-# # ---------------
-# issue = client.Issue.build
-# labels = ['label1', 'label2']
-# issue.save({
-#   "fields" => {
-#     "summary"   => "blarg from in example.rb",
-#     "project"   => {"key" => "SAMPLEPROJECT"},
-#     "issuetype" => {"id" => "3"},
-#     "labels"    => labels,
-#     "priority"  => {"id" => "1"}
-#   }
-# })
-# issue.fetch
-# pp issue
-#
-# # Update an issue
-# # ---------------
-# issue = client.Issue.find("10002")
-# issue.save({"fields"=>{"summary"=>"EVEN MOOOOOOARRR NINJAAAA!"}})
-# pp issue
-#
-# # Transition an issue
-# # -------------------
-# issue_transition = issue.transitions.build
-# issue_transition.save!('transition' => {'id' => transition_id})
-#
-# # Change assignee
-# # -------------------
-# issue.save({'fields' => {'assignee' => {'name' => person_name}}})
-#
-# # Find a user
-# # -----------
-# user = client.User.find('admin')
-# pp user
-#
-# # Get all issue watchers
-# # ----------------------
-# issue = client.Issue.find("10002")
-# watchers = issue.watchers.all
-# watchers = client.Watcher.all(:issue => issue)
-# # Get all issue types
-# # -------------------
-# issuetypes = client.Issuetype.all
-# pp issuetypes
-#
-# # Get a single issue type
-# # -----------------------
-# issuetype = client.Issuetype.find('5')
-# pp issuetype
-#
-# #  Get all comments for an issue
-# #  -----------------------------
-# issue.comments.each do |comment|
-#   pp comment
-# end
-#
-# # Build and Save a comment
-# # ------------------------
-# comment = issue.comments.build
-# comment.save!(:body => "New comment from example script")
-#
-# # Delete a comment from the collection
-# # ------------------------------------
-# issue.comments.last.delete
-#
-# # Update an existing comment
-# # --------------------------
-# issue.comments.first.save({"body" => "an updated comment frome example.rb"})
-
-
-# # Add attachment to Issue
-# # ------------------------
-#  issue = client.Issue.find('PROJ-1')
-#  attachment = issue.attachments.build
-#  attachment.save('file': '/path/to/file')
-#
-
-# List all available link types
-# ------------------------------
-pp client.Issuelinktype.all
-
-# List issue's links
-# -------------------------
-issue = client.Issue.find("10002")
-pp issue.issuelinks
-
-# Link two issues (on the same Jira instance)
-# --------------------------------------------
-link = client.Issuelink.build
-link.save(
-    {
-        :type => {:name => 'Relates'},
-        :inwardIssue => {:key => 'AL-1'},
-        :outwardIssue => {:key => 'AL-2'}
-    }
-)
-
-# List issue's remote links
-# -------------------------
-pp issue.remotelink.all
-
-# Link two remote issues (on the different Jira instance)
-# In order to add remote links, you have to add
-# Application Links between two Jira instances first.
-# More information:
-# https://developer.atlassian.com/jiradev/jira-platform/guides/other/guide-jira-remote-issue-links/fields-in-remote-issue-links
-# http://stackoverflow.com/questions/29850252/jira-api-issuelink-connect-two-different-instances
-# -------------------------------------------------------
-client_1 = JIRA::Client.new(options)
-client_2 = JIRA::Client.new(options)
-
-# you have to search for your app id here, instead of getting the first
-client_2_app_link = client_2.ApplicationLink.manifest
-issue_1 = client_1.Issue.find('BB-2')
-issue_2 = client_2.Issue.find('AA-1')
-
-remote_link = issue_2.remotelink.build
-
-remote_link.save(
-    {
-        :globalId => "appId=#{client_2_app_link.id}&issueId=#{issue_1.id}",
-        :application => {
-            :type => 'com.atlassian.jira',
-            :name => client_2_app_link['name']
-        },
-        :relationship => 'relates to',
-
-        :object => {
-            :url => client_1.options[:site] + client_1.options[:context_path] + "/browse/#{issue_1.key}",
-            :title => issue_1.key,
-        }
-    }
-)