square.rb 3.3.0.20191217

data/lib/square/http/http_client.rb

@@ -0,0 +1,99 @@
+module Square
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/square/http/http_method_enum.rb

@@ -0,0 +1,8 @@
+module Square
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/square/http/http_request.rb

@@ -0,0 +1,45 @@
+module Square
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/square/http/http_response.rb

@@ -0,0 +1,24 @@
+module Square
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/square.rb

@@ -0,0 +1,49 @@
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'square/api_helper.rb'
+require_relative 'square/client.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/cash_drawers_api.rb'
+require_relative 'square/api/catalog_api.rb'
+require_relative 'square/api/customers_api.rb'
+require_relative 'square/api/employees_api.rb'
+require_relative 'square/api/inventory_api.rb'
+require_relative 'square/api/labor_api.rb'
+require_relative 'square/api/locations_api.rb'
+require_relative 'square/api/reporting_api.rb'
+require_relative 'square/api/checkout_api.rb'
+require_relative 'square/api/orders_api.rb'
+require_relative 'square/api/transactions_api.rb'
+require_relative 'square/api/merchants_api.rb'
+require_relative 'square/api/payments_api.rb'
+require_relative 'square/api/refunds_api.rb'

data/spec/user_journey_spec.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative '../test/api/api_test_base'
+require 'json'
+
+describe "UserJourney" do
+  let(:access_token) { ApiTestBase::CONFIG.access_token }
+  let(:environment) { ApiTestBase::CONFIG.environment }
+
+  let(:phone_number) { "1-212-555-4240" }
+  let(:phone_number2) { "1-917-500-1000" }
+  let(:postal_code) { "10003" }
+  let(:postal_code2) { "98100" }
+
+  let :customer do
+    {
+      "given_name": "Amelia",
+      "family_name": "Earhart",
+      "phone_number": phone_number,
+      "note": "a customer",
+      "address": {
+        "address_line_1": "500 Electric Ave",
+        "address_line_2": "Suite 600",
+        "locality": "New York",
+        "administrative_district_level_1": "NY",
+        "postal_code": postal_code,
+        "country": "US"
+      }
+    }
+  end
+
+  let :sq do
+    Square::Client.new(access_token: access_token, environment: environment)
+  end
+
+  let :unauthoerized_sq do
+    Square::Client.new(access_token: "bad_token")
+  end
+
+  let :customer2 do
+    tmp_customer = customer.clone
+    tmp_customer[:phone_number] = phone_number2
+    tmp_customer[:address][:postal_code] = postal_code2
+    tmp_customer
+  end
+
+  describe 'Response Object Verification' do
+    it "should contain following fields" do
+      response = sq.locations.list_locations
+      assert_equal response.status_code, 200
+      assert_includes response.body.to_h.keys, :locations
+      assert_equal response.data.to_h.keys, %i[locations]
+      assert_nil response.errors
+      assert_nil response.cursor
+    end
+  end
+
+  describe 'ListLocations' do
+    it 'should return success 200' do
+      assert_equal sq.locations.list_locations.status_code, 200
+    end
+  end
+
+  describe 'API Call Error' do
+    it 'should return error' do
+      response = unauthoerized_sq.locations.list_locations
+      assert_equal response.status_code, 401
+      assert_instance_of Array, response.errors
+      refute_nil response.errors
+    end
+  end
+
+  # There is no sandbox support for V1 endpoints as production token is required for the following tests
+  # describe 'V1 Category' do
+  #   it 'should succeed for each endpoint call' do
+  #     location_id = "your_location_id"
+  #     access_token = "your_production_access_token"
+  #     name1 = "fruit"
+  #     name2 = "drink"
+  #     api = Square::Client.new(access_token: access_token).v1_items
+  #
+  #     # create
+  #     response = api.create_category(location_id: location_id, body: {name: name1})
+  #     assert_equal response.data.name, name1
+  #     assert_nil response.errors
+  #     assert_equal response.status_code, 200
+  #
+  #     created_id = response.data.id
+  #
+  #     # list
+  #     response = api.list_categories(location_id: location_id)
+  #     assert_instance_of Array, response.data
+  #     assert_equal response.status_code, 200
+  #
+  #     # update
+  #     response = api.update_category(location_id: location_id, category_id: created_id, body: {name: name2})
+  #     assert_equal response.data.name, name2
+  #     assert_equal response.status_code, 200
+  #
+  #     # delete
+  #     response = api.delete_category(location_id: location_id, category_id: created_id)
+  #     assert_nil response.data
+  #     assert_equal response.status_code, 200
+  #   end
+  # end
+
+  describe 'V2 Customers' do
+    it 'should succeed for each endpoint call' do
+      # create
+      response = sq.customers.create_customer(body: customer)
+      assert_equal response.data.customer[:phone_number], phone_number
+
+      assert_equal response.status_code, 200
+      created_customer = response.data.customer
+
+      # retrieve
+      response = sq.customers.retrieve_customer(customer_id: created_customer[:id])
+      assert_equal response.data.customer[:phone_number], phone_number
+      assert_equal response.data.customer[:address][:postal_code], postal_code
+      assert_equal response.status_code, 200
+
+      # list
+      response = sq.customers.list_customers
+      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)
+      assert_equal response.data.customer[:phone_number], phone_number2
+      assert_equal response.data.customer[:address][:postal_code], postal_code2
+      assert_equal response.status_code, 200
+
+      # retrieve
+      response = sq.customers.retrieve_customer(customer_id: created_customer[:id])
+      assert_equal response.data.customer[:phone_number], phone_number2
+      assert_equal response.data.customer[:address][:postal_code], postal_code2
+      assert_equal response.status_code, 200
+
+      # delete
+      response = sq.customers.delete_customer(customer_id: created_customer[:id])
+      assert_equal response.data.to_h, {}
+      assert_equal response.status_code, 200
+    end
+  end
+end

data/test/api/api_test_base.rb

@@ -0,0 +1,24 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'square'
+require_relative '../test_helper'
+require_relative '../http_response_catcher'
+
+class ApiTestBase < Minitest::Test
+  parallelize_me!
+  include Square
+
+  # Create configuration and set any test parameters
+  CONFIG = Configuration.new(
+    access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
+    environment: "sandbox"
+  )
+end

data/test/api/test_catalog_api.rb

@@ -0,0 +1,59 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'api_test_base'
+
+class CatalogApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = CatalogApi.new CONFIG, http_call_back: @response_catcher
+  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(TestHelper.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(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/api/test_customers_api.rb

@@ -0,0 +1,45 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'api_test_base'
+
+class CustomersApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = CustomersApi.new CONFIG, http_call_back: @response_catcher
+  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/api/test_employees_api.rb

@@ -0,0 +1,36 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'api_test_base'
+
+class EmployeesApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = EmployeesApi.new CONFIG, http_call_back: @response_catcher
+  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(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/api/test_labor_api.rb

@@ -0,0 +1,74 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'api_test_base'
+
+class LaborApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = LaborApi.new CONFIG, http_call_back: @response_catcher
+  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(TestHelper.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
+    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)
+
+    # 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
+
+  # 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(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/api/test_locations_api.rb

@@ -0,0 +1,35 @@
+# 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