square.rb 14.1.0.20210915 → 17.0.0.20211215

data/lib/square/client.rb

@@ -4,13 +4,17 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '14.1.0.20210915'
+      '17.0.0.20211215'
     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
@@ -209,15 +213,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-09-15', access_token: 'TODO: Replace',
-                   additional_headers: {}, config: nil)
+                   square_version: '2021-12-15', access_token: '',
+                   user_agent_detail: '', 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,
@@ -226,6 +231,7 @@ module Square
                                     custom_url: custom_url,
                                     square_version: square_version,
                                     access_token: access_token,
+                                    user_agent_detail: user_agent_detail,
                                     additional_headers: additional_headers)
                 else
                   config

data/lib/square/configuration.rb

@@ -3,26 +3,28 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client, :timeout, :max_retries, :retry_interval, :backoff_factor,
-                :retry_statuses, :retry_methods, :environment, :custom_url, :square_version,
-                :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, :user_agent_detail
+
     def additional_headers
       @additional_headers.clone
     end
 
-
     class << self
       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-09-15', access_token: 'TODO: Replace',
-                   additional_headers: {})
+                   square_version: '2021-12-15', 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 value to use for connection timeout
       @timeout = timeout
 
@@ -61,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,
+                   user_agent_detail: nil, additional_headers: nil)
+      http_client_instance ||= self.http_client_instance
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -75,15 +79,18 @@ module Square
       custom_url ||= self.custom_url
       square_version ||= self.square_version
       access_token ||= self.access_token
+      user_agent_detail ||= self.user_agent_detail
       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,
                         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)
     end
 
@@ -92,7 +99,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
@@ -24,6 +42,7 @@ module Square
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout.positive?
       end
+      @connection
     end
 
     # Method overridden from HttpClient.

data/test/api/test_locations_api.rb

@@ -7,11 +7,8 @@ class LocationsApiTests < ApiTestBase
     @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Provides information of all locations of a business.
-  #
-  #Many Square API endpoints require a `location_id` parameter.
-  #The `id` field of the [`Location`]($m/Location) objects returned by this
-  #endpoint correspond to that `location_id` parameter.
+  # Provides details about all of the seller's locations,
+  #including those with an inactive status.
   def test_list_locations()
 
     # Perform the API call through the SDK function

data/test/test_helper.rb

@@ -82,7 +82,7 @@ class TestHelper
     unless @cache.keys.include? url  
       @cache[url] = Tempfile.new('APIMatic')
       @cache[url].binmode
-      @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
+      @cache[url].write(URI.open(url, {ssl_ca_cert: Certifi.where}).read)
     end
     return @cache[url].path
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 14.1.0.20210915
+  version: 17.0.0.20211215
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -209,9 +209,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="