square.rb 17.1.0.20220120 → 18.0.0.20220216

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407147246777f8a4eda2d4848cad5edb62be5801c25b6361f0dfb21d58663fd9
-  data.tar.gz: 735c7e92297b1d4a79ebd856dbe39cc304051536622f0277ddd9489811652cb6
+  metadata.gz: d63ad56661f521ead949670191ddb004cf944daedf7836047c9281e8e6600ecf
+  data.tar.gz: 548171c3a90103f2a2492166e6b69f9c0dd7855f1c20d656e4c7c1f922053e86
 SHA512:
-  metadata.gz: 90ccb1516f8ff8998787d63a168c8c8688b9a12691d85cac3a2b6af35ce52af93bbc013e11336d5319cc252ec75ce7f790165ea5c38c69367f092e5ef62b365d
-  data.tar.gz: 05a3eb69caf678ad7f071b66a27c3ed4375ac96470ba09e51df9db6eba1401b80bd461c7fd6cb7bde91f30bb7ee5d11b9f7f293a59d40c70ab5ed52b25b9d180
+  metadata.gz: 4d5f5cdb0c4992a16eca7327a67642d9fcb807ae040b7c3426d5635ac3ef9f40ab9d144fe011b60c5ad996b81b098e49a3e4cf8a3e6aa3dd4742fab08fd6e1b3
+  data.tar.gz: 56b7b2f269877ec3b2f867d608e0a803a066e74bc958d2e0f60e156a034360e872d0c7eccefa5d552a35b700f2c9cb83b364a942e96968a713ab33013069dea5

data/README.md

@@ -10,7 +10,7 @@ Use this gem to integrate Square payments into your app and grow your business w
 
 ## Requirements
 
-We support Ruby 2.5.x, 2.6.x, 2.7.x, and 3.0.x.
+We support Ruby 2.6 through 3.1.
 
 ## Installation
 

data/lib/square/api/base_api.rb

@@ -38,7 +38,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/17.1.0.20220120 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/18.0.0.20220216 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/merchants_api.rb

@@ -5,15 +5,17 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns `Merchant` information for a given access token.
-    # If you don't know a `Merchant` ID, you can use this endpoint to retrieve
-    # the merchant ID for an access token.
-    # You can specify your personal access token to get your own merchant
-    # information or specify an OAuth token
-    # to get the information for the  merchant that granted you access.
+    # Provides details about the merchant associated with a given access token.
+    # The access token used to connect your application to a Square seller is
+    # associated
+    # with a single merchant. That means that `ListMerchants` returns a list
+    # with a single `Merchant` object. You can specify your personal access
+    # token
+    # to get your own merchant information or specify an OAuth token to get the
+    # information for the merchant that granted your application access.
     # If you know the merchant ID, you can also use the
     # [RetrieveMerchant]($e/Merchants/RetrieveMerchant)
-    # endpoint to get the merchant information.
+    # endpoint to retrieve the merchant information.
     # @param [Integer] cursor Optional parameter: The cursor generated by the
     # previous response.
     # @return [ListMerchantsResponse Hash] response from the API call
@@ -48,7 +50,7 @@ module Square
       )
     end
 
-    # Retrieve a `Merchant` object for the given `merchant_id`.
+    # Retrieves the `Merchant` object for the given `merchant_id`.
     # @param [String] merchant_id Required parameter: The ID of the merchant to
     # retrieve. If the string "me" is supplied as the ID, then retrieve the
     # merchant that is currently accessible to this call.

data/lib/square/api_helper.rb

@@ -8,18 +8,16 @@ module Square
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      case formatting
-      when 'unindexed'
-        tuples += array.map { |element| ["#{key}[]", element] }
-      when 'indexed'
-        tuples += array.map.with_index do |element, index|
-          ["#{key}[#{index}]", element]
-        end
-      when '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
 
@@ -75,31 +73,19 @@ module Square
       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 += case array_serialization
-                             when 'csv'
-                               "#{seperator}#{key}=#{value.map do |element|
-                                 CGI.escape(element.to_s)
-                               end.join(',')}"
-                             when 'psv'
-                               "#{seperator}#{key}=#{value.map do |element|
-                                 CGI.escape(element.to_s)
-                               end.join('|')}"
-                             when '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
@@ -163,6 +149,18 @@ 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|

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '17.1.0.20220120'
+      '18.0.0.20220216'
     end
 
     def square_version
@@ -213,16 +213,16 @@ module Square
       @terminal ||= TerminalApi.new config
     end
 
-    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+    def initialize(connection: nil, 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-01-20', access_token: '',
+                   square_version: '2022-02-16', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(http_client_instance: http_client_instance,
-                                    timeout: timeout, max_retries: max_retries,
+                  Configuration.new(connection: connection, timeout: timeout,
+                                    max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,

data/lib/square/configuration.rb

@@ -3,9 +3,9 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client, :http_client_instance, :timeout, :max_retries, :retry_interval,
-                :backoff_factor, :retry_statuses, :retry_methods, :environment, :custom_url,
-                :square_version, :access_token, :user_agent_detail
+    attr_reader :http_client, :connection, :timeout, :max_retries, :retry_interval, :backoff_factor,
+                :retry_statuses, :retry_methods, :environment, :custom_url, :square_version,
+                :access_token, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -15,15 +15,15 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+    def initialize(connection: nil, 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-01-20', access_token: '',
+                   square_version: '2022-02-16', access_token: '',
                    user_agent_detail: '', additional_headers: {})
-      # The Http Client passed from the sdk user for making requests
-      @http_client_instance = http_client_instance
+      # The Faraday connection object passed by the SDK user for making requests
+      @connection = connection
 
       # The value to use for connection timeout
       @timeout = timeout
@@ -66,12 +66,12 @@ module Square
       @user_agent_detail = get_user_agent(user_agent_detail)
     end
 
-    def clone_with(http_client_instance: nil, timeout: nil, max_retries: nil,
+    def clone_with(connection: 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)
-      http_client_instance ||= self.http_client_instance
+      connection ||= self.connection
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -85,8 +85,8 @@ module Square
       user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
 
-      Configuration.new(http_client_instance: http_client_instance,
-                        timeout: timeout, max_retries: max_retries,
+      Configuration.new(connection: connection, timeout: timeout,
+                        max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
@@ -102,8 +102,7 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods,
-                        http_client_instance: http_client_instance)
+                        retry_methods: retry_methods, connection: connection)
     end
 
     def get_user_agent(user_agent_detail)

data/lib/square/http/faraday_client.rb

@@ -4,29 +4,28 @@ require 'faraday_middleware'
 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:,
-                   http_client_instance: nil, cache: false, verify: true)
-      if http_client_instance.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,
-                          cache: cache, verify: verify)
-      else
-        if http_client_instance.instance_variable_get('@connection').nil?
-          raise ArgumentError,
-                "`connection` cannot be nil in `#{self.class}`. Please specify a valid value."
-        end
-        @connection = http_client_instance.instance_variable_get('@connection')
-      end
+                   connection: nil, 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,
+                                        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:,
                           cache: false, verify: true)
-      @connection = Faraday.new do |faraday|
+      Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
         faraday.use :gzip
@@ -42,7 +41,6 @@ module Square
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout.positive?
       end
-      @connection
     end
 
     # Method overridden from HttpClient.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 17.1.0.20220120
+  version: 18.0.0.20220216
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging