square.rb 6.3.0.20200826 → 17.1.0.20220120

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

@@ -1,61 +1,65 @@
-require 'date'
-require 'json'
-require 'faraday'
-require 'certifi'
-require 'logging'
-
-require_relative 'square/api_helper.rb'
-require_relative 'square/client.rb'
-
-# Utilities
-require_relative 'square/utilities/file_wrapper.rb'
-
-# 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'
-
-# Models
-
-# Exceptions
-require_relative 'square/exceptions/api_exception.rb'
-
-require_relative 'square/configuration.rb'
-
-# 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_locations_api.rb'
-require_relative 'square/api/v1_employees_api.rb'
-require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/v1_items_api.rb'
-require_relative 'square/api/apple_pay_api.rb'
-require_relative 'square/api/bank_accounts_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/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/subscriptions_api.rb'
-require_relative 'square/api/team_api.rb'
-require_relative 'square/api/terminal_api.rb'
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'square/api_helper'
+require_relative 'square/client'
+
+# Utilities
+require_relative 'square/utilities/file_wrapper'
+require_relative 'square/utilities/date_time_helper'
+
+# Http
+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'
+
+require_relative 'square/configuration'
+
+# Controllers
+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'

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)

data/test/api/api_test_base.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 require 'json'
 require 'minitest/autorun'
 require 'minitest/hell'
@@ -19,6 +14,6 @@ class ApiTestBase < Minitest::Test
   # Create configuration and set any test parameters
   CONFIG = Configuration.new(
     access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
-    environment: "sandbox"
+    environment: 'sandbox'
   )
 end

data/test/api/test_catalog_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_customers_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_employees_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_labor_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -35,12 +32,11 @@ class LaborApiTests < ApiTestBase
   # Returns a paginated list of `EmployeeWage` instances for a business.
   def test_list_employee_wages()
     # Parameters for the API call
-    employee_id = nil
     limit = nil
     cursor = nil
 
     # Perform the API call through the SDK function
-    result = @controller.list_employee_wages(employee_id: employee_id, limit: limit, cursor: cursor)
+    result = @controller.list_employee_wages(limit: limit, cursor: cursor)
 
     # Test response code
     assert_equal(200, @response_catcher.response.status_code)

data/test/api/test_locations_api.rb

@@ -1,35 +1,21 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-require_relative 'api_test_base'
-
-class LocationsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
-  end
-
-  # Provides the details for all of a business's locations.
-  #
-  #Most other Connect API endpoints have a required `location_id` path parameter.
-  #The `id` field of the [`Location`](#type-location) objects returned by this
-  #endpoint correspond to that `location_id` parameter.
-  def test_test_list_locations()
-
-    # Perform the API call through the SDK function
-    result = @controller.list_locations()
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end
+require_relative 'api_test_base'
+
+class LocationsApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
+  end
+
+  # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
+  #including those with an inactive status.
+  def test_list_locations()
+
+    # Perform the API call through the SDK function
+    result = @controller.list_locations()
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+end

data/test/api/test_merchants_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_payments_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -12,8 +9,8 @@ class PaymentsApiTests < ApiTestBase
     @controller = PaymentsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Retrieves a list of payments taken by the account making the request.
-  #
+  # Retrieves a list of payments taken by the account making the request.
+  #
   #Max results per page: 100
   def test_test_list_payments()
     # Parameters for the API call

data/test/api/test_refunds_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -12,8 +9,8 @@ class RefundsApiTests < ApiTestBase
     @controller = RefundsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Retrieves a list of refunds for the account making the request.
-  #
+  # Retrieves a list of refunds for the account making the request.
+  #
   #Max results per page: 100
   def test_test_list_payment_refunds()
     # Parameters for the API call

data/test/http_response_catcher.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 class HttpResponseCatcher < Square::HttpCallBack
   attr_accessor :response
 

data/test/test_helper.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 require 'tempfile'
 require 'open-uri'
 
@@ -87,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