square.rb 8.0.0.20201216 → 26.1.0.20230119

data/lib/square/api_helper.rb

@@ -8,17 +8,16 @@ module Square
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
-        tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
-        tuples += array.map.with_index do |element, index|
-          ["#{key}[#{index}]", element]
-        end
-      elsif formatting == 'plain'
-        tuples += array.map { |element| [key, element] }
-      else
-        raise ArgumentError, 'Invalid format provided.'
-      end
+      tuples += case formatting
+                when 'csv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join(',')]]
+                when 'psv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join('|')]]
+                when 'tsv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join("\t")]]
+                else
+                  array.map { |element| [key, element] }
+                end
       tuples
     end
 
@@ -55,7 +54,7 @@ module Square
         end
 
         # Find the template parameter and replace it with its value.
-        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
       end
       query_builder
     end
@@ -63,9 +62,7 @@ module Square
     # Appends the given set of parameters to the given query string.
     # @param [String] The query string builder to add the query parameters to.
     # @param [Hash] The parameters to append.
-    # @param [String] The format of array parameter serialization.
-    def self.append_url_with_query_parameters(query_builder, parameters,
-                                              array_serialization: 'indexed')
+    def self.append_url_with_query_parameters(query_builder, parameters)
       # Perform parameter validation.
       unless query_builder.instance_of? String
         raise ArgumentError, 'Given value for parameter \"query_builder\"
@@ -75,29 +72,20 @@ module Square
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
+      array_serialization = 'indexed'
+      parameters = process_complex_types_parameters(parameters, array_serialization)
+
       parameters.each do |key, value|
         seperator = query_builder.include?('?') ? '&' : '?'
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
-                               "#{seperator}#{key}=#{value.map do |element|
-                                 CGI.escape(element.to_s)
-                               end.join(',')}"
-                             elsif array_serialization == 'psv'
-                               "#{seperator}#{key}=#{value.map do |element|
-                                 CGI.escape(element.to_s)
-                               end.join('|')}"
-                             elsif array_serialization == 'tsv'
-                               "#{seperator}#{key}=#{value.map do |element|
-                                 CGI.escape(element.to_s)
-                               end.join("\t")}"
-                             else
-                               "#{seperator}#{APIHelper.serialize_array(
-                                 key, value, formatting: array_serialization
-                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
-                               .join('&')}"
-                             end
+            APIHelper.serialize_array(
+              key, value, formatting: array_serialization
+            ).each do |element|
+              seperator = query_builder.include?('?') ? '&' : '?'
+              query_builder += "#{seperator}#{element[0]}=#{element[1]}"
+            end
           else
             query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
           end
@@ -114,7 +102,7 @@ module Square
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
       # Ensure that the urls are absolute.
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      matches = url.match(%r{^(https?://[^/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
       # Get the http protocol match.
@@ -125,7 +113,7 @@ module Square
 
       # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
+      query.gsub!(%r{//+}, '/')
 
       # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
@@ -137,11 +125,17 @@ module Square
     # Parses JSON string.
     # @param [String] A JSON string.
     def self.json_deserialize(json)
-      return JSON.parse(json, symbolize_names: true)
+      JSON.parse(json, symbolize_names: true)
     rescue StandardError
       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)
@@ -151,8 +145,8 @@ module Square
     # Form encodes a hash of parameters.
     # @param [Hash] The hash of parameters to encode.
     # @return [Hash] A hash with the same parameters form encoded.
-    def self.form_encode_parameters(form_parameters,
-                                    array_serialization: 'indexed')
+    def self.form_encode_parameters(form_parameters)
+      array_serialization = 'indexed'
       encoded = {}
       form_parameters.each do |key, value|
         encoded.merge!(APIHelper.form_encode(value, key, formatting:
@@ -161,11 +155,24 @@ module Square
       encoded
     end
 
+    # Process complex types in query_params.
+    # @param [Hash] The hash of query parameters.
+    # @return [Hash] A hash with the processed query parameters.
+    def self.process_complex_types_parameters(query_parameters, array_serialization)
+      processed_params = {}
+      query_parameters.each do |key, value|
+        processed_params.merge!(APIHelper.form_encode(value, key, formatting:
+          array_serialization))
+      end
+      processed_params
+    end
+
     def self.custom_merge(a, b)
       x = {}
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|
@@ -198,22 +205,18 @@ 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
       elsif obj.instance_of? Array
         if formatting == 'indexed'
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']'))
+            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 + '[]',
+                    APIHelper.form_encode(value, "#{instance_name}[]",
                                           formatting: formatting)
                   else
                     APIHelper.form_encode(value, instance_name,
@@ -223,14 +226,14 @@ module Square
           end
         else
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']', formatting: formatting))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
           end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key.to_s + ']', formatting: formatting))
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
         end
       elsif obj.instance_of? File
         retval[instance_name] = UploadIO.new(
@@ -266,16 +269,173 @@ module Square
       val
     end
 
-    # Safely converts a string into an rfc3339 DateTime object
-    # @param [String] The datetime string
-    # @return [DateTime] A DateTime object of rfc3339 format
-    def self.rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
+    # 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
-        DateTime.rfc3339(date_time + 'Z')
+        '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,13 +4,17 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '8.0.0.20201216'
+      '26.1.0.20230119'
     end
 
     def square_version
       config.square_version
     end
 
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
     # Access to mobile_authorization controller.
     # @return [MobileAuthorizationApi] Returns the controller instance.
     def mobile_authorization
@@ -23,24 +27,12 @@ module Square
       @o_auth ||= OAuthApi.new config
     end
 
-    # Access to v1_employees controller.
-    # @return [V1EmployeesApi] Returns the controller instance.
-    def v1_employees
-      @v1_employees ||= V1EmployeesApi.new config
-    end
-
     # Access to v1_transactions controller.
     # @return [V1TransactionsApi] Returns the controller instance.
     def v1_transactions
       @v1_transactions ||= V1TransactionsApi.new config
     end
 
-    # Access to v1_items controller.
-    # @return [V1ItemsApi] Returns the controller instance.
-    def v1_items
-      @v1_items ||= V1ItemsApi.new config
-    end
-
     # Access to apple_pay controller.
     # @return [ApplePayApi] Returns the controller instance.
     def apple_pay
@@ -59,6 +51,18 @@ module Square
       @bookings ||= BookingsApi.new config
     end
 
+    # Access to booking_custom_attributes controller.
+    # @return [BookingCustomAttributesApi] Returns the controller instance.
+    def booking_custom_attributes
+      @booking_custom_attributes ||= BookingCustomAttributesApi.new config
+    end
+
+    # Access to cards controller.
+    # @return [CardsApi] Returns the controller instance.
+    def cards
+      @cards ||= CardsApi.new config
+    end
+
     # Access to cash_drawers controller.
     # @return [CashDrawersApi] Returns the controller instance.
     def cash_drawers
@@ -77,6 +81,12 @@ module Square
       @customers ||= CustomersApi.new config
     end
 
+    # Access to customer_custom_attributes controller.
+    # @return [CustomerCustomAttributesApi] Returns the controller instance.
+    def customer_custom_attributes
+      @customer_custom_attributes ||= CustomerCustomAttributesApi.new config
+    end
+
     # Access to customer_groups controller.
     # @return [CustomerGroupsApi] Returns the controller instance.
     def customer_groups
@@ -107,6 +117,18 @@ module Square
       @employees ||= EmployeesApi.new config
     end
 
+    # Access to gift_cards controller.
+    # @return [GiftCardsApi] Returns the controller instance.
+    def gift_cards
+      @gift_cards ||= GiftCardsApi.new config
+    end
+
+    # Access to gift_card_activities controller.
+    # @return [GiftCardActivitiesApi] Returns the controller instance.
+    def gift_card_activities
+      @gift_card_activities ||= GiftCardActivitiesApi.new config
+    end
+
     # Access to inventory controller.
     # @return [InventoryApi] Returns the controller instance.
     def inventory
@@ -131,6 +153,12 @@ module Square
       @locations ||= LocationsApi.new config
     end
 
+    # Access to location_custom_attributes controller.
+    # @return [LocationCustomAttributesApi] Returns the controller instance.
+    def location_custom_attributes
+      @location_custom_attributes ||= LocationCustomAttributesApi.new config
+    end
+
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
@@ -161,18 +189,42 @@ module Square
       @orders ||= OrdersApi.new config
     end
 
+    # Access to order_custom_attributes controller.
+    # @return [OrderCustomAttributesApi] Returns the controller instance.
+    def order_custom_attributes
+      @order_custom_attributes ||= OrderCustomAttributesApi.new config
+    end
+
     # Access to payments controller.
     # @return [PaymentsApi] Returns the controller instance.
     def payments
       @payments ||= PaymentsApi.new config
     end
 
+    # Access to payouts controller.
+    # @return [PayoutsApi] Returns the controller instance.
+    def payouts
+      @payouts ||= PayoutsApi.new config
+    end
+
     # Access to refunds controller.
     # @return [RefundsApi] Returns the controller instance.
     def refunds
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to sites controller.
+    # @return [SitesApi] Returns the controller instance.
+    def sites
+      @sites ||= SitesApi.new config
+    end
+
+    # Access to snippets controller.
+    # @return [SnippetsApi] Returns the controller instance.
+    def snippets
+      @snippets ||= SnippetsApi.new config
+    end
+
     # Access to subscriptions controller.
     # @return [SubscriptionsApi] Returns the controller instance.
     def subscriptions
@@ -191,17 +243,37 @@ module Square
       @terminal ||= TerminalApi.new config
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: 'production',
-                   square_version: '2020-12-16', access_token: 'TODO: Replace',
-                   additional_headers: {}, config: nil)
+    # Access to vendors controller.
+    # @return [VendorsApi] Returns the controller instance.
+    def vendors
+      @vendors ||= VendorsApi.new config
+    end
+
+    # 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: '2023-01-19', access_token: '',
+                   user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(timeout: timeout, max_retries: max_retries,
+                  Configuration.new(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,
                                     environment: environment,
+                                    custom_url: custom_url,
                                     square_version: square_version,
                                     access_token: access_token,
+                                    user_agent_detail: user_agent_detail,
                                     additional_headers: additional_headers)
                 else
                   config