square.rb 43.0.1.20250716 → 44.0.0.0

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

@@ -0,0 +1,216 @@
+# 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/{api → square_legacy/api}/api_test_base.rb

@@ -3,12 +3,12 @@ require 'minitest/autorun'
 require 'minitest/hell'
 require 'minitest/pride'
 require 'minitest/proveit'
-require 'square'
+require 'square_legacy'
 require_relative '../http_response_catcher'
 
 class ApiTestBase < Minitest::Test
   parallelize_me!
-  include Square
+  include SquareLegacy
   include CoreLibrary
 
   # Create configuration and set any test parameters

data/test/{http_response_catcher.rb → square_legacy/http_response_catcher.rb}

@@ -1,4 +1,4 @@
-class HttpResponseCatcher < Square::HttpCallBack
+class HttpResponseCatcher < SquareLegacy::HttpCallBack
   attr_accessor :response
 
   def on_before_request(request)

data/test/{webhooks → square_legacy/webhooks}/test_webhooks_helper.rb

@@ -1,4 +1,4 @@
-require_relative '../../lib/square/utilities/webhooks_helper.rb'
+require_relative '../../../lib/square_legacy/utilities/webhooks_helper.rb'
 require 'minitest/autorun'
 require 'minitest/hell'
 require 'minitest/pride'
@@ -18,7 +18,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_signature_validation_pass
     @logger.info('Running test_signature_validation_pass') # Log a message
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       @request_body,
       @signature_header,
       @signature_key,
@@ -35,7 +35,7 @@ class WebhooksHelperTest < Minitest::Test
     signatureKey = "signature-key";
     url = "https://webhook.site/webhooks";
 
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       escpaedRequestBody,
       newSignatureHeader,
       signatureKey,
@@ -46,7 +46,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_signature_validation_fails_on_notification_url_mismatch
     @logger.info('Running test_signature_validation_fails_on_notification_url_mismatch') # Log a message
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       @request_body,
       @signature_header,
       @signature_key,
@@ -57,7 +57,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_signature_validation_fails_on_invalid_signature_key
     @logger.info('Running test_signature_validation_fails_on_invalid_signature_key') # Log a message
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       @request_body,
       @signature_header,
       'MCmhFRxGX82xMwg5FsaoQA',
@@ -67,7 +67,7 @@ class WebhooksHelperTest < Minitest::Test
   end
 
   def test_signature_validation_fails_on_invalid_signature_header
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       @request_body,
       '1z2n3DEJJiUPKcPzQo1ftvbxGdw=',
       @signature_key,
@@ -78,7 +78,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_signature_validation_fails_on_request_body_mismatch
     request_body = '{"merchant_id":"MLEFBHHSJGVHD","type":"webhooks.test_notification","event_id":"ac3ac95b-f97d-458c-a6e6-18981597e05f","created_at":"2022-06-13T20:30:59.037339943Z","data":{"type":"webhooks","id":"bc368e64-01aa-407e-b46e-3231809b1129"}}'
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       request_body,
       @signature_header,
       @signature_key,
@@ -98,7 +98,7 @@ class WebhooksHelperTest < Minitest::Test
                 "id": "bc368e64-01aa-407e-b46e-3231809b1129"
             }
         }'
-    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+    is_valid = SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
       request_body,
       @signature_header,
       @signature_key,
@@ -109,7 +109,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_throws_error_on_empty_signature_key
     assert_raises(RuntimeError, 'signature_key is null or empty') do
-      Square::WebhooksHelper.is_valid_webhook_event_signature(
+      SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
         @request_body,
         @signature_header,
         '',
@@ -120,7 +120,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_throws_error_on_signature_key_not_configured
     assert_raises(RuntimeError) do
-      Square::WebhooksHelper.is_valid_webhook_event_signature(
+      SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
         @request_body,
         @signature_header,
         nil,
@@ -131,7 +131,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_throws_error_on_empty_notification_url
     assert_raises(RuntimeError, 'notification_url is null or empty') do
-      Square::WebhooksHelper.is_valid_webhook_event_signature(
+      SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
         @request_body,
         @signature_header,
         @signature_key,
@@ -142,7 +142,7 @@ class WebhooksHelperTest < Minitest::Test
 
   def test_throws_error_on_notification_url_not_configured
     assert_raises(RuntimeError) do
-      Square::WebhooksHelper.is_valid_webhook_event_signature(
+      SquareLegacy::WebhooksHelper.is_valid_webhook_event_signature(
         @request_body,
         @signature_header,
         @signature_key,

data/test/test_helper.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "minitest/rg"
+require_relative "../lib/square"
+
+def test_token
+  @test_token ||= ENV.fetch("SQUARE_TOKEN", nil) || ENV.fetch("TEST_SQUARE_TOKEN", nil) || ENV.fetch("SQUARE_SANDBOX_TOKEN", nil) || "test_token"
+end
+
+def client
+  @client ||= Square::Client.new(
+    token: test_token,
+    base_url: Square::Environment::SANDBOX
+  )
+end
+
+def verbose_mode?
+  @verbose_mode ||= ENV.fetch("VERBOSE", "false") == "true"
+end
+
+def minitest_verbose?
+  return false unless defined?(Minitest)
+  
+  # Check TESTOPTS environment variable for --verbose flag
+  ENV['TESTOPTS']&.include?('--verbose') || ARGV.include?('--verbose')
+end
+
+def verbose?
+  verbose_mode? || minitest_verbose?
+end
+
+def new_test_uuid
+  SecureRandom.uuid
+end
+
+def new_test_square_temp_id
+  "##{SecureRandom.uuid}"
+end
+
+def new_test_money(amount)
+  Square::Types::Money.new(
+    amount: amount,
+    currency: 'USD'
+  )
+end
+
+def get_test_file
+  file_path = File.join(__dir__, 'testdata', 'image.jpeg')
+  File.open(file_path, 'rb')
+end
+
+def get_default_location_id(client)
+  response = client.locations.list
+  response.locations.first.id
+end
+
+def create_location(client)
+  response = client.locations.create(
+    location: {
+      name: "Test Location #{new_test_uuid}"
+    }
+  )
+  response.location.id
+end
+
+def create_test_catalog_item(opts = {})
+  variation = Square::Types::CatalogObject.new(
+    type: 'ITEM_VARIATION',
+    id: "##{new_test_uuid}",
+    present_at_all_locations: true,
+    item_variation_data: {
+      name: opts[:variation_name] || "Variation #{new_test_uuid}",
+      track_inventory: true,
+      pricing_type: 'FIXED_PRICING',
+      price_money: {
+        amount: opts[:price] || 1000,
+        currency: opts[:currency] || 'USD'
+      }
+    }
+  )
+
+  Square::Types::CatalogObject.new(
+    type: 'ITEM',
+    id: "##{new_test_uuid}",
+    present_at_all_locations: true,
+    item_data: {
+      name: opts[:name] || "Item #{new_test_uuid}",
+      description: opts[:description] || 'Test item description',
+      abbreviation: opts[:abbreviation] || 'TST',
+      variations: [variation]
+    }
+  )
+end
+
+def test_address
+  Square::Types::Address.new(
+    address_line_1: '500 Electric Ave',
+    address_line_2: 'Suite 600',
+    locality: 'New York',
+    administrative_district_level_1: 'NY',
+    postal_code: '10003',
+    country: 'US'
+  )
+end
+
+def create_test_customer_request
+  Square::Types::CustomerRequest.new(
+    idempotency_key: new_test_uuid,
+    given_name: 'Amelia',
+    family_name: 'Earhart',
+    phone_number: '1-212-555-4240',
+    note: 'test customer',
+    address: test_address
+  )
+end
+
+def create_test_customer(client)
+  response = client.customers.create(create_test_customer_request)
+  response.customer.id
+end
+
+