balanced 0.3.11 → 0.5.1

data/lib/balanced/resources/marketplace.rb

@@ -4,12 +4,39 @@ module Balanced
   class Marketplace
     include Balanced::Resource
 
+    @@marketplace_uri = nil
+
     # Returns an instance representing the marketplace associated with
     # the current API key.
     #
     # @return [Marketplace]
     def self.my_marketplace
-      Balanced::Merchant.me.marketplace
+      marketplace = Balanced::Merchant.me.marketplace
+      @@marketplace_uri = marketplace.uri if marketplace
+      marketplace
+    end
+
+    # @return [String, nil] the marketplace's URI
+    def self.marketplace_uri
+      if !@@marketplace_uri and Balanced.is_configured_with_api_key?
+        begin
+          self.my_marketplace
+        rescue Balanced::Error
+          # do nothing..
+        end
+      end
+      @@marketplace_uri
+    end
+
+    def self.marketplace_exists?
+      !!marketplace_uri
+    end
+
+    # @return [Marketplace]
+    def save
+      marketplace = super
+      @@marketplace_uri = marketplace.uri
+      marketplace
     end
 
     # Returns an instance representing the marketplace associated with
@@ -20,10 +47,33 @@ module Balanced
       self.class.my_marketplace
     end
 
+    # Create an Account associated with this Marketplace. This account
+    # will have no roles associated with it.
+    #
+    # @return [Account]
+    def create_account options={}
+      email_address = options.fetch(:email_address) { nil }
+      name = options.fetch(:name) { nil }
+      meta = options.fetch(:meta) { nil }
+
+      account_attributes = {
+          :uri => self.accounts_uri,
+          :email_address => email_address,
+          :name => name,
+          :meta => meta
+      }
+
+      account = Account.new account_attributes
+      account.save
+    end
+
+
     # Create a buyer Account associated with this Marketplace.
     #
     # @return [Account]
     def create_buyer *args
+      warn_on_positional args
+
       options = args.last.is_a?(Hash) ? args.pop : {}
       email_address = args[0] || options.fetch(:email_address) { nil }
       card = args[1] || options.fetch(:card_uri) { options.fetch(:card) { nil} }
@@ -61,6 +111,8 @@ module Balanced
     #
     # @return [Account]
     def create_merchant *args
+      warn_on_positional args
+
       options = args.last.is_a?(Hash) ? args.pop : {}
       email_address = args[0] || options.fetch(:email_address) { nil }
       merchant = args[1] || options.fetch(:merchant) { nil }
@@ -73,7 +125,7 @@ module Balanced
           :email_address => email_address,
           :bank_account_uri => bank_account_uri,
           :name => name,
-          :meta => meta,
+          :meta => meta
       }
 
       if merchant.respond_to? :keys
@@ -86,7 +138,71 @@ module Balanced
       account.save
     end
 
+    # Creates a BankAccount object tied to this marketplace, for use with
+    # accounts
+    #
+    # @return [BankAccount]
+    def create_bank_account *args
+      warn_on_positional args
+
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      name = args[0] || options.fetch(:name) { }
+      account_number = args[1] || options.fetch(:account_number) { nil }
+      bank_code = args[2] || options.fetch(:bank_code) {
+        options.fetch(:routing_number) {
+          nil
+        }
+      }
+      meta = args[3] || options.fetch(:meta) { nil }
+
+      bank_account = BankAccount.new(
+          :uri => self.bank_accounts_uri,
+          :name => name,
+          :account_number => account_number,
+          :bank_code => bank_code,
+          :meta => meta
+      )
+
+      bank_account.save
+    end
+
+    # Creates a Card object tied to this marketplace, for use with
+    # accounts
+    #
+    # @return [Card]
+    def create_card *args
+      warn_on_positional args
+
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      card_number = args[0] || options.fetch(:card_number) { nil }
+      expiration_month = args[1] || options.fetch(:expiration_month) { nil }
+      expiration_year = args[2] || options.fetch(:expiration_year) { nil }
+      security_code = args[3] || options.fetch(:expiration_year) { nil }
+      postal_code = args[4] || options.fetch(:postal_code) { nil }
+      name = args[5] || options.fetch(:name) { nil }
+      phone_number = args[6] || options.fetch(:phone_number) { nil }
+      street_address = args[7] || options.fetch(:street_address) { nil }
+      city = args[8] || options.fetch(:city) { nil }
+      country_code = args[9] || options.fetch(:country_code) { nil }
+      meta = args[10] || options.fetch(:meta) { nil }
+
+      card = Card.new(
+          :uri => self.cards_uri,
+          :card_number => card_number,
+          :expiration_month => expiration_month,
+          :expiration_year => expiration_year,
+          :name => name,
+          :security_code => security_code,
+          :street_address => street_address,
+          :city => city,
+          :postal_code => postal_code,
+          :country_code => country_code,
+          :phone_number => phone_number,
+          :meta => meta
+      )
+      card.save
+    end
+
   end
 
 end
-

data/lib/balanced/resources/merchant.rb

@@ -1,4 +1,5 @@
 module Balanced
+  # Resource representing the marketplace merchant object.
   class Merchant
     include Balanced::Resource
 
@@ -18,4 +19,3 @@ module Balanced
 
   end
 end
-

data/lib/balanced/resources/resource.rb

@@ -27,6 +27,25 @@ module Balanced
       reload @response
     end
 
+    def warn_on_positional args
+      msg = <<-WARNING
+      #############################################################
+      #   WARNING! WARNING! WARNING! WARNING! WARNING! WARNING!   #
+      #############################################################
+
+      Using positional arguments is **DEPRECATED**. Please use the
+      keyword options pattern instead. Version __0.7.0__ of the
+      Ruby client will not support positional arguments.
+
+      If you need help, please hop on irc.freenode.net #balanced
+      or contact support@balancedpayments.com
+      WARNING
+      # warn if [...] otherwise, it's ok if it's: [], [{}] or [{...}]
+      unless (args.size == 1 and args.last.is_a? Hash) or (args.size == 0)
+        warn msg
+      end
+    end
+
     def response
       @response
     end
@@ -83,20 +102,27 @@ module Balanced
       Utils.underscore resource_name
     end
 
+    # Returns the resource URI for a given class.
+    #
+    # @example A Balanced::Account resource
+    #   Balanced::Account.uri # => "/v1/marketplaces/TEST-MP72zVdg2j9IiqRffW9lczRZ/accounts"
+    #
+    # @return [String] the uri of the instance or the class
     def uri
-      # the uri of a particular resource depends if there's a marketplace created or not
-      # if there's a marketplace, then all resources have their own uri from there and the top level ones
-      # if there's not a marketplace
+      # the uri of a particular resource depends if there's a marketplace
+      # created or not. if there's a marketplace, then all resources have their
+      # own uri from there and the top level ones. if there's not a marketplace
+      #
       #    if there's an api key, then the merchant is available
       #    if there's no api key, the only resources exposed are purely top level
-      if self == Balanced::Merchant or self == Balanced::Marketplace or self == Balanced::ApiKey
+      if self == Balanced::Merchant || self == Balanced::Marketplace || self == Balanced::ApiKey
         collection_path
       else
-        if Balanced::Marketplace.my_marketplace.nil?
-          raise Balanced::Error, "#{self.name} is nested under a marketplace, which is not created or configured."
-        else
-          Balanced::Marketplace.my_marketplace.send(collection_name + '_uri')
+        if !Balanced::Marketplace.marketplace_exists?
+          raise Balanced::StandardError, "#{self.name} is nested under a marketplace, which is not created or configured."
         end
+
+        Balanced::Marketplace.marketplace_uri + "/#{collection_name}"
       end
     end
 
@@ -134,7 +160,7 @@ module Balanced
         instance.class.instance_eval {
           define_method(name) { @attributes[name] }                       # Get.
           define_method("#{name}=") { |value| @attributes[name] = value } # Set.
-          define_method("#{name}?") { !!@attributes[name].nil? }               # Present.
+          define_method("#{name}?") { !!@attributes[name] }               # Present.
         }
         instance.send("#{name}=".to_s, value)
       end
@@ -168,4 +194,3 @@ module Balanced
 
   end
 end
-

data/lib/balanced/version.rb

@@ -1,3 +1,3 @@
 module Balanced
-  VERSION = '0.3.11'
+  VERSION = '0.5.1'
 end

data/spec/balanced/error_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Balanced::Error, '#response' do
+  it "sets the response in the initializer" do
+    response = {status: 200}
+    Balanced::Error.new(response).response.should == response
+  end
+end
+
+describe Balanced::Error, '#body' do
+  it 'is constructed from the response[:body]' do
+    response = {body: {}}
+    error = Balanced::Error.new(response)
+    error.body.should == response[:body]
+  end
+
+  it "defaults to an empty hash when no body is passed" do
+    Balanced::Error.new({}).body.should == {}
+  end
+
+  describe "generating methods from response keys"  do
+    before do
+      response = {body: {foo: 'bar'}}
+      @error = Balanced::Error.new(response)
+    end
+
+    it 'generates a getter for each key' do
+      @error.foo.should == 'bar'
+    end
+
+    it 'generates a predicate method' do
+      @error.foo?.should be_true
+    end
+  end
+end
+
+describe Balanced::StandardError do
+  subject { Balanced::StandardError.new('ohnoe!') }
+
+  its(:message) { should == 'ohnoe!' }
+  its(:error_message) { should == 'ohnoe!' }
+end

data/spec/balanced/resources/account_spec.rb

@@ -12,8 +12,11 @@ describe Balanced::Account do
     use_vcr_cassette
 
     context "when ApiKey is not configured" do
+
       use_vcr_cassette
+
       before do
+        Balanced::Marketplace.stub(:marketplace_uri) { nil }
         Balanced.configure nil
       end
 
@@ -53,69 +56,73 @@ describe Balanced::Account do
         :dob => "1842-01",
         :phone_number => "+16505551234",
       }
+
+      @card = Balanced::Card.new(
+        :card_number => "4111111111111111",
+        :expiration_month => "12",
+        :expiration_year => "2015",
+      ).save
+
+      @buyer = Balanced::Account.new(
+        :uri => @marketplace.accounts_uri,
+        :email_address => "buyer7@example.org",
+        :card_uri => @card.uri,
+        :name => "Jack Q Buyer"
+      ).save
+
+      @bank_account = @marketplace.create_bank_account(
+        :account_number => "1234567890",
+        :bank_code => "321174851",
+        :name => "Jack Q Merchant"
+      )
+
+      @merchant = Balanced::Account.new(
+        :uri => @marketplace.accounts_uri,
+        :email_address => "merchant@example.org",
+        :merchant => @merchant_attributes,
+        :bank_account_uri => @bank_account.uri,
+        :name => "Jack Q Merchant"
+      ).save
+
+
     end
 
-    describe "new" do
+    describe "#credit" do
       use_vcr_cassette
       before do
-        @bank_account = Balanced::BankAccount.new(
-          :account_number => "1234567890",
-          :bank_code => "321174851",
-          :name => "Jack Q Merchant"
-        ).save
-      end
-      it do
-        -> do
-          @merchant = Balanced::Account.new(
-            :uri => @marketplace.accounts_uri,
-            :email_address => "merchant@example.org",
-            :merchant => @merchant_attributes,
-            :bank_account_uri => @bank_account.uri,
-            :name => "Jack Q Merchant"
-          )
-        end.should_not raise_error
+        @buyer.debit :amount => 1250
       end
-    end
 
-    describe "#save" do
+      # WARNING: This test is deprecated
+      context "all args passed directly" do
+        subject {
+          @merchant.credit 1250, "description", {}, @bank_account.uri
+        }
 
-      describe "when creating" do
-        use_vcr_cassette
-        before do
-          bank_account = Balanced::BankAccount.new(
-            :account_number => "1234567890",
-            :bank_code => "321174851",
-            :name => "Jack Q Merchant"
-          ).save
-          @merchant = Balanced::Account.new(
-            :uri => @marketplace.accounts_uri,
-            :email_address => "merchant@example.org",
-            :merchant => @merchant_attributes,
-            :bank_account_uri => bank_account.uri,
-            :name => "Jack Q Merchant"
+        its(:amount) { should == 1250 }
+        its(:meta) { should == {} }
+        its(:description) { should == "description" }
+      end
+
+      context "args passed by name via options hash" do
+        subject {
+          @merchant.credit(
+            amount: 1250,
+            description: "description",
+            meta: {},
+            destination_uri: @bank_account.uri
           )
-        end
-        it { -> { @merchant.save }.should_not raise_error }
+        }
+
+        its(:amount) { should == 1250 }
+        its(:meta) { should == {} }
+        its(:description) { should == "description" }
       end
+    end
 
+    describe "#save" do
       describe "after #save" do
         describe "attributes" do
-          use_vcr_cassette
-          before do
-            bank_account = Balanced::BankAccount.new(
-              :account_number => "1234567890",
-              :bank_code => "321174851",
-              :name => "Jack Q Merchant"
-            ).save
-            @merchant = Balanced::Account.new(
-              :uri => @marketplace.accounts_uri,
-              :email_address => "merchant2@example.org",
-              :merchant => @merchant_attributes,
-              :bank_account_uri => bank_account.uri,
-              :name => "Jack Q Merchant"
-            ).save
-          end
-
           describe "#id" do
             subject { @merchant.id }
             it { should_not be_nil }
@@ -127,7 +134,7 @@ describe Balanced::Account do
           end
           describe "#email_address" do
             subject { @merchant.email_address }
-            it { should eql "merchant2@example.org" }
+            it { should eql "merchant@example.org" }
           end
           describe "#name" do
             subject { @merchant.name }
@@ -175,55 +182,22 @@ describe Balanced::Account do
     end
 
     describe "#add_bank_account" do
-      describe "when executing" do
-        use_vcr_cassette
-
-        before do
-          @bank_account = Balanced::BankAccount.new(
-            :account_number => "1234567890",
-            :bank_code => "321174851",
-            :name => "Jack Q Merchant"
-          ).save
-
-          @merchant = Balanced::Account.new(
-            :uri => @marketplace.accounts_uri,
-            :email_address => "merchant1@example.org",
-            :merchant => @merchant_attributes,
-            :bank_account_uri => @bank_account.uri,
-            :name => "Jack Q Merchant"
-          ).save
+      use_vcr_cassette
+      before do
+        @new_bank_account = @marketplace.create_bank_account(
+          :account_number => "1234567890",
+          :bank_code => "321174851",
+          :name => "Jack Q Merchant"
+        )
+      end
 
-          @new_bank_account = Balanced::BankAccount.new(
-            :account_number => "53434533",
-            :bank_code => "12345678",
-            :name => "Jack Q Merchant"
-          ).save
-        end
+      describe "when executing" do
         it { -> { @merchant.add_bank_account(@new_bank_account.uri) }.should_not raise_error }
       end
 
       describe "after executing" do
         use_vcr_cassette
         before do
-          @bank_account = Balanced::BankAccount.new(
-            :account_number => "12345678901",
-            :bank_code => "321174851",
-            :name => "Jack Q Merchant"
-          ).save
-
-          @merchant = Balanced::Account.new(
-            :uri => @marketplace.accounts_uri,
-            :email_address => "merchant4@example.org",
-            :merchant => @merchant_attributes,
-            :bank_account_uri => @bank_account.uri,
-            :name => "Jack Q Merchant"
-          ).save
-
-          @new_bank_account = Balanced::BankAccount.new(
-            :account_number => "53434533",
-            :bank_code => "12345678",
-            :name => "Jack Q Merchant"
-          ).save
           @merchant.add_bank_account(@new_bank_account.uri)
           @bank_accounts = Balanced::BankAccount.find(@merchant.bank_accounts_uri).items
         end
@@ -231,8 +205,6 @@ describe Balanced::Account do
         subject { @bank_accounts.size }
         it { should eql 2 }
       end
-
-
     end
   end
 
@@ -483,12 +455,13 @@ describe Balanced::Account do
       it "takes optional parameters"  do
         debit = @buyer.debit(
           :amount => 500,
-          :appears_on_statement_as => "BOBS BURGERS",
+          :appears_on_statement_as => "BOBS BURGERS"
         )
         debit.should be_instance_of Balanced::Debit
         debit.amount.should eql 500
         debit.appears_on_statement_as.should eql "BOBS BURGERS"
       end
+      # this is deprecated
       it "takes positional parameters" do
         debit = @buyer.debit(500, "FOO FIGHTER")
         debit.should be_instance_of Balanced::Debit
@@ -512,8 +485,8 @@ describe Balanced::Account do
         :expiration_year => "2015",
       ).save
       Balanced::Marketplace.my_marketplace.create_buyer(
-        "john.doe@example.com",
-        card.uri
+        :email_address => "john.doe@example.com",
+        :card_uri => card.uri,
       )
     end
 
@@ -548,9 +521,9 @@ describe Balanced::Account do
         :expiration_month => "12",
         :expiration_year => "2015",
       ).save
-      buyer = Balanced::Marketplace.my_marketplace.create_buyer(
-        "john.doe@example.com",
-        card.uri
+      @buyer = Balanced::Marketplace.my_marketplace.create_buyer(
+        :email_address => "john.doe@example.com",
+        :card_uri => card.uri,
       )
     end