balanced 0.7.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e69cc58c7b89500cead1e3ed9a7e87488942aa72
+  data.tar.gz: 845faa189939c479db8234bbe615ad68c0fbcc59
+SHA512:
+  metadata.gz: 00a427992fe65be31e2caeb435dc4ee25fa6e85c26559ae321fd53a3f83be55305541e4f2f16e14f4e9838d190888d4458c15aa2389d60ec612085bd77a08090
+  data.tar.gz: 69f1756cee7c1c263b341502299bcbe4102cdb128c982f2393354b85738e315ec70d310058c4ef17448ef6987f60e8d70409b4c2aa46fd5ec46b2b0511a87ac8

data/README.md

@@ -19,10 +19,12 @@ Or install it yourself as:
 
     $ gem install balanced
 
-## Usage
-
-See https://www.balancedpayments.com/docs/overview?language=ruby for tutorials and documentation.
+## Documentation & Usage
 
+* [Balanced Overview](https://www.balancedpayments.com/docs/overview?language=ruby)
+* [RDoc](http://rubydoc.info/gems/balanced)
+* [Balanced API with Ruby examples](https://www.balancedpayments.com/docs/api?language=ruby)
+* [Example scripts](https://github.com/balanced/balanced-ruby/tree/master/examples)
 
 ## Contributing
 
@@ -75,4 +77,4 @@ Documentation is built using YARD - http://rubydoc.info/docs/yard
 #####OpenSSL
     SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed (OpenSSL::SSL::SSLError)
 
-The machine's Ruby/OpenSSL environment can't find any root certificates to trust. Please refer [here](http://www.google.com/search?q=SSL+connect+returned=1+errno=0+state=SSLv3) to find the best solution for your environment.
+The machine's Ruby/OpenSSL environment can't find any root certificates to trust. Please refer [here](http://www.google.com/search?q=SSL+connect+returned=1+errno=0+state=SSLv3) to find the best solution for your environment.

data/examples/customers.rb

@@ -0,0 +1,115 @@
+cwd = File.dirname(File.dirname(File.absolute_path(__FILE__)))
+$:.unshift(cwd + "/lib")
+require 'balanced'
+require 'ruby-debug'
+
+
+begin
+  Balanced::Card
+rescue NameError
+  raise "wtf"
+end
+
+host = ENV.fetch('BALANCED_HOST') { nil }
+options = {}
+if host
+  options[:scheme] = 'http'
+  options[:host] = host
+  options[:port] = 5000
+end
+
+Balanced.configure(nil, options)
+
+puts "create our new api key"
+api_key = Balanced::ApiKey.new.save
+puts "Our secret is: ", api_key.secret
+secret = api_key.secret
+
+puts "configure with our secret #{secret}"
+Balanced.configure(secret)
+
+puts "create our marketplace"
+begin
+  marketplace = Balanced::Marketplace.new.save
+rescue Balanced::Conflict => ex
+  marketplace = Balanced::Marketplace.mine
+end
+
+puts "create a customer"
+#
+customer = marketplace.create_customer(
+          :name           => "Bill",
+          :email          => "bill@bill.com",
+          :business_name  => "Bill Inc.",
+          :ssn_last4      => "1234",
+          :address => {
+            :line1 => "1234 1st Street",
+            :city  => "San Francisco",
+            :state => "CA"
+        }
+  ).save
+
+puts "our customer uri is #{customer.uri}"
+
+puts "create a card and a bank account for our customer"
+
+bank_account = marketplace.create_bank_account(
+          :account_number => "1234567980",
+          :bank_code => "321174811",
+          :name => "Jack Q Merchant"
+        )
+
+card = marketplace.create_card(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+
+puts "our bank account uri is #{bank_account.uri}"
+puts "our card uri is #{card.uri}"
+
+puts "associate the newly created bank account and card to our customer"
+debugger
+customer.add_card(card)
+customer.add_bank_account(bank_account)
+
+puts "check and make sure our customer now has a card and bank account listed"
+
+raise "customer's cards should not be empty" unless customer.cards.any?
+raise "customer's bank accounts should not be empty" unless customer.bank_accounts.any?
+
+puts "create a debit on our customer"
+
+customer.debit(
+  :amount       => 5000,
+  :description  => "new debit"
+  )
+
+puts "check to make sure debit is added"
+
+raise "customer should not have 0 debits" unless customer.debits.any?
+raise "customer debit should be 5000" unless customer.debits.first.amount == 5000
+
+puts "create a credit on our customer"
+
+customer.credit(
+  :amount      => 2500,
+  :description => "new credit"
+  )
+
+puts "check to make sure credit is added"
+
+raise "customer should not have 0 credits" unless customer.credits.any?
+raise "customer should be 2500" unless customer.credits.first.amount == 2500
+
+puts "check to see what is the active card for a customer"
+
+raise "active card is incorrect" unless customer.active_card.id == card.id
+
+puts "check to see what is the active bank_account for a customer"
+
+raise "active bank account is incorrect" unless customer.active_bank_account.id == bank_account.id
+
+
+
+

data/lib/balanced/resources.rb

@@ -13,3 +13,5 @@ require "refund"
 require "transaction"
 require "callback"
 require "event"
+require "customer"
+

data/lib/balanced/resources/customer.rb

@@ -0,0 +1,102 @@
+module Balanced
+  # A customer represents a business or person within your Marketplace. A
+  # customer can have many funding instruments such as cards and bank accounts
+  # associated to them.
+  #
+  class Customer
+    include Balanced::Resource
+
+    def self.uri
+      # Override the default nesting
+       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 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
+
+      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
+    end
+
+    def credit(options = {})
+      options.merge!(:uri => self.credits_uri)
+      Credit.new(options).save
+    end
+
+    # Associates the Card represented by 'card' with this Customer.
+    #
+    # @return [Card]
+
+    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)
+      save
+    end
+
+    # Associates the BankAccount represented by bank_account with this
+    # Customer.
+    #
+    # @return [BankAccount]
+    def add_bank_account(bank_account)
+      if bank_account.kind_of?(Balanced::BankAccount) && bank_account.hash.nil?
+        bank_account.save
+      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

data/lib/balanced/resources/marketplace.rb

@@ -209,6 +209,11 @@ module Balanced
       card.save
     end
 
+    def create_customer(options = {})
+      customer = Customer.new(options)
+      customer.save
+    end
+
     def create_callback *args
       warn_on_positional args
 

data/lib/balanced/utils.rb

@@ -30,6 +30,10 @@ module Balanced
       word
     end
 
+    def extract_uri_from_object(object)
+      object.respond_to?(:uri) ? object.uri : object
+    end
+
     def hash_with_indifferent_read_access base = {}
       indifferent = Hash.new do |hash, key|
         hash[key.to_s] if key.is_a? Symbol

data/lib/balanced/version.rb

@@ -1,3 +1,3 @@
 module Balanced
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/spec/balanced/resources/customer_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+
+describe Balanced::Customer, :vcr do
+  before do
+    api_key = Balanced::ApiKey.new.save
+    Balanced.configure api_key.secret
+    @marketplace = Balanced::Marketplace.new.save
+  end
+
+  describe "Customer.uri", :vcr do
+
+    context "when Api Key is configured properly", :vcr do
+      before do
+        api_key = Balanced::ApiKey.new.save
+        Balanced.configure api_key.secret
+        Balanced::Customer.new
+      end
+
+      it "matches the resource's uri structure" do
+        uri = Balanced::Customer.uri
+        uri.should_not be_nil
+        uri.should match CUSTOMERS_URI_REGEX
+      end
+    end
+  end
+
+  describe "customer", :vcr do
+    describe "#create", :vcr do
+      before do
+        @customer = @marketplace.create_customer(
+          :name           => "Bill",
+          :email          => "bill@bill.com",
+          :business_name  => "Bill Inc.",
+          :ssn_last4      => "1234",
+          :address => {
+            :line1 => "1234 1st Street",
+            :city  => "San Francisco",
+            :state => "CA"
+        }
+        ).save
+      end
+      it "should create a new customer" do
+        @customer.should_not be_nil
+      end
+      it "should contain the correct attributes" do
+        @customer.name.should eq("Bill")
+        @customer.email.should eq("bill@bill.com")
+        @customer.business_name.should eq("Bill Inc.")
+      end
+    end
+
+    describe "#add_card using untokenized object", :vcr do
+      before do
+      @customer = @marketplace.create_customer
+      @card = Balanced::Card.new(
+        :card_number       => "4111111111111111",
+        :expiration_month  => "12",
+        :expiration_year   => "2015",
+        )
+        @customer.add_card(@card)
+      end
+      it "should add a card to a customer" do
+        @customer.cards.size.should eq(1)
+      end
+    end
+
+    describe "#add_card using tokenized object", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @card = @marketplace.create_card(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+        @customer.add_card(@card)
+        @customer_card_id = @customer.cards.first.id
+        @card_id = @card.id
+      end
+      it "should add a card to a customer" do
+        @customer.cards.size.should eq(1)
+      end
+      it "card added should be the same card" do
+        @customer_card_id.should eq(@card_id)
+      end
+    end
+
+    describe "#add_card using uri", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @card = @marketplace.create_card(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+        @customer.add_card(@card.uri)
+        @customer_card_id = @customer.cards.first.id
+        @card_id = @card.id
+      end
+      it "should add a card to a customer" do
+        @customer.cards.size.should eq(1)
+      end
+      it "card added should be the same card" do
+        @customer_card_id.should eq(@card_id)
+      end
+    end
+
+    describe "#add_bank_account using tokenized object", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @bank_account = @marketplace.create_bank_account(
+          :account_number => "1234567980",
+          :bank_code => "321174811",
+          :name => "Jack Q Merchant"
+        )
+        @customer.add_bank_account(@bank_account)
+        @customer_bank_account_id = @customer.bank_accounts.first.id
+        @bank_account_id = @bank_account.id
+      end
+      it "should add a bank account to a customer" do
+        @customer.bank_accounts.size.should eq(1)
+      end
+      it "bank account added should be the same bank account" do
+        @customer_bank_account_id = @bank_account_id
+      end
+    end
+
+    describe "#add_bank_account using uri", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @bank_account = @marketplace.create_bank_account(
+          :account_number => "1234567980",
+          :bank_code => "321174811",
+          :name => "Jack Q Merchant"
+        )
+        @customer.add_bank_account(@bank_account.uri)
+        @customer_bank_account_id = @customer.bank_accounts.first.id
+        @bank_account_id = @bank_account.id
+      end
+      it "should add a bank account to a customer" do
+        @customer.bank_accounts.size.should eq(1)
+      end
+      it "bank account added should be the same bank account" do
+        @customer_bank_account_id = @bank_account_id
+      end
+    end
+
+    describe "#debit" do
+      before do
+        @customer = @marketplace.create_customer
+        @card = @marketplace.create_card(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+        @customer.add_card(@card)
+        @customer.debit :amount => 1000
+      end
+      context "customer debit should be added" do
+        subject {@customer.debits.first}
+        its(:amount) { should eq 1000}
+      end
+    end
+
+    describe "compound credit and debit", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @bank_account = @marketplace.create_bank_account(
+          :account_number => "1234567980",
+          :bank_code => "321174811",
+          :name => "Jack Q Merchant"
+        )
+        @card = Balanced::Card.new(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+        @customer.add_card(@card)
+        @customer.add_bank_account(@bank_account)
+        @customer.debit :amount => 1250
+      end
+
+      context "args passed by name via options hash" do
+        subject {
+          @customer.credit(
+            amount: 1250,
+            description: "description",
+            meta: {}
+          )
+        }
+
+        its(:amount) { should == 1250 }
+        its(:meta) { should == {} }
+        its(:description) { should == "description" }
+      end
+    end
+
+    describe "#active_card", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @card = @marketplace.create_card(
+          :card_number       => "4111111111111111",
+          :expiration_month  => "12",
+          :expiration_year   => "2015",
+        ).save
+        @customer.add_card(@card)
+      end
+      it "should display the most recently added valid card" do
+        @customer.active_card.should_not be_nil
+      end
+    end
+
+    describe "#active_bank_account", :vcr do
+      before do
+        @customer = @marketplace.create_customer
+        @bank_account = @marketplace.create_bank_account(
+          :account_number => "1234567980",
+          :bank_code => "321174811",
+          :name => "Jack Q Merchant"
+        )
+        @customer.add_bank_account(@bank_account)
+      end
+      it "should display the most recently added valid card" do
+        @customer.active_bank_account.should_not be_nil
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -48,3 +48,4 @@ DEBITS_URI_REGEX = /\/v1\/marketplaces\/TEST-\w*\/accounts\/\w*\/debits/
 TRANSACTIONS_URI_REGEX = /\/v1\/marketplaces\/TEST-\w*\/accounts\/\w*\/transactions/
 CREDITS_URI_REGEX = /\/v1\/marketplaces\/TEST-\w*\/accounts\/\w*\/credits/
 CARDS_URI_REGEX = /\/v1\/marketplaces\/TEST-\w*\/accounts\/\w*\/cards/
+CUSTOMERS_URI_REGEX = /\/v1\/customers/

data/upload_docs.rb

@@ -22,7 +22,8 @@ args = [
   'lib/balanced/resources/hold.rb',
   'lib/balanced/resources/marketplace.rb',
   'lib/balanced/resources/merchant.rb',
-  'lib/balanced/resources/transaction.rb'
+  'lib/balanced/resources/transaction.rb',
+  'lib/balanced/resources/customer.rb'
 ]
 
 YARD::CLI::CommandParser.run(*args)

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: balanced
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.7.1
 platform: ruby
 authors:
 - Mahmoud Abdelkader
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.6
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,17 +34,15 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: ! "Balanced is the payments platform for marketplaces.\n    Integrate
-  a payments experience just like Amazon for your marketplace.\n    Forget about dealing
+description: "Balanced is the payments platform for marketplaces.\n    Integrate a
+  payments experience just like Amazon for your marketplace.\n    Forget about dealing
   with banking systems, compliance, fraud, and security.\n    "
 email:
-- !binary |-
-  bWFobW91ZEBwb3VuZHBheS5jb20=
+- mahmoud@poundpay.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -75,6 +69,7 @@ files:
 - doc/balanced_templates/default/onefile/html/setup.rb
 - doc/balanced_templates/default/tags/html/index.erb
 - examples/bank_account_debits.rb
+- examples/customers.rb
 - examples/events_and_callbacks.rb
 - examples/examples.rb
 - lib/balanced.rb
@@ -88,6 +83,7 @@ files:
 - lib/balanced/resources/callback.rb
 - lib/balanced/resources/card.rb
 - lib/balanced/resources/credit.rb
+- lib/balanced/resources/customer.rb
 - lib/balanced/resources/debit.rb
 - lib/balanced/resources/event.rb
 - lib/balanced/resources/hold.rb
@@ -106,11 +102,11 @@ files:
 - spec/balanced/resources/bank_account_spec.rb
 - spec/balanced/resources/callback_spec.rb
 - spec/balanced/resources/credit_spec.rb
+- spec/balanced/resources/customer_spec.rb
 - spec/balanced/resources/hold_spec.rb
 - spec/balanced/resources/marketplace_spec.rb
 - spec/balanced/resources/merchant_spec.rb
 - spec/balanced/resources/resource_spec.rb
-- spec/balanced/resources/transactions_spec.rb
 - spec/balanced/response/balanced_exception_middleware_spec.rb
 - spec/balanced_spec.rb
 - spec/client_spec.rb
@@ -119,27 +115,26 @@ files:
 - upload_docs.rb
 homepage: https://balancedpayments.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sign up on https://balancedpayments.com/
 test_files:
 - spec/balanced/error_spec.rb
@@ -149,14 +144,13 @@ test_files:
 - spec/balanced/resources/bank_account_spec.rb
 - spec/balanced/resources/callback_spec.rb
 - spec/balanced/resources/credit_spec.rb
+- spec/balanced/resources/customer_spec.rb
 - spec/balanced/resources/hold_spec.rb
 - spec/balanced/resources/marketplace_spec.rb
 - spec/balanced/resources/merchant_spec.rb
 - spec/balanced/resources/resource_spec.rb
-- spec/balanced/resources/transactions_spec.rb
 - spec/balanced/response/balanced_exception_middleware_spec.rb
 - spec/balanced_spec.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
 - spec/utils_spec.rb
-has_rdoc: 

data/spec/balanced/resources/transactions_spec.rb

@@ -1,66 +0,0 @@
-require "spec_helper"
-
-describe Balanced::Transaction, :vcr do
-  before do
-    api_key = Balanced::ApiKey.new.save
-    Balanced.configure api_key.secret
-    @marketplace = Balanced::Marketplace.new.save
-
-    @merchant_attributes = {
-        :type => "person",
-        :name => "Billy Jones",
-        :street_address => "801 High St.",
-        :postal_code => "94301",
-        :country => "USA",
-        :dob => "1842-01",
-        :phone_number => "+16505551234",
-    }
-    bank_account = @marketplace.create_bank_account(
-      :account_number => "1234567890",
-      :bank_code => "321174851",
-      :name => "Jack Q Merchant"
-    )
-    card = Balanced::Card.new(
-      :card_number => "4111111111111111",
-      :expiration_month => "1",
-      :expiration_year => "2015",
-    ).save
-    @merchant = @marketplace.create_merchant(
-      :email_address => "merchant@example.org",
-      :merchant => @merchant_attributes,
-      :bank_account_uri => bank_account.uri,
-      :name => "Jack Q Merchant"
-    )
-    @buyer = @marketplace.create_buyer(
-      :email_address => "buyer+transactions@example.org",
-      :card_uri => card.uri,
-      :name => "Jack Q Buyer"
-    ).save
-
-    1.upto 5 do |n|
-      @buyer.debit(:amount => 1000, :description => "Transaction ##{n}")
-      @merchant.credit(:amount => 500, :description => "Credit from Debit ##{n}")
-    end
-
-  end
-
-  describe "Transaction", :vcr do
-    it "#all" do
-      Balanced::Transaction.all.length.should eql(15)
-    end
-
-    describe "#paginate", :vcr do
-      it "#total" do
-        Balanced::Transaction.paginate.total.should eql(15)
-      end
-
-      it "#each" do
-        counter = 0
-        Balanced::Transaction.paginate.each do |transaction|
-          counter += 1
-        end
-        counter.should eql(15)
-      end
-    end
-  end
-end