square.rb 26.1.0.20230119 → 27.0.0.20230419

data/lib/square/client.rb

@@ -1,10 +1,10 @@
 module Square
   #  square client class.
   class Client
-    attr_reader :config
+    attr_reader :config, :auth_managers
 
     def sdk_version
-      '26.1.0.20230119'
+      '27.0.0.20230419'
     end
 
     def square_version
@@ -18,250 +18,251 @@ module Square
     # Access to mobile_authorization controller.
     # @return [MobileAuthorizationApi] Returns the controller instance.
     def mobile_authorization
-      @mobile_authorization ||= MobileAuthorizationApi.new config
+      @mobile_authorization ||= MobileAuthorizationApi.new @global_configuration
     end
 
     # Access to o_auth controller.
     # @return [OAuthApi] Returns the controller instance.
     def o_auth
-      @o_auth ||= OAuthApi.new config
+      @o_auth ||= OAuthApi.new @global_configuration
     end
 
     # Access to v1_transactions controller.
     # @return [V1TransactionsApi] Returns the controller instance.
     def v1_transactions
-      @v1_transactions ||= V1TransactionsApi.new config
+      @v1_transactions ||= V1TransactionsApi.new @global_configuration
     end
 
     # Access to apple_pay controller.
     # @return [ApplePayApi] Returns the controller instance.
     def apple_pay
-      @apple_pay ||= ApplePayApi.new config
+      @apple_pay ||= ApplePayApi.new @global_configuration
     end
 
     # Access to bank_accounts controller.
     # @return [BankAccountsApi] Returns the controller instance.
     def bank_accounts
-      @bank_accounts ||= BankAccountsApi.new config
+      @bank_accounts ||= BankAccountsApi.new @global_configuration
     end
 
     # Access to bookings controller.
     # @return [BookingsApi] Returns the controller instance.
     def bookings
-      @bookings ||= BookingsApi.new config
+      @bookings ||= BookingsApi.new @global_configuration
     end
 
     # Access to booking_custom_attributes controller.
     # @return [BookingCustomAttributesApi] Returns the controller instance.
     def booking_custom_attributes
-      @booking_custom_attributes ||= BookingCustomAttributesApi.new config
+      @booking_custom_attributes ||= BookingCustomAttributesApi.new @global_configuration
     end
 
     # Access to cards controller.
     # @return [CardsApi] Returns the controller instance.
     def cards
-      @cards ||= CardsApi.new config
+      @cards ||= CardsApi.new @global_configuration
     end
 
     # Access to cash_drawers controller.
     # @return [CashDrawersApi] Returns the controller instance.
     def cash_drawers
-      @cash_drawers ||= CashDrawersApi.new config
+      @cash_drawers ||= CashDrawersApi.new @global_configuration
     end
 
     # Access to catalog controller.
     # @return [CatalogApi] Returns the controller instance.
     def catalog
-      @catalog ||= CatalogApi.new config
+      @catalog ||= CatalogApi.new @global_configuration
     end
 
     # Access to customers controller.
     # @return [CustomersApi] Returns the controller instance.
     def customers
-      @customers ||= CustomersApi.new config
+      @customers ||= CustomersApi.new @global_configuration
     end
 
     # Access to customer_custom_attributes controller.
     # @return [CustomerCustomAttributesApi] Returns the controller instance.
     def customer_custom_attributes
-      @customer_custom_attributes ||= CustomerCustomAttributesApi.new config
+      @customer_custom_attributes ||= CustomerCustomAttributesApi.new @global_configuration
     end
 
     # Access to customer_groups controller.
     # @return [CustomerGroupsApi] Returns the controller instance.
     def customer_groups
-      @customer_groups ||= CustomerGroupsApi.new config
+      @customer_groups ||= CustomerGroupsApi.new @global_configuration
     end
 
     # Access to customer_segments controller.
     # @return [CustomerSegmentsApi] Returns the controller instance.
     def customer_segments
-      @customer_segments ||= CustomerSegmentsApi.new config
+      @customer_segments ||= CustomerSegmentsApi.new @global_configuration
     end
 
     # Access to devices controller.
     # @return [DevicesApi] Returns the controller instance.
     def devices
-      @devices ||= DevicesApi.new config
+      @devices ||= DevicesApi.new @global_configuration
     end
 
     # Access to disputes controller.
     # @return [DisputesApi] Returns the controller instance.
     def disputes
-      @disputes ||= DisputesApi.new config
+      @disputes ||= DisputesApi.new @global_configuration
     end
 
     # Access to employees controller.
     # @return [EmployeesApi] Returns the controller instance.
     def employees
-      @employees ||= EmployeesApi.new config
+      @employees ||= EmployeesApi.new @global_configuration
     end
 
     # Access to gift_cards controller.
     # @return [GiftCardsApi] Returns the controller instance.
     def gift_cards
-      @gift_cards ||= GiftCardsApi.new config
+      @gift_cards ||= GiftCardsApi.new @global_configuration
     end
 
     # Access to gift_card_activities controller.
     # @return [GiftCardActivitiesApi] Returns the controller instance.
     def gift_card_activities
-      @gift_card_activities ||= GiftCardActivitiesApi.new config
+      @gift_card_activities ||= GiftCardActivitiesApi.new @global_configuration
     end
 
     # Access to inventory controller.
     # @return [InventoryApi] Returns the controller instance.
     def inventory
-      @inventory ||= InventoryApi.new config
+      @inventory ||= InventoryApi.new @global_configuration
     end
 
     # Access to invoices controller.
     # @return [InvoicesApi] Returns the controller instance.
     def invoices
-      @invoices ||= InvoicesApi.new config
+      @invoices ||= InvoicesApi.new @global_configuration
     end
 
     # Access to labor controller.
     # @return [LaborApi] Returns the controller instance.
     def labor
-      @labor ||= LaborApi.new config
+      @labor ||= LaborApi.new @global_configuration
     end
 
     # Access to locations controller.
     # @return [LocationsApi] Returns the controller instance.
     def locations
-      @locations ||= LocationsApi.new config
+      @locations ||= LocationsApi.new @global_configuration
     end
 
     # Access to location_custom_attributes controller.
     # @return [LocationCustomAttributesApi] Returns the controller instance.
     def location_custom_attributes
-      @location_custom_attributes ||= LocationCustomAttributesApi.new config
+      @location_custom_attributes ||= LocationCustomAttributesApi.new @global_configuration
     end
 
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
-      @checkout ||= CheckoutApi.new config
+      @checkout ||= CheckoutApi.new @global_configuration
     end
 
     # Access to transactions controller.
     # @return [TransactionsApi] Returns the controller instance.
     def transactions
-      @transactions ||= TransactionsApi.new config
+      @transactions ||= TransactionsApi.new @global_configuration
     end
 
     # Access to loyalty controller.
     # @return [LoyaltyApi] Returns the controller instance.
     def loyalty
-      @loyalty ||= LoyaltyApi.new config
+      @loyalty ||= LoyaltyApi.new @global_configuration
     end
 
     # Access to merchants controller.
     # @return [MerchantsApi] Returns the controller instance.
     def merchants
-      @merchants ||= MerchantsApi.new config
+      @merchants ||= MerchantsApi.new @global_configuration
     end
 
     # Access to orders controller.
     # @return [OrdersApi] Returns the controller instance.
     def orders
-      @orders ||= OrdersApi.new config
+      @orders ||= OrdersApi.new @global_configuration
     end
 
     # Access to order_custom_attributes controller.
     # @return [OrderCustomAttributesApi] Returns the controller instance.
     def order_custom_attributes
-      @order_custom_attributes ||= OrderCustomAttributesApi.new config
+      @order_custom_attributes ||= OrderCustomAttributesApi.new @global_configuration
     end
 
     # Access to payments controller.
     # @return [PaymentsApi] Returns the controller instance.
     def payments
-      @payments ||= PaymentsApi.new config
+      @payments ||= PaymentsApi.new @global_configuration
     end
 
     # Access to payouts controller.
     # @return [PayoutsApi] Returns the controller instance.
     def payouts
-      @payouts ||= PayoutsApi.new config
+      @payouts ||= PayoutsApi.new @global_configuration
     end
 
     # Access to refunds controller.
     # @return [RefundsApi] Returns the controller instance.
     def refunds
-      @refunds ||= RefundsApi.new config
+      @refunds ||= RefundsApi.new @global_configuration
     end
 
     # Access to sites controller.
     # @return [SitesApi] Returns the controller instance.
     def sites
-      @sites ||= SitesApi.new config
+      @sites ||= SitesApi.new @global_configuration
     end
 
     # Access to snippets controller.
     # @return [SnippetsApi] Returns the controller instance.
     def snippets
-      @snippets ||= SnippetsApi.new config
+      @snippets ||= SnippetsApi.new @global_configuration
     end
 
     # Access to subscriptions controller.
     # @return [SubscriptionsApi] Returns the controller instance.
     def subscriptions
-      @subscriptions ||= SubscriptionsApi.new config
+      @subscriptions ||= SubscriptionsApi.new @global_configuration
     end
 
     # Access to team controller.
     # @return [TeamApi] Returns the controller instance.
     def team
-      @team ||= TeamApi.new config
+      @team ||= TeamApi.new @global_configuration
     end
 
     # Access to terminal controller.
     # @return [TerminalApi] Returns the controller instance.
     def terminal
-      @terminal ||= TerminalApi.new config
+      @terminal ||= TerminalApi.new @global_configuration
     end
 
     # Access to vendors controller.
     # @return [VendorsApi] Returns the controller instance.
     def vendors
-      @vendors ||= VendorsApi.new config
+      @vendors ||= VendorsApi.new @global_configuration
     end
 
     # Access to webhook_subscriptions controller.
     # @return [WebhookSubscriptionsApi] Returns the controller instance.
     def webhook_subscriptions
-      @webhook_subscriptions ||= WebhookSubscriptionsApi.new config
+      @webhook_subscriptions ||= WebhookSubscriptionsApi.new @global_configuration
     end
 
     def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
                    max_retries: 0, retry_interval: 1, backoff_factor: 2,
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], environment: 'production',
-                   custom_url: 'https://connect.squareup.com',
-                   square_version: '2023-01-19', access_token: '',
-                   user_agent_detail: '', additional_headers: {}, config: nil)
+                   retry_methods: %i[get put], http_callback: nil,
+                   environment: 'production',
+                   custom_url: 'https://connect.squareup.com', access_token: '',
+                   square_version: '2023-04-19', user_agent_detail: '',
+                   additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,
                                     timeout: timeout, max_retries: max_retries,
@@ -269,15 +270,44 @@ module Square
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,
                                     retry_methods: retry_methods,
+                                    http_callback: http_callback,
                                     environment: environment,
                                     custom_url: custom_url,
-                                    square_version: square_version,
                                     access_token: access_token,
+                                    square_version: square_version,
                                     user_agent_detail: user_agent_detail,
                                     additional_headers: additional_headers)
                 else
                   config
                 end
+
+      custom_user_agent_parameters = {
+        '{api-version}' => { 'value': @config.square_version, 'encode': false },
+        '{detail}' => { 'value': @config.user_agent_detail, 'encode': true }
+      }
+
+      user_agent_params = BaseApi.user_agent_parameters.merge!(custom_user_agent_parameters)
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+                                                 .additional_headers(@config.additional_headers)
+                                                 .global_header('Square-Version', @config.square_version)
+                                                 .sdk_module(Square)
+                                                 .symbolize_hash(true)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      ['global'].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['global'] = OAuth2.new(http_client_config.access_token)
     end
   end
 end

data/lib/square/configuration.rb

@@ -1,11 +1,9 @@
 module Square
   # All configuration including auth info and base URI for the API access
   # are configured in this class.
-  class Configuration
+  class Configuration < CoreLibrary::HttpClientConfiguration
     # The attribute readers for properties.
-    attr_reader :http_client, :connection, :adapter, :timeout, :max_retries, :retry_interval,
-                :backoff_factor, :retry_statuses, :retry_methods, :environment, :custom_url,
-                :square_version, :access_token, :user_agent_detail
+    attr_reader :environment, :custom_url, :access_token, :square_version, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -18,34 +16,16 @@ module Square
     def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
                    max_retries: 0, retry_interval: 1, backoff_factor: 2,
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], environment: 'production',
-                   custom_url: 'https://connect.squareup.com',
-                   square_version: '2023-01-19', access_token: '',
-                   user_agent_detail: '', additional_headers: {})
-      # The Faraday connection object passed by the SDK user for making requests
-      @connection = connection
+                   retry_methods: %i[get put], http_callback: nil,
+                   environment: 'production',
+                   custom_url: 'https://connect.squareup.com', access_token: '',
+                   square_version: '2023-04-19', user_agent_detail: '',
+                   additional_headers: {})
 
-      # The Faraday adapter object passed by the SDK user for performing http requests
-      @adapter = adapter
-
-      # The value to use for connection timeout
-      @timeout = timeout
-
-      # The number of times to retry an endpoint call if it fails
-      @max_retries = max_retries
-
-      # Pause in seconds between retries
-      @retry_interval = retry_interval
-
-      # The amount to multiply each successive retry's interval amount
-      # by in order to provide backoff
-      @backoff_factor = backoff_factor
-
-      # A list of HTTP statuses to retry
-      @retry_statuses = retry_statuses
-
-      # A list of HTTP methods to retry
-      @retry_methods = retry_methods
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
 
       # Current API environment
       @environment = String(environment)
@@ -53,17 +33,17 @@ module Square
       # Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
       @custom_url = custom_url
 
-      # Square Connect API versions
-      @square_version = square_version
-
       # The OAuth 2.0 Access Token to use for API requests.
       @access_token = access_token
 
+      # Square Connect API versions
+      @square_version = square_version
+
       # Additional headers to add to each API request
       @additional_headers = additional_headers.clone
 
       # The Http Client to use for making requests.
-      @http_client = create_http_client
+      set_http_client CoreLibrary::FaradayClient.new(self)
 
       # User agent detail, to be appended with user-agent header.
       @user_agent_detail = get_user_agent(user_agent_detail)
@@ -71,9 +51,10 @@ module Square
 
     def clone_with(connection: nil, adapter: nil, timeout: nil,
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
-                   retry_statuses: nil, retry_methods: nil, environment: nil,
-                   custom_url: nil, square_version: nil, access_token: nil,
-                   user_agent_detail: nil, additional_headers: nil)
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, custom_url: nil, access_token: nil,
+                   square_version: nil, user_agent_detail: nil,
+                   additional_headers: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -82,10 +63,11 @@ module Square
       backoff_factor ||= self.backoff_factor
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
       environment ||= self.environment
       custom_url ||= self.custom_url
-      square_version ||= self.square_version
       access_token ||= self.access_token
+      square_version ||= self.square_version
       user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
 
@@ -94,24 +76,17 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods, environment: environment,
-                        custom_url: custom_url, square_version: square_version,
-                        access_token: access_token,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback, environment: environment,
+                        custom_url: custom_url, access_token: access_token,
+                        square_version: square_version,
                         user_agent_detail: user_agent_detail,
                         additional_headers: additional_headers)
     end
 
-    def create_http_client
-      FaradayClient.new(timeout: timeout, max_retries: max_retries,
-                        retry_interval: retry_interval,
-                        backoff_factor: backoff_factor,
-                        retry_statuses: retry_statuses,
-                        retry_methods: retry_methods, connection: connection,
-                        adapter: adapter)
-    end
-
     def get_user_agent(user_agent_detail)
-      raise ArgumentError, 'The length of user-agent detail should not exceed 128 characters.' unless user_agent_detail.length < 128
+      raise ArgumentError, 'The length of user-agent detail should not exceed 128 characters.' unless
+        user_agent_detail.length < 128
 
       user_agent_detail
     end
@@ -130,7 +105,7 @@ module Square
     }.freeze
 
     # Generates the appropriate base URI for the environment and the server.
-    # @param [Configuration::Server] The server enum for which the base URI is
+    # @param [Configuration::Server] server The server enum for which the base URI is
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = 'default')

data/lib/square/exceptions/api_exception.rb

@@ -1,15 +1,5 @@
 module Square
   # Class for exceptions when there is a network error, status code error, etc.
-  class APIException < StandardError
-    attr_reader :response, :response_code
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason)
-      @response = response
-      @response_code = response.status_code
-    end
+  class APIException < CoreLibrary::ApiException
   end
 end

data/lib/square/http/api_response.rb

@@ -1,21 +1,16 @@
 module Square
   # Http response received.
-  class ApiResponse
-    attr_reader(:status_code, :reason_phrase, :headers, :raw_body, :request,
-                :data, :errors, :body, :cursor)
+  class ApiResponse < CoreLibrary::ApiResponse
+    attr_reader :body, :cursor
 
     # The constructor
-    # @param [HttpResponse] The original, raw response from the api.
-    # @param [Object] The data field specified for the response.
-    # @param [Array<String>] Any errors returned by the server.
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
     def initialize(http_response,
                    data: nil,
                    errors: nil)
-      @status_code = http_response.status_code
-      @reason_phrase = http_response.reason_phrase
-      @headers = http_response.headers
-      @raw_body = http_response.raw_body
-      @request = http_response.request
+      super
       @errors = errors
 
       if (data.is_a? Hash) && data.keys.any?
@@ -32,14 +27,13 @@ module Square
       end
     end
 
-    # returns true if status_code is between 200-300
-    def success?
-      status_code >= 200 && status_code < 300
-    end
-
-    # returns true if status_code is between 400-600
-    def error?
-      status_code >= 400 && status_code < 600
+    # The factory method for creating the API Response instance of the SDK from its parent instance in the core lirbary.
+    # @param [CoreLibrary::HttpResponse] parent_instance The Api Response instance from core library.
+    def self.create(parent_instance)
+      ApiResponse.new(CoreLibrary::HttpResponse
+                           .new(parent_instance.status_code, parent_instance.reason_phrase,
+                                parent_instance.headers, parent_instance.raw_body, parent_instance.request),
+                      data: parent_instance.data, errors: parent_instance.errors)
     end
   end
 end

data/lib/square/http/auth/o_auth2.rb

@@ -1,12 +1,19 @@
 module Square
   # Utility class for OAuth 2 authorization and token management.
-  class OAuth2
-    # Add OAuth2 authentication to the http request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(config, http_request)
-      token = config.access_token
-      http_request.headers['Authorization'] = "Bearer #{token}"
+  class OAuth2 < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerAuth: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(access_token)
+      auth_params = {}
+      @_access_token = access_token
+      auth_params['Authorization'] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
     end
   end
 end

data/lib/square/http/http_call_back.rb

@@ -1,19 +1,5 @@
 module Square
   # HttpCallBack allows defining callables for pre and post API calls.
-  class HttpCallBack
-    # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] The HttpRequest object which the HttpClient
-    # will execute.
-    def on_before_request(_http_request)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
-
-    # A controller will call this method after making an HTTP Request.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def on_after_response(_http_response)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
+  class HttpCallBack < CoreLibrary::HttpCallback
   end
 end

data/lib/square/http/http_method_enum.rb

@@ -1,8 +1,5 @@
 module Square
   # HTTP Methods Enumeration.
-  class HttpMethodEnum
-    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
-                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
-                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  class HttpMethodEnum < CoreLibrary::HttpMethod
   end
 end