Support Payrix Canada API through region configuration

CHANGELOG.md

@@ -7,6 +7,7 @@
   - Replace `Payrix.test_mode = false` with `Payrix.environment = :production`.
 - Change default request environment to `:sandbox`.
   - Set `Payrix.environment = :production` to keep existing behaviour.
+- Require specifying the destination API through `Payrix.region=` configuration or a per-request `:region` option.
 
 ### Removals
 

README.md

@@ -45,6 +45,7 @@ require 'bundler/setup'
 require 'payrix'
 
 Payrix.api_key = '928b...'
+Payrix.region = :us
 
 # Retrieve a single transaction
 Payrix::Txn.retrieve('t1_txn_64026b07cc6a79dd5cfd0da')
@@ -243,10 +244,11 @@ merchant.members # => [...}
 Set the following configuration parameters per request.
 
 - `:api_key` - Set the API key used.
+- `:region` - Set the API used (see valid values in Configuration below).
 - `:environment` - Set the environment used (see valid values in Configuration below).
 
 ```ruby
-Payrix::Merchant.retrieve('t1_mer_620acd189522582b3fb7849', { api_key: 'b442...', environment: :production })
+Payrix::Merchant.retrieve('t1_mer_620acd189522582b3fb7849', { api_key: 'b442...', region: :ca, environment: :production })
 ```
 
 This is useful if you need to configure the request in a thread-safe way. This is not possible using the static configuration mentioned in Configuration below. The per-request configuration always takes precedent.
@@ -276,6 +278,7 @@ end
 There are a few configuration parameters.
 
 - `Payrix.api_key=` - Use this to set the API key.
+- `Payrix.region=` - Use this to set the appropriate API. Set to `:us` or `:ca`.
 - `Payrix.environment=` - Use this to set the request environment. Set to `:sandbox` or `:production`.
 
 ## Development

lib/payrix.rb

@@ -24,6 +24,22 @@ module Payrix
     production: :production,
   }.freeze
 
+  REGIONS = {
+    us: :us,
+    ca: :ca,
+  }.freeze
+
+  ENDPOINTS = {
+    REGIONS.fetch(:us) => {
+      ENVIRONMENTS.fetch(:sandbox) => 'https://test-api.payrix.com',
+      ENVIRONMENTS.fetch(:production) => 'https://api.payrix.com',
+    },
+    REGIONS.fetch(:ca) => {
+      ENVIRONMENTS.fetch(:sandbox) => 'https://test-api.payrixcanada.com',
+      ENVIRONMENTS.fetch(:production) => 'https://api.payrixcanada.com',
+    },
+  }.freeze
+
   class << self
     attr_writer :configuration
   end
@@ -36,6 +52,10 @@ def self.api_key=(api_key)
     configuration.api_key = api_key
   end
 
+  def self.region=(region)
+    configuration.region = region
+  end
+
   def self.environment=(environment)
     configuration.environment = environment
   end

lib/payrix/client.rb

@@ -4,7 +4,7 @@ module Payrix
   # The Payrix::Client is used both internally and externally to initiate API requests to the Payrix API.
   class Client
     def request(method:, resource:, data: {}, filters: {}, options: {})
-      url = Payrix.configuration.url(options[:environment])
+      url = Payrix.configuration.url(options[:region], options[:environment])
 
       page_number = Payrix::RequestOptions::Page::Number.construct(options[:page])
       page_limit = Payrix::RequestOptions::Page::Limit.construct(options[:limit])

lib/payrix/configuration.rb

@@ -4,35 +4,35 @@ module Payrix
   # Use this class to configure API parameters such as API URL, API key, etc.
   class Configuration
     attr_accessor :api_key, :session_key
-    attr_reader :environment
+    attr_reader :region, :environment
 
     def initialize
       @api_key = ''
       @session_key = ''
+      @region = nil
       @environment = Payrix::ENVIRONMENTS.fetch(:sandbox)
     end
 
+    def region=(region)
+      validate_region!(region)
+
+      @region = region.to_sym
+    end
+
     def environment=(environment)
       validate_environment!(environment)
 
       @environment = environment.to_sym
     end
 
-    def url(environment_override = nil)
-      environment = @environment
-
-      unless environment_override.nil?
-        validate_environment!(environment_override)
+    def url(region_override = nil, environment_override = nil)
+      region = region_override || @region
+      environment = environment_override || @environment
 
-        environment = environment_override.to_sym
-      end
+      validate_region!(region)
+      validate_environment!(environment)
 
-      case environment
-      when Payrix::ENVIRONMENTS.fetch(:sandbox)
-        'https://test-api.payrix.com'
-      when Payrix::ENVIRONMENTS.fetch(:production)
-        'https://api.payrix.com'
-      end
+      Payrix::ENDPOINTS[region.to_sym][environment.to_sym]
     end
 
     private
@@ -41,5 +41,10 @@ def validate_environment!(environment)
       raise InvalidEnvironmentError unless environment.respond_to?(:to_sym)
       raise InvalidEnvironmentError unless Payrix::ENVIRONMENTS.values.include?(environment.to_sym)
     end
+
+    def validate_region!(region)
+      raise InvalidRegionError unless region.respond_to?(:to_sym)
+      raise InvalidRegionError unless Payrix::REGIONS.values.include?(region.to_sym)
+    end
   end
 end

lib/payrix/errors.rb

@@ -46,6 +46,10 @@ class NotFoundError < Error
   class InvalidEnvironmentError < Error
   end
 
+  # A pre-flight error indicating that the region set is not valid.
+  class InvalidRegionError < Error
+  end
+
   # An error returned when the API returns an invalid authentication error.
   class InvalidAuthenticationError < Error
   end

spec/lib/payrix/client_spec.rb

@@ -37,7 +37,7 @@
           WebMock
             .stub_request(
               :get,
-              'https://api.payrix.com/txns?page[number]=1&page[limit]=10&expand[merchant][]=',
+              'https://api.payrixcanada.com/txns?page[number]=1&page[limit]=10&expand[merchant][]=',
             )
             .with(
               headers: {
@@ -68,6 +68,7 @@
                 limit: 10,
                 expand: ['merchant'],
                 api_key: 'custom-key',
+                region: :ca,
                 environment: :production,
               },
             )
@@ -111,7 +112,7 @@
       it 'supports advanced requests' do
         stub =
           WebMock
-            .stub_request(:post, 'https://api.payrix.com/txns?expand[merchant][]=')
+            .stub_request(:post, 'https://api.payrixcanada.com/txns?expand[merchant][]=')
             .with(
               headers: {
                 'Content-Type' => 'application/json',
@@ -143,6 +144,7 @@
               options: {
                 expand: ['merchant'],
                 api_key: 'custom-key',
+                region: :ca,
                 environment: :production,
               },
             )
@@ -194,7 +196,7 @@
       it 'supports advanced requests' do
         stub =
           WebMock
-            .stub_request(:put, 'https://api.payrix.com/txns/t1_txn_64026b07cc6a79dd5cfd0da')
+            .stub_request(:put, 'https://api.payrixcanada.com/txns/t1_txn_64026b07cc6a79dd5cfd0da')
             .with(
               headers: {
                 'Content-Type' => 'application/json',
@@ -225,6 +227,7 @@
               },
               options: {
                 api_key: 'custom-key',
+                region: :ca,
                 environment: :production,
               },
             )
@@ -264,7 +267,7 @@
       it 'supports advanced requests' do
         stub =
           WebMock
-            .stub_request(:delete, 'https://api.payrix.com/txns/t1_txn_64026b07cc6a79dd5cfd0da')
+            .stub_request(:delete, 'https://api.payrixcanada.com/txns/t1_txn_64026b07cc6a79dd5cfd0da')
             .with(
               headers: {
                 'Content-Type' => 'application/json',
@@ -289,6 +292,7 @@
               resource: 'txns/t1_txn_64026b07cc6a79dd5cfd0da',
               options: {
                 api_key: 'custom-key',
+                region: :ca,
                 environment: :production,
               },
             )