square.rb 26.1.0.20230119 → 26.2.0.20230315

metadata

@@ -1,153 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 26.1.0.20230119
+  version: 26.2.0.20230315
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logging
+  name: apimatic_core_interfaces
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: apimatic_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-- !ruby/object:Gem::Dependency
-  name: faraday-follow_redirects
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: faraday-multipart
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-gzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: faraday-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-net_http_persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: certifi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2018.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2018.01.18
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2018.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2018.01.18
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: faraday-http-cache
+  name: apimatic_faraday_client_adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -237,12 +141,9 @@ files:
 - lib/square/client.rb
 - lib/square/configuration.rb
 - lib/square/exceptions/api_exception.rb
-- lib/square/exceptions/validation_exception.rb
 - lib/square/http/api_response.rb
 - lib/square/http/auth/o_auth2.rb
-- lib/square/http/faraday_client.rb
 - lib/square/http/http_call_back.rb
-- lib/square/http/http_client.rb
 - lib/square/http/http_method_enum.rb
 - lib/square/http/http_request.rb
 - lib/square/http/http_response.rb
@@ -259,7 +160,6 @@ files:
 - test/api/test_payments_api.rb
 - test/api/test_refunds_api.rb
 - test/http_response_catcher.rb
-- test/test_helper.rb
 homepage: ''
 licenses:
 - Apache-2.0

data/lib/square/exceptions/validation_exception.rb

@@ -1,13 +0,0 @@
-module Square
-  # Class for exceptions when there is a schema validation error.
-  class ValidationException < StandardError
-    attr_reader :reason
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    def initialize(value, template)
-      @reason = "The value #{value} provided doesn't validate against the schema #{template}"
-      super(reason)
-    end
-  end
-end

data/lib/square/http/faraday_client.rb

@@ -1,93 +0,0 @@
-require 'faraday/http_cache'
-require 'faraday/retry'
-require 'faraday/multipart'
-require 'faraday/follow_redirects'
-require 'faraday/gzip'
-require 'faraday/net_http_persistent'
-
-module Square
-  # An implementation of HttpClient.
-  class FaradayClient < HttpClient
-    # The attribute readers for properties.
-    attr_reader :connection
-
-    # The constructor.
-    def initialize(timeout:, max_retries:, retry_interval:,
-                   backoff_factor:, retry_statuses:, retry_methods:,
-                   connection:, adapter:, cache: false, verify: true)
-      @connection = if connection.nil?
-                      create_connection(timeout: timeout, max_retries: max_retries,
-                                        retry_interval: retry_interval, backoff_factor: backoff_factor,
-                                        retry_statuses: retry_statuses, retry_methods: retry_methods,
-                                        adapter: adapter, cache: cache, verify: verify)
-                    else
-                      connection
-                    end
-    end
-
-    # Method to initialize connection.
-    def create_connection(timeout:, max_retries:, retry_interval:,
-                          backoff_factor:, retry_statuses:, retry_methods:,
-                          adapter:, cache: false, verify: true)
-      Faraday.new do |faraday|
-        faraday.use Faraday::HttpCache, serializer: Marshal if cache
-        faraday.use Faraday::FollowRedirects::Middleware
-        faraday.request :gzip
-        faraday.request :multipart
-        faraday.request :url_encoded
-        faraday.ssl[:ca_file] = Certifi.where
-        faraday.ssl[:verify] = verify
-        faraday.request :retry, max: max_retries, interval: retry_interval,
-                                backoff_factor: backoff_factor,
-                                retry_statuses: retry_statuses,
-                                methods: retry_methods,
-                                retry_if: proc { |env, _exc|
-                                            env.request.context['forced_retry'] ||= false
-                                          }
-        faraday.adapter adapter
-        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
-        faraday.options[:timeout] = timeout if timeout.positive?
-      end
-    end
-
-    # Method overridden from HttpClient.
-    def execute_as_string(http_request)
-      response = @connection.send(
-        http_request.http_method.downcase,
-        http_request.query_url
-      ) do |request|
-        request.headers = http_request.headers.map { |k, v| [k.to_s, v.to_s] }
-        request.options.context ||= {}
-        request.options.context.merge!(http_request.context)
-        unless http_request.http_method == HttpMethodEnum::GET &&
-               http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
-      end
-      convert_response(response, http_request)
-    end
-
-    # Method overridden from HttpClient.
-    def execute_as_binary(http_request)
-      response = @connection.send(
-        http_request.http_method.downcase,
-        http_request.query_url
-      ) do |request|
-        request.headers = http_request.headers
-        request.options.context ||= {}
-        request.options.context.merge!(http_request.context)
-        unless http_request.http_method == HttpMethodEnum::GET &&
-               http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
-      end
-      convert_response(response, http_request)
-    end
-
-    # Method overridden from HttpClient.
-    def convert_response(response, http_request)
-      HttpResponse.new(response.status, response.reason_phrase,
-                       response.headers, response.body, http_request)
-    end
-  end
-end

data/lib/square/http/http_client.rb

@@ -1,118 +0,0 @@
-module Square
-  # An interface for the methods that an HTTP Client must implement.
-  #
-  # This class should not be instantiated but should be used as a base class
-  # for HTTP Client classes.
-  class HttpClient
-    # Execute an HttpRequest when the response is expected to be a string.
-    # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_string(_http_request)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
-
-    # Execute an HttpRequest when the response is expected to be binary.
-    # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_binary(_http_request)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
-
-    # Converts the HTTP Response from the client to an HttpResponse object.
-    # @param [Dynamic] The response object received from the client.
-    def convert_response(_response)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
-
-    # Get a GET HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The context for the HTTP Request.
-    def get(query_url,
-            headers: {},
-            context: {})
-      HttpRequest.new(HttpMethodEnum::GET,
-                      query_url,
-                      headers: headers,
-                      context: context)
-    end
-
-    # Get a HEAD HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The context for the HTTP Request.
-    def head(query_url,
-             headers: {},
-             context: {})
-      HttpRequest.new(HttpMethodEnum::HEAD,
-                      query_url,
-                      headers: headers,
-                      context: context)
-    end
-
-    # Get a POST HttpRequest object.
-    # @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 post(query_url,
-             headers: {},
-             parameters: {},
-             context: {})
-      HttpRequest.new(HttpMethodEnum::POST,
-                      query_url,
-                      headers: headers,
-                      parameters: parameters,
-                      context: context)
-    end
-
-    # Get a PUT HttpRequest object.
-    # @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 put(query_url,
-            headers: {},
-            parameters: {},
-            context: {})
-      HttpRequest.new(HttpMethodEnum::PUT,
-                      query_url,
-                      headers: headers,
-                      parameters: parameters,
-                      context: context)
-    end
-
-    # Get a PATCH HttpRequest object.
-    # @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 patch(query_url,
-              headers: {},
-              parameters: {},
-              context: {})
-      HttpRequest.new(HttpMethodEnum::PATCH,
-                      query_url,
-                      headers: headers,
-                      parameters: parameters,
-                      context: context)
-    end
-
-    # Get a DELETE HttpRequest object.
-    # @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 delete(query_url,
-               headers: {},
-               parameters: nil,
-               context: {})
-      HttpRequest.new(HttpMethodEnum::DELETE,
-                      query_url,
-                      headers: headers,
-                      parameters: parameters,
-                      context: context)
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,89 +0,0 @@
-require 'tempfile'
-require 'open-uri'
-
-class TestHelper
-
-  @cache = Hash.new
-
-  # Class method to compare the received headers with the expected headers.
-  # @param [Hash] A hash of expected headers (keys in lower case).
-  # @param [Hash] A hash of received headers.
-  # @param [Boolean, optional] A flag which determines if we allow extra headers.
-  def self.match_headers(expected_headers,
-                         received_headers,
-                         allow_extra: true)
-    return false if ((received_headers.length < expected_headers.length) ||
-                    ((allow_extra == false) && (received_headers.length > expected_headers.length)))
-
-    received_headers = Hash[received_headers.map{|k, v| [k.to_s.downcase, v]}]
-    expected_headers.each do |e_key, e_value|
-      return false unless received_headers.key?(e_key)
-      return false if ((e_value != nil) &&
-                       (e_value != received_headers[e_key]))
-    end
-
-    return true
-  end
-
-  # Class method to compare the received body with the expected body.
-  # @param [Dynamic] The expected body.
-  # @param [Dynamic] The received body.
-  # @param [Boolean, optional] A flag which determines if we check values in dictionaries.
-  # @param [Boolean, optional] A flag which determines if we check the order of array elements.
-  # @param [Boolean, optional] A flag which determines if we check the count of array elements.
-  def self.match_body(expected_body,
-                      received_body,
-                      check_values: false,
-                      check_order: false,
-                      check_count: false)
-    if expected_body.instance_of? Hash
-      return false unless received_body.instance_of? Hash
-      for key in expected_body.keys           
-        return false unless received_body.keys.include? key
-        if check_values or expected_body[key].instance_of? Hash
-          return false unless TestHelper.match_body(expected_body[key], 
-                                                    received_body[key], 
-                                                    check_values: check_values, 
-                                                    check_order: check_order, 
-                                                    check_count: check_count)
-        end
-      end
-    elsif expected_body.instance_of? Array
-      return false unless received_body.instance_of? Array
-      if check_count == true && (expected_body.length != received_body.length)
-        return false
-      else
-        previous_matches = Array.new
-        expected_body.each.with_index do |expected_element, i|
-          matches = (received_body.map.with_index do |received_element, j|
-                      j if TestHelper.match_body(expected_element, 
-                                                 received_element, 
-                                                 check_values: check_values, 
-                                                 check_order: check_order, 
-                                                 check_count: check_count)
-                    end).compact
-          return false if matches.length == 0
-          if check_order == true
-            return false if (i != 0 && matches.map{|x| previous_matches.map{|y| y > x}.all?}.all?)
-            previous_matches = matches
-          end
-        end
-      end
-    elsif expected_body != received_body
-      return false
-    end
-    return true
-  end  
-  
-  # Class method which takes a URL, downloads the file (if not already downloaded 
-  # for this test session) and returns the path of the file.
-  # @param [String] The URL of the required file.
-  def self.get_file(url)
-    unless @cache.keys.include? url  
-      @cache[url] = Tempfile.new('APIMatic')
-      @cache[url].binmode
-      @cache[url].write(URI.open(url, {ssl_ca_cert: Certifi.where}).read)
-    end
-    return @cache[url].path
-  end
-end