jira-ruby 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc33adf73b2ff3a7e4ba9d20246e3a7a760d6c94530aac292776e1cd03455d6
-  data.tar.gz: 91be26b124667936bf93d4216210c5ce77d203b744bfce7b5d7a0e2bd313d339
+  metadata.gz: 4a043cafa57aad32acfda37495a8419b4511581786620049cb6264a05265aefb
+  data.tar.gz: 2c3b66dd69faaef351e043b10c62f3cfd7662e003905363db6bdbf458bfb10b1
 SHA512:
-  metadata.gz: 4a7c2b8d43b3b8235a1ea51f1baf4d628a3726a7bb8dc39ecb62b8ef795ca085fb85ebb99941e8d699f5a20cb41ecceb3a3675781eb081481329ddc36f957701
-  data.tar.gz: dbabaf3245895c038b4496230eb2a3fdf7e0590a9bf549ace6b87db25268a492714579758e4789f8edd9a5da173be0e7b5bf3c732b17a0c9caad7cc1556bed55
+  metadata.gz: 677a496c74235ea213ac92416b9dfb303e56bc04ea94b617134925ce744c25bd81583b2516a342c347a935959795c35813245499efcf2c058b075d308ef51454
+  data.tar.gz: ef42dd385a24ff73526e8e2d21fedb0af60832444f9d1e43c0c23a1cca58da61751a24901430abf0650cffacdd7b41ff28fa7620deb195ede7081af504eb4295

data/.github/workflows/CI.yml

@@ -10,6 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '4.0'
           - '3.4'
           - '3.3'
           - '3.2'

data/.github/workflows/rubocop.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.4'
           bundler-cache: true
       - name: Run rubocop
         run: |

data/README.md

@@ -1,6 +1,5 @@
 # JIRA API Gem
 
-[![Code Climate](https://codeclimate.com/github/sumoheavy/jira-ruby.svg)](https://codeclimate.com/github/sumoheavy/jira-ruby)
 [![Build Status](https://github.com/sumoheavy/jira-ruby/actions/workflows/CI.yml/badge.svg)](https://github.com/sumoheavy/jira-ruby/actions/workflows/CI.yml)
 
 This gem provides access to the Atlassian JIRA REST API.

data/jira-ruby.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'activesupport'
-  s.add_dependency 'atlassian-jwt'
+  s.add_dependency 'cgi'
+  s.add_dependency 'jwt', '>= 2.1'
   s.add_dependency 'multipart-post'
   s.add_dependency 'oauth', '~> 1.0'
 end

data/lib/jira/atlassian/jwt.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Copyright 2013 Atlassian Pty Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'jwt'
+require 'uri'
+require 'cgi'
+
+module JIRA
+  module Atlassian
+    module Jwt
+      class << self
+        CANONICAL_QUERY_SEPARATOR = '&'
+        ESCAPED_CANONICAL_QUERY_SEPARATOR = '%26'
+
+        def create_canonical_request(uri, http_method, base_uri)
+          uri = URI.parse(uri) unless uri.is_a? URI
+          base_uri = URI.parse(base_uri) unless base_uri.is_a? URI
+
+          [
+            http_method.upcase,
+            canonicalize_uri(uri, base_uri),
+            canonicalize_query_string(uri.query)
+          ].join(CANONICAL_QUERY_SEPARATOR)
+        end
+
+        def build_claims(issuer, url, http_method, base_url = '', issued_at = nil, expires = nil, attributes = {}) # rubocop:disable Metrics/ParameterLists
+          issued_at ||= Time.now.to_i
+          expires ||= issued_at + 60
+          qsh = Digest::SHA256.hexdigest(create_canonical_request(url, http_method, base_url))
+
+          {
+            iss: issuer,
+            iat: issued_at,
+            exp: expires,
+            qsh: qsh
+          }.merge(attributes)
+        end
+
+        def canonicalize_uri(uri, base_uri)
+          path = uri.path.sub(/^#{base_uri.path}/, '')
+          path = '/' if path.nil? || path.empty?
+          path = "/#{path}" unless path.start_with? '/'
+          path.chomp!('/') if path.length > 1
+          path.gsub(CANONICAL_QUERY_SEPARATOR, ESCAPED_CANONICAL_QUERY_SEPARATOR)
+        end
+
+        def canonicalize_query_string(query)
+          return '' if query.nil? || query.empty?
+
+          query = CGI.parse(query)
+          query.delete('jwt')
+          query.each do |k, v|
+            query[k] = v.map { |a| CGI.escape a }.join(',') if v.is_a? Array
+            query[k].gsub!('+', '%20')  # Use %20, not CGI.escape default of "+"
+            query[k].gsub!('%7E', '~')  # Unescape "~" per JS tests
+          end
+          query = query.sort.to_h
+          query.map { |k, v| "#{CGI.escape k}=#{v}" }.join(CANONICAL_QUERY_SEPARATOR)
+        end
+      end
+    end
+  end
+end

data/lib/jira/base_factory.rb

@@ -38,7 +38,7 @@ 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,
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :jql_paged, :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

data/lib/jira/client.rb

@@ -302,6 +302,10 @@ module JIRA
       JIRA::Resource::AgileFactory.new(self)
     end
 
+    def Properties
+      JIRA::Resource::PropertiesFactory.new(self)
+    end
+
     # HTTP methods without a body
 
     # Make an HTTP DELETE request
@@ -351,7 +355,9 @@ module JIRA
     # @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, merge_default_headers(headers))
+      res = @request_client.request_multipart(path, file, merge_default_headers(headers))
+      puts "response: #{res}" if @http_debug
+      res
     end
 
     # Make an HTTP PUT request
@@ -375,7 +381,9 @@ module JIRA
     # @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)
+      res = @request_client.request(http_method, path, body, headers)
+      puts "response: #{res}" if @http_debug
+      res
     end
 
     # @private

data/lib/jira/jwt_client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'atlassian/jwt'
+require 'jira/atlassian/jwt'
 
 module JIRA
   class JwtClient < HttpClient
@@ -29,7 +29,7 @@ module JIRA
     end
 
     def build_jwt(url)
-      claim = Atlassian::Jwt.build_claims \
+      claim = JIRA::Atlassian::Jwt.build_claims \
         @options[:issuer],
         url,
         http_method.to_s,

data/lib/jira/resource/attachment.rb

@@ -146,10 +146,14 @@ module JIRA
       # @raise [JIRA::HTTPError] if failed
       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'
+        # If :filename does not exist or is nil, that is fine as it will force
+        # Upload to determine the filename automatically from file.
+        # Breaking the filename out allows this to support any IO-based file parameter.
+        fname = attrs['filename'] || attrs[:filename]
+        mime_type = attrs['mimeType'] || attrs[:mimeType] || 'application/binary'
 
         headers = { 'X-Atlassian-Token' => 'nocheck' }
-        data = { 'file' => Multipart::Post::UploadIO.new(file, mime_type, file) }
+        data = { 'file' => Multipart::Post::UploadIO.new(file, mime_type, fname) }
 
         response = client.post_multipart(path, data, headers)
 
@@ -159,6 +163,17 @@ module JIRA
         true
       end
 
+      def http_download
+        # Actually fetch the attachment
+        # Note: Jira handles attachment's weird!
+        # Typically, they respond with a redirect location that should not have the same authentication
+        client.get(attrs['content'])
+      rescue JIRA::HTTPError => e
+        raise e unless e.response.code =~ /\A3\d\d\z/ && e.response['location'].present?
+
+        Net::HTTP.get_response(URI(e.response['location']))
+      end
+
       private
 
       def set_attributes(attributes, response)

data/lib/jira/resource/comment.rb

@@ -9,6 +9,18 @@ module JIRA
       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/resource/createmeta.rb

@@ -12,22 +12,22 @@ module JIRA
 
       def self.all(client, params = {})
         if params.key?(:projectKeys)
-          values = Array(params[:projectKeys]).map { |i| (i.is_a?(JIRA::Resource::Project) ? i.key : i) }
+          values = Array(params[:projectKeys]).map { |i| i.is_a?(JIRA::Resource::Project) ? i.key : i }
           params[:projectKeys] = values.join(',')
         end
 
         if params.key?(:projectIds)
-          values = Array(params[:projectIds]).map { |i| (i.is_a?(JIRA::Resource::Project) ? i.id : i) }
+          values = Array(params[:projectIds]).map { |i| i.is_a?(JIRA::Resource::Project) ? i.id : i }
           params[:projectIds] = values.join(',')
         end
 
         if params.key?(:issuetypeNames)
-          values = Array(params[:issuetypeNames]).map { |i| (i.is_a?(JIRA::Resource::Issuetype) ? i.name : i) }
+          values = Array(params[:issuetypeNames]).map { |i| i.is_a?(JIRA::Resource::Issuetype) ? i.name : i }
           params[:issuetypeNames] = values.join(',')
         end
 
         if params.key?(:issuetypeIds)
-          values = Array(params[:issuetypeIds]).map { |i| (i.is_a?(JIRA::Resource::Issuetype) ? i.id : i) }
+          values = Array(params[:issuetypeIds]).map { |i| i.is_a?(JIRA::Resource::Issuetype) ? i.id : i }
           params[:issuetypeIds] = values.join(',')
         end
 

data/lib/jira/resource/issue.rb

@@ -57,6 +57,7 @@ module JIRA
       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 :properties, class: JIRA::Resource::Properties
 
       # Get collection of issues.
       # @param client [JIRA::Client]
@@ -80,7 +81,57 @@ module JIRA
         result
       end
 
+      # Get issues using JQL query.
+      # @param client [JIRA::Client]
+      # @param jql [String] the JQL query string to search with
+      # @param options [Hash] Jira API options for the search
+      # @return [Array<JIRA::Resource::Issue>] or [Integer] total count if max_results is 0
       def self.jql(client, jql, options = { fields: nil, max_results: nil, expand: nil, reconcile_issues: nil })
+        issues = []
+        total = nil
+        next_page_token = nil
+        is_last = false
+
+        until is_last
+          result = jql_paged(client, jql, options.merge(next_page_token:))
+
+          issues.concat(result[:issues])
+          total = result[:total]
+          next_page_token = result[:next_page_token]
+          is_last = next_page_token.nil?
+        end
+        options[:max_results]&.zero? ? total : issues
+      end
+
+      # Get paged issues using JQL query.
+      # @param jql [String] the JQL query string to search with
+      # @param options [Hash] Jira API options for the search, including next_page_token
+      # @return [Hash] with format { issues: [JIRA::Resource::Issue], next_page_token: [String], total: [Integer] }
+      def self.jql_paged(client, jql, options = { fields: nil, max_results: nil, expand: nil, reconcile_issues: nil, next_page_token: nil })
+        url = jql_url(client, jql, options)
+        next_page_token = options[:next_page_token]
+        max_results = options[:max_results]
+
+        issues = []
+
+        page_url = url.dup
+        page_url << "&nextPageToken=#{next_page_token}" if next_page_token
+
+        response = client.get(page_url)
+        json = parse_json(response.body)
+        total = json['total']
+
+        unless max_results&.zero?
+          next_page_token = json['nextPageToken']
+          json['issues'].map do |issue|
+            issues << client.Issue.build(issue)
+          end
+        end
+
+        { issues:, next_page_token:, total: }
+      end
+
+      def self.jql_url(client, jql, options)
         url = client.options[:rest_base_path] + "/search/jql?jql=#{CGI.escape(jql)}"
 
         if options[:fields]
@@ -95,24 +146,7 @@ module JIRA
           options[:expand] = [options[:expand]] if options[:expand].is_a?(String)
           url << "&expand=#{options[:expand].to_a.map { |value| CGI.escape(value.to_s) }.join(',')}"
         end
-
-        issues = []
-        next_page_token = nil
-        json = {}
-        while json['isLast'] != true
-          page_url = url.dup
-          page_url << "&nextPageToken=#{next_page_token}" if next_page_token
-
-          response = client.get(page_url)
-          json = parse_json(response.body)
-          return json['total'] if options[:max_results]&.zero?
-
-          next_page_token = json['nextPageToken']
-          json['issues'].map do |issue|
-            issues << client.Issue.build(issue)
-          end
-        end
-        issues
+        url
       end
 
       # Fetches the attributes for the specified resource from JIRA unless

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/worklog.rb

@@ -10,6 +10,18 @@ module JIRA
       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,5 +1,5 @@
 # frozen_string_literal: true
 
 module JIRA
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

data/lib/jira-ruby.rb

@@ -23,6 +23,7 @@ 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'