square.rb 6.0.0.20200625 → 6.5.0.20201028

data/lib/square/api/v1_locations_api.rb

@@ -30,7 +30,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides details for all business locations associated with a Square
@@ -59,7 +61,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/v1_transactions_api.rb

@@ -18,7 +18,7 @@ module Square
       _query_builder << '/v1/{location_id}/bank-accounts'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -38,7 +38,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides non-confidential details for a merchant's associated bank
@@ -58,8 +60,8 @@ module Square
       _query_builder << '/v1/{location_id}/bank-accounts/{bank_account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'bank_account_id' => bank_account_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'bank_account_id' => { 'value' => bank_account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -79,7 +81,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides summary information for a merchant's online store orders.
@@ -102,7 +106,7 @@ module Square
       _query_builder << '/v1/{location_id}/orders'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -128,7 +132,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single online store order,
@@ -146,8 +152,8 @@ module Square
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -167,7 +173,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates the details of an online store order. Every update you perform on
@@ -189,8 +197,8 @@ module Square
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -212,7 +220,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides summary information for all payments taken for a given
@@ -260,7 +270,7 @@ module Square
       _query_builder << '/v1/{location_id}/payments'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -289,7 +299,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single payment.
@@ -307,8 +319,8 @@ module Square
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'payment_id' => payment_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -328,7 +340,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides the details for all refunds initiated by a merchant or any of the
@@ -366,7 +380,7 @@ module Square
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -394,7 +408,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Issues a refund for a previously processed payment. You must issue
@@ -420,7 +436,7 @@ module Square
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -442,7 +458,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides summary information for all deposits and withdrawals
@@ -485,7 +503,7 @@ module Square
       _query_builder << '/v1/{location_id}/settlements'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -514,7 +532,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single settlement.
@@ -545,8 +565,8 @@ module Square
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'settlement_id' => settlement_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'settlement_id' => { 'value' => settlement_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -566,7 +586,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api_helper.rb

@@ -36,17 +36,22 @@ module Square
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
-      # Iterate and append parameters.
-      parameters.each do |key, value|
-        replace_value = ''
-
-        if value.nil?
+      parameters.each do |key, val|
+        if val.nil?
           replace_value = ''
-        elsif value.instance_of? Array
-          value.map! { |element| CGI.escape(element.to_s) }
-          replace_value = value.join('/')
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
         else
-          replace_value = CGI.escape(value.to_s)
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
         end
 
         # Find the template parameter and replace it with its value.

data/lib/square/client.rb

@@ -4,11 +4,11 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.0.0.20200625'
+      '6.5.0.20201028'
     end
 
     def square_version
-      '2020-06-25'
+      config.square_version
     end
 
     # Access to mobile_authorization controller.
@@ -113,6 +113,12 @@ module Square
       @inventory ||= InventoryApi.new config
     end
 
+    # Access to invoices controller.
+    # @return [InvoicesApi] Returns the controller instance.
+    def invoices
+      @invoices ||= InvoicesApi.new config
+    end
+
     # Access to labor controller.
     # @return [LaborApi] Returns the controller instance.
     def labor
@@ -125,24 +131,12 @@ module Square
       @locations ||= LocationsApi.new config
     end
 
-    # Access to reporting controller.
-    # @return [ReportingApi] Returns the controller instance.
-    def reporting
-      @reporting ||= ReportingApi.new config
-    end
-
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
       @checkout ||= CheckoutApi.new config
     end
 
-    # Access to orders controller.
-    # @return [OrdersApi] Returns the controller instance.
-    def orders
-      @orders ||= OrdersApi.new config
-    end
-
     # Access to transactions controller.
     # @return [TransactionsApi] Returns the controller instance.
     def transactions
@@ -161,6 +155,12 @@ module Square
       @merchants ||= MerchantsApi.new config
     end
 
+    # Access to orders controller.
+    # @return [OrdersApi] Returns the controller instance.
+    def orders
+      @orders ||= OrdersApi.new config
+    end
+
     # Access to payments controller.
     # @return [PaymentsApi] Returns the controller instance.
     def payments
@@ -173,6 +173,12 @@ module Square
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to subscriptions controller.
+    # @return [SubscriptionsApi] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsApi.new config
+    end
+
     # Access to team controller.
     # @return [TeamApi] Returns the controller instance.
     def team
@@ -187,13 +193,14 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {},
-                   config: nil)
+                   square_version: '2020-10-28', access_token: 'TODO: Replace',
+                   additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     environment: environment,
+                                    square_version: square_version,
                                     access_token: access_token,
                                     additional_headers: additional_headers)
                 else

data/lib/square/configuration.rb

@@ -9,6 +9,7 @@ module Square
     attr_reader :retry_interval
     attr_reader :backoff_factor
     attr_reader :environment
+    attr_reader :square_version
     attr_reader :access_token
 
     def additional_headers
@@ -21,7 +22,8 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {})
+                   square_version: '2020-10-28', access_token: 'TODO: Replace',
+                   additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -38,6 +40,9 @@ module Square
       # Current API environment
       @environment = String(environment)
 
+      # Square Connect API versions
+      @square_version = square_version
+
       # OAuth 2.0 Access Token
       @access_token = access_token
 
@@ -49,20 +54,23 @@ module Square
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, access_token: nil,
-                   additional_headers: nil)
+                   backoff_factor: nil, environment: nil, square_version: nil,
+                   access_token: nil, additional_headers: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
       environment ||= self.environment
+      square_version ||= self.square_version
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
       Configuration.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
-                        environment: environment, access_token: access_token,
+                        environment: environment,
+                        square_version: square_version,
+                        access_token: access_token,
                         additional_headers: additional_headers)
     end
 

data/lib/square/http/api_response.rb

@@ -34,10 +34,12 @@ module Square
       end
     end
 
+    # returns true if status_code is between 200-300
     def success?
       status_code >= 200 && status_code < 300
     end
 
+    # returns true if status_code is between 400-600
     def error?
       status_code >= 400 && status_code < 600
     end

data/lib/square/http/faraday_client.rb

@@ -10,6 +10,7 @@ module Square
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use :gzip
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where

data/spec/user_journey_spec.rb

@@ -121,11 +121,8 @@ describe "UserJourney" do
 
       # list
       response = sq.customers.list_customers
-      if response.data != nil
-        assert_equal response.data.to_h.keys, %i[customers]
-        assert_equal response.status_code, 200
-      end
-
+      assert_equal response.data.to_h.keys, %i[customers]
+      assert_equal response.status_code, 200
 
       # update
       response = sq.customers.update_customer(customer_id: created_customer[:id], body: customer2)