square.rb 20.1.0.20220616 → 22.0.0.20220817

data/lib/square/api_helper.rb

@@ -130,6 +130,12 @@ module Square
       raise TypeError, 'Server responded with invalid JSON.'
     end
 
+    # Parses JSON string.
+    # @param [object] The object to serialize.
+    def self.json_serialize(obj)
+      serializable_types.map { |x| obj.is_a? x }.any? ? obj.to_s : obj.to_json
+    end
+
     # Removes elements with empty values from a hash.
     # @param [Hash] The hash to clean.
     def self.clean_hash(hash)
@@ -199,9 +205,6 @@ module Square
     def self.form_encode(obj, instance_name, formatting: 'indexed')
       retval = {}
 
-      serializable_types = [String, Numeric, TrueClass,
-                            FalseClass, Date, DateTime]
-
       # Create a form encoded hash for this object.
       if obj.nil?
         nil
@@ -210,7 +213,7 @@ module Square
           obj.each_with_index do |value, index|
             retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
-        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+        elsif APIHelper.serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
                     APIHelper.form_encode(value, "#{instance_name}[]",
@@ -265,5 +268,174 @@ module Square
       end
       val
     end
+
+    # Deserialize the value against the template (group of types).
+    # @param [String] The value to be deserialized.
+    # @param [String] The parameter indicates the type-combination
+    # against which the value will be mapped (oneOf(Integer, String)).
+    def self.deserialize(template, value)
+      decoded = APIHelper.json_deserialize(value)
+      map_types(decoded, template)
+    end
+
+    # Validates and processes the value against the template(group of types).
+    # @param [String] The value to be mapped against the template.
+    # @param [String] The parameter indicates the group of types (oneOf(Integer, String)).
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    def self.map_types(value, template, group_name: nil)
+      result_value = nil
+      matches = 0
+      types = []
+      group_name = template.partition('(').first if group_name.nil? && template.match?(/anyOf|oneOf/)
+
+      return if value.nil?
+
+      if template.end_with?('{}') || template.end_with?('[]')
+        types = template.split(group_name, 2).last.gsub(/\s+/, '').split
+      else
+        template = template.split(group_name, 2).last.delete_prefix('(').delete_suffix(')')
+        types = template.scan(/(anyOf|oneOf)[(]([^[)]]*)[)]/).flatten.combination(2).map { |a, b| "#{a}(#{b})" }
+        types.each { |t| template = template.gsub(", #{t}", '') }
+        types = template.gsub(/\s+/, '').split(',').push(*types)
+      end
+      types.each do |element|
+        if element.match?(/^(oneOf|anyOf)[(].*$/)
+          begin
+            result_value = map_types(value, element, matches)
+            matches += 1
+          rescue ValidationException
+            next
+          end
+        elsif element.end_with?('{}')
+          result_value, matches = map_hash_type(value, element, group_name, matches)
+        elsif element.end_with?('[]')
+          result_value, matches = map_array_type(value, element, group_name, matches)
+        else
+          begin
+            result_value, matches = map_type(value, element, group_name, matches)
+          rescue StandardError
+            next
+          end
+        end
+        break if group_name == 'anyOf' && matches == 1
+      end
+      raise ValidationException.new(value, template) unless matches == 1
+
+      value = result_value unless result_value.nil?
+      value
+    end
+
+    # Validates and processes the value against the [Hash] type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_hash_type(value, type, group_name, matches)
+      if value.instance_of? Hash
+        decoded = {}
+        value.each do |key, val|
+          type = type.chomp('{}').to_s
+          val = map_types(val, type, group_name: group_name)
+          decoded[key] = val unless type.empty?
+        rescue ValidationException
+          next
+        end
+        matches += 1 if decoded.length == value.length
+        value = decoded unless decoded.empty?
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the [Array] type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_array_type(value, type, group_name, matches)
+      if value.instance_of? Array
+        decoded = []
+        value.each do |val|
+          type = type.chomp('[]').to_s
+          val = map_types(val, type, group_name: group_name)
+          decoded.append(val) unless type.empty?
+        rescue ValidationException
+          next
+        end
+        matches += 1 if decoded.length == value.length
+        value = decoded unless decoded.empty?
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_type(value, type, _group_name, matches)
+      if Square.constants.select do |c|
+        Square.const_get(c).to_s == "Square::#{type}"
+      end.empty?
+        value, matches = map_data_type(value, type, matches)
+      else
+        value, matches = map_complex_type(value, type, matches)
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the complex types.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_complex_type(value, type, matches)
+      obj = Square.const_get(type)
+      value = if obj.respond_to? 'from_hash'
+                obj.send('from_hash', value)
+              else
+                obj.constants.find { |k| obj.const_get(k) == value }
+              end
+      matches += 1 unless value.nil?
+      [value, matches]
+    end
+
+    # Validates and processes the value against the data types.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_data_type(value, element, matches)
+      element = element.split('|').map { |x| Object.const_get x }
+      matches += 1 if element.all? { |x| APIHelper.data_types.include?(x) } &&
+                      element.any? { |x| (value.instance_of? x) || (value.class.ancestors.include? x) }
+      [value, matches]
+    end
+
+    # Validates the value against the template(group of types).
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The parameter indicates the group of types (oneOf(Integer, String)).
+    def self.validate_types(value, template)
+      map_types(APIHelper.json_deserialize(value.to_json), template)
+    end
+
+    # Get content-type depending on the value
+    def self.get_content_type(value)
+      if serializable_types.map { |x| value.is_a? x }.any?
+        'text/plain; charset=utf-8'
+      else
+        'application/json; charset=utf-8'
+      end
+    end
+
+    # Array of serializable types
+    def self.serializable_types
+      [String, Numeric, TrueClass,
+       FalseClass, Date, DateTime]
+    end
+
+    # Array of supported data types
+    def self.data_types
+      [String, Float, Integer,
+       TrueClass, FalseClass, Date,
+       DateTime, Array, Hash, Object]
+    end
   end
 end

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '20.1.0.20220616'
+      '22.0.0.20220817'
     end
 
     def square_version
@@ -231,13 +231,18 @@ module Square
       @vendors ||= VendorsApi.new config
     end
 
-    def initialize(connection: nil, adapter: Faraday.default_adapter,
-                   timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    # Access to webhook_subscriptions controller.
+    # @return [WebhookSubscriptionsApi] Returns the controller instance.
+    def webhook_subscriptions
+      @webhook_subscriptions ||= WebhookSubscriptionsApi.new config
+    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: '2022-06-16', access_token: '',
+                   square_version: '2022-08-17', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -15,13 +15,12 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(connection: nil, adapter: Faraday.default_adapter,
-                   timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    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: '2022-06-16', access_token: '',
+                   square_version: '2022-08-17', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square/exceptions/validation_exception.rb

@@ -0,0 +1,13 @@
+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

@@ -3,6 +3,7 @@ require 'faraday/retry'
 require 'faraday/multipart'
 require 'faraday/follow_redirects'
 require 'faraday/gzip'
+require 'faraday/net_http_persistent'
 
 module Square
   # An implementation of HttpClient.

data/lib/square.rb

@@ -25,6 +25,7 @@ require_relative 'square/http/auth/o_auth2'
 
 # Exceptions
 require_relative 'square/exceptions/api_exception'
+require_relative 'square/exceptions/validation_exception'
 
 require_relative 'square/configuration'
 
@@ -66,3 +67,4 @@ require_relative 'square/api/subscriptions_api'
 require_relative 'square/api/team_api'
 require_relative 'square/api/terminal_api'
 require_relative 'square/api/vendors_api'
+require_relative 'square/api/webhook_subscriptions_api'

data/test/test_helper.rb

@@ -49,7 +49,7 @@ class TestHelper
         end
       end
     elsif expected_body.instance_of? Array
-      return False unless received_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 20.1.0.20220616
+  version: 22.0.0.20220817
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !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
@@ -215,10 +229,12 @@ files:
 - lib/square/api/transactions_api.rb
 - lib/square/api/v1_transactions_api.rb
 - lib/square/api/vendors_api.rb
+- lib/square/api/webhook_subscriptions_api.rb
 - lib/square/api_helper.rb
 - 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