jira-ruby 2.3.0 → 3.2.0

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,11 +1,14 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class IssuelinkFactory < JIRA::BaseFactory # :nodoc:
     end
 
-    # Because of circular dependency Issue->IssueLink->Issue
-    # we have to declare JIRA::Resource::Issue class.
-    class Issue < JIRA::Base; end
+    class Issue < JIRA::Base
+      # Because of circular dependency Issue->IssueLink->Issue
+      # we have to declare JIRA::Resource::Issue class.
+    end
 
     class Issuelink < JIRA::Base
       has_one :type, class: JIRA::Resource::Issuelinktype

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/jql"
         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/properties.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module JIRA
+  module Resource
+    class PropertiesFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Properties < JIRA::Base
+      belongs_to :issue
+
+      def self.key_attribute
+        :key
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        response = client.get("#{issue.url}/#{endpoint_name}")
+        json = parse_json(response.body)
+        json[key_attribute.to_s.pluralize].map do |attrs|
+          ## Net get the individual property
+          self_response = client.get(attrs['self'])
+          property = parse_json(self_response.body)
+          ## Make sure to build the new resource via the issue.properties in order to support the has_many proxy
+          issue.properties.build(property)
+        end
+      end
+
+      ## Override save so we can handle the required attrs (and default 'value' when appropriate)
+      def save!(attrs = {}, path = nil)
+        if attrs.is_a?(Hash) && attrs.key?(self.class.key_attribute.to_s)
+          raise ArgumentError, "Use of 'value' is required when '#{self.class.key_attribute}' is provided" \
+            unless attrs.key?('value')
+
+          set_attrs(self.class.key_attribute.to_s => attrs[self.class.key_attribute.to_s])
+        end
+
+        raise ArgumentError, "'key' is required on a new record" if new_record?
+
+        path ||= patched_url
+        ## We can take either the 'value' element from the hash, OR use the entire attrs as the value
+        value = attrs.is_a?(Hash) && attrs.key?('value') ? attrs['value'] : attrs
+        value = '' if value.nil?
+        ## Note: this API endpoint requires a non-empty JSON body for the value of the property
+        ## Note2: this API endpoint does not return a body, so no need to call set_attrs_from_response
+        client.send(:put, path, value.to_json)
+        set_attrs({ 'value' => value }, false)
+        @expanded = false
+        true
+      end
+    end
+  end
+end

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]).first
       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)
+        issues
       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:
@@ -26,10 +28,9 @@ module JIRA
 
       def save!(user_id, path = nil)
         path ||= new_record? ? url : patched_url
-        response = client.post(path, user_id.to_json)
+        client.post(path, user_id.to_json)
         true
       end
-
     end
   end
 end

data/lib/jira/resource/webhook.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WebhookFactory < JIRA::BaseFactory # :nodoc:
     end
 
     class Webhook < JIRA::Base
-      REST_BASE_PATH = '/rest/webhooks/1.0'.freeze
+      REST_BASE_PATH = '/rest/webhooks/1.0'
 
       def self.endpoint_name
         'webhook'
@@ -14,15 +16,19 @@ module JIRA
         client.options[:context_path] + REST_BASE_PATH
       end
 
+      def self.singular_path(client, key, prefix = '/')
+        "#{full_url(client)}#{prefix}/#{endpoint_name}/#{key}"
+      end
+
       def self.collection_path(client, prefix = '/')
-        full_url(client) + prefix + endpoint_name
+        "#{full_url(client)}#{prefix}/#{endpoint_name}"
       end
 
       def self.all(client, options = {})
         response = client.get(collection_path(client))
         json = parse_json(response.body)
         json.map do |attrs|
-          new(client, { attrs: attrs }.merge(options))
+          new(client, { attrs: }.merge(options))
         end
       end
 

data/lib/jira/resource/worklog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WorklogFactory < JIRA::BaseFactory # :nodoc:
@@ -5,10 +7,21 @@ module JIRA
 
     class Worklog < JIRA::Base
       has_one :author, class: JIRA::Resource::User
-      has_one :update_author, class: JIRA::Resource::User,
-                              attribute_key: 'updateAuthor'
+      has_one :update_author, class: JIRA::Resource::User, attribute_key: 'updateAuthor'
       belongs_to :issue
       nested_collections true
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        response = client.get("#{issue.url}/#{endpoint_name}")
+        json = parse_json(response.body)
+        json = json[endpoint_name.pluralize]
+        json.map do |attrs|
+          new(client, { attrs: }.merge(options))
+        end
+      end
     end
   end
 end

data/lib/jira/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
-  VERSION = '2.3.0'.freeze
+  VERSION = '3.2.0'
 end

data/lib/jira-ruby.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << __dir__
 
 require 'active_support'
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
-  inflector.singular /status$/, 'status'
+  inflector.singular(/status$/, 'status')
 end
 
 require 'jira/base'
@@ -18,8 +20,10 @@ require 'jira/resource/component'
 require 'jira/resource/issuetype'
 require 'jira/resource/version'
 require 'jira/resource/status'
+require 'jira/resource/status_category'
 require 'jira/resource/transition'
 require 'jira/resource/project'
+require 'jira/resource/properties'
 require 'jira/resource/priority'
 require 'jira/resource/comment'
 require 'jira/resource/worklog'
@@ -31,12 +35,11 @@ require 'jira/resource/issue_picker_suggestions_issue'
 require 'jira/resource/issue_picker_suggestions'
 require 'jira/resource/remotelink'
 require 'jira/resource/sprint'
-require 'jira/resource/sprint_report'
+require 'jira/resource/resolution'
 require 'jira/resource/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
 require 'jira/resource/rapidview'
-require 'jira/resource/resolution'
 require 'jira/resource/serverinfo'
 require 'jira/resource/createmeta'
 require 'jira/resource/webhook'

data/lib/tasks/generate.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 namespace :jira do
@@ -11,7 +13,7 @@ namespace :jira do
   task :generate_public_cert do
     puts "Executing 'openssl req -x509 -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem'"
     system('openssl req -x509 -subj "/C=US/ST=New York/L=New York/O=SUMO Heavy Industries/CN=www.sumoheavy.com" -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem')
-    puts "Done. The RSA-SHA1 private keyfile is in the current directory: \'rsakey.pem\'."
+    puts "Done. The RSA-SHA1 private keyfile is in the current directory: 'rsakey.pem'."
     puts 'You will need to copy the following certificate into your application link configuration in Jira:'
     system('cat rsacert.pem')
   end