jira-auto-tool 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1617932b12de543b8a02418c83d819e51370d0ab3742dfc853dc69e4464eb952
-  data.tar.gz: 5165fb49766732d0c205ed4032a4686418a1174e92964739a72cf74be97ee47f
+  metadata.gz: 01e73565bdbb82263685fcd3f903a96f53606fd2a742dcd7baf290767535e231
+  data.tar.gz: 6caf206fb9f7754362edf4ec3fd1c2c85ba82f13a95711f8716e968b63deb85e
 SHA512:
-  metadata.gz: 1f419962472fd5bba92201da6d04cb94062edbbb273192813434416551e763df392f8a0522645003cf085b03ed474c04a7637101b14969a0f6cd09ffa86ff8e6
-  data.tar.gz: 8b31f53f77f7a118b79620cd38663a8955ae128235b0fa8286341b9d57f57ff690dbe326981088dbf70e6d4b22bdbb8707d722f311b88dda2d81446e72e14c3e
+  metadata.gz: 1f195ea5c9cbeb1a525cc3b9684d71f0a791b05935510f221bfc347b173165abc70598ceacf01918cee660172f385a9ed1ac824aaeecaa78d4cc6894683a6cf5
+  data.tar.gz: 807721d720cde7b2142a8c5cae279ea20fe857d79a107e90efa62742f8fa5cb298a5cde6333463085cd00ac6e702101237d4ec0b421d923f2e0e90e65c934952

data/.ruby-version

@@ -0,0 +1 @@
+3.4.8

data/features/configure_environment.feature

@@ -205,7 +205,7 @@ Feature: Environment Configuration Management
     When I run `jira-auto-tool --env-list`
     Then it should fail with:
       """
-      ERROR  Jira::Auto::Tool::EnvironmentLoader : ./jira-auto-tool.env.yaml.erb:6: failed to load with the following error:
+      ERROR  Jira::Auto::Tool::EnvironmentLoader : ./jira-auto-tool.env.yaml.erb:6: failed to load with the following error: (RuntimeError)
       This is meant to fail while loading!
       """
 

data/features/control_http_request_rate_limit.feature

@@ -4,7 +4,13 @@ Feature: Control the HTTP request rate limit
   I need the ability to control the HTTP request limit
 
   Scenario Outline: Limiting the request rate
-    Given the following environment variables are set:
+    Given a Jira Scrum board
+    And the board only has the following sprints:
+      | name                    | length | start_date              | state  |
+      | ART-16_CRM_24.4.1       | 2-week | 2024-12-01 11:00:00 UTC | closed |
+      | ART-16_E2E-Test_24.4.2  | 4-day  | 2024-12-05 11:00:00 UTC | future |
+      | ART-32_Platform_24.4.7  | 3-week | 2024-10-07 11:00:00 UTC | future |
+    And the following environment variables are set:
       | name                          | value                           |
       | JAT_RATE_INTERVAL_IN_SECONDS  | <rate_interval_in_seconds>      |
       | JAT_RATE_LIMIT_IMPLEMENTATION | <jat_rate_limit_implementation> |
@@ -14,7 +20,7 @@ Feature: Control the HTTP request rate limit
     Examples:
       | jat_rate_limit_implementation | rate_limit_per_interval | rate_interval_in_seconds | minimal_time | maximal_time |
       |                               | 0                       | 0                        | 0            | 5            |
-      | in_process                    | 1                       | 2                        | 1            | 20           |
+      | in_process                    | 1                       | 1                        | 1            | 20           |
       | redis                         | 1                       | 2                        | 1            | 20           |
       | redis                         | 1                       | 10                       | 18           | 120          |
 

data/lib/jira/auto/tool/project/ticket_fields.rb

@@ -39,12 +39,12 @@ module Jira
           def each_issue_type_field
             tool.jira_client.Createmeta.all({ projectKeys: project.key, "expand" => "projects.issuetypes.fields" })
                 .each do |createmeta|
-              createmeta.attrs["issuetypes"].each do |issue_type|
-                issue_type_name = issue_type["name"]
-                issue_type["fields"].each_value do |field|
-                  yield(issue_type_name, field)
-                end
-              end
+                  createmeta.attrs["issuetypes"].each do |issue_type|
+                    issue_type_name = issue_type["name"]
+                    issue_type["fields"].each_value do |field|
+                      yield(issue_type_name, field)
+                    end
+                  end
             end
           end
 

data/lib/jira/auto/tool/rate_limited_jira_client.rb

@@ -33,11 +33,11 @@ module Jira
 
         alias original_request request
 
-        def request(*args)
+        def request(*)
           if rate_limit_per_interval == NO_RATE_LIMIT_PER_INTERVAL
-            original_request(*args)
+            original_request(*)
           else
-            rate_limit { original_request(*args) }
+            rate_limit { original_request(*) }
           end
         end
 

data/lib/jira/auto/tool/ticket.rb

@@ -42,8 +42,23 @@ module Jira
           %i[key summary sprint implementation_team expected_start_date]
         end
 
+        # Compatibility helper to access Issue fields across Jira API versions
+        # - jira-ruby v2: JIRA::Resource::Issue responds to #fields
+        # - jira-ruby v3: fields are nested under #attrs['fields']
+        def ticket_fields
+          if jira_ticket.respond_to?(:fields)
+            jira_ticket.fields
+          else
+            raise "attrs not found in #{jira_ticket}!" unless jira_ticket.respond_to?(:attrs)
+
+            attrs = jira_ticket.attrs
+            attrs["fields"] || attrs[:fields] ||
+              raise("fields not found in #{attrs} from #{jira_ticket}!")
+          end
+        end
+
         def sprint
-          jira_ticket.fields.fetch(tool.jira_sprint_field.id)
+          ticket_fields.fetch(tool.jira_sprint_field.id)
         end
 
         def jira_client
@@ -96,8 +111,8 @@ module Jira
         def jira_field_value(field_id = caller_locations(1, 1).first.base_label)
           log.debug { "jira_field_value(#{field_id})" }
 
-          field = jira_ticket.fields.fetch(field_id) do |id|
-            raise "#{id}: value not found in #{jira_ticket.fields}"
+          field = ticket_fields.fetch(field_id) do |id|
+            raise "#{id}: value not found in #{ticket_fields}"
           end
 
           log.debug { "jira_field_value(#{field_id}), field: #{field}" }

data/lib/jira/auto/tool/version.rb

@@ -3,7 +3,7 @@
 module Jira
   module Auto
     class Tool
-      VERSION = "1.2.4"
+      VERSION = "1.3.0"
     end
   end
 end

data/lib/jira/auto/tool.rb

@@ -160,7 +160,6 @@ module Jira
         ].collect { |value_name| [value_name, !HOLDS_A_SECRET] }).freeze
 
       ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
-        holds_a_secret ||= false
         define_overridable_environment_based_value(method_name, holds_a_secret)
       end
 
@@ -209,7 +208,7 @@ module Jira
       end
 
       def tickets(jql = "project = #{project.key}")
-        jira_client.Issue.jql(jql).collect { |jira_ticket| Ticket.new(self, jira_ticket) }
+        jira_client.Issue.jql(jql, fields: ["*all"]).collect { |jira_ticket| Ticket.new(self, jira_ticket) }
       rescue StandardError => e
         raise <<~EOEM
           Error fetching project tickets: Something went wrong:

data/spec/jira/auto/tool/ticket_fields_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# //wsl.localhost/Ubuntu/home/cbroult/work/ruby/jira-auto-tool/features/ticket_fields_spec.rb
+
+require "spec_helper"
+require "jira/auto/tool/ticket"
+
+module Jira
+  module Auto
+    class Tool
+      RSpec.describe Jira::Auto::Tool::Ticket do
+        let(:tool) { instance_double(Tool) }
+
+        describe "#ticket_fields" do
+          context "when JIRA API V2, jira_ticket responds to #fields" do
+            let(:jira_ticket_with_fields) do
+              jira_resource_double(JIRA::Resource::Issue, fields: { "example_field" => "value" })
+            end
+
+            it "returns the fields hash" do
+              ticket = described_class.new(tool, jira_ticket_with_fields)
+              expect(ticket.ticket_fields).to eq({ "example_field" => "value" })
+            end
+          end
+
+          context "when JIRA API V3, jira_ticket does not respond to #fields but responds to #attrs" do
+            let(:jira_ticket_with_attrs) do
+              jira_resource_double(JIRA::Resource::Issue, attrs: { "fields" => { "example_field" => "value" } })
+            end
+
+            let(:jira_ticket_with_invalid_attrs) do
+              jira_resource_double(JIRA::Resource::Issue, attrs: { "invalid" => "data" })
+            end
+
+            it "returns the fields hash from attrs" do
+              ticket = described_class.new(tool, jira_ticket_with_attrs)
+              expect(ticket.ticket_fields).to eq({ "example_field" => "value" })
+            end
+
+            it "raises an error if fields are not found in attrs" do
+              ticket = described_class.new(tool, jira_ticket_with_invalid_attrs)
+              expect do
+                ticket.ticket_fields
+              end
+                .to raise_error("fields not found in {\"invalid\" => \"data\"} from #{jira_ticket_with_invalid_attrs}!")
+            end
+          end
+
+          context "when jira_ticket does not respond to #fields or #attrs" do
+            let(:jira_ticket_without_fields_or_attrs) { jira_resource_double(JIRA::Resource::Issue) }
+
+            it "raises an error indicating attrs are not found" do
+              ticket = described_class.new(tool, jira_ticket_without_fields_or_attrs)
+              expect do
+                ticket.ticket_fields
+              end.to raise_error("attrs not found in #{jira_ticket_without_fields_or_attrs}!")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/jira/auto/tool_spec.rb

@@ -230,8 +230,6 @@ module Jira
         end
 
         described_class::ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
-          holds_a_secret ||= false
-
           describe "environment based values - #{method_name} - holds_a_secret = #{holds_a_secret}}" do
             let(:object_with_overridable_value) { tool }
 
@@ -435,7 +433,7 @@ module Jira
               allow(tool)
                 .to receive_messages(project: jira_resource_double(JIRA::Resource::Project, key: "project_key"))
 
-              allow(query).to receive(:jql).with(expected_jql).and_return([instance_double(JIRA::Resource::Issue)])
+              allow(query).to receive(:jql).with(expected_jql, fields: ["*all"]).and_return([instance_double(JIRA::Resource::Issue)])
             end
 
             context "without arguments" do

data/spec/spec_helper.rb

@@ -33,9 +33,9 @@ RSpec.configure do |config|
   end
 
   config.include(Module.new do
-    def jira_resource_double(*args)
+    def jira_resource_double(*)
       # rubocop:disable RSpec/VerifiedDoubles
-      double(*args)
+      double(*)
       # rubocop:enable RSpec/VerifiedDoubles
     end
   end)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-auto-tool
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Christophe Broult
@@ -23,6 +23,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: http_logger
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +228,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Guardfile
@@ -357,6 +372,7 @@ files:
 - spec/jira/auto/tool/team_spec.rb
 - spec/jira/auto/tool/team_sprint_prefix_mapper_spec.rb
 - spec/jira/auto/tool/team_sprint_ticket_dispatcher_spec.rb
+- spec/jira/auto/tool/ticket_fields_spec.rb
 - spec/jira/auto/tool/ticket_spec.rb
 - spec/jira/auto/tool/until_date_spec.rb
 - spec/jira/auto/tool_spec.rb
@@ -377,14 +393,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.5
+      version: 3.4.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Automate making adjustments to Jira sprints for multiple teams following
   some naming conventions.