square-ruby 0.1.0

data/lib/square/api_operations/retrieve.rb

@@ -0,0 +1,21 @@
+module Square
+  module APIOperations
+    module Retrieve
+      # Retrieve a resource.
+      #
+      # @param id [String] ID of the resource to retrieve.
+      # @param params [Hash] Hash of query params. Optional.
+      #
+      # @return [Square::DataType]
+      def retrieve(id, params = {})
+        response = Square.make_request(
+          endpoint: self.generate_endpoint_url(id),
+          params: params
+        )
+
+        response = Square.parse_response(response)
+        @data_type.new(response)
+      end
+    end
+  end
+end

data/lib/square/api_operations/update.rb

@@ -0,0 +1,25 @@
+module Square
+  module APIOperations
+    module Update
+      # Update a resource.
+      #
+      # @param id [String] ID of the resource to update.
+      # @param parent_id [String] ID of the 'parent' to update. Optional.
+      # @param params [Hash] Payload. Optional.
+      #
+      # @return [Square::DataType]
+      def update(*args, params)
+        id, parent_id = args
+
+        response = Square.make_request(
+          method: 'PUT',
+          endpoint: self.generate_endpoint_url(id, parent_id),
+          payload: params
+        )
+
+        response = Square.parse_response(response)
+        @data_type.new(response)
+      end
+    end
+  end
+end

data/lib/square/api_resource.rb

@@ -0,0 +1,55 @@
+module Square
+  class APIResource
+    # Set a data_type property for this resource.
+    #
+    # @param data_type [Square::DataType] Data type. Optional.
+    #
+    # @return [Square::DataType]
+    def self.data_type(data_type = nil)
+      if !data_type.nil?
+        @data_type = data_type
+      end
+
+      @data_type
+    end
+
+    # Set an endpoint base for this resource.
+    #
+    # @param base [String] API endpoint. Optional.
+    #
+    # @return [String]
+    def self.endpoint_base(base = nil)
+      if !base.nil?
+        @endpoint_base = base
+      end
+
+      @endpoint_base
+    end
+
+    # Set a property for nested resources.
+    #
+    # @param parent [String] API 'parent' endpoint. Optional.
+    #
+    # @return [String]
+    def self.nested_under(parent = nil)
+      if !parent.nil?
+        @nested_under = parent
+      end
+
+      @nested_under
+    end
+
+    private
+
+    # Generate an endpoint based on provided arguments.
+    #
+    # @param id [String] Resource ID. Optional.
+    # @param parent_id [String] ID of the 'parent' resource. Optional.
+    #
+    # @return [String] Endpoint URL.
+    def self.generate_endpoint_url(*args)
+      id, parent_id = args
+      File.join([@nested_under, parent_id, @endpoint_base, id].compact)
+    end
+  end
+end

data/lib/square/bank_accounts.rb

@@ -0,0 +1,10 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-bankaccounts
+  class BankAccount < APIResource
+    extend Square::APIOperations::List
+    extend Square::APIOperations::Retrieve
+
+    endpoint_base 'bank-accounts'
+    data_type Square::DataTypes::BankAccount
+  end
+end

data/lib/square/category.rb

@@ -0,0 +1,12 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-categories
+  class Category < APIResource
+    extend Square::APIOperations::List
+    extend Square::APIOperations::Create
+    extend Square::APIOperations::Update
+    extend Square::APIOperations::Delete
+
+    endpoint_base 'categories'
+    data_type Square::DataTypes::Category
+  end
+end

data/lib/square/data_type.rb

@@ -0,0 +1,7 @@
+module Square
+  class DataType < Hashie::Dash
+    include Hashie::Extensions::Dash::Coercion
+    include Hashie::Extensions::IndifferentAccess
+    include Hashie::Extensions::IgnoreUndeclared
+  end
+end

data/lib/square/data_types/bank_account.rb

@@ -0,0 +1,32 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatypes
+    class BankAccount < Square::DataType
+      # The bank account's Square-issued ID.
+      property :id
+
+      # The Square-issued ID of the merchant associated with the bank account.
+      property :merchant_id
+
+      # The name of the bank that manages the account.
+      property :bank_name
+
+      # The name associated with the bank account.
+      property :name
+
+      # The bank account's type (for example, savings or checking).
+      property :type # BankAccount.Type
+
+      # The bank account's routing number.
+      property :routing_number
+
+      # The last few digits of the bank account number.
+      property :account_number_suffix
+
+      # The currency code of the currency associated with the bank account,
+      # in ISO 4217 format. For example, the currency code for US dollars
+      # is USD.
+      property :currency_code
+    end
+  end
+end

data/lib/square/data_types/category.rb

@@ -0,0 +1,12 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-category
+    class Category < Square::DataType
+      # The category's unique ID.
+      property :id
+
+      # The category's name.
+      property :name
+    end
+  end
+end

data/lib/square/data_types/coordinates.rb

@@ -0,0 +1,12 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-coordinates
+    class Coordinates < Square::DataType
+      # The latitude coordinate, in degrees.
+      property :latitude # number
+
+      # The longitude coordinate, in degrees.
+      property :longitude # number
+    end
+  end
+end

data/lib/square/data_types/device.rb

@@ -0,0 +1,12 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-device
+    class Device < DataType
+      # The device's merchant-specified name.
+      property :name
+
+      # The device's Square-issued ID.
+      property :id
+    end
+  end
+end

data/lib/square/data_types/discount.rb

@@ -0,0 +1,36 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-discount
+    class Discount < Square::DataType
+      # The discount's unique ID.
+      property :id
+
+      # The discount's name.
+      property :name
+
+      # The rate of the discount, as a string representation of a decimal
+      # number. A value of 0.07 corresponds to a rate of 7%. This rate is
+      # 0 if discount_type is VARIABLE_PERCENTAGE.
+      # This field is not included for amount-based discounts.
+      property :rate
+
+      # The amount of the discount. This amount is 0 if discount_type is
+      # VARIABLE_AMOUNT.
+      # This field is not included for rate-based discounts.
+      property :amount_money, coerce: Square::DataTypes::Money
+
+      # Indicates whether the discount is a FIXED value or entered at the
+      # time of sale.
+      property :discount_type # Discount.Type
+
+      # Indicates whether a mobile staff member needs to enter their PIN to
+      # apply the discount to a payment.
+      property :pin_required # boolean
+
+      # The color of the discount's display label in Square Register, if not
+      # the default color.
+      # The default color is 9da2a6.
+      property :color # Item.Color
+    end
+  end
+end

data/lib/square/data_types/fee.rb

@@ -0,0 +1,39 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-fee
+    class Fee < Square::DataType
+      # The fee's unique ID.
+      property :id
+
+      # The fee's name.
+      property :name
+
+      # The rate of the fee, as a string representation of a decimal number.
+      # A value of 0.07 corresponds to a rate of 7%.
+      property :rate, coerce: Float
+
+      # Forthcoming.
+      property :calculation_phase # Fee.CalculationPhase
+
+      # The type of adjustment the fee applies to a payment. Currently,
+      # this value is TAX for all fees.
+      property :adjustment_type # Fee.AdjustmentType
+
+      # If true, the fee applies to custom amounts entered into Square
+      # Register that are not associated with a particular item.
+      property :applies_to_custom_amounts # boolean
+
+      # If true, the fee is applied to all appropriate items. If false,
+      # the fee is not applied at all.
+      property :enabled # boolean
+
+      # Whether the fee is ADDITIVE or INCLUSIVE.
+      property :inclusion_type # Fee.InclusionType
+
+      # In countries with multiple classifications for sales taxes, indicates
+      # which classification the fee falls under. Currently relevant only
+      # to Canadian merchants.
+      property :type # Fee.Type
+    end
+  end
+end

data/lib/square/data_types/global_address.rb

@@ -0,0 +1,67 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-globaladdress
+    class GlobalAddress < Square::DataType
+      # The first line of the address.
+      # Fields that start with address_line provide the address's most
+      # specific details, like street number, street name, and building name.
+      # They do not provide less specific details like city, state/province,
+      # or country (these details are provided in other fields).
+      property :address_line_1
+
+      # The second line of the address, if any.
+      property :address_line_2
+
+      # The third line of the address, if any.
+      property :address_line_3
+
+      # The fourth line of the address, if any.
+      property :address_line_4
+
+      # The fifth line of the address, if any.
+      property :address_line_5
+
+      # The city or town of the address.
+      property :locality
+
+      # A civil region within the address's locality, if any.
+      property :sublocality
+
+      # A civil region within the address's sublocality, if any.
+      property :sublocality_1
+
+      # A civil region within the address's sublocality_1, if any.
+      property :sublocality_2
+
+      # A civil region within the address's sublocality_2, if any.
+      property :sublocality_3
+
+      # A civil region within the address's sublocality_3, if any.
+      property :sublocality_4
+
+      # A civil region within the address's sublocality_4, if any.
+      property :sublocality_5
+
+      # A civil entity within the address's country. In the United States,
+      # this is the state.
+      property :administrative_district_level_1
+
+      # A civil entity within the address's administrative_district_level_1,
+      # if any. In the United States, this is the county.
+      property :administrative_district_level_2
+
+      # A civil entity within the address's administrative_district_level_2,
+      # if any.
+      property :administrative_district_level_3
+
+      # The address's postal code.
+      property :postal_code
+
+      # The address's country, in ISO 3166-1-alpha-2 format.
+      property :country_code
+
+      # The coordinates of the address.
+      property :address_coordinates, coerce: Square::DataTypes::Coordinates	
+    end
+  end
+end

data/lib/square/data_types/inventory_entry.rb

@@ -0,0 +1,12 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-inventoryentry
+    class InventoryEntry < Square::DataType
+      # The variation that the entry corresponds to.
+      property :variation_id
+
+      # The current available quantity of the item variation.
+      property :quantity_on_hand # number
+    end
+  end
+end

data/lib/square/data_types/item.rb

@@ -0,0 +1,79 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-item
+    class Item < Square::DataType
+      # The item's unique ID.
+      property :id
+
+      # The item's name.
+      property :name
+
+      # The item's description, if any.
+      property :description
+
+      # The item's type. This value is NORMAL for almost all items.
+      property :type # Item.Type
+
+      # The text of the item's display label in Square Register. This value
+      # is present only if an abbreviation other than the default has been set.
+      property :abbreviation
+
+      # The color of the item's display label in Square Register, if not the
+      # default color.
+      # The default color is 9da2a6.
+      property :color # Item.Color
+
+      # Indicates whether the item is viewable in the merchant's online
+      # store (PUBLIC) or PRIVATE.
+      property :visibility # Item.Visibility
+
+      # If true, the item is available for purchase from the merchant's
+      # online store.
+      property :available_online # boolean
+
+      # The item's master image, if any.
+      property :master_image, coerce: Square::DataTypes::ItemImage
+
+      # The category the item belongs to, if any.
+      property :category, coerce: Square::DataTypes::Category
+
+      # The item's variations.
+      property :variations, coerce: Array[Square::DataTypes::ItemVariation]
+
+      # The modifier lists that apply to the item, if any.
+      property :modifier_lists, coerce: Array[Square::DataTypes::ModifierList]
+
+      # The fees that apply to the item, if any.
+      property :fees, coerce: Array[Square::DataTypes::Fee]
+
+      # Deprecated. This field is not used.
+      property :taxable, required: false # boolean
+
+      # undocumented
+      property :available_for_pickup
+      property :images
+
+      # Get this item's variation. There should only ever be one.
+      #
+      # @return [Square::DataTypes::ItemVariation] First variation.
+      def variation
+        self.variations.first
+      end
+
+      def remove_fees(params = {})
+        fees.each do |fee|
+          remove_fee(fee.id, params)
+        end
+      end
+
+      def remove_fee(fee_id, params = {})
+        Square::Fee.remove(self.id, fee_id, params)
+      end
+
+      def apply_fee(fee_id, params = {})
+        Square::Fee.apply(self.id, fee_id, params)
+      end
+
+    end
+  end
+end