balanced 0.5.5 → 0.5.6

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-See https://www.balancedpayments.com/docs/ruby for tutorials and documentation.
+See https://www.balancedpayments.com/docs/overview?language=ruby for tutorials and documentation.
 
 
 ## Contributing

data/examples/bank_account_debits.rb

@@ -0,0 +1,56 @@
+"""
+Learn how to authenticate a bank account so you can debit with it.
+"""
+cwd = File.dirname(File.dirname(File.absolute_path(__FILE__)))
+$:.unshift(cwd + "/lib")
+require 'balanced'
+
+host = ENV.fetch('BALANCED_HOST') { nil }
+options = {}
+if host
+  options[:scheme] = 'http'
+  options[:host] = host
+  options[:port] = 5000
+end
+
+Balanced.configure(nil, options)
+
+# create a new marketplace
+api_key = Balanced::ApiKey.new.save
+Balanced.configure(api_key.secret)
+marketplace = Balanced::Marketplace.new.save
+
+# create a bank account
+bank_account = marketplace.create_bank_account(
+    :account_number => "1234567890",
+    :bank_code => "12",
+    :name => "Jack Q Merchant"
+)
+account = marketplace.create_account()
+account.add_bank_account(bank_account.uri)
+
+puts "you can't debit until you authenticate"
+begin
+  account.debit(:amount => 100)
+rescue Balanced::Error => ex
+  puts "Debit failed, %s" % ex.message
+end
+
+# authenticate
+verification = bank_account.verify
+
+begin
+  verification.confirm(1,2)
+rescue Balanced::BankAccountVerificationFailure => ex
+  puts 'Authentication error , %s' % ex.message
+  puts "PROTIP: for TEST bank accounts the valid amount is always 1 and 1"
+end
+verification = bank_account.verifications.find(:first).first
+
+raise "unpossible" if verification.confirm(1, 1).state != 'verified'
+debit = account.debit(:amount => 100)
+puts "debited the bank account %s for %d cents" % [
+  debit.source.uri,
+  debit.amount
+]
+puts "and there you have it"

data/lib/balanced/error.rb

@@ -97,4 +97,14 @@ module Balanced
 
   # Raised when Balanced returns a 504 HTTP status code
   class GatewayTimeout < Error; end
+
+
+  # custom mapped exceptions
+  class FundingInstrumentVerificationError < Error; end
+
+  # Raised when Balanced has an issue with you verifying a bank account
+  class BankAccountVerificationFailure < FundingInstrumentVerificationError
+
+  end
+
 end

data/lib/balanced/pager.rb

@@ -8,6 +8,12 @@ module Balanced
     include Enumerable
 
     # A pager for paginating through resource records.
+    #
+    # @param [String] uri the uri of the resource
+    # @param [Hash] options
+    # @option options [Integer] limit
+    # @option options [Integer] offset
+    # @option options [Integer] per an alias for the :limit option
     def initialize uri, options = {}
       @uri = uri
       @options = options

data/lib/balanced/resources/bank_account.rb

@@ -40,7 +40,13 @@ module Balanced
       meta = args[2] || options.fetch(:meta) { nil }
       description = args[3] || options.fetch(:description) { nil }
 
-      self.account.debit(amount, appears_on_statement_as, meta, description, self.uri)
+      self.account.debit(
+          :amount => amount,
+          :appears_on_statement_as => appears_on_statement_as,
+          :meta => meta,
+          :description => description,
+          :source_uri => self.uri
+      )
     end
 
     # Creates a Credit of funds from your Marketplace's escrow account to this
@@ -82,5 +88,22 @@ module Balanced
       save
     end
 
+    def verify
+      Verification.new(
+          'uri' => self.verifications_uri
+      ).save
+    end
+
   end
+
+  class Verification
+    include Balanced::Resource
+
+    def confirm(amount_1, amount_2)
+      self.amount_1 = amount_1
+      self.amount_2 = amount_2
+      save
+    end
+  end
+
 end

data/lib/balanced/response/balanced_exception_middleware.rb

@@ -22,9 +22,22 @@ module Faraday
         503 => Balanced::ServiceUnavailable,
         504 => Balanced::GatewayTimeout,
     }
+    CATEGORY_CODE_MAP = {
+        'bank-account-authentication-not-pending' =>
+        Balanced::BankAccountVerificationFailure,
+        'bank-account-authentication-failed' =>
+        Balanced::BankAccountVerificationFailure,
+        'bank-account-authentication-already-exists' =>
+        Balanced::BankAccountVerificationFailure,
+    }
     def on_complete(response)
       status_code = response[:status].to_i
-      error_class = HTTP_STATUS_CODES[status_code]
+      if response.key? :body and response[:body] != nil
+        category_code = response[:body]['category_code']
+      else
+        category_code = nil
+      end
+      error_class = CATEGORY_CODE_MAP[category_code] || HTTP_STATUS_CODES[status_code]
       raise error_class.new(response) if error_class
     end
 

data/lib/balanced/version.rb

@@ -1,3 +1,3 @@
 module Balanced
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 end

data/spec/balanced/resources/bank_account_spec.rb

@@ -9,9 +9,9 @@ describe Balanced::BankAccount do
 
     @marketplace = Balanced::Marketplace.new.save
     card = @marketplace.create_card(
-      :card_number      => "5105105105105100",
-      :expiration_month => "12",
-      :expiration_year  => "2015"
+        :card_number => "5105105105105100",
+        :expiration_month => "12",
+        :expiration_year => "2015"
     )
     # An initial balance for the marketplace
     @buyer = @marketplace.create_buyer(
@@ -21,9 +21,9 @@ describe Balanced::BankAccount do
     @buyer.debit :amount => 10000000
 
     @incomplete_bank_account_hash = {
-      :account_number => "0987654321",
-      :bank_code => "321174851",
-      :name => "Timmy T. McTimmerson"
+        :account_number => "0987654321",
+        :bank_code => "321174851",
+        :name => "Timmy T. McTimmerson"
     }
   end
 
@@ -32,9 +32,9 @@ describe Balanced::BankAccount do
 
     it 'should not create without a type field' do
       lambda { Balanced::BankAccount.new(
-                 :account_number => "0987654321",
-                 :bank_code => "321174851",
-                 :name => "Timmy T. McTimmerson"
+          :account_number => "0987654321",
+          :bank_code => "321174851",
+          :name => "Timmy T. McTimmerson"
       ).save }.should raise_error(Balanced::BadRequest)
     end
   end
@@ -44,10 +44,10 @@ describe Balanced::BankAccount do
 
     before do
       @bank_account = @marketplace.create_bank_account(
-        :account_number => "0987654321",
-        :bank_code => "321174851",
-        :name => "Timmy T. McTimmerson",
-        :type => "checking"
+          :account_number => "0987654321",
+          :bank_code => "321174851",
+          :name => "Timmy T. McTimmerson",
+          :type => "checking"
       )
     end
 
@@ -102,48 +102,114 @@ describe Balanced::BankAccount do
 
       before do
         @credit = @bank_account.credit(
-          :amount => 50,
-          :description => 'Blah'
+            :amount => 50,
+            :description => 'Blah'
         )
       end
 
       describe 'bank_account' do
         subject { @credit.bank_account }
-        its(:account_number) {should end_with '4321'}
-        its(:routing_number) {should eql '321174851'}
+        its(:account_number) { should end_with '4321' }
+        its(:routing_number) { should eql '321174851' }
 
       end
 
-      describe 'without an account' do
-         subject { @credit }
-         it { should respond_to :account }
-         its(:account) { should be_nil }
-      end
-
       describe 'with an account' do
         use_vcr_cassette
 
         before do
           @account = @marketplace.create_account
           bank_account = @marketplace.create_bank_account(
-            :account_number => "1234567890111",
-            :bank_code => "021000021",
-            :name => "Timmy T. McTimmerson",
-            :type => "checking"
+              :account_number => "1234567890111",
+              :bank_code => "021000021",
+              :name => "Timmy T. McTimmerson",
+              :type => "checking"
           )
           @account.add_bank_account(bank_account.uri)
           bank_account = bank_account.reload
           @credit_with_account = bank_account.credit(
-            :amount => 500,
-            :description => 'Blahblahblah'
+              :amount => 500,
+              :description => 'Blahblahblah'
           )
         end
 
-         subject { @credit_with_account }
-         it { should respond_to :account }
-         it { should be_instance_of Balanced::Credit }
+        subject { @credit_with_account }
+        it { should respond_to :account }
+        it { should be_instance_of Balanced::Credit }
       end
 
     end
+
+  end
+
+  describe 'verification' do
+
+    describe 'cannot debit when unverified' do
+      use_vcr_cassette
+
+      before do
+        @bank_account = @marketplace.create_bank_account(
+            :account_number => "0987654321",
+            :bank_code => "321174851",
+            :name => "Timmy T. McTimmerson",
+            :type => "checking"
+        )
+        @account = @marketplace.create_account
+        @account.add_bank_account(@bank_account.uri)
+      end
+
+      it do
+        lambda {
+          @account.debit(:amount => 100)
+        }.should raise_error(Balanced::Conflict)
+      end
+    end
+
+    describe 'debits when verified' do
+      use_vcr_cassette
+
+      before do
+        @bank_account = @marketplace.create_bank_account(
+            :account_number => "0987654321",
+            :bank_code => "321174851",
+            :name => "Timmy T. McTimmerson",
+            :type => "checking"
+        )
+        @account = @marketplace.create_account
+        @account.add_bank_account(@bank_account.uri)
+      end
+
+      it do
+
+        authentication = @bank_account.verify
+        authentication.confirm(1, 1)
+
+        @account.debit(:amount => 100)
+      end
+    end
+
+    describe 'errors when incorrectly verified' do
+      use_vcr_cassette
+
+      before do
+        @bank_account = @marketplace.create_bank_account(
+            :account_number => "0987654321",
+            :bank_code => "321174851",
+            :name => "Timmy T. McTimmerson",
+            :type => "checking"
+        )
+        @account = @marketplace.create_account
+        @account.add_bank_account(@bank_account.uri)
+      end
+
+      it do
+
+        authentication = @bank_account.verify
+
+        lambda {
+          authentication.confirm(1, 2)
+        }.should raise_error(Balanced::BankAccountVerificationFailure)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: balanced
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -74,6 +74,7 @@ files:
 - doc/balanced_templates/default/onefile/html/layout.erb
 - doc/balanced_templates/default/onefile/html/setup.rb
 - doc/balanced_templates/default/tags/html/index.erb
+- examples/bank_account_debits.rb
 - examples/events_and_callbacks.rb
 - examples/examples.rb
 - lib/balanced.rb