jira-ruby 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc33adf73b2ff3a7e4ba9d20246e3a7a760d6c94530aac292776e1cd03455d6
-  data.tar.gz: 91be26b124667936bf93d4216210c5ce77d203b744bfce7b5d7a0e2bd313d339
+  metadata.gz: 8d81df9752f33a1c48332b6793d3b6596359b77b1a79575b57382553c1e04400
+  data.tar.gz: 5d6d16a50ccd3293b893068c303405a67450006197bd1d5aec85d75a9d3179e4
 SHA512:
-  metadata.gz: 4a7c2b8d43b3b8235a1ea51f1baf4d628a3726a7bb8dc39ecb62b8ef795ca085fb85ebb99941e8d699f5a20cb41ecceb3a3675781eb081481329ddc36f957701
-  data.tar.gz: dbabaf3245895c038b4496230eb2a3fdf7e0590a9bf549ace6b87db25268a492714579758e4789f8edd9a5da173be0e7b5bf3c732b17a0c9caad7cc1556bed55
+  metadata.gz: e4dc469b98fac2378bf647cd33e433a33ddc17ddf83d2e6fe835d21eda2239c6e3899fe9a838ebb4b1130356fa011302dd7f463ce9f4a0f660d4f66c5258e547
+  data.tar.gz: 2a09541af9b0028a16338dd13d31014e1e919e730e86ff370150536f1a2e4a8911532283dea8f7d57571010fffa5c2986097fda8d4da7034b35a3afbc806fcfa

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

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport'
   s.add_dependency 'atlassian-jwt'
+  s.add_dependency 'cgi'
   s.add_dependency 'multipart-post'
   s.add_dependency 'oauth', '~> 1.0'
 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/resource/issue.rb

@@ -80,7 +80,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 +145,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JIRA
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/spec/integration/issue_spec.rb

@@ -78,10 +78,9 @@ describe JIRA::Resource::Issue do
     end
 
     describe 'GET jql issues' do # JIRA::Resource::Issue.jql uses the search endpoint
-      jql_query_string = "PROJECT = 'SAMPLEPROJECT'"
       let(:client) { client }
       let(:site_url) { site_url }
-      let(:jql_query_string) { jql_query_string }
+      let(:jql_query_string) { "PROJECT = 'SAMPLEPROJECT'" }
 
       let(:expected_attributes) do
         {

data/spec/jira/resource/issue_spec.rb

@@ -173,6 +173,40 @@ describe JIRA::Resource::Issue do
     end
   end
 
+  describe '.jql_paged' do
+    let(:issue) { double }
+    let(:response) { double }
+
+    before do
+      allow(response).to receive(:body).and_return(response_string)
+      allow(client).to receive(:Issue).and_return(issue)
+      allow(issue).to receive(:build).with({ 'key' => 'foo' }).and_return('1')
+      allow(issue).to receive(:build).with({ 'key' => 'bar' }).and_return('2')
+      allow(issue).to receive(:build).with({ 'key' => 'baz' }).and_return('3')
+    end
+
+    context 'without next_page_token (first page)' do
+      subject { described_class.jql_paged(client, 'foo bar', page_size: 2) }
+
+      before { expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?jql=foo+bar').and_return(response) }
+
+      let(:response) { double }
+      let(:response_string) { '{"issues": [{"key":"foo"},{"key":"bar"}], "isLast": false, "nextPageToken": "abc"}' }
+
+      it { is_expected.to eq(issues: %w[1 2], next_page_token: 'abc', total: nil) }
+    end
+
+    context 'with next_page_token' do
+      subject { described_class.jql_paged(client, 'foo bar', page_size: 2, next_page_token: 'abc') }
+
+      let(:response_string) { '{"issues": [{"key":"baz"}], "isLast": true}' }
+
+      before { expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?jql=foo+bar&nextPageToken=abc').and_return(double(body: response_string)) }
+
+      it { is_expected.to eq(issues: %w[3], next_page_token: nil, total: nil) }
+    end
+  end
+
   it 'returns meta data available for editing an issue' do
     subject = described_class.new(client, attrs: { 'fields' => { 'key' => 'TST=123' } })
     response = double

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
 bindir: bin
 cert_chain: []
-date: 2025-09-15 00:00:00.000000000 Z
+date: 2026-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement