square.rb 44.1.0.20250924 → 45.0.1.20260122

data/test/square/internal/types/test_utils.rb

@@ -1,216 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-describe Square::Internal::Types::Utils do
-  Utils = Square::Internal::Types::Utils
-
-  module TestUtils
-    class M < Square::Internal::Types::Model
-      field :value, String
-    end
-
-    class UnionMemberA < Square::Internal::Types::Model
-      literal :type, "A"
-      field :only_on_a, String
-    end
-
-    class UnionMemberB < Square::Internal::Types::Model
-      literal :type, "B"
-      field :only_on_b, String
-    end
-
-    module U
-      extend Square::Internal::Types::Union
-
-      discriminant :type
-
-      member -> { UnionMemberA }, key: "A"
-      member -> { UnionMemberB }, key: "B"
-    end
-
-    SymbolStringHash = Square::Internal::Types::Hash[Symbol, String]
-    SymbolModelHash = -> { Square::Internal::Types::Hash[Symbol, TestUtils::M] }
-  end
-
-  describe ".coerce" do
-    describe "NilClass" do
-      it "always returns nil" do
-        assert_nil Utils.coerce(NilClass, "foobar")
-        assert_nil Utils.coerce(NilClass, 1)
-        assert_nil Utils.coerce(NilClass, Object.new)
-      end
-    end
-
-    describe "String" do
-      it "coerces from String, Symbol, Numeric, or Boolean" do
-        assert_equal "foobar", Utils.coerce(String, "foobar")
-        assert_equal "foobar", Utils.coerce(String, :foobar)
-        assert_equal "1", Utils.coerce(String, 1)
-        assert_equal "1.0", Utils.coerce(String, 1.0)
-        assert_equal "true", Utils.coerce(String, true)
-      end
-
-      it "passes through value if it cannot be coerced and not strict" do
-        obj = Object.new
-
-        assert_equal obj, Utils.coerce(String, obj)
-      end
-
-      it "raises an error if value cannot be coerced and strict" do
-        assert_raises Square::Internal::Errors::TypeError do
-          Utils.coerce(String, Object.new, strict: true)
-        end
-      end
-    end
-
-    describe "Symbol" do
-      it "coerces from Symbol, String" do
-        assert_equal :foobar, Utils.coerce(Symbol, :foobar)
-        assert_equal :foobar, Utils.coerce(Symbol, "foobar")
-      end
-
-      it "passes through value if it cannot be coerced and not strict" do
-        obj = Object.new
-
-        assert_equal obj, Utils.coerce(Symbol, obj)
-      end
-
-      it "raises an error if value cannot be coerced and strict" do
-        assert_raises Square::Internal::Errors::TypeError do
-          Utils.coerce(Symbol, Object.new, strict: true)
-        end
-      end
-    end
-
-    describe "Integer" do
-      it "coerces from Numeric, String, Time" do
-        assert_equal 1, Utils.coerce(Integer, 1)
-        assert_equal 1, Utils.coerce(Integer, 1.0)
-        assert_equal 1, Utils.coerce(Integer, Complex.rect(1))
-        assert_equal 1, Utils.coerce(Integer, Rational(1))
-        assert_equal 1, Utils.coerce(Integer, "1")
-        assert_equal 1_713_916_800, Utils.coerce(Integer, Time.utc(2024, 4, 24))
-      end
-
-      it "passes through value if it cannot be coerced and not strict" do
-        obj = Object.new
-
-        assert_equal obj, Utils.coerce(Integer, obj)
-      end
-
-      it "raises an error if value cannot be coerced and strict" do
-        assert_raises Square::Internal::Errors::TypeError do
-          Utils.coerce(Integer, Object.new, strict: true)
-        end
-      end
-    end
-
-    describe "Float" do
-      it "coerces from Numeric, Time" do
-        assert_in_delta(1.0, Utils.coerce(Float, 1.0))
-        assert_in_delta(1.0, Utils.coerce(Float, 1))
-        assert_in_delta(1.0, Utils.coerce(Float, Complex.rect(1)))
-        assert_in_delta(1.0, Utils.coerce(Float, Rational(1)))
-        assert_in_delta(1_713_916_800.0, Utils.coerce(Integer, Time.utc(2024, 4, 24)))
-      end
-
-      it "passes through value if it cannot be coerced and not strict" do
-        obj = Object.new
-
-        assert_equal obj, Utils.coerce(Float, obj)
-      end
-
-      it "raises an error if value cannot be coerced and strict" do
-        assert_raises Square::Internal::Errors::TypeError do
-          Utils.coerce(Float, Object.new, strict: true)
-        end
-      end
-    end
-
-    describe "Model" do
-      it "coerces a hash" do
-        result = Utils.coerce(TestUtils::M, { value: "foobar" })
-
-        assert_kind_of TestUtils::M, result
-        assert_equal "foobar", result.value
-      end
-
-      it "coerces a hash when the target is a type function" do
-        result = Utils.coerce(-> { TestUtils::M }, { value: "foobar" })
-
-        assert_kind_of TestUtils::M, result
-        assert_equal "foobar", result.value
-      end
-
-      it "will not coerce non-hashes" do
-        assert_equal "foobar", Utils.coerce(TestUtils::M, "foobar")
-      end
-    end
-
-    describe "Enum" do
-      module ExampleEnum
-        extend Square::Internal::Types::Enum
-
-        FOO = :FOO
-        BAR = :BAR
-
-        finalize!
-      end
-
-      it "coerces into a Symbol version of the member value" do
-        assert_equal :FOO, Utils.coerce(ExampleEnum, "FOO")
-      end
-
-      it "returns given value if not a member" do
-        assert_equal "NOPE", Utils.coerce(ExampleEnum, "NOPE")
-      end
-    end
-
-    describe "Array" do
-      StringArray = Square::Internal::Types::Array[String]
-      ModelArray = -> { Square::Internal::Types::Array[TestUtils::M] }
-      UnionArray = -> { Square::Internal::Types::Array[TestUtils::U] }
-
-      it "coerces an array of literals" do
-        skip "TODO: Fix me!"
-
-        assert_equal %w[a b c], Utils.coerce(StringArray, %w[a b c])
-        assert_equal ["1", "2.0", "true"], Utils.coerce(StringArray, [1, 2.0, true])
-        assert_equal ["1", "2.0", "true"], Utils.coerce(StringArray, Set.new([1, 2.0, true]))
-      end
-
-      it "coerces an array of Models" do
-        assert_equal [TestUtils::M.new(value: "foobar"), TestUtils::M.new(value: "bizbaz")],
-                     Utils.coerce(ModelArray, [{ value: "foobar" }, { value: "bizbaz" }])
-
-        assert_equal [TestUtils::M.new(value: "foobar"), TestUtils::M.new(value: "bizbaz")],
-                     Utils.coerce(ModelArray, [TestUtils::M.new(value: "foobar"), TestUtils::M.new(value: "bizbaz")])
-      end
-
-      it "coerces an array of model unions" do
-        assert_equal [TestUtils::UnionMemberA.new(type: "A", only_on_a: "A"), TestUtils::UnionMemberB.new(type: "B", only_on_b: "B")],
-                     Utils.coerce(UnionArray, [{ type: "A", only_on_a: "A" }, { type: "B", only_on_b: "B" }])
-      end
-
-      it "returns given value if not an array" do
-        skip "TODO: Fix me!"
-
-        assert_equal 1, Utils.coerce(StringArray, 1)
-      end
-    end
-
-    describe "Hash" do
-      it "coerces the keys and values" do
-        ssh_res = Utils.coerce(TestUtils::SymbolStringHash, { "foo" => "bar", "biz" => "2" })
-
-        assert_equal "bar", ssh_res[:foo]
-        assert_equal "2", ssh_res[:biz]
-
-        smh_res = Utils.coerce(TestUtils::SymbolModelHash, { "foo" => { "value" => "foo" } })
-
-        assert_equal TestUtils::M.new(value: "foo"), smh_res[:foo]
-      end
-    end
-  end
-end

data/test/square_legacy/api/api_test_base.rb

@@ -1,27 +0,0 @@
-require 'json'
-require 'minitest/autorun'
-require 'minitest/hell'
-require 'minitest/pride'
-require 'minitest/proveit'
-require 'square_legacy'
-require_relative '../http_response_catcher'
-
-class ApiTestBase < Minitest::Test
-  parallelize_me!
-  include SquareLegacy
-  include CoreLibrary
-
-  # Create configuration and set any test parameters
-  def create_configuration
-    Configuration.new(
-      access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
-      environment: 'sandbox', http_callback: HttpResponseCatcher.new
-    )
-  end
-
-  # Initializes the base test controller
-  def setup_class
-    _config = create_configuration
-    @client = Client.new(config: _config)
-  end
-end

data/test/square_legacy/api/test_catalog_api.rb

@@ -1,57 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class CatalogApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.catalog
-    @response_catcher = @controller.http_call_back
-  end
-
-  # Returns information about the Square Catalog API, such as batch size
-  #limits for `BatchUpsertCatalogObjects`.
-  def test_test_catalog_info()
-
-    # Perform the API call through the SDK function
-    result = @controller.catalog_info()
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-  # Returns a list of [CatalogObject](#type-catalogobject)s that includes
-  #all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem)
-  #and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter
-  #is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types:
-  #`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.
-  #
-  #__Important:__ ListCatalog does not return deleted catalog items. To retrieve
-  #deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects`
-  #to `true`.
-  def test_test_list_catalog()
-    # Parameters for the API call
-    cursor = nil
-    types = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_catalog(cursor: cursor, types: types)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end

data/test/square_legacy/api/test_customers_api.rb

@@ -1,43 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class CustomersApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.customers
-    @response_catcher = @controller.http_call_back
-  end
-
-  # Creates a new customer for a business, which can have associated cards on file.
-  #
-  #You must provide __at least one__ of the following values in your request to this
-  #endpoint:
-  #
-  #- `given_name`
-  #- `family_name`
-  #- `company_name`
-  #- `email_address`
-  #- `phone_number`
-  #
-  #This endpoint does not accept an idempotency key. If you accidentally create
-  #a duplicate customer, you can delete it with the
-  #[DeleteCustomer](#endpoint-deletecustomer) endpoint.
-  def test_create_customer()
-    # Parameters for the API call
-    body = APIHelper.json_deserialize(
-      '{"given_name":"Amelia","family_name":"Earhart","email_address":"Amelia.Ear'\
-      'hart@example.com","address":{"address_line_1":"500 Electric Ave","address_l'\
-      'ine_2":"Suite 600","locality":"New York"},"phone_number":"1-212-555-4240","'\
-      'reference_id":"YOUR_REFERENCE_ID","note":"a customer"}'
-      )
-
-    # Perform the API call through the SDK function
-    result = @controller.create_customer(body: body)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-  end
-
-end

data/test/square_legacy/api/test_employees_api.rb

@@ -1,34 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class EmployeesApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.employees
-    @response_catcher = @controller.http_call_back
-  end
-
-  # Gets a list of `Employee` objects for a business.
-  def test_test_list_employees()
-    # Parameters for the API call
-    location_id = nil
-    status = nil
-    limit = nil
-    cursor = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_employees(location_id: location_id, status: status, limit: limit, cursor: cursor)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end

data/test/square_legacy/api/test_labor_api.rb

@@ -1,82 +0,0 @@
-require_relative 'api_test_base'
-
-class LaborApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.labor
-    @response_catcher = @controller.http_call_back
-  end
-
-  # Returns a paginated list of `BreakType` instances for a business.
-  def test_list_break_types()
-    # Parameters for the API call
-    location_id = nil
-    limit = nil
-    cursor = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_break_types(location_id: location_id, limit: limit, cursor: cursor)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-  # Returns a paginated list of `EmployeeWage` instances for a business.
-  def test_list_employee_wages()
-    # Parameters for the API call
-    limit = nil
-    cursor = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_employee_wages(limit: limit, cursor: cursor)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-  # Returns a list of `WorkweekConfig` instances for a business.
-  def test_list_workweek_configs()
-    # Parameters for the API call
-    limit = nil
-    cursor = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_workweek_configs(limit: limit, cursor: cursor)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-  def test_search_timecards()
-    # Perform the API call through the SDK function
-    result = @controller.search_timecards(body: {limit: 100})
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-end

data/test/square_legacy/api/test_locations_api.rb

@@ -1,22 +0,0 @@
-require_relative 'api_test_base'
-
-class LocationsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.locations
-    @response_catcher = @controller.http_call_back
-  end
-
-  # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
-  #including those with an inactive status. Locations are listed alphabetically by `name`.
-  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/square_legacy/api/test_merchants_api.rb

@@ -1,38 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class MerchantsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.merchants
-    @response_catcher = @controller.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.
-  #
-  #If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant)
-  #endpoint to get the merchant information.
-  def test_list_merchants()
-    # Parameters for the API call
-    cursor = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_merchants(cursor: cursor)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end

data/test/square_legacy/api/test_payments_api.rb

@@ -1,40 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class PaymentsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.payments
-    @response_catcher = @controller.http_call_back
-  end
-
-  # 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
-    begin_time = nil
-    end_time = nil
-    sort_order = nil
-    cursor = nil
-    location_id = nil
-    total = nil
-    last_4 = nil
-    card_brand = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_payments(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, total: total, last_4: last_4, card_brand: card_brand)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end

data/test/square_legacy/api/test_refunds_api.rb

@@ -1,42 +0,0 @@
-
-
-require_relative 'api_test_base'
-
-class RefundsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    setup_class
-    @controller = @client.refunds
-    @response_catcher = @controller.http_call_back
-  end
-
-  # 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
-    begin_time = nil
-    end_time = nil
-    sort_order = nil
-    cursor = nil
-    location_id = nil
-    status = nil
-    source_type = nil
-    updated_at_begin_time = nil
-    updated_at_end_time = nil
-    sort_field = nil
-
-    # Perform the API call through the SDK function
-    result = @controller.list_payment_refunds(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, status: status, source_type: source_type, updated_at_begin_time: updated_at_begin_time, updated_at_end_time: updated_at_end_time, sort_field: sort_field)
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end

data/test/square_legacy/http_response_catcher.rb

@@ -1,14 +0,0 @@
-class HttpResponseCatcher < SquareLegacy::HttpCallBack
-  attr_accessor :response
-
-  def on_before_request(request)
-  end
-
-  # Catching the response
-  def on_after_response(response)
-    @response = response
-  end
-end
-
-
-