Normalize API versions

[Buitragox]

Summary:

This change centralizes version management at the class level, creating a consistent and reusable way to define and access API versions.

Unit Tests:

6154 tests, 80974 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 100% passed

RuboCop:

808 files inspected, no offenses detected

[Buitragox]

After the recent issue with this change where gateways would share versions, I added this hook, so a new hash would be created each time the gateway class is inherited. Let me know what you think of this.

[Buitragox]

New tests to verify classes and instances don't share the same versions hash.

[almalee24]

How is this method used? Is it just for the versionable_test.rb?

[Buitragox]

This method is inside the ClassMethods module. This module is extended to the base class in line 6, so any methods inside this module will be class methods. This allows for the versions to be set and fetch without creating an instance.

The intended usage for this method is to be used at the top of any Gateway subclass.

class MyTestGateway < Gateway
  version 'v3' # This sets the :default_api key in the versions hash.
  version 'v5', :recurring_api # This sets the :recurring_api key in the versions hash
end

You can see this method being used in this PR in adyen.rb, braintree_blue.rb and global_collect.rb.

[almalee24]

Also this one, how is it used? What is the difference between this one and the one in line 25?

[Buitragox]

The fetch_version method inside ClassMethods is intended to be used outside of instance methods.

For example, some gateways create live_url and test_url at the top of the file without creating an instance of the class, so you can do something like this:

module ActiveMerchant # :nodoc:
  module Billing # :nodoc:
    class ForteGateway < Gateway
      version 'v2'

      self.test_url = "https://sandbox.forte.net/api/#{fetch_version}"
      self.live_url = "https://api.forte.net/#{fetch_version}"

      # other methods ...
    end
  end
end

The fetch_version method outside ClassMethods is intended to be used inside of instance methods. There are a couple of examples of this in this PR, you can see it being used for the Adyen gateway and GlobalCollect gateway.

[Heavyblade]

Maybe Something with less "moving parts" using class instance variables like this:

module ActiveMerchant
  module Versionable
    def self.included(base)
      base.extend(ClassMethods)
    end

    module ClassMethods
      def versions
        @versions ||= {}
      end

      def version(version, feature = :default_api)
        versions[feature] = version
      end

      def fetch_version(feature = :default_api)
        versions[feature]
      end
    end

    def fetch_version(feature = :default_api)
      self.class.versions[feature]
    end
  end
end

I Already ran unit tests and seems to work properly 😉

[almalee24]

Looks good to me! I was able to verify it works by using Timecop.freeze and that inherited method you added solves the issue