balanced 0.8.2 → 1.0.beta1

data/lib/balanced/resources.rb

@@ -1,17 +1,18 @@
-$:.unshift File.join(File.dirname(__FILE__), "balanced", "resources")
-require "resource"
-require "account"
-require "api_key"
-require "bank_account"
-require "card"
-require "credit"
-require "debit"
-require "hold"
-require "marketplace"
-require "merchant"
-require "refund"
-require "reversal"
-require "transaction"
-require "callback"
-require "event"
-require "customer"
+$:.unshift(File.join(File.dirname(__FILE__), 'balanced', 'resources'))
+require 'resource'
+require 'hypermedia'
+require 'funding_instrument'
+require 'api_key'
+require 'bank_account'
+require 'card'
+require 'credit'
+require 'debit'
+require 'card_hold'
+require 'marketplace'
+require 'refund'
+require 'reversal'
+require 'callback'
+require 'event'
+require 'customer'
+require 'order'
+require 'transfer'

data/lib/balanced/resources/api_key.rb

@@ -6,7 +6,11 @@ module Balanced
   # *NOTE:* Never give out or expose your ApiKey. You may POST to this
   # endpoint to create new ApiKeys and then DELETE any old keys.
   class ApiKey
+
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
+
+    define_hypermedia_types [:api_keys]
 
     def save
       Balanced.configure nil

data/lib/balanced/resources/bank_account.rb

@@ -4,101 +4,52 @@ module Balanced
   #
   # *NOTE:* The BankAccount resource does not support creating a Hold.
   #
-  class BankAccount
+  class BankAccount < Balanced::DebitableFundingInstrument
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
 
-    def self.uri
-      # Override the default nesting -- bank accounts can be top-level now
-      # but they can also be nested under marketplaces, which is what we
-      # want to default to unless explicitly set
-       self.collection_path
-    end
-
-    def initialize attributes = {}
-      Balanced::Utils.stringify_keys! attributes
-      unless attributes.has_key? 'uri'
-        attributes['uri'] = self.class.uri
-      end
-      super attributes
-    end
-
-    def has_account?
-      self.respond_to? 'account' and !self.account.nil?
-    end
+    define_hypermedia_types [:bank_accounts]
 
     # Creates a Debit of funds from this BankAccount to your Marketplace's escrow account.
     #
-    # @param [String] appears_on_statement_as If nil then Balanced will use
-    #    the +domain_name+ property from your Marketplace.
     # @return [Debit]
-    def debit *args
-      warn_on_positional args
-
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { nil }
-      appears_on_statement_as = args[1] || options.fetch(:appears_on_statement_as) { nil }
-      meta = args[2] || options.fetch(:meta) { nil }
-      description = args[3] || options.fetch(:description) { nil }
-
-      self.account.debit(
-          :amount => amount,
-          :appears_on_statement_as => appears_on_statement_as,
-          :meta => meta,
-          :description => description,
-          :source_uri => self.uri
-      )
+    def debit(options = {})
+      options[:href] = self.debits.href
+      debit = Balanced::Debit.new(options)
+      debit.save
     end
 
     # Creates a Credit of funds from your Marketplace's escrow account to this
     # Account.
     #
     # @return [Credit]
-    def credit *args
-      warn_on_positional args
-
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { nil }
-      description = args[1] || options.fetch(:description) { nil }
-      appears_on_statement_as = args[3] || options.fetch(:appears_on_statement_as) { nil }
-      
-      if self.has_account?
-        meta = args[2] || options.fetch(:meta) { nil }
-        destination_uri = args[4] || options.fetch(:destination_uri) { self.uri }
-        credit = self.account.credit(
-            :amount => amount,
-            :meta => meta,
-            :description => description,
-            :destination_uri => destination_uri,
-            :appears_on_statement_as => appears_on_statement_as
-        )
-      else
-        credit = Credit.new(
-            :uri => self.credits_uri,
-            :amount => amount,
-            :description => description,
-            :appears_on_statement_as => appears_on_statement_as
-        )
-        credit.save
-      end
-
-      credit
-    end
-
-    def invalidate
-      self.is_valid = false
-      save
+    def credit(options = {})
+      options[:href] = self.credits.href
+      credit = Balanced::Credit.new(options)
+      credit.save
     end
 
     def verify
-      Verification.new(
-          'uri' => self.verifications_uri
-      ).save
+      options = {:href => self.bank_account_verifications.href}
+      vf = BankAccountVerification.new(options)
+      vf.save
     end
 
+    def associate_to_customer(customer)
+      self.links['customer'] = Balanced::Utils.extract_href_from_object(customer)
+      save
+    end
   end
 
-  class Verification
+  class BankAccountVerification
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
+
+    define_hypermedia_types [:bank_account_verification,
+                             :bank_account_verifications,
+                             :verification,
+                             :verifications
+                            ]
 
     def confirm(amount_1, amount_2)
       self.amount_1 = amount_1

data/lib/balanced/resources/callback.rb

@@ -5,6 +5,8 @@ module Balanced
   #
   class Callback
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
+    define_hypermedia_types [:callbacks]
 
   end
 

data/lib/balanced/resources/card.rb

@@ -2,85 +2,35 @@ module Balanced
   # A card represents a source of funds for an Account. You may Hold or Debit
   # funds from the account associated with the Card.
   #
-  class Card
+  class Card < Balanced::DebitableFundingInstrument
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
 
-    def initialize attributes = {}
-      Balanced::Utils.stringify_keys! attributes
-      unless attributes.has_key? 'uri'
-        attributes['uri'] = self.class.uri
-      end
-      super attributes
-    end
+    define_hypermedia_types [:cards]
 
-    # Creates a Debit of funds from this Card to your Marketplace's escrow account.
-    #
-    # If +appears_on_statement_as+ is nil, then Balanced will use the
-    # +domain_name+ property from your Marketplace.
-    #
-    # @param [Array] args
-    # @option args [Integer] :amount the amount of the purchase in cents
-    # @option args [String] :appears_on_statement_as
-    # @option args [String] :hold_uri
-    # @option args [Hash] :meta a hash of data to save with the Debit
-    # @option args [String] :description
-    # @option args [String] :source_uri
+    # Creates a Debit of funds from this Card to the Marketplace's escrow account.
     #
+    # @param [Hash] options
     # @return [Debit]
-    def debit *args
-      warn_on_positional args
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { nil }
-      appears_on_statement_as = args[1] || options.fetch(:appears_on_statement_as) { nil }
-      hold_uri = args[2] || options.fetch(:hold_uri) { nil }
-      meta = args[3] || options.fetch(:meta) { nil }
-      description = args[3] || options.fetch(:description) { nil }
-
-      ensure_associated_to_account!
-
-      self.account.debit(
-          :amount => amount,
-          :appears_on_statement_as => appears_on_statement_as,
-          :hold_uri => hold_uri,
-          :meta => meta,
-          :description => description,
-          :source_uri => self.uri
-      )
+    def debit(options={})
+      options[:href] = self.debits.href
+      debit = Balanced::Debit.new(options)
+      debit.save
     end
 
     # Creates a Hold of funds from this Card to your Marketplace.
     #
     # @return [Hold]
-    def hold *args
-      warn_on_positional args
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { nil }
-      meta = args[1] || options.fetch(:meta) { nil }
-      description = args[3] || options.fetch(:description) { nil }
-
-      ensure_associated_to_account!
-
-      self.account.hold(
-          :amount => amount,
-          :meta => meta,
-          :source_uri => self.uri,
-          :description => description
-      )
+    def hold(options={})
+      options[:href] = self.card_holds.href
+      hold = Balanced::CardHold.new(options)
+      hold.save
     end
 
-    def invalidate
-      self.is_valid = false
+    def associate_to_customer(customer)
+      self.links['customer'] = Balanced::Utils.extract_href_from_object(customer)
       save
     end
-
-    private
-    # Ensure that one of account, account_uri, customer or customer_uri are set.
-    # Otherwise raise an exception.
-    def ensure_associated_to_account!
-      if attributes.values_at('account', 'account_uri', 'customer', 'customer_uri').compact.empty?
-        raise UnassociatedCardError.new(self)
-      end
-    end
   end
 
 end

data/lib/balanced/resources/card_hold.rb

@@ -0,0 +1,38 @@
+module Balanced
+  # A Hold is a reservation of funds on a funding source such as a Card. This
+  # reservation is guaranteed until the +expires_at+ date. You may capture
+  # the Hold at any time before then which will create a Debit and transfer
+  # the funds to your Marketplace. If you do not capture the Hold it will
+  # be marked as invalid which is represented by the +is_void+ field being
+  # set to +true+.
+  #
+  # By default a Hold is created using the most recently added funding source
+  # on the Account. You may specify a specific funding source such as a Card
+  # or BankAccount uri.
+  #
+  class CardHold
+    include Balanced::Resource
+    include Balanced::HypermediaRegistry
+
+    define_hypermedia_types [:card_holds]
+
+    # Captures a valid Hold and returns a Debit representing the transfer of
+    # funds from the buyer's Account to your Marketplace.
+    #
+    # @return [Debit]
+    def capture(options={})
+      options[:href] = self.debits.href
+      debit = Balanced::Debit.new(options)
+      debit.save
+      reload
+      debit
+    end
+
+    def unstore
+      destroy
+    end
+    alias_method :delete, :unstore
+
+  end
+end
+

data/lib/balanced/resources/credit.rb

@@ -8,60 +8,16 @@ module Balanced
   #
   class Credit
     include Balanced::Resource
+    include Balanced::HypermediaRegistry
 
-    # @param [Array] args
-    # @option [String] :uri the uri of the credit, in the case of an update
-    # @option [Hash] :bank_account
-    # @option [Integer] :amount amount in cents
-    # @option [String] :description a text description of the credit
-    # @option [String] :appears_on_statement_as
-    # @option [Hash] :meta
-    # @option [String] :destination_uri the uri of the bank account to credit
-    def initialize *args
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      uri = options.fetch(:uri) { self.class.uri }
-      bank_account = options.fetch(:bank_account) {}
-      amount = args[0] || options.fetch(:amount) { }
-      description = args[1] || options.fetch(:description) { nil }
+    define_hypermedia_types [:credits]
 
-      unless bank_account.nil?
-        # Accountless bank account
-        attributes = {
-            :uri => uri,
-            :amount => amount,
-            :description => description,
-            :bank_account => bank_account,
-            :meta => nil
-        }
-      else
-        meta = args[2] || options.fetch(:meta) { nil }
-        destination_uri = args[3] || options.fetch(:destination_uri) { nil }
-        appears_on_statement_as = args[4] || options.fetch(:appears_on_statement_as) { nil }
-        attributes = {
-            :uri => uri,
-            :amount => amount,
-            :meta => meta,
-            :description => description,
-            :destination_uri => destination_uri,
-            :appears_on_statement_as => appears_on_statement_as
-        }
-      end
-
-      Balanced::Utils.stringify_keys! attributes
-
-      super attributes
-    end
-
-    def reverse *args
-      warn_on_positional args
-
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { nil }
-      description = args[1] || options.fetch(:description) { nil }
+    def reverse(options={})
+      amount = options[:amount]
+      description = options[:description]
 
       reversal = Reversal.new(
-          :uri => self.reversals_uri,
-          :credit_uri => self.uri,
+          :href => self.reversals.href,
           :amount => amount,
           :description => description
       )

data/lib/balanced/resources/customer.rb

@@ -4,20 +4,11 @@ module Balanced
   # associated to them.
   #
   class Customer
-    include Balanced::Resource
 
-    def self.uri
-      # Override the default nesting
-       self.collection_path
-    end
+    include Balanced::Resource
+    include Balanced::HypermediaRegistry
 
-    def initialize attributes = {}
-      Balanced::Utils.stringify_keys! attributes
-      unless attributes.has_key? 'uri'
-        attributes['uri'] = self.class.uri
-      end
-      super attributes
-    end
+    define_hypermedia_types [:customers]
 
     # Attempts to find an existing customer by email
     #
@@ -31,53 +22,41 @@ module Balanced
     def self.find_by_email email
       self.find(:first, :email => email)
     end
-    
-    def debit(options = {})
-      amount = options[:amount]
-      appears_on_statement_as = options[:appears_on_statement_as]
-      hold_uri = options[:hold_uri]
-      meta = options[:meta]
-      description = options[:description]
-      source_uri = options[:source_uri]
-      on_behalf_of = options[:on_behalf_of] || options[:on_behalf_of_uri]
 
-      if on_behalf_of
-        if on_behalf_of.respond_to? :uri
-          on_behalf_of = on_behalf_of.uri
-        end
-        if !on_behalf_of.is_a?(String)
-          raise ArgumentError, 'The on_behalf_of parameter needs to be a customer URI'
-        end
-        if on_behalf_of == self.uri
-          raise ArgumentError, 'The on_behalf_of parameter MAY NOT be the same account as the customer you are debiting!'
-        end
-      end
+    def self.owner
+      owner_customer = Balanced::Marketplace.mine.owner_customer
+      owner_customer
+    end
 
-      debit = Debit.new(
-          :uri => self.debits_uri,
-          :amount => amount,
-          :appears_on_statement_as => appears_on_statement_as,
-          :hold_uri => hold_uri,
-          :meta => meta,
-          :description => description,
-          :source_uri => source_uri,
-          :on_behalf_of_uri => on_behalf_of
-      )
-      debit.save
+    def debit(options = {})
+      if self.source.nil?
+        raise "No source available for #{self}"
+      end
+      self.source.debit(options)
     end
 
     def credit(options = {})
-      options.merge!(:uri => self.credits_uri)
-      Credit.new(options).save
+      if self.destination.nil?
+        raise "No destination available for #{self}"
+      end
+      self.destination.credit(options)
+    end
+
+    def create_order(options = {})
+      options[:href] = self.orders.href
+      order = Balanced::Order.new(options)
+      order.save
     end
 
     # Associates the Card represented by 'card' with this Customer.
     #
     # @return [Customer]
-
-    def add_card(card)
-      card.save if card.kind_of?(Balanced::Card) && card.hash.nil?
-      self.card_uri = Balanced::Utils.extract_uri_from_object(card)
+    def add_source(source)
+      if source.is_a?(Balanced::Resource)
+        self.links['source'] = source.id
+      else
+        self.links['source'] = source
+      end
       save
     end
 
@@ -85,31 +64,14 @@ module Balanced
     # Customer.
     #
     # @return [Customer]
-    def add_bank_account(bank_account)
-      if bank_account.kind_of?(Balanced::BankAccount) && bank_account.fingerprint.nil?
-        bank_account.save
+    def add_destination(destination)
+      if destination.is_a?(Balanced::Resource)
+        self.links['destination'] = destination.id
+      else
+        self.links['destination'] = destination
       end
-      self.bank_account_uri = Balanced::Utils.extract_uri_from_object(bank_account)
       save
     end
 
-    def active_card
-      pager = Pager.new(
-        self.cards_uri,
-        :is_active => true,
-        :sort => 'created_at,desc',
-        :limit => 1)
-      pager.first
-    end
-
-    def active_bank_account
-      pager = Pager.new(
-        self.bank_accounts_uri,
-        :is_active => true,
-        :sort => 'created_at,desc',
-        :limit => 1)
-      pager.first
-    end
-
   end
 end