jira-ruby 2.3.0 → 3.0.0.beta2

data/lib/jira/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string'
 require 'active_support/inflector'
 require 'set'
@@ -81,8 +83,8 @@ module JIRA
         if options[relation]
           instance_variable_set("@#{relation}", options[relation])
           instance_variable_set("@#{relation}_id", options[relation].key_value)
-        elsif options["#{relation}_id".to_sym]
-          instance_variable_set("@#{relation}_id", options["#{relation}_id".to_sym])
+        elsif options[:"#{relation}_id"]
+          instance_variable_set("@#{relation}_id", options[:"#{relation}_id"])
         else
           raise ArgumentError, "Required option #{relation.inspect} missing" unless options[relation]
         end
@@ -96,7 +98,7 @@ module JIRA
       json = parse_json(response.body)
       json = json[endpoint_name.pluralize] if collection_attributes_are_nested
       json.map do |attrs|
-        new(client, { attrs: attrs }.merge(options))
+        new(client, { attrs: }.merge(options))
       end
     end
 
@@ -111,7 +113,7 @@ module JIRA
     # Builds a new instance of the resource with the given attributes.
     # These attributes will be posted to the JIRA Api if save is called.
     def self.build(client, attrs)
-      new(client, attrs: attrs)
+      new(client, attrs:)
     end
 
     # Returns the name of this resource for use in URL components.
@@ -141,7 +143,7 @@ module JIRA
     #   JIRA::Resource::Comment.singular_path('456','/issue/123/')
     #     # => /jira/rest/api/2/issue/123/comment/456
     def self.singular_path(client, key, prefix = '/')
-      collection_path(client, prefix) + '/' + key
+      "#{collection_path(client, prefix)}/#{key}"
     end
 
     # Returns the attribute name of the attribute used for find.
@@ -193,10 +195,11 @@ module JIRA
     #                       # => Looks for {"foo":{"bar":{"baz":{"child":{}}}}}
     def self.has_one(resource, options = {})
       attribute_key = options[:attribute_key] || resource.to_s
-      child_class = options[:class] || ('JIRA::Resource::' + resource.to_s.classify).constantize
+      child_class = options[:class] || "JIRA::Resource::#{resource.to_s.classify}".constantize
       define_method(resource) do
         attribute = maybe_nested_attribute(attribute_key, options[:nested_under])
         return nil unless attribute
+
         child_class.new(client, attrs: attribute)
       end
     end
@@ -244,7 +247,7 @@ module JIRA
     #                       # => Looks for {"foo":{"bar":{"baz":{"children":{}}}}}
     def self.has_many(collection, options = {})
       attribute_key = options[:attribute_key] || collection.to_s
-      child_class = options[:class] || ('JIRA::Resource::' + collection.to_s.classify).constantize
+      child_class = options[:class] || "JIRA::Resource::#{collection.to_s.classify}".constantize
       self_class_basename = name.split('::').last.downcase.to_sym
       define_method(collection) do
         child_class_options = { self_class_basename => self }
@@ -288,11 +291,7 @@ module JIRA
     # and returns true when found, otherwise proxies the
     # call to the superclass.
     def respond_to?(method_name, _include_all = false)
-      if attrs.key?(method_name.to_s)
-        true
-      else
-        super(method_name)
-      end
+      attrs.key?(method_name.to_s) || super(method_name)
     end
 
     # Overrides method_missing to check the attribute hash
@@ -322,7 +321,7 @@ module JIRA
     # issue it returns '/issue'
     def path_component
       path_component = "/#{self.class.endpoint_name}"
-      path_component += '/' + key_value if key_value
+      path_component += "/#{key_value}" if key_value
       path_component
     end
 
@@ -331,6 +330,7 @@ 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)
       @expanded = true
@@ -359,14 +359,14 @@ module JIRA
     def save(attrs, path = url)
       begin
         save_status = save!(attrs, path)
-      rescue JIRA::HTTPError => exception
+      rescue JIRA::HTTPError => e
         begin
-          set_attrs_from_response(exception.response) # Merge error status generated by JIRA REST API
-        rescue JSON::ParserError => parse_exception
+          set_attrs_from_response(e.response) # Merge error status generated by JIRA REST API
+        rescue JSON::ParserError
           set_attrs('exception' => {
-                      'class' => exception.response.class.name,
-                      'code' => exception.response.code,
-                      'message' => exception.response.message
+                      'class' => e.response.class.name,
+                      'code' => e.response.code,
+                      'message' => e.response.message
                     })
         end
         # raise exception
@@ -378,10 +378,10 @@ module JIRA
     # Sets the attributes hash from a HTTPResponse object from JIRA if it is
     # not nil or is not a json response.
     def set_attrs_from_response(response)
-      unless response.body.nil? || (response.body.length < 2)
-        json = self.class.parse_json(response.body)
-        set_attrs(json)
-      end
+      return if response.body.nil? || (response.body.length < 2)
+
+      json = self.class.parse_json(response.body)
+      set_attrs(json)
     end
 
     # Set the current attributes from a hash.  If clobber is true, any existing
@@ -419,7 +419,7 @@ module JIRA
       prefix = '/'
       unless self.class.belongs_to_relationships.empty?
         prefix = self.class.belongs_to_relationships.inject(prefix) do |prefix_so_far, relationship|
-          prefix_so_far.to_s + relationship.to_s + '/' + send("#{relationship}_id").to_s + '/'
+          "#{prefix_so_far}#{relationship}/#{send("#{relationship}_id")}/"
         end
       end
       if @attrs['self']
@@ -434,7 +434,8 @@ module JIRA
     end
 
     # This method fixes issue that there is no / prefix in url. It is happened when we call for instance
-    # Looks like this issue is actual only in case if you use atlassian sdk your app path is not root (like /jira in example below)
+    # Looks like this issue is actual only in case if you use atlassian sdk your app pathis not root
+    # (like /jira in example below)
     # issue.save() for existing resource.
     # As a result we got error 400 from JIRA API:
     # [07/Jun/2015:15:32:19 +0400] "PUT jira/rest/api/2/issue/10111 HTTP/1.1" 400 -
@@ -443,6 +444,7 @@ module JIRA
     def patched_url
       result = url
       return result if result.start_with?('/', 'http')
+
       "/#{result}"
     end
 
@@ -476,15 +478,18 @@ module JIRA
 
     def self.maybe_nested_attribute(attributes, attribute_name, nested_under = nil)
       return attributes[attribute_name] if nested_under.nil?
+
       if nested_under.instance_of? Array
         final = nested_under.inject(attributes) do |parent, key|
           break if parent.nil?
+
           parent[key]
         end
         return nil if final.nil?
+
         final[attribute_name]
       else
-        return attributes[nested_under][attribute_name]
+        attributes[nested_under][attribute_name]
       end
     end
 
@@ -493,10 +498,10 @@ module JIRA
     end
 
     def self.url_with_query_params(url, query_params)
-      if !query_params.empty?
-        "#{url}?#{hash_to_query_string query_params}"
-      else
+      if query_params.empty?
         url
+      else
+        "#{url}?#{hash_to_query_string query_params}"
       end
     end
 
@@ -506,20 +511,16 @@ module JIRA
 
     def self.hash_to_query_string(query_params)
       query_params.map do |k, v|
-        CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
       end.join('&')
     end
 
     def self.query_params_for_single_fetch(options)
-      Hash[options.select do |k, _v|
-        QUERY_PARAMS_FOR_SINGLE_FETCH.include? k
-      end]
+      options.slice(*QUERY_PARAMS_FOR_SINGLE_FETCH)
     end
 
     def self.query_params_for_search(options)
-      Hash[options.select do |k, _v|
-        QUERY_PARAMS_FOR_SEARCH.include? k
-      end]
+      options.slice(*QUERY_PARAMS_FOR_SEARCH)
     end
   end
 end

data/lib/jira/base_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   # This is the base class for all the JIRA resource factory instances.
   class BaseFactory
@@ -36,7 +38,8 @@ module JIRA
     # The principle purpose of this class is to delegate methods to the corresponding
     # non-factory class and automatically prepend the client argument to the argument
     # list.
-    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues, :get_board_issues, :get_sprints, :get_sprint_issues, :get_projects, :get_projects_full
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues,
+                             :get_board_issues, :get_sprints, :get_sprint_issues, :get_projects, :get_projects_full
 
     # This method needs special handling as it has a default argument value
     def build(attrs = {})

data/lib/jira/client.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'forwardable'
-require 'ostruct'
 
 module JIRA
   # This class is the main access point for all JIRA::Resource instances.
@@ -34,6 +35,7 @@ module JIRA
   #   :default_headers    => {},
   #   :use_client_cert    => false,
   #   :read_timeout       => nil,
+  #   :max_retries        => nil,
   #   :http_debug         => false,
   #   :shared_secret      => nil,
   #   :cert_path          => nil,
@@ -52,48 +54,50 @@ module JIRA
     #
     # The authenticated client instance returned by the respective client type
     # (Oauth, Basic)
-    attr_accessor :consumer, :request_client, :http_debug, :cache
+    attr_accessor :consumer, :request_client, :http_debug, :field_map_cache
 
     # The configuration options for this client instance
     attr_reader :options
 
-    def_delegators :@request_client, :init_access_token, :set_access_token, :set_request_token, :request_token, :access_token, :authenticated?
-
-    DEFINED_OPTIONS = [
-      :site,
-      :context_path,
-      :signature_method,
-      :request_token_path,
-      :authorize_path,
-      :access_token_path,
-      :private_key,
-      :private_key_file,
-      :rest_base_path,
-      :consumer_key,
-      :consumer_secret,
-      :ssl_verify_mode,
-      :ssl_version,
-      :use_ssl,
-      :username,
-      :password,
-      :auth_type,
-      :proxy_address,
-      :proxy_port,
-      :proxy_username,
-      :proxy_password,
-      :use_cookies,
-      :additional_cookies,
-      :default_headers,
-      :use_client_cert,
-      :read_timeout,
-      :http_debug,
-      :issuer,
-      :base_url,
-      :shared_secret,
-      :cert_path,
-      :key_path,
-      :ssl_client_cert,
-      :ssl_client_key
+    def_delegators :@request_client, :init_access_token, :set_access_token, :set_request_token, :request_token,
+                   :access_token, :authenticated?
+
+    DEFINED_OPTIONS = %i[
+      site
+      context_path
+      signature_method
+      request_token_path
+      authorize_path
+      access_token_path
+      private_key
+      private_key_file
+      rest_base_path
+      consumer_key
+      consumer_secret
+      ssl_verify_mode
+      ssl_version
+      use_ssl
+      username
+      password
+      auth_type
+      proxy_address
+      proxy_port
+      proxy_username
+      proxy_password
+      use_cookies
+      additional_cookies
+      default_headers
+      use_client_cert
+      read_timeout
+      max_retries
+      http_debug
+      issuer
+      base_url
+      shared_secret
+      cert_path
+      key_path
+      ssl_client_cert
+      ssl_client_key
     ].freeze
 
     DEFAULT_OPTIONS = {
@@ -108,6 +112,23 @@ module JIRA
       default_headers: {}
     }.freeze
 
+    # Creates a new JIRA::Client instance
+    # @param [Hash] options The configuration options for the client
+    # @option options [Symbol] :auth_type The authentication type to use, :basic, :oauth, :oauth_2legged, or :cookie.
+    # @option options [String] :site The base URL for the JIRA instance
+    # @option options [Boolean] :use_ssl Whether to use HTTPS for requests
+    # @option options [Integer] :ssl_verify_mode The SSL verification mode OpenSSL::SSL::VERIFY_PEER or OpenSSL::SSL::VERIFY_NONE
+    # @option options [Hash] :default_headers Additional headers to send with each request
+    # @option options [String] :cert_path The path to the SSL certificate file to verify the server with
+    # @option options [String] :use_client_cert Whether to use a client certificate for authentication
+    # @option options [String] :ssl_client_cert The client certificate to use
+    # @option options [String] :ssl_client_key The client certificate key to use
+    # @option options [String] :proxy_address The address of the proxy server to use
+    # @option options [Integer] :proxy_port The port of the proxy server to use
+    # @option options [String] :proxy_username The username for the proxy server
+    # @option options [String] :proxy_password The password for the proxy server
+    # @return [JIRA::Client] The client instance
+    # @raise [ArgumentError] If an unknown option is given
     def initialize(options = {})
       options = DEFAULT_OPTIONS.merge(options)
       @options = options
@@ -117,11 +138,20 @@ module JIRA
       raise ArgumentError, "Unknown option(s) given: #{unknown_options}" unless unknown_options.empty?
 
       if options[:use_client_cert]
-        @options[:ssl_client_cert] = OpenSSL::X509::Certificate.new(File.read(@options[:cert_path])) if @options[:cert_path]
+        if @options[:cert_path]
+          @options[:ssl_client_cert] =
+            OpenSSL::X509::Certificate.new(File.read(@options[:cert_path]))
+        end
         @options[:ssl_client_key] = OpenSSL::PKey::RSA.new(File.read(@options[:key_path])) if @options[:key_path]
 
-        raise ArgumentError, 'Options: :cert_path or :ssl_client_cert must be set when :use_client_cert is true' unless @options[:ssl_client_cert]
-        raise ArgumentError, 'Options: :key_path or :ssl_client_key must be set when :use_client_cert is true' unless @options[:ssl_client_key]
+        unless @options[:ssl_client_cert]
+          raise ArgumentError,
+                'Options: :cert_path or :ssl_client_cert must be set when :use_client_cert is true'
+        end
+        unless @options[:ssl_client_key]
+          raise ArgumentError,
+                'Options: :key_path or :ssl_client_key must be set when :use_client_cert is true'
+        end
       end
 
       case options[:auth_type]
@@ -133,7 +163,11 @@ module JIRA
       when :basic
         @request_client = HttpClient.new(@options)
       when :cookie
-        raise ArgumentError, 'Options: :use_cookies must be true for :cookie authorization type' if @options.key?(:use_cookies) && !@options[:use_cookies]
+        if @options.key?(:use_cookies) && !@options[:use_cookies]
+          raise ArgumentError,
+                'Options: :use_cookies must be true for :cookie authorization type'
+        end
+
         @options[:use_cookies] = true
         @request_client = HttpClient.new(@options)
         @request_client.make_cookie_auth_request
@@ -146,8 +180,6 @@ module JIRA
       @http_debug = @options[:http_debug]
 
       @options.freeze
-
-      @cache = OpenStruct.new
     end
 
     def Project # :nodoc:
@@ -182,6 +214,10 @@ module JIRA
       JIRA::Resource::StatusFactory.new(self)
     end
 
+    def StatusCategory # :nodoc:
+      JIRA::Resource::StatusCategoryFactory.new(self)
+    end
+
     def Resolution # :nodoc:
       JIRA::Resource::ResolutionFactory.new(self)
     end
@@ -226,10 +262,6 @@ module JIRA
       JIRA::Resource::SprintFactory.new(self)
     end
 
-    def SprintReport
-      JIRA::Resource::SprintReportFactory.new(self)
-    end
-
     def ServerInfo
       JIRA::Resource::ServerInfoFactory.new(self)
     end
@@ -271,29 +303,63 @@ module JIRA
     end
 
     # HTTP methods without a body
+
+    # Make an HTTP DELETE request
+    # @param [String] path The path to request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def delete(path, headers = {})
       request(:delete, path, nil, merge_default_headers(headers))
     end
 
+    # Make an HTTP GET request
+    # @param [String] path The path to request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def get(path, headers = {})
       request(:get, path, nil, merge_default_headers(headers))
     end
 
+    # Make an HTTP HEAD request
+    # @param [String] path The path to request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def head(path, headers = {})
       request(:head, path, nil, merge_default_headers(headers))
     end
 
     # HTTP methods with a body
+
+    # Make an HTTP POST request
+    # @param [String] path The path to request
+    # @param [String] body The body of the request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
     def post(path, body = '', headers = {})
       headers = { 'Content-Type' => 'application/json' }.merge(headers)
       request(:post, path, body, merge_default_headers(headers))
     end
 
+    # Make an HTTP POST request with a file upload
+    # @param [String] path The path to request
+    # @param [String] file The file to upload
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def post_multipart(path, file, headers = {})
       puts "post multipart: #{path} - [#{file}]" if @http_debug
-      @request_client.request_multipart(path, file, headers)
+      @request_client.request_multipart(path, file, merge_default_headers(headers))
     end
 
+    # Make an HTTP PUT request
+    # @param [String] path The path to request
+    # @param [String] body The body of the request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def put(path, body = '', headers = {})
       headers = { 'Content-Type' => 'application/json' }.merge(headers)
       request(:put, path, body, merge_default_headers(headers))
@@ -301,11 +367,18 @@ module JIRA
 
     # Sends the specified HTTP request to the REST API through the
     # appropriate method (oauth, basic).
+    # @param [Symbol] http_method The HTTP method to use
+    # @param [String] path The path to request
+    # @param [String] body The body of the request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def request(http_method, path, body = '', headers = {})
       puts "#{http_method}: #{path} - [#{body}]" if @http_debug
       @request_client.request(http_method, path, body, headers)
     end
 
+    # @private
     # Stops sensitive client information from being displayed in logs
     def inspect
       "#<JIRA::Client:#{object_id}>"

data/lib/jira/has_many_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Whenever a collection from a has_many relationship is accessed, an instance
 # of this class is returned.  This instance wraps the Array of instances in
@@ -6,37 +8,39 @@
 #
 # In practice, instances of this class behave exactly like an Array.
 #
-class JIRA::HasManyProxy
-  attr_reader :target_class, :parent
-  attr_accessor :collection
+module JIRA
+  class HasManyProxy
+    attr_reader :target_class, :parent
+    attr_accessor :collection
 
-  def initialize(parent, target_class, collection = [])
-    @parent       = parent
-    @target_class = target_class
-    @collection   = collection
-  end
+    def initialize(parent, target_class, collection = [])
+      @parent       = parent
+      @target_class = target_class
+      @collection   = collection
+    end
 
-  # Builds an instance of this class with the correct parent.
-  # For example, issue.comments.build(attrs) will initialize a
-  # comment as follows:
-  #
-  #   JIRA::Resource::Comment.new(issue.client,
-  #                               :attrs => attrs,
-  #                               :issue => issue)
-  def build(attrs = {})
-    resource = target_class.new(parent.client, :attrs => attrs, parent.to_sym => parent)
-    collection << resource
-    resource
-  end
+    # Builds an instance of this class with the correct parent.
+    # For example, issue.comments.build(attrs) will initialize a
+    # comment as follows:
+    #
+    #   JIRA::Resource::Comment.new(issue.client,
+    #                               :attrs => attrs,
+    #                               :issue => issue)
+    def build(attrs = {})
+      resource = target_class.new(parent.client, :attrs => attrs, parent.to_sym => parent)
+      collection << resource
+      resource
+    end
 
-  # Forces an HTTP request to fetch all instances of the target class that
-  # are associated with the parent
-  def all
-    target_class.all(parent.client, parent.to_sym => parent)
-  end
+    # Forces an HTTP request to fetch all instances of the target class that
+    # are associated with the parent
+    def all
+      target_class.all(parent.client, parent.to_sym => parent)
+    end
 
-  # Delegate any missing methods to the collection that this proxy wraps
-  def method_missing(method_name, *args, &block)
-    collection.send(method_name, *args, &block)
+    # Delegate any missing methods to the collection that this proxy wraps
+    def method_missing(method_name, ...)
+      collection.send(method_name, ...)
+    end
   end
 end