jira-ruby 2.2.0 → 3.0.0.beta1

data/jira-ruby.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'jira/version'
 
@@ -9,27 +11,19 @@ Gem::Specification.new do |s|
   s.summary     = 'Ruby Gem for use with the Atlassian JIRA REST API'
   s.description = 'API for JIRA'
   s.licenses    = ['MIT']
-  s.metadata    = { 'source_code_uri' => 'https://github.com/sumoheavy/jira-ruby' }
+  s.metadata    = {
+    'source_code_uri' => 'https://github.com/sumoheavy/jira-ruby',
+    'rubygems_mfa_required' => 'true'
+  }
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 3.1.0'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # Runtime Dependencies
-  s.add_runtime_dependency 'activesupport'
-  s.add_runtime_dependency 'atlassian-jwt'
-  s.add_runtime_dependency 'multipart-post'
-  s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
-
-  # Development Dependencies
-  s.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
-  s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.5'
-  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
-  s.add_development_dependency 'railties'
-  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
-  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
-  s.add_development_dependency 'webmock', '~> 1.18', '>= 1.18.0'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'atlassian-jwt'
+  s.add_dependency 'multipart-post'
+  s.add_dependency 'oauth', '~> 1.0'
 end

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 }
@@ -322,7 +325,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 +334,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 +363,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
+          set_attrs_from_response(e.response) # Merge error status generated by JIRA REST API
         rescue JSON::ParserError => parse_exception
           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 +382,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 +423,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 +438,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 +448,7 @@ module JIRA
     def patched_url
       result = url
       return result if result.start_with?('/', 'http')
+
       "/#{result}"
     end
 
@@ -476,15 +482,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 +502,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 +515,20 @@ 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|
+      options.select do |k, _v|
         QUERY_PARAMS_FOR_SINGLE_FETCH.include? k
-      end]
+      end.to_h
     end
 
     def self.query_params_for_search(options)
-      Hash[options.select do |k, _v|
+      options.select do |k, _v|
         QUERY_PARAMS_FOR_SEARCH.include? k
-      end]
+      end.to_h
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'forwardable'
 require 'ostruct'
@@ -34,12 +36,14 @@ module JIRA
   #   :default_headers    => {},
   #   :use_client_cert    => false,
   #   :read_timeout       => nil,
+  #   :max_retries        => nil,
   #   :http_debug         => false,
   #   :shared_secret      => nil,
   #   :cert_path          => nil,
   #   :key_path           => nil,
   #   :ssl_client_cert    => nil,
   #   :ssl_client_key     => nil
+  #   :ca_file            => nil
   #
   # See the JIRA::Base class methods for all of the available methods on these accessor
   # objects.
@@ -56,43 +60,45 @@ module JIRA
     # 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 = {
@@ -116,11 +122,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]
@@ -132,7 +147,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
@@ -181,6 +200,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
@@ -225,10 +248,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
@@ -290,7 +309,7 @@ module JIRA
 
     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
 
     def put(path, body = '', headers = {})

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
@@ -36,7 +38,7 @@ class JIRA::HasManyProxy
   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)
+  def method_missing(method_name, ...)
+    collection.send(method_name, ...)
   end
 end

data/lib/jira/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'net/https'
 require 'cgi/cookie'
@@ -21,7 +23,7 @@ module JIRA
       body = { username: @options[:username].to_s, password: @options[:password].to_s }.to_json
       @options.delete(:username)
       @options.delete(:password)
-      make_request(:post, @options[:context_path] + '/rest/auth/1/session', body, 'Content-Type' => 'application/json')
+      make_request(:post, "#{@options[:context_path]}/rest/auth/1/session", body, 'Content-Type' => 'application/json')
     end
 
     def make_request(http_method, url, body = '', headers = {})
@@ -45,12 +47,13 @@ module JIRA
     end
 
     def http_conn(uri)
-      if @options[:proxy_address]
-        http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] || 80, @options[:proxy_username], @options[:proxy_password])
-      else
-        http_class = Net::HTTP
-      end
-      http_conn = http_class.new(uri.host, uri.port)
+      http_conn =
+        if @options[:proxy_address]
+          Net::HTTP.new(uri.host, uri.port, @options[:proxy_address], @options[:proxy_port] || 80,
+                        @options[:proxy_username], @options[:proxy_password])
+        else
+          Net::HTTP.new(uri.host, uri.port)
+        end
       http_conn.use_ssl = @options[:use_ssl]
       if @options[:use_client_cert]
         http_conn.cert = @options[:ssl_client_cert]
@@ -59,6 +62,8 @@ module JIRA
       http_conn.verify_mode = @options[:ssl_verify_mode]
       http_conn.ssl_version = @options[:ssl_version] if @options[:ssl_version]
       http_conn.read_timeout = @options[:read_timeout]
+      http_conn.max_retries = @options[:max_retries] if @options[:max_retries]
+      http_conn.ca_file = @options[:ca_file] if @options[:ca_file]
       http_conn
     end
 
@@ -93,13 +98,13 @@ module JIRA
 
     def store_cookies(response)
       cookies = response.get_fields('set-cookie')
-      if cookies
-        cookies.each do |cookie|
-          data = CGI::Cookie.parse(cookie)
-          data.delete('Path')
-          @cookies.merge!(data)
-        end
+      return unless cookies
+      cookies.each do |cookie|
+        data = CGI::Cookie.parse(cookie)
+        data.delete('Path')
+        @cookies.merge!(data)
       end
+
     end
 
     def add_cookies(request)

data/lib/jira/http_error.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'forwardable'
+require 'active_support/core_ext/object'
+
 module JIRA
   class HTTPError < StandardError
     extend Forwardable

data/lib/jira/jwt_client.rb

@@ -1,67 +1,43 @@
+# frozen_string_literal: true
+
 require 'atlassian/jwt'
 
 module JIRA
   class JwtClient < HttpClient
     def make_request(http_method, url, body = '', headers = {})
       @http_method = http_method
+      jwt_header = build_jwt_header(url)
 
-      super(http_method, url, body, headers)
+      super(http_method, url, body, headers.merge(jwt_header))
     end
 
     def make_multipart_request(url, data, headers = {})
       @http_method = :post
+      jwt_header = build_jwt_header(url)
 
-      super(url, data, headers)
+      super(url, data, headers.merge(jwt_header))
     end
 
-    class JwtUriBuilder
-      attr_reader :request_url, :http_method, :shared_secret, :site, :issuer
-
-      def initialize(request_url, http_method, shared_secret, site, issuer)
-        @request_url = request_url
-        @http_method = http_method
-        @shared_secret = shared_secret
-        @site = site
-        @issuer = issuer
-      end
-
-      def build
-        uri = URI.parse(request_url)
-        new_query = URI.decode_www_form(String(uri.query)) << ['jwt', jwt_header]
-        uri.query = URI.encode_www_form(new_query)
-
-        return uri.to_s unless uri.is_a?(URI::HTTP)
-
-        uri.request_uri
-      end
+    private
 
-      private
+    attr_reader :http_method
 
-      def jwt_header
-        claim = Atlassian::Jwt.build_claims \
-          issuer,
-          request_url,
-          http_method.to_s,
-          site,
-          (Time.now - 60).to_i,
-          (Time.now + 86_400).to_i
+    def build_jwt_header(url)
+      jwt = build_jwt(url)
 
-        JWT.encode claim, shared_secret
-      end
+      { 'Authorization' => "JWT #{jwt}" }
     end
 
-    private
-
-    attr_reader :http_method
-
-    def request_path(url)
-      JwtUriBuilder.new(
+    def build_jwt(url)
+      claim = Atlassian::Jwt.build_claims \
+        @options[:issuer],
         url,
         http_method.to_s,
-        @options[:shared_secret],
         @options[:site],
-        @options[:issuer]
-      ).build
+        (Time.now - 60).to_i,
+        (Time.now + 86_400).to_i
+
+      JWT.encode claim, @options[:shared_secret]
     end
   end
 end

data/lib/jira/oauth_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'oauth'
 require 'json'
 require 'forwardable'
@@ -45,8 +47,8 @@ module JIRA
 
     # Returns the current request token if it is set, else it creates
     # and sets a new token.
-    def request_token(options = {}, *arguments, &block)
-      @request_token ||= get_request_token(options, *arguments, block)
+    def request_token(options = {}, ...)
+      @request_token ||= get_request_token(options, ...)
     end
 
     # Sets the request token from a given token and secret.
@@ -71,6 +73,7 @@ module JIRA
     # JIRA::Client::UninitializedAccessTokenError exception if it is not set.
     def access_token
       raise UninitializedAccessTokenError unless @access_token
+
       @access_token
     end
 
@@ -82,7 +85,7 @@ module JIRA
         uri.query = if uri.query.to_s == ''
                       oauth_params_str
                     else
-                      uri.query + '&' + oauth_params_str
+                      "#{uri.query}&#{oauth_params_str}"
                     end
         url = uri.to_s
       end

data/lib/jira/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jira-ruby'
 require 'rails'
 

data/lib/jira/request_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'oauth'
 require 'json'
 require 'net/https'
@@ -11,12 +13,14 @@ module JIRA
     def request(*args)
       response = make_request(*args)
       raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
+
       response
     end
 
     def request_multipart(*args)
       response = make_multipart_request(*args)
       raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
+
       response
     end
 
@@ -28,4 +32,4 @@ module JIRA
       raise NotImplementedError
     end
   end
-end
+end