square-ruby 0.1.0

data/lib/square/data_types/phone_number.rb

@@ -0,0 +1,13 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-phonenumber
+    class PhoneNumber < Square::DataType
+      # The phone number's international calling code. For US phone numbers,
+      # this value is +1.
+      property :calling_code
+
+      # The phone number.
+      property :number
+    end
+  end
+end

data/lib/square/data_types/refund.rb

@@ -0,0 +1,31 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-refund
+    class Refund < DataType
+      # The type of refund (FULL or PARTIAL).
+      property :type # Refund.Type
+
+      # The merchant-specified reason for the refund.
+      property :reason
+
+      # The amount of money refunded. This amount is always negative.
+      property :refunded_money, coerce: Square::DataTypes::Money
+
+      # The time when the merchant initiated the refund for Square to process,
+      # in ISO 8601 format.
+      property :created_at
+
+      # The time when Square processed the refund on behalf of the merchant,
+      # in ISO 8601 format.
+      property :processed_at
+
+      # The Square-issued ID of the payment the refund is applied to.
+      property :payment_id
+
+      # undocumented
+      property :merchant_id
+      property :refunded_processing_fee_money
+      property :refunded_additive_tax_money
+    end
+  end
+end

data/lib/square/data_types/settlement.rb

@@ -0,0 +1,28 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-settlement
+    class Settlement < Square::DataType
+      # The settlement's unique identifier.
+      property :id
+
+      # The settlement's current status.
+      property :status # Settlement.Status
+
+      # The time when the settlement was submitted for deposit or withdrawal,
+      # in ISO 8601 format.
+      property :initiated_at
+
+      # The Square-issued unique identifier for the bank account associated
+      # with the settlement.
+      property :bank_account_id
+
+      # The amount of money involved in the settlement. A positive amount
+      # indicates a deposit, and a negative amount indicates a withdrawal.
+      # This amount is never zero.
+      property :total_money, coerce: Square::DataTypes::Money
+
+      # The entries included in this settlement.
+      property :entries, coerce: Array[Square::DataTypes::SettlementEntry]
+    end
+  end
+end

data/lib/square/data_types/settlement_entry.rb

@@ -0,0 +1,21 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-settlemententry
+    class SettlementEntry < Square::DataType
+      # The type of activity this entry represents.
+      property :type # SettlementEntry.Type
+
+      # The payment associated with the settlement entry, if any.
+      property :payment_id
+
+      # The total amount of money this entry contributes to the total
+      # settlement amount.
+      property :amount_money, coerce: Square::DataTypes::Money
+
+      # The amount of all Square fees associated with this settlement entry.
+      # This value is always negative or zero.
+      # This amount has already been applied to amount_money.
+      property :fee_money, coerce: Square::DataTypes::Money
+    end
+  end
+end

data/lib/square/data_types/tender.rb

@@ -0,0 +1,50 @@
+module Square
+  module DataTypes
+    class Tender < DataType
+      # The tender's unique ID.
+      property :id
+
+      # The type of tender.
+      property :type # Tender.Type
+
+      # A human-readable description of the tender.
+      property :name
+
+      # The ID of the employee that processed the tender.
+      # This field is included only if the associated merchant had employee
+      # management features enabled at the time the tender was processed.
+      property :employee_id
+
+      # The URL of the receipt for the tender.
+      property :receipt_url
+
+      # The brand of credit card provided.
+      # Only present if the tender's type is CREDIT_CARD.
+      property :card_brand # Tender.CardBrand
+
+      # The last four digits of the provided credit card's account number.
+      # Only present if the tender's type is CREDIT_CARD.
+      property :pan_suffix
+
+      # The method with which the tender was entered.
+      property :entry_method # Tender.EntryMethod
+
+      # Notes entered by the merchant about the tender at the time of payment,
+      # if any. Typically only present for tender with the type OTHER.
+      property :payment_note
+
+      # The total amount of money provided in this form of tender.
+      property :total_money, coerce: Square::DataTypes::Money
+
+      # The amount of total_money applied to the payment.
+      property :tendered_money, coerce: Square::DataTypes::Money
+
+      # The amount of total_money returned to the buyer as change.
+      property :change_back_money, coerce: Square::DataTypes::Money
+
+      # The total of all refunds applied to this tender.
+      # This amount is always negative or zero.
+      property :refunded_money, coerce: Square::DataTypes::Money
+    end
+  end
+end

data/lib/square/discount.rb

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

data/lib/square/fee.rb

@@ -0,0 +1,49 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-fees
+  class Fee < APIResource
+    extend Square::APIOperations::List
+    extend Square::APIOperations::Retrieve
+    extend Square::APIOperations::Create
+    extend Square::APIOperations::Update
+    extend Square::APIOperations::Delete
+
+    endpoint_base 'fees'
+    data_type Square::DataTypes::Fee
+
+    # Adjust inventory for a varation.
+    #
+    # @param item_id [String] Item ID.
+    # @param fee_id [String] Fee ID.
+    # @param params [Hash] Params hash. Optional.
+    #
+    # @return [Square::DataType]
+    def self.apply(item_id, fee_id, params = {})
+      response = Square.make_request(
+        method: 'PUT',
+        endpoint: "items/#{item_id}/fees/#{fee_id}",
+        params: params
+      )
+
+      response = Square.parse_response(response)
+      Square::DataTypes::Item.new(response)
+    end
+    
+    # Adjust inventory for a varation.
+    #
+    # @param item_id [String] Item ID.
+    # @param fee_id [String] Fee ID.
+    # @param params [Hash] Params hash. Optional.
+    #
+    # @return [Square::DataType]
+    def self.remove(item_id, fee_id, params = {})
+      response = Square.make_request(
+        method: 'DELETE',
+        endpoint: "items/#{item_id}/fees/#{fee_id}",
+        params: params
+      )
+
+      response = Square.parse_response(response)
+      Square::DataTypes::Item.new(response)
+    end
+  end
+end

data/lib/square/inventory.rb

@@ -0,0 +1,26 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-inventory
+  class Inventory < APIResource
+    extend Square::APIOperations::List
+
+    endpoint_base 'inventory'
+    data_type Square::DataTypes::InventoryEntry
+
+    # Adjust inventory for a varation.
+    #
+    # @param variation_id [String] Variation ID.
+    # @param params [Hash] Params hash. Optional.
+    #
+    # @return [Square::DataType]
+    def self.adjust(variation_id, params = {})
+      response = Square.make_request(
+        method: 'POST',
+        endpoint: self.generate_endpoint_url(variation_id),
+        payload: params
+      )
+
+      response = Square.parse_response(response)
+      @data_type.new(response)
+    end
+  end
+end

data/lib/square/item.rb

@@ -0,0 +1,40 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-itemmanagement
+  class Item < APIResource
+    extend Square::APIOperations::List
+    extend Square::APIOperations::Retrieve
+    extend Square::APIOperations::Create
+    extend Square::APIOperations::Update
+    extend Square::APIOperations::Delete
+
+    endpoint_base 'items'    
+    data_type Square::DataTypes::Item
+
+    # Upload an image for an item.
+    # https://docs.connect.squareup.com/api/connect/v1/#post-image
+    #
+    # @param image_url [String] Image URL.
+    # @param item_id [String] Square item id.
+    #
+    # @return [Net::HTTPResponse] API response.
+    def self.upload_image(image_url, item_id)
+      image = open(image_url)
+      filename = File.basename(image_url)
+
+      uri = URI.parse("#{Square.api_host}/v1/me/#{instance_variable_get('@endpoint_base')}/#{item_id}/image")
+      connection = Net::HTTP.new(uri.host, uri.port)
+      connection.use_ssl = (uri.scheme == 'https')
+
+      # Making this request here because RestClient doesn't do multipart
+      # requests the way Square wants it.
+      request = Net::HTTP::Post::Multipart.new(
+        uri.path,
+        image_data: UploadIO.new(image, 'image/jpeg', filename)
+      )
+
+      # Copy the auth header.
+      request['Authorization'] = Square.request_headers(Square.access_token)[:authorization]
+      connection.request(request)
+    end
+  end
+end

data/lib/square/list_response.rb

@@ -0,0 +1,79 @@
+module Square
+  class ListResponse
+    include Enumerable
+
+    attr_accessor :response
+
+    # RegExp used for parsing Link headers when the API paginates data. Don't
+    # care about rel attributes right now because this is the only thing this is
+    # used for.
+    LINK_REGEXP = /^<([ -~]+)>;/i
+
+    # Initialize.
+    #
+    # @param response [RestClient::Response] Raw resonse object.
+    # @param data_type [Square::DataType] Data type to new up records.
+    #
+    # @return [ListResponse]
+    def initialize(response, data_type)
+      @response = response
+      @data_type = data_type
+      @values = {}
+      parse_response(@response)
+    end
+
+    # Each.
+    #
+    # @param block [Block]
+    def each(&block)
+      @values.each(&block)
+    end
+
+    # Get more records.
+    #
+    # @return [Array] parsed records.
+    def more
+      if !has_more?
+        return nil
+      end
+
+      @response = Square.make_request(url: @next_link)
+      self.class.new(@response, @data_type)
+    end
+
+    # Check if there are more pages.
+    #
+    # @return [Boolean]
+    def has_more?
+      !@next_link.nil?
+    end
+
+    # Pass through methods to the original response object.
+    def method_missing(name, *args, &block)
+      @response.send(name, *args, &block)
+    end
+
+    private
+
+    # Parse a response.
+    #
+    # @return [Array] parsed records.
+    def parse_response(response)
+      # Detect a Link header.
+      if !response.headers[:link].nil?
+        match = LINK_REGEXP.match(response.headers[:link])
+
+        if match.nil?
+          @next_link = nil
+        else
+          @next_link = match.captures[0]
+        end
+      else
+        @next_link = nil
+      end
+
+      parsed_response = JSON.parse(response)
+      @values = parsed_response.map {|record| @data_type.new(record)}
+    end
+  end
+end

data/lib/square/merchant.rb

@@ -0,0 +1,13 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-merchant
+  class Merchant < APIResource
+    extend Square::APIOperations::Retrieve
+
+    data_type Square::DataTypes::Merchant
+
+    def self.retrieve(merchant_id = nil)
+      response = Square.get(merchant_id)
+      @data_type.new(response)
+    end
+  end
+end

data/lib/square/payment.rb

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

data/lib/square/refund.rb

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

data/lib/square/settlement.rb

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

data/lib/square/variation.rb

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

data/lib/square/version.rb

@@ -0,0 +1,3 @@
+module Square
+  VERSION = "0.1.0"
+end

data/lib/square/webhook.rb

@@ -0,0 +1,10 @@
+module Square
+  # https://docs.connect.squareup.com/api/connect/v1/#navsection-webhooks
+  class Webhook < APIResource
+    extend Square::APIOperations::List
+    extend Square::APIOperations::Update
+
+    endpoint_base 'webhooks'
+    data_type Array
+  end
+end

data/square-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'square/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'square-ruby'
+  spec.version       = Square::VERSION
+  spec.authors       = ['Brian Wm. McAllister', 'David Michael', 'Brianne King']
+  spec.email         = ['brian.mcallister@giantmachines.com', 'david.michael@giantmachines.com', 'brianne.king@giantmachines.com']
+
+  spec.summary       = 'Square Connect API library'
+  spec.description   = 'Square Connect API'
+  spec.homepage      = 'https://github.com/giantmachines/square-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
+
+  spec.add_runtime_dependency 'hashie', '~> 3.4'
+  spec.add_runtime_dependency 'rest-client', '~> 1.8'
+  spec.add_runtime_dependency 'multipart-post', '~> 2.0'
+end