jira-ruby 3.0.0.beta2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433679cf875ed954de485aea9bf822e89fe31a03455ea4c42feb6ccd09b625f4
-  data.tar.gz: f76496cfd565688dd0297579ee63398969770537c3507caa84e2b03ae4a9babe
+  metadata.gz: 8d81df9752f33a1c48332b6793d3b6596359b77b1a79575b57382553c1e04400
+  data.tar.gz: 5d6d16a50ccd3293b893068c303405a67450006197bd1d5aec85d75a9d3179e4
 SHA512:
-  metadata.gz: 3b4c890643c64efc50bc67e80d9583aeff780cceeef08264cefc2a5b9efca858f5b622dfba366c7a7bfbc1c5ffbd9e34d9abb460f5bb10dc7ad39ef5717d2566
-  data.tar.gz: 4b8c10a1873d6aabe8be992c10df1a743d0701db5a96a4306cf0082f6adb3bf9e55f1e08b518bf0aa93f4eb3cf25e431bb778de59cd70ec07319e8ad206c1d49
+  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/.rubocop.yml

@@ -62,9 +62,12 @@ Naming/AccessorMethodName:
 Naming/HeredocDelimiterNaming:
   Enabled: false
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: false
 
+Naming/PredicateMethod:
+  AllowBangMethods: true
+
 Naming/VariableNumber:
   Enabled: false
 

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

@@ -67,7 +67,7 @@ module JIRA
         result = []
         loop do
           url = client.options[:rest_base_path] +
-                "/search?expand=transitions.fields&maxResults=#{max_results}&startAt=#{start_at}"
+                "/search/jql?expand=transitions.fields&maxResults=#{max_results}&startAt=#{start_at}"
           response = client.get(url)
           json = parse_json(response.body)
           json['issues'].map do |issue|
@@ -80,30 +80,72 @@ module JIRA
         result
       end
 
-      def self.jql(client, jql, options = { fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true })
-        url = client.options[:rest_base_path] + "/search?jql=#{CGI.escape(jql)}"
+      # 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]
           url << "&fields=#{options[:fields].map do |value|
                               CGI.escape(client.Field.name_to_id(value))
                             end.join(',')}"
         end
-        url << "&startAt=#{CGI.escape(options[:start_at].to_s)}" if options[:start_at]
         url << "&maxResults=#{CGI.escape(options[:max_results].to_s)}" if options[:max_results]
-        url << '&validateQuery=false' if options[:validate_query] === false # rubocop:disable Style/CaseEquality
+        url << "&reconcileIssues=#{CGI.escape(options[:reconcile_issues].to_s)}" if options[:reconcile_issues]
 
         if options[:expand]
           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
-
-        response = client.get(url)
-        json = parse_json(response.body)
-        return json['total'] if options[:max_results]&.zero?
-
-        json['issues'].map do |issue|
-          client.Issue.build(issue)
-        end
+        url
       end
 
       # Fetches the attributes for the specified resource from JIRA unless

data/lib/jira/resource/project.rb

@@ -17,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))

data/lib/jira/resource/sprint.rb

@@ -20,14 +20,14 @@ module JIRA
       end
 
       def add_issue(issue)
-        add_issues([issue])
+        add_issues([issue]).first
       end
 
       def add_issues(issues)
         issue_ids = issues.map(&:id)
         request_body = { issues: issue_ids }.to_json
         client.post("#{agile_path}/issue", request_body)
-        true
+        issues
       end
 
       def start_date

data/lib/jira/version.rb

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

data/spec/integration/issue_spec.rb

@@ -45,10 +45,10 @@ describe JIRA::Resource::Issue do
       end
 
       before do
-        stub_request(:get, "#{site_url}/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0")
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search/jql?expand=transitions.fields&maxResults=1000&startAt=0")
           .to_return(status: 200, body: get_mock_response('issue.json'))
 
-        stub_request(:get, "#{site_url}/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=11")
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search/jql?expand=transitions.fields&maxResults=1000&startAt=11")
           .to_return(status: 200, body: get_mock_response('empty_issues.json'))
       end
 
@@ -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/integration/project_spec.rb

@@ -23,7 +23,7 @@ describe JIRA::Resource::Project do
 
     describe 'issues' do
       it 'returns all the issues' do
-        stub_request(:get, "#{site_url}/jira/rest/api/2/search?jql=project=\"SAMPLEPROJECT\"")
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search/jql?jql=project=\"SAMPLEPROJECT\"")
           .to_return(status: 200, body: get_mock_response('project/SAMPLEPROJECT.issues.json'))
         subject = client.Project.build('key' => key)
         issues = subject.issues

data/spec/integration/rapidview_spec.rb

@@ -46,7 +46,7 @@ describe JIRA::Resource::RapidView do
 
         stub_request(
           :get,
-          "#{site_url}/jira/rest/api/2/search?jql=id IN(10001, 10000)"
+          "#{site_url}/jira/rest/api/2/search/jql?jql=id IN(10001, 10000)"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')
@@ -54,7 +54,7 @@ describe JIRA::Resource::RapidView do
 
         stub_request(
           :get,
-          "#{site_url}/jira/rest/api/2/search?jql=id IN(10000, 10001) AND sprint IS NOT EMPTY"
+          "#{site_url}/jira/rest/api/2/search/jql?jql=id IN(10000, 10001) AND sprint IS NOT EMPTY"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')

data/spec/jira/client_spec.rb

@@ -99,7 +99,7 @@ RSpec.shared_examples 'HttpClient tests' do
 end
 
 RSpec.shared_examples 'OAuth Common Tests' do
-  include_examples 'Client Common Tests'
+  it_behaves_like 'Client Common Tests'
 
   specify { expect(subject.request_client).to be_a JIRA::OauthClient }
 
@@ -162,8 +162,8 @@ describe JIRA::Client do
         .to_return(status: 401, headers: {})
     end
 
-    include_examples 'Client Common Tests'
-    include_examples 'HttpClient tests'
+    it_behaves_like 'Client Common Tests'
+    it_behaves_like 'HttpClient tests'
 
     specify { expect(subject.request_client).to be_a JIRA::HttpClient }
 
@@ -214,8 +214,8 @@ describe JIRA::Client do
         .to_return(status: 200, body: '[]', headers: {})
     end
 
-    include_examples 'Client Common Tests'
-    include_examples 'HttpClient tests'
+    it_behaves_like 'Client Common Tests'
+    it_behaves_like 'HttpClient tests'
 
     specify { expect(subject.request_client).to be_a JIRA::HttpClient }
 
@@ -251,8 +251,8 @@ describe JIRA::Client do
         .to_return(status: 200, body: '[]', headers: {})
     end
 
-    include_examples 'Client Common Tests'
-    include_examples 'HttpClient tests'
+    it_behaves_like 'Client Common Tests'
+    it_behaves_like 'HttpClient tests'
 
     specify { expect(subject.request_client).to be_a JIRA::JwtClient }
 
@@ -286,13 +286,13 @@ describe JIRA::Client do
   context 'with oauth' do
     subject { described_class.new(consumer_key: 'foo', consumer_secret: 'bar') }
 
-    include_examples 'OAuth Common Tests'
+    it_behaves_like 'OAuth Common Tests'
   end
 
   context 'with oauth_2legged' do
     subject { described_class.new(consumer_key: 'foo', consumer_secret: 'bar', auth_type: :oauth_2legged) }
 
-    include_examples 'OAuth Common Tests'
+    it_behaves_like 'OAuth Common Tests'
   end
 
   context 'with unknown options' do

data/spec/jira/resource/agile_spec.rb

@@ -31,7 +31,7 @@ describe JIRA::Resource::Agile do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
-      expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
+      expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
       issues = described_class.get_board_issues(client, 1)
@@ -48,7 +48,7 @@ describe JIRA::Resource::Agile do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?startAt=50').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
-      expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
+      expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
       expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
 
       issues = described_class.get_board_issues(client, 1, startAt: 50)

data/spec/jira/resource/filter_spec.rb

@@ -28,7 +28,7 @@ describe JIRA::Resource::Filter do
       owner: jira_user,
       jql: '"Git Repository" ~ jira-ruby AND status = Resolved',
       viewUrl: 'https://localhost/secure/IssueNavigator.jspa?mode=hide&requestId=42',
-      searchUrl: 'https://localhost/rest/api/2/search?jql=%22Git+Repository%22+~+jira-ruby+AND+status+%3D+Resolved',
+      searchUrl: 'https://localhost/rest/api/2/search/jql?jql=%22Git+Repository%22+~+jira-ruby+AND+status+%3D+Resolved',
       favourite: false,
       sharePermissions: [
         {
@@ -69,6 +69,7 @@ describe JIRA::Resource::Filter do
       startAt: 0,
       maxResults: 50,
       total: 2,
+      isLast: true,
       issues: [jql_issue]
     }
   end
@@ -86,7 +87,7 @@ describe JIRA::Resource::Filter do
     expect(filter).to be_present
     allow(client).to receive(:options).and_return(rest_base_path: 'localhost')
     expect(client).to receive(:get)
-      .with("localhost/search?jql=#{CGI.escape(filter.jql)}")
+      .with("localhost/search/jql?jql=#{CGI.escape(filter.jql)}")
       .and_return(issue_jql_response)
     issues = filter.issues
     expect(issues).to be_an(Array)

data/spec/jira/resource/issue_spec.rb

@@ -42,10 +42,10 @@ describe JIRA::Resource::Issue do
     issue = double
 
     allow(response).to receive(:body).and_return('{"issues":[{"id":"1","summary":"Bugs Everywhere"}]}')
-    expect(client).to receive(:get).with('/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0')
+    expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?expand=transitions.fields&maxResults=1000&startAt=0')
                                    .and_return(response)
     allow(empty_response).to receive(:body).and_return('{"issues":[]}')
-    expect(client).to receive(:get).with('/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=1')
+    expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?expand=transitions.fields&maxResults=1000&startAt=1')
                                    .and_return(empty_response)
 
     expect(client).to receive(:Issue).and_return(issue)
@@ -70,85 +70,141 @@ describe JIRA::Resource::Issue do
     expect(issue_from_id.attrs).to eq(issue_from_key.attrs)
   end
 
-  it 'searches an issue with a jql query string' do
-    response = double
-    issue = double
+  describe '.jql' do
+    subject { described_class.jql(client, 'foo bar', args) }
 
-    allow(response).to receive(:body).and_return('{"issues": {"key":"foo"}}')
-    expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=foo+bar')
-                                   .and_return(response)
-    expect(client).to receive(:Issue).and_return(issue)
-    expect(issue).to receive(:build).with(%w[key foo]).and_return('')
+    let(:args) { {} }
+    let(:issue) { double }
+    let(:response) { double }
+    let(:response_string) { '{"issues": {"key":"foo"}, "isLast": true}' }
 
-    expect(described_class.jql(client, 'foo bar')).to eq([''])
-  end
+    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(%w[key foo]).and_return('')
+    end
 
-  it 'searches an issue with a jql query string and fields' do
-    response = double
-    issue = double
+    it 'searches an issue with a jql query string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/search/jql?jql=foo+bar')
+                                     .and_return(response)
+      expect(described_class.jql(client, 'foo bar')).to eq([''])
+    end
 
-    allow(response).to receive(:body).and_return('{"issues": {"key":"foo"}}')
-    expect(client).to receive(:get)
-      .with('/jira/rest/api/2/search?jql=foo+bar&fields=foo,bar')
-      .and_return(response)
-    expect(client).to receive(:Issue).and_return(issue)
-    expect(issue).to receive(:build).with(%w[key foo]).and_return('')
+    it 'passes thorugh the reconcileIssues parameter' do
+      expect(client).to receive(:get)
+        .with('/jira/rest/api/2/search/jql?jql=foo+bar&reconcileIssues=true')
+        .and_return(response)
 
-    expect(described_class.jql(client, 'foo bar', fields: %w[foo bar])).to eq([''])
-  end
+      expect(described_class.jql(client, 'foo bar', reconcile_issues: true)).to eq([''])
+    end
 
-  it 'searches an issue with a jql query string, start at, and maxResults' do
-    response = double
-    issue = double
+    it 'searches an issue with a jql query string and fields' do
+      expect(client).to receive(:get)
+        .with('/jira/rest/api/2/search/jql?jql=foo+bar&fields=foo,bar')
+        .and_return(response)
 
-    allow(response).to receive(:body).and_return('{"issues": {"key":"foo"}}')
-    expect(client).to receive(:get)
-      .with('/jira/rest/api/2/search?jql=foo+bar&startAt=1&maxResults=3')
-      .and_return(response)
-    expect(client).to receive(:Issue).and_return(issue)
-    expect(issue).to receive(:build).with(%w[key foo]).and_return('')
+      expect(described_class.jql(client, 'foo bar', fields: %w[foo bar])).to eq([''])
+    end
 
-    expect(described_class.jql(client, 'foo bar', start_at: 1, max_results: 3)).to eq([''])
-  end
+    context 'when maxResults is provided' do
+      let(:args) { { max_results: } }
 
-  it 'searches an issue with a jql query string and maxResults equals zero and should return the count of tickets' do
-    response = double
-    double
+      context 'with non-zero' do
+        let(:max_results) { 3 }
 
-    allow(response).to receive(:body).and_return('{"total": 1, "issues": []}')
-    expect(client).to receive(:get)
-      .with('/jira/rest/api/2/search?jql=foo+bar&maxResults=0')
-      .and_return(response)
+        it 'searches an issue with a jql query string and maxResults' do
+          expect(client).to receive(:get)
+            .with('/jira/rest/api/2/search/jql?jql=foo+bar&maxResults=3')
+            .and_return(response)
 
-    expect(described_class.jql(client, 'foo bar', max_results: 0)).to eq(1)
-  end
+          expect(subject).to eq([''])
+        end
+      end
 
-  it 'searches an issue with a jql query string and string expand' do
-    response = double
-    issue = double
+      context 'with zero' do
+        let(:response_string) { '{"total": 1, "issues": []}' }
+        let(:max_results) { 0 }
 
-    allow(response).to receive(:body).and_return('{"issues": {"key":"foo"}}')
-    expect(client).to receive(:get)
-      .with('/jira/rest/api/2/search?jql=foo+bar&expand=transitions')
-      .and_return(response)
-    expect(client).to receive(:Issue).and_return(issue)
-    expect(issue).to receive(:build).with(%w[key foo]).and_return('')
+        it 'searches an issue with a jql query string and should return the count of tickets' do
+          expect(client).to receive(:get)
+            .with('/jira/rest/api/2/search/jql?jql=foo+bar&maxResults=0')
+            .and_return(response)
 
-    expect(described_class.jql(client, 'foo bar', expand: 'transitions')).to eq([''])
+          expect(subject).to eq(1)
+        end
+      end
+    end
+
+    it 'searches an issue with a jql query string and string expand' do
+      expect(client).to receive(:get)
+        .with('/jira/rest/api/2/search/jql?jql=foo+bar&expand=transitions')
+        .and_return(response)
+
+      expect(described_class.jql(client, 'foo bar', expand: 'transitions')).to eq([''])
+    end
+
+    it 'searches an issue with a jql query string and array expand' do
+      expect(client).to receive(:get)
+        .with('/jira/rest/api/2/search/jql?jql=foo+bar&expand=transitions')
+        .and_return(response)
+
+      expect(described_class.jql(client, 'foo bar', expand: %w[transitions])).to eq([''])
+    end
+
+    context 'when pagination is required' do
+      let(:response_string) { '{"issues": [{"key":"foo"}], "isLast": false, "nextPageToken": "abc"}' }
+      let(:second_response_string) { '{"issues": [{"key":"bar"}], "isLast": true}' }
+
+      before do
+        allow(issue).to receive(:build).with({ 'key' => 'foo' }).and_return('1')
+        allow(issue).to receive(:build).with({ 'key' => 'bar' }).and_return('2')
+      end
+
+      it 'makes multiple requests' do
+        expect(client).to receive(:get)
+          .with('/jira/rest/api/2/search/jql?jql=foo+bar')
+          .and_return(response)
+        expect(client).to receive(:get)
+          .with('/jira/rest/api/2/search/jql?jql=foo+bar&nextPageToken=abc')
+          .and_return(double(body: second_response_string))
+
+        expect(subject).to eq(%w[1 2])
+      end
+    end
   end
 
-  it 'searches an issue with a jql query string and array expand' do
-    response = double
-    issue = double
+  describe '.jql_paged' do
+    let(:issue) { double }
+    let(:response) { double }
 
-    allow(response).to receive(:body).and_return('{"issues": {"key":"foo"}}')
-    expect(client).to receive(:get)
-      .with('/jira/rest/api/2/search?jql=foo+bar&expand=transitions')
-      .and_return(response)
-    expect(client).to receive(:Issue).and_return(issue)
-    expect(issue).to receive(:build).with(%w[key foo]).and_return('')
+    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) }
 
-    expect(described_class.jql(client, 'foo bar', expand: %w[transitions])).to eq([''])
+      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

data/spec/jira/resource/project_spec.rb

@@ -42,7 +42,7 @@ describe JIRA::Resource::Project do
       issue_factory = double('issue factory')
 
       expect(client).to receive(:get)
-        .with('/jira/rest/api/2/search?jql=project%3D%22test%22')
+        .with('/jira/rest/api/2/search/jql?jql=project%3D%22test%22')
         .and_return(response)
       expect(client).to receive(:Issue).and_return(issue_factory)
       expect(issue_factory).to receive(:build)
@@ -58,7 +58,7 @@ describe JIRA::Resource::Project do
         issue_factory = double('issue factory')
 
         expect(client).to receive(:get)
-          .with('/jira/rest/api/2/search?jql=project%3D%22test%22&expand=changelog&startAt=1&maxResults=100')
+          .with('/jira/rest/api/2/search/jql?jql=project%3D%22test%22&expand=changelog&startAt=1&maxResults=100')
           .and_return(response)
         expect(client).to receive(:Issue).and_return(issue_factory)
         expect(issue_factory).to receive(:build)

data/spec/jira/resource/sprint_spec.rb

@@ -127,12 +127,12 @@ describe JIRA::Resource::Sprint do
         { issues: [issue.id] }
       end
 
-      describe '#add_issu' do
+      describe '#add_issue' do
         context 'when an issue is passed' do
           it 'posts with the issue id' do
             expect(client).to receive(:post).with(post_issue_path, post_issue_input.to_json)
 
-            sprint.add_issue(issue)
+            expect(sprint.add_issue(issue)).to eq(issue)
           end
         end
       end
@@ -160,7 +160,7 @@ describe JIRA::Resource::Sprint do
           it 'posts with the issue id' do
             expect(client).to receive(:post).with(post_issue_path, post_issue_input.to_json)
 
-            sprint.add_issues(issues)
+            expect(sprint.add_issues(issues)).to eq(issues)
           end
         end
       end

data/spec/mock_responses/board/1_issues.json

@@ -3,6 +3,7 @@
   "startAt": 0,
   "maxResults": 1000,
   "total": 9,
+  "isLast": true,
   "issues": [
     {
       "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
@@ -59,4 +60,4 @@
       "key": "SBT-19"
     }
   ]
-}
+}

data/spec/mock_responses/issue.json

@@ -3,6 +3,7 @@
   "startAt": 0,
   "maxResults": 1000,
   "total": 11,
+  "isLast": true,
   "issues": [
     {
       "expand": "editmeta,renderedFields,transitions,changelog",

data/spec/mock_responses/rapidview/SAMPLEPROJECT.issues.full.json

@@ -2,6 +2,7 @@
     "expand": "schema,names",
     "startAt": 0,
     "maxResults": 50,
+    "isLast": true,
     "total": 2,
     "issues": [
         {
@@ -273,4 +274,4 @@
             }
         }
     ]
-}
+}

data/spec/mock_responses/rapidview/SAMPLEPROJECT.issues.json

@@ -101,6 +101,7 @@
   },
   "canManageSprints": true,
   "maxIssuesExceeded": false,
+  "isLast": true,
   "queryResultLimit": 2147483647,
   "versionData": {
     "versionsPerProject": {
@@ -108,4 +109,4 @@
     },
     "canCreateVersion": true
   }
-}
+}

data/spec/support/shared_examples/integration.rb

@@ -76,7 +76,7 @@ shared_examples 'a resource with JQL inputs and a collection GET endpoint' do
   it 'gets the collection' do
     stub_request(
       :get,
-      "#{site_url}#{client.options[:rest_base_path]}/search?jql=#{CGI.escape(jql_query_string)}"
+      "#{site_url}#{client.options[:rest_base_path]}/search/jql?jql=#{CGI.escape(jql_query_string)}"
     ).to_return(status: 200, body: get_mock_response('issue.json'))
 
     collection = build_receiver.jql(jql_query_string)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.1.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
 bindir: bin
 cert_chain: []
-date: 2025-03-11 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