jira-ruby 2.3.0 → 3.0.0.beta1

data/lib/jira/resource/applinks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class ApplicationLinkFactory < JIRA::BaseFactory # :nodoc:
@@ -5,7 +7,7 @@ module JIRA
     end
 
     class ApplicationLink < JIRA::Base
-      REST_BASE_PATH = '/rest/applinks/1.0'.freeze
+      REST_BASE_PATH = '/rest/applinks/1.0'
 
       def self.endpoint_name
         'listApplicationlinks'
@@ -24,12 +26,12 @@ module JIRA
         json = parse_json(response.body)
         json = json['list']
         json.map do |attrs|
-          new(client, { attrs: attrs }.merge(options))
+          new(client, { attrs: }.merge(options))
         end
       end
 
       def self.manifest(client)
-        url = full_url(client) + '/manifest'
+        url = "#{full_url(client)}/manifest"
         response = client.get(url)
         json = parse_json(response.body)
         JIRA::Base.new(client, attrs: json)

data/lib/jira/resource/attachment.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'net/http/post/multipart'
+require 'open-uri'
 
 module JIRA
   module Resource
@@ -15,18 +18,55 @@ module JIRA
       end
 
       def self.meta(client)
-        response = client.get(client.options[:rest_base_path] + '/attachment/meta')
+        response = client.get("#{client.options[:rest_base_path]}/attachment/meta")
         parse_json(response.body)
       end
 
+      # Opens a file streaming the download of the attachment.
+      # @example Write file contents to a file.
+      #   File.open('some-filename', 'wb') do |output|
+      #     download_file do |file|
+      #       IO.copy_stream(file, output)
+      #     end
+      #   end
+      # @example Stream file contents for an HTTP response.
+      #   response.headers[ "Content-Type" ] = "application/octet-stream"
+      #   download_file do |file|
+      #     chunk = file.read(8000)
+      #     while chunk.present? do
+      #       response.stream.write(chunk)
+      #       chunk = file.read(8000)
+      #     end
+      #   end
+      #   response.stream.close
+      # @param [Hash] headers Any additional headers to call Jira.
+      # @yield |file|
+      # @yieldparam [IO] file The IO object streaming the download.
+      def download_file(headers = {}, &block)
+        default_headers = client.options[:default_headers]
+        URI.parse(content).open(default_headers.merge(headers), &block)
+      end
+
+      # Downloads the file contents as a string object.
+      #
+      # Note that this reads the contents into a ruby string in memory.
+      # A file might be very large so it is recommend to avoid this unless you are certain about doing so.
+      # Use the download_file method instead and avoid calling the read method without a limit.
+      #
+      # @param [Hash] headers Any additional headers to call Jira.
+      # @return [String,NilClass] The file contents.
+      def download_contents(headers = {})
+        download_file(headers, &:read)
+      end
+
       def save!(attrs, path = url)
         file = attrs['file'] || attrs[:file] # Keep supporting 'file' parameter as a string for backward compatibility
         mime_type = attrs[:mimeType] || 'application/binary'
 
         headers = { 'X-Atlassian-Token' => 'nocheck' }
-        data = { 'file' => UploadIO.new(file, mime_type, file) }
+        data = { 'file' => Multipart::Post::UploadIO.new(file, mime_type, file) }
 
-        response = client.post_multipart(path, data , headers)
+        response = client.post_multipart(path, data, headers)
 
         set_attributes(attrs, response)
 

data/lib/jira/resource/board.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module JIRA
@@ -7,7 +9,7 @@ module JIRA
 
     class Board < JIRA::Base
       def self.all(client)
-        path = path_base(client) + '/board'
+        path = "#{path_base(client)}/board"
         response = client.get(path)
         json = parse_json(response.body)
         results = json['values']
@@ -74,13 +76,13 @@ module JIRA
       end
 
       def add_issue_to_backlog(issue)
-        client.post(path_base(client) + '/backlog/issue', { issues: [issue.id] }.to_json)
+        client.post("#{path_base(client)}/backlog/issue", { issues: [issue.id] }.to_json)
       end
 
       private
 
       def self.path_base(client)
-        client.options[:context_path] + '/rest/agile/1.0'
+        "#{client.options[:context_path]}/rest/agile/1.0"
       end
 
       def path_base(client)

data/lib/jira/resource/board_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class BoardConfigurationFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/comment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class CommentFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class ComponentFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/createmeta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class CreatemetaFactory < JIRA::BaseFactory # :nodoc:
@@ -36,7 +38,7 @@ module JIRA
 
         json = parse_json(response.body)
         json['projects'].map do |attrs|
-          new(client, attrs: attrs)
+          new(client, attrs:)
         end
       end
     end

data/lib/jira/resource/field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class FieldFactory < JIRA::BaseFactory # :nodoc:
@@ -26,20 +28,22 @@ module JIRA
         # as a system field can't take precedence
         fields.each do |f|
           next if f.custom
+
           name = safe_name(f.name)
           field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
           field_map[name] = f.id
         end
 
-        fields.each do |f|
+        fields.each do |f| # rubocop:disable Style/CombinableLoops
           next unless f.custom
+
           name = if field_map.key? f.name
                    renamed = safer_name(f.name, f.id)
                    warn "Duplicate Field name #{f.name} #{f.id} - renaming as #{renamed}"
                    renamed
                  else
                    safe_name(f.name)
-          end
+                 end
           field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
           field_map[name] = f.id
         end
@@ -55,6 +59,7 @@ module JIRA
       def self.name_to_id(client, field_name)
         field_name = field_name.to_s
         return field_name unless client.cache.field_map && client.cache.field_map[field_name]
+
         client.cache.field_map[field_name]
       end
 
@@ -66,7 +71,7 @@ module JIRA
         end
       end
 
-      def method_missing(method_name, *args, &block)
+      def method_missing(method_name, *args, &)
         if attrs.key?(method_name.to_s)
           attrs[method_name.to_s]
         else
@@ -74,7 +79,7 @@ module JIRA
           if attrs.key?(official_name)
             attrs[official_name]
           else
-            super(method_name, *args, &block)
+            super
           end
         end
       end

data/lib/jira/resource/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class FilterFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/issue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'json'
 
@@ -7,44 +9,25 @@ module JIRA
     end
 
     class Issue < JIRA::Base
-      has_one :reporter,  class: JIRA::Resource::User,
-                          nested_under: 'fields'
-      has_one :assignee,  class: JIRA::Resource::User,
-                          nested_under: 'fields'
-      has_one :project,   nested_under: 'fields'
-
+      has_one :reporter, class: JIRA::Resource::User, nested_under: 'fields'
+      has_one :assignee, class: JIRA::Resource::User, nested_under: 'fields'
+      has_one :project, nested_under: 'fields'
       has_one :issuetype, nested_under: 'fields'
-
-      has_one :priority,  nested_under: 'fields'
-
-      has_one :status,    nested_under: 'fields'
-
+      has_one :priority, nested_under: 'fields'
+      has_one :status, nested_under: 'fields'
+      has_one :resolution, nested_under: 'fields'
       has_many :transitions
-
       has_many :components, nested_under: 'fields'
-
       has_many :comments, nested_under: %w[fields comment]
-
-      has_many :attachments, nested_under: 'fields',
-                             attribute_key: 'attachment'
-
-      has_many :versions,    nested_under: 'fields'
-      has_many :fixVersions, class: JIRA::Resource::Version,
-                             nested_under: 'fields'
-
+      has_many :attachments, nested_under: 'fields', attribute_key: 'attachment'
+      has_many :versions, nested_under: 'fields'
+      has_many :fixVersions, class: JIRA::Resource::Version, nested_under: 'fields'
       has_many :worklogs, nested_under: %w[fields worklog]
-      has_one :sprint, class: JIRA::Resource::Sprint,
-                       nested_under: 'fields'
-
-      has_many :closed_sprints, class: JIRA::Resource::Sprint,
-                                nested_under: 'fields', attribute_key: 'closedSprints'
-
+      has_one :sprint, class: JIRA::Resource::Sprint, nested_under: 'fields'
+      has_many :closed_sprints, class: JIRA::Resource::Sprint, nested_under: 'fields', attribute_key: 'closedSprints'
       has_many :issuelinks, nested_under: 'fields'
-
       has_many :remotelink, class: JIRA::Resource::Remotelink
-
-      has_many :watchers,   attribute_key: 'watches',
-                            nested_under: %w[fields watches]
+      has_many :watchers, attribute_key: 'watches', nested_under: %w[fields watches]
 
       def self.all(client)
         start_at = 0
@@ -59,15 +42,21 @@ module JIRA
             result.push(client.Issue.build(issue))
           end
           break if json['issues'].empty?
+
           start_at += json['issues'].size
         end
         result
       end
 
-      def self.jql(client, jql, options = { fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true })
+      def self.jql(client, jql, options = { fields: nil, start_at: nil, max_results: nil, expand: nil,
+validate_query: true })
         url = client.options[:rest_base_path] + "/search?jql=#{CGI.escape(jql)}"
 
-        url << "&fields=#{options[:fields].map { |value| CGI.escape(client.Field.name_to_id(value)) }.join(',')}" if options[:fields]
+        if options[:fields]
+          url << "&fields=#{options[:fields].map do |value|
+                              CGI.escape(client.Field.name_to_id(value))
+                            end.join(',')}"
+        end
         url << "&startAt=#{CGI.escape(options[:start_at].to_s)}" if options[:start_at]
         url << "&maxResults=#{CGI.escape(options[:max_results].to_s)}" if options[:max_results]
         url << '&validateQuery=false' if options[:validate_query] === false
@@ -79,9 +68,8 @@ module JIRA
 
         response = client.get(url)
         json = parse_json(response.body)
-        if options[:max_results] && (options[:max_results] == 0)
-          return json['total']
-        end
+        return json['total'] if options[:max_results] && (options[:max_results]).zero?
+
         json['issues'].map do |issue|
           client.Issue.build(issue)
         end
@@ -92,14 +80,15 @@ module JIRA
       # is not set
       def fetch(reload = false, query_params = {})
         return if expanded? && !reload
+
         response = client.get(url_with_query_params(url, query_params))
         set_attrs_from_response(response)
-        if @attrs && @attrs['fields'] && @attrs['fields']['worklog'] && (@attrs['fields']['worklog']['total'] > @attrs['fields']['worklog']['maxResults'])
+        if @attrs && @attrs['fields'] &&
+           @attrs['fields']['worklog'] &&
+           (@attrs['fields']['worklog']['total'] > @attrs['fields']['worklog']['maxResults'])
           worklog_url = client.options[:rest_base_path] + "/#{self.class.endpoint_name}/#{id}/worklog"
           response = client.get(worklog_url)
-          unless response.body.nil? || (response.body.length < 2)
-            set_attrs({ 'fields' => { 'worklog' => self.class.parse_json(response.body) } }, false)
-          end
+          set_attrs({ 'fields' => { 'worklog' => self.class.parse_json(response.body) } }, false) unless response.body.nil? || (response.body.length < 2)
         end
         @expanded = true
       end
@@ -113,14 +102,16 @@ module JIRA
       end
 
       def respond_to?(method_name, _include_all = false)
-        if attrs.key?('fields') && [method_name.to_s, client.Field.name_to_id(method_name)].any? { |k| attrs['fields'].key?(k) }
+        if attrs.key?('fields') && [method_name.to_s, client.Field.name_to_id(method_name)].any? do |k|
+             attrs['fields'].key?(k)
+           end
           true
         else
           super(method_name)
         end
       end
 
-      def method_missing(method_name, *args, &block)
+      def method_missing(method_name, *args, &)
         if attrs.key?('fields')
           if attrs['fields'].key?(method_name.to_s)
             attrs['fields'][method_name.to_s]
@@ -129,11 +120,11 @@ module JIRA
             if attrs['fields'].key?(official_name)
               attrs['fields'][official_name]
             else
-              super(method_name, *args, &block)
+              super
             end
           end
         else
-          super(method_name, *args, &block)
+          super
         end
       end
     end

data/lib/jira/resource/issue_picker_suggestions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuePickerSuggestionsFactory < JIRA::BaseFactory # :nodoc:
@@ -6,7 +8,8 @@ module JIRA
     class IssuePickerSuggestions < JIRA::Base
       has_many :sections, class: JIRA::Resource::IssuePickerSuggestionsIssue
 
-      def self.all(client, query = '', options = { current_jql: nil, current_issue_key: nil, current_project_id: nil, show_sub_tasks: nil, show_sub_tasks_parent: nil })
+      def self.all(client, query = '', options = { current_jql: nil, current_issue_key: nil, current_project_id: nil,
+show_sub_tasks: nil, show_sub_tasks_parent: nil })
         url = client.options[:rest_base_path] + "/issue/picker?query=#{CGI.escape(query)}"
 
         url << "&currentJQL=#{CGI.escape(options[:current_jql])}" if options[:current_jql]

data/lib/jira/resource/issue_picker_suggestions_issue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuePickerSuggestionsIssueFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/issuelink.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuelinkFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/issuelinktype.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuelinktypeFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/issuetype.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuetypeFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/priority.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class PriorityFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class ProjectFactory < JIRA::BaseFactory # :nodoc:
@@ -15,7 +17,7 @@ module JIRA
 
       # Returns all the issues for this project
       def issues(options = {})
-        search_url = client.options[:rest_base_path] + '/search'
+        search_url = "#{client.options[:rest_base_path]}/search"
         query_params = { jql: "project=\"#{key}\"" }
         query_params.update Base.query_params_for_search(options)
         response = client.get(url_with_query_params(search_url, query_params))
@@ -26,7 +28,7 @@ module JIRA
       end
 
       def users(start_at: nil, max_results: nil)
-        users_url = client.options[:rest_base_path] + '/user/assignable/search'
+        users_url = "#{client.options[:rest_base_path]}/user/assignable/search"
         query_params = { project: key_value }
         query_params['startAt'] = start_at if start_at
         query_params['maxResults'] = max_results if max_results

data/lib/jira/resource/rapidview.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module JIRA
@@ -7,7 +9,7 @@ module JIRA
 
     class RapidView < JIRA::Base
       def self.all(client)
-        response = client.get(path_base(client) + '/rapidview')
+        response = client.get("#{path_base(client)}/rapidview")
         json = parse_json(response.body)
         json['views'].map do |view|
           client.RapidView.build(view)
@@ -44,7 +46,7 @@ module JIRA
 
       def sprints(options = {})
         params = { includeHistoricSprints: options.fetch(:include_historic, false),
-                   includeFutureSprints:   options.fetch(:include_future, false) }
+                   includeFutureSprints: options.fetch(:include_future, false) }
         response = client.get(path_base(client) + "/sprintquery/#{id}?#{params.to_query}")
         json = self.class.parse_json(response.body)
         json['sprints'].map do |sprint|
@@ -56,7 +58,7 @@ module JIRA
       private
 
       def self.path_base(client)
-        client.options[:context_path] + '/rest/greenhopper/1.0'
+        "#{client.options[:context_path]}/rest/greenhopper/1.0"
       end
 
       def path_base(client)

data/lib/jira/resource/remotelink.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class RemotelinkFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/resolution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class ResolutionFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/serverinfo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class ServerInfoFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/sprint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class SprintFactory < JIRA::BaseFactory # :nodoc:
@@ -12,19 +14,20 @@ module JIRA
 
       # get all issues of sprint
       def issues(options = {})
-        jql = 'sprint = ' + id.to_s
+        jql = "sprint = #{id}"
         jql += " and updated >= '#{options[:updated]}'" if options[:updated]
         Issue.jql(client, jql)
       end
 
       def add_issue(issue)
-        request_body = { issues: [issue.id] }.to_json
-        response = client.post("#{agile_path}/issue", request_body)
-        true
+        add_issues([issue])
       end
 
-      def sprint_report
-        get_sprint_details_attribute('sprint_report')
+      def add_issues(issues)
+        issue_ids = issues.map(&:id)
+        request_body = { issues: issue_ids }.to_json
+        client.post("#{agile_path}/issue", request_body)
+        true
       end
 
       def start_date
@@ -42,13 +45,14 @@ module JIRA
       def get_sprint_details_attribute(attribute_name)
         attribute = instance_variable_get("@#{attribute_name}")
         return attribute if attribute
+
         get_sprint_details
         instance_variable_get("@#{attribute_name}")
       end
 
       def get_sprint_details
         search_url =
-          "#{client.options[:site]}#{client.options[:client_path]}/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=#{rapidview_id}&sprintId=#{id}"
+          "#{client.options[:site]}#{client.options[:client_path]}/rest/agile/1.0/sprint/#{id}"
         begin
           response = client.get(search_url)
         rescue StandardError
@@ -56,22 +60,9 @@ module JIRA
         end
         json = self.class.parse_json(response.body)
 
-        @start_date = Date.parse(json['sprint']['startDate']) unless json['sprint']['startDate'] == 'None'
-        @end_date = Date.parse(json['sprint']['endDate']) unless json['sprint']['endDate'] == 'None'
-        @completed_date = Date.parse(json['sprint']['completeDate']) unless json['sprint']['completeDate'] == 'None'
-        @sprint_report = client.SprintReport.build(json['contents'])
-      end
-
-      def rapidview_id
-        return @attrs['rapidview_id'] if @attrs['rapidview_id']
-        search_url = client.options[:site] + '/secure/GHGoToBoard.jspa?sprintId=' + id.to_s
-        begin
-          response = client.get(search_url)
-        rescue JIRA::HTTPError => error
-          return unless error.response.instance_of? Net::HTTPFound
-          rapid_view_match = /rapidView=(\d+)&/.match(error.response['location'])
-          @attrs['rapidview_id'] = rapid_view_match[1] unless rapid_view_match.nil?
-        end
+        @start_date = json['startDate'] && Date.parse(json['startDate'])
+        @end_date = json['endDate'] && Date.parse(json['endDate'])
+        @complete_date = json['completeDate'] && Date.parse(json['completeDate'])
       end
 
       def save(attrs = {}, _path = nil)

data/lib/jira/resource/status.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'status_category'
+
 module JIRA
   module Resource
     class StatusFactory < JIRA::BaseFactory # :nodoc:
     end
 
-    class Status < JIRA::Base; end
+    class Status < JIRA::Base
+      has_one :status_category, class: JIRA::Resource::StatusCategory, attribute_key: 'statusCategory'
+    end
   end
 end

data/lib/jira/resource/status_category.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JIRA
+  module Resource
+    class StatusCategoryFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class StatusCategory < JIRA::Base; end
+  end
+end

data/lib/jira/resource/suggested_issue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class SuggestedIssueFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/transition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class TransitionFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class UserFactory < JIRA::BaseFactory # :nodoc:
@@ -13,7 +15,7 @@ module JIRA
       MAX_RESULTS = 1000
 
       def self.singular_path(client, key, prefix = '/')
-        collection_path(client, prefix) + '?username=' + key
+        "#{collection_path(client, prefix)}?accountId=#{key}"
       end
 
       # Cannot retrieve more than 1,000 users through the api, please see: https://jira.atlassian.com/browse/JRASERVER-65089

data/lib/jira/resource/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class VersionFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/watcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WatcherFactory < JIRA::BaseFactory # :nodoc:
@@ -29,7 +31,6 @@ module JIRA
         response = client.post(path, user_id.to_json)
         true
       end
-
     end
   end
 end