square.rb 26.0.0.20221214 → 26.2.0.20230315

data/lib/square/http/http_request.rb

@@ -1,49 +1,5 @@
 module Square
   # Represents a single Http Request.
-  class HttpRequest
-    attr_accessor :http_method, :query_url, :headers,
-                  :parameters, :username, :password,
-                  :context
-
-    # The constructor.
-    # @param [HttpMethodEnum] The HTTP method.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [Hash, Optional] The context for the HTTP Request.
-    def initialize(http_method,
-                   query_url,
-                   headers: {},
-                   parameters: {},
-                   context: {})
-      @http_method = http_method
-      @query_url = query_url
-      @headers = headers
-      @parameters = parameters
-      @context = context
-    end
-
-    # Add a header to the HttpRequest.
-    # @param [String] The name of the header.
-    # @param [String] The value of the header.
-    def add_header(name, value)
-      @headers[name] = value
-    end
-
-    # Add a parameter to the HttpRequest.
-    # @param [String] The name of the parameter.
-    # @param [String] The value of the parameter.
-    def add_parameter(name, value)
-      @parameters[name] = value
-    end
-
-    # Add a query parameter to the HttpRequest.
-    # @param [String] The name of the query parameter.
-    # @param [String] The value of the query parameter.
-    def add_query_parameter(name, value)
-      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
-                                                              name => value)
-      @query_url = APIHelper.clean_url(@query_url)
-    end
+  class HttpRequest < CoreLibrary::HttpRequest
   end
 end

data/lib/square/http/http_response.rb

@@ -1,24 +1,5 @@
 module Square
   # Http response received.
-  class HttpResponse
-    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
-
-    # The constructor
-    # @param [Integer] The status code returned by the server.
-    # @param [String] The reason phrase returned by the server.
-    # @param [Hash] The headers sent by the server in the response.
-    # @param [String] The raw body of the response.
-    # @param [HttpRequest] The request that resulted in this response.
-    def initialize(status_code,
-                   reason_phrase,
-                   headers,
-                   raw_body,
-                   request)
-      @status_code = status_code
-      @reason_phrase = reason_phrase
-      @headers = headers
-      @raw_body = raw_body
-      @request = request
-    end
+  class HttpResponse < CoreLibrary::HttpResponse
   end
 end

data/lib/square/utilities/date_time_helper.rb

@@ -1,151 +1,6 @@
 require 'date'
 module Square
   # A utility  that supports dateTime conversion to different formats
-  class DateTimeHelper
-    # Safely converts a DateTime object into a rfc1123 format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The rfc1123 formatted datetime string
-    def self.to_rfc1123(date_time)
-      date_time&.httpdate
-    end
-
-    # Safely converts a map of DateTime objects into a map of rfc1123 format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of rfc1123 formatted datetime string
-    def self.to_rfc1123_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into an array of rfc1123 format string
-    # @param [Array] an array of DateTime objects
-    # @return [Array] an array of rfc1123 formatted datetime string
-    def self.to_rfc1123_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
-        end
-      end
-    end
-
-    # Safely converts a DateTime object into a unix format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The unix formatted datetime string
-    def self.to_unix(date_time)
-      date_time.to_time.utc.to_i unless date_time.nil?
-    end
-
-    # Safely converts a map of DateTime objects into a map of unix format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of unix formatted datetime string
-    def self.to_unix_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into a map of unix format string
-    # @param [hash] an array of DateTime objects
-    # @return [hash] an array of unix formatted datetime string
-    def self.to_unix_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
-        end
-      end
-    end
-
-    # Safely converts a DateTime object into a rfc3339 format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The rfc3339 formatted datetime string
-    def self.to_rfc3339(date_time)
-      date_time&.rfc3339
-    end
-
-    # Safely converts a map of DateTime objects into a map of rfc1123 format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of rfc1123 formatted datetime string
-    def self.to_rfc3339_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into an array of rfc1123 format string
-    # @param [Array] an array of DateTime objects
-    # @return [Array] an array of rfc1123 formatted datetime string
-    def self.to_rfc3339_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
-        end
-      end
-    end
-
-    # Safely converts a rfc1123 format string into a DateTime object
-    # @param [String] The rfc1123 formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_rfc1123(date_time)
-      DateTime.httpdate(date_time)
-    end
-
-    # Safely converts a unix format string into a DateTime object
-    # @param [String] The unix formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_unix(date_time)
-      Time.at(date_time.to_i).utc.to_datetime
-    end
-
-    # Safely converts a rfc3339 format string into a DateTime object
-    # @param [String] The rfc3339 formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
-      else
-        DateTime.rfc3339("#{date_time}Z")
-      end
-    end
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
   end
 end

data/lib/square/utilities/file_wrapper.rb

@@ -1,11 +1,11 @@
 module Square
   # A utility to allow users to set the content-type for files
-  class FileWrapper
-    attr_reader :content_type, :file
-
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
     def initialize(file, content_type: 'application/octet-stream')
-      @file = file
-      @content_type = content_type
+      super
     end
   end
 end

data/lib/square.rb

@@ -1,8 +1,11 @@
 require 'date'
 require 'json'
-require 'faraday'
-require 'certifi'
-require 'logging'
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+# rubocop:disable Style/MixinUsage
+include CoreLibrary
+# rubocop:enable Style/MixinUsage
 
 require_relative 'square/api_helper'
 require_relative 'square/client'
@@ -14,8 +17,6 @@ require_relative 'square/utilities/date_time_helper'
 # Http
 require_relative 'square/http/api_response'
 require_relative 'square/http/http_call_back'
-require_relative 'square/http/http_client'
-require_relative 'square/http/faraday_client'
 require_relative 'square/http/http_method_enum'
 require_relative 'square/http/http_request'
 require_relative 'square/http/http_response'
@@ -25,7 +26,6 @@ require_relative 'square/http/auth/o_auth2'
 
 # Exceptions
 require_relative 'square/exceptions/api_exception'
-require_relative 'square/exceptions/validation_exception'
 
 require_relative 'square/configuration'
 
@@ -54,6 +54,7 @@ require_relative 'square/api/inventory_api'
 require_relative 'square/api/invoices_api'
 require_relative 'square/api/labor_api'
 require_relative 'square/api/locations_api'
+require_relative 'square/api/location_custom_attributes_api'
 require_relative 'square/api/checkout_api'
 require_relative 'square/api/transactions_api'
 require_relative 'square/api/loyalty_api'

data/spec/user_journey_spec.rb

@@ -4,8 +4,8 @@ require_relative '../test/api/api_test_base'
 require 'json'
 
 describe "UserJourney" do
-  let(:access_token) { ApiTestBase::CONFIG.access_token }
-  let(:environment) { ApiTestBase::CONFIG.environment }
+  let(:access_token) { ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken')}
+  let(:environment) { "sandbox" }
 
   let(:phone_number) { "1-212-555-4240" }
   let(:phone_number2) { "1-917-500-1000" }

data/test/api/api_test_base.rb

@@ -4,7 +4,6 @@ require 'minitest/hell'
 require 'minitest/pride'
 require 'minitest/proveit'
 require 'square'
-require_relative '../test_helper'
 require_relative '../http_response_catcher'
 
 class ApiTestBase < Minitest::Test
@@ -12,8 +11,17 @@ class ApiTestBase < Minitest::Test
   include Square
 
   # Create configuration and set any test parameters
-  CONFIG = Configuration.new(
-    access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
-    environment: 'sandbox'
-  )
+  def create_configuration
+    Configuration.new(
+      access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
+      environment: 'sandbox', http_callback: HttpResponseCatcher.new
+    )
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+    _auth_managers = @client.auth_managers
+  end
 end

data/test/api/test_catalog_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class CatalogApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = CatalogApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.catalog
+    @response_catcher = @controller.http_call_back
   end
 
   # Returns information about the Square Catalog API, such as batch size
@@ -23,7 +24,7 @@ class CatalogApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
   # Returns a list of [CatalogObject](#type-catalogobject)s that includes
@@ -50,7 +51,7 @@ class CatalogApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end

data/test/api/test_customers_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class CustomersApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = CustomersApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.customers
+    @response_catcher = @controller.http_call_back
   end
 
   # Creates a new customer for a business, which can have associated cards on file.

data/test/api/test_employees_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class EmployeesApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = EmployeesApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.employees
+    @response_catcher = @controller.http_call_back
   end
 
   # Gets a list of `Employee` objects for a business.
@@ -27,7 +28,7 @@ class EmployeesApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end

data/test/api/test_labor_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class LaborApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = LaborApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.labor
+    @response_catcher = @controller.http_call_back
   end
 
   # Returns a paginated list of `BreakType` instances for a business.
@@ -26,7 +27,7 @@ class LaborApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
   # Returns a paginated list of `EmployeeWage` instances for a business.
@@ -45,7 +46,7 @@ class LaborApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
   # Returns a list of `WorkweekConfig` instances for a business.
@@ -64,7 +65,7 @@ class LaborApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end

data/test/api/test_locations_api.rb

@@ -3,8 +3,9 @@ require_relative 'api_test_base'
 class LocationsApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.locations
+    @response_catcher = @controller.http_call_back
   end
 
   # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),

data/test/api/test_merchants_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class MerchantsApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = MerchantsApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.merchants
+    @response_catcher = @controller.http_call_back
   end
 
   # Returns `Merchant` information for a given access token.
@@ -31,7 +32,7 @@ class MerchantsApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end

data/test/api/test_payments_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class PaymentsApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = PaymentsApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.payments
+    @response_catcher = @controller.http_call_back
   end
 
   # Retrieves a list of payments taken by the account making the request.
@@ -33,7 +34,7 @@ class PaymentsApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end

data/test/api/test_refunds_api.rb

@@ -5,8 +5,9 @@ require_relative 'api_test_base'
 class RefundsApiTests < ApiTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = RefundsApi.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.refunds
+    @response_catcher = @controller.http_call_back
   end
 
   # Retrieves a list of refunds for the account making the request.
@@ -32,7 +33,7 @@ class RefundsApiTests < ApiTestBase
     expected_headers = {}
     expected_headers['content-type'] = 'application/json'
 
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
   end
 
 end