square.rb 12.0.0.20210616 → 15.0.0.20211020

data/lib/square/api_helper.rb

@@ -8,13 +8,14 @@ module Square
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
+      case formatting
+      when 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
+      when 'indexed'
         tuples += array.map.with_index do |element, index|
           ["#{key}[#{index}]", element]
         end
-      elsif formatting == 'plain'
+      when 'plain'
         tuples += array.map { |element| [key, element] }
       else
         raise ArgumentError, 'Invalid format provided.'
@@ -55,7 +56,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
@@ -80,15 +81,16 @@ module Square
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
+            query_builder += case array_serialization
+                             when 'csv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join(',')}"
-                             elsif array_serialization == 'psv'
+                             when 'psv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join('|')}"
-                             elsif array_serialization == 'tsv'
+                             when 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join("\t")}"
@@ -114,7 +116,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 +127,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,7 +139,7 @@ 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
@@ -166,6 +168,7 @@ module Square
       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|
@@ -207,13 +210,12 @@ module Square
       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?
           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 +225,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(
@@ -265,17 +267,5 @@ module Square
       end
       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)
-      else
-        DateTime.rfc3339(date_time + 'Z')
-      end
-    end
   end
 end

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '12.0.0.20210616'
+      '15.0.0.20211020'
     end
 
     def square_version
@@ -23,12 +23,6 @@ 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
@@ -215,15 +209,16 @@ module Square
       @terminal ||= TerminalApi.new config
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: 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: '2021-06-16', access_token: 'TODO: Replace',
+                   square_version: '2021-10-20', access_token: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(timeout: timeout, max_retries: max_retries,
+                  Configuration.new(http_client_instance: http_client_instance,
+                                    timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,

data/lib/square/configuration.rb

@@ -3,17 +3,9 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    attr_reader :max_retries
-    attr_reader :retry_interval
-    attr_reader :backoff_factor
-    attr_reader :retry_statuses
-    attr_reader :retry_methods
-    attr_reader :environment
-    attr_reader :custom_url
-    attr_reader :square_version
-    attr_reader :access_token
+    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
 
     def additional_headers
       @additional_headers.clone
@@ -23,13 +15,16 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: 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: '2021-06-16', access_token: 'TODO: Replace',
+                   square_version: '2021-10-20', access_token: '',
                    additional_headers: {})
+      # The Http Client passed from the sdk user for making requests
+      @http_client_instance = http_client_instance
+
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -68,10 +63,12 @@ module Square
       @http_client = create_http_client
     end
 
-    def clone_with(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, additional_headers: nil)
+    def clone_with(http_client_instance: 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,
+                   additional_headers: nil)
+      http_client_instance ||= self.http_client_instance
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -84,7 +81,8 @@ module Square
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
-      Configuration.new(timeout: timeout, max_retries: max_retries,
+      Configuration.new(http_client_instance: http_client_instance,
+                        timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
@@ -99,7 +97,8 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods)
+                        retry_methods: retry_methods,
+                        http_client_instance: http_client_instance)
     end
 
     # All the environments the SDK can run in.

data/lib/square/http/api_response.rb

@@ -25,7 +25,7 @@ module Square
           end.new(*data.values)
 
           @cursor = data.fetch(:cursor, nil)
-          data.reject! { |k| k == :cursor || k == :errors }
+          data.reject! { |k| %i[cursor errors].include?(k) }
           @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
         end
       else

data/lib/square/http/faraday_client.rb

@@ -7,7 +7,25 @@ module Square
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
                    backoff_factor:, retry_statuses:, retry_methods:,
-                   cache: false, verify: true)
+                   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
+    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.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
@@ -22,8 +40,9 @@ module Square
                                 methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
-        faraday.options[:timeout] = timeout if timeout > 0
+        faraday.options[:timeout] = timeout if timeout.positive?
       end
+      @connection
     end
 
     # Method overridden from HttpClient.

data/lib/square/utilities/date_time_helper.rb

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

data/lib/square/utilities/file_wrapper.rb

@@ -1,8 +1,7 @@
 module Square
   # A utility to allow users to set the content-type for files
   class FileWrapper
-    attr_reader :content_type
-    attr_reader :file
+    attr_reader :content_type, :file
 
     def initialize(file, content_type: 'application/octet-stream')
       @file = file

data/lib/square.rb

@@ -4,62 +4,62 @@ require 'faraday'
 require 'certifi'
 require 'logging'
 
-require_relative 'square/api_helper.rb'
-require_relative 'square/client.rb'
+require_relative 'square/api_helper'
+require_relative 'square/client'
 
 # Utilities
-require_relative 'square/utilities/file_wrapper.rb'
+require_relative 'square/utilities/file_wrapper'
+require_relative 'square/utilities/date_time_helper'
 
 # Http
-require_relative 'square/http/api_response.rb'
-require_relative 'square/http/http_call_back.rb'
-require_relative 'square/http/http_client.rb'
-require_relative 'square/http/faraday_client.rb'
-require_relative 'square/http/http_method_enum.rb'
-require_relative 'square/http/http_request.rb'
-require_relative 'square/http/http_response.rb'
-require_relative 'square/http/auth/o_auth2.rb'
+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'
+require_relative 'square/http/auth/o_auth2'
 
 # Models
 
 # Exceptions
-require_relative 'square/exceptions/api_exception.rb'
+require_relative 'square/exceptions/api_exception'
 
-require_relative 'square/configuration.rb'
+require_relative 'square/configuration'
 
 # Controllers
-require_relative 'square/api/base_api.rb'
-require_relative 'square/api/mobile_authorization_api.rb'
-require_relative 'square/api/o_auth_api.rb'
-require_relative 'square/api/v1_employees_api.rb'
-require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/apple_pay_api.rb'
-require_relative 'square/api/bank_accounts_api.rb'
-require_relative 'square/api/bookings_api.rb'
-require_relative 'square/api/cards_api.rb'
-require_relative 'square/api/cash_drawers_api.rb'
-require_relative 'square/api/catalog_api.rb'
-require_relative 'square/api/customers_api.rb'
-require_relative 'square/api/customer_groups_api.rb'
-require_relative 'square/api/customer_segments_api.rb'
-require_relative 'square/api/devices_api.rb'
-require_relative 'square/api/disputes_api.rb'
-require_relative 'square/api/employees_api.rb'
-require_relative 'square/api/gift_cards_api.rb'
-require_relative 'square/api/gift_card_activities_api.rb'
-require_relative 'square/api/inventory_api.rb'
-require_relative 'square/api/invoices_api.rb'
-require_relative 'square/api/labor_api.rb'
-require_relative 'square/api/locations_api.rb'
-require_relative 'square/api/checkout_api.rb'
-require_relative 'square/api/transactions_api.rb'
-require_relative 'square/api/loyalty_api.rb'
-require_relative 'square/api/merchants_api.rb'
-require_relative 'square/api/orders_api.rb'
-require_relative 'square/api/payments_api.rb'
-require_relative 'square/api/refunds_api.rb'
-require_relative 'square/api/sites_api.rb'
-require_relative 'square/api/snippets_api.rb'
-require_relative 'square/api/subscriptions_api.rb'
-require_relative 'square/api/team_api.rb'
-require_relative 'square/api/terminal_api.rb'
+require_relative 'square/api/base_api'
+require_relative 'square/api/mobile_authorization_api'
+require_relative 'square/api/o_auth_api'
+require_relative 'square/api/v1_transactions_api'
+require_relative 'square/api/apple_pay_api'
+require_relative 'square/api/bank_accounts_api'
+require_relative 'square/api/bookings_api'
+require_relative 'square/api/cards_api'
+require_relative 'square/api/cash_drawers_api'
+require_relative 'square/api/catalog_api'
+require_relative 'square/api/customers_api'
+require_relative 'square/api/customer_groups_api'
+require_relative 'square/api/customer_segments_api'
+require_relative 'square/api/devices_api'
+require_relative 'square/api/disputes_api'
+require_relative 'square/api/employees_api'
+require_relative 'square/api/gift_cards_api'
+require_relative 'square/api/gift_card_activities_api'
+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/checkout_api'
+require_relative 'square/api/transactions_api'
+require_relative 'square/api/loyalty_api'
+require_relative 'square/api/merchants_api'
+require_relative 'square/api/orders_api'
+require_relative 'square/api/payments_api'
+require_relative 'square/api/refunds_api'
+require_relative 'square/api/sites_api'
+require_relative 'square/api/snippets_api'
+require_relative 'square/api/subscriptions_api'
+require_relative 'square/api/team_api'
+require_relative 'square/api/terminal_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 12.0.0.20210616
+  version: 15.0.0.20211020
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,6 @@ files:
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb
 - lib/square/api/transactions_api.rb
-- lib/square/api/v1_employees_api.rb
 - lib/square/api/v1_transactions_api.rb
 - lib/square/api_helper.rb
 - lib/square/client.rb
@@ -183,6 +182,7 @@ files:
 - lib/square/http/http_method_enum.rb
 - lib/square/http/http_request.rb
 - lib/square/http/http_response.rb
+- lib/square/utilities/date_time_helper.rb
 - lib/square/utilities/file_wrapper.rb
 - spec/user_journey_spec.rb
 - test/api/api_test_base.rb
@@ -208,14 +208,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: square