balanced 0.3.11 → 0.5.1

data/.gitignore

@@ -21,6 +21,7 @@ doc/
 # env
 .idea
 werk
+*.iml
 
 # lib
 Gemfile.lock

data/README.md

@@ -55,6 +55,12 @@ spec/cassettes.  To clear them and regenerate:
     $ rm -rf spec/cassettes
 
 
+### Issues
+
+All issues should be documented at 
+[balanced-ruby/issues](https://github.com/balanced/balanced-ruby/issues)
+
+
 ### Building Documentation
 
 Documentation is built using YARD - http://rubydoc.info/docs/yard

data/examples/examples.rb

@@ -1,4 +1,5 @@
-$:.unshift("/Users/mahmoud/code/poundpay/ruby/balanced-ruby/lib")
+cwd = File.dirname(File.dirname(File.absolute_path(__FILE__)))
+$:.unshift(cwd + "/lib")
 require 'balanced'
 
 begin
@@ -7,9 +8,9 @@ rescue NameError
   raise "wtf"
 end
 
-host = ENV['BALANCED_HOST'] or nil
+host = ENV.fetch('BALANCED_HOST') { nil }
 options = {}
-if host then
+if host
   options[:scheme] = 'http'
   options[:host] = host
   options[:port] = 5000
@@ -79,11 +80,11 @@ refund = debit.refund()  # the full amount!
 puts "ok, we have a merchant that's signing up, let's create an account for them " \
      "first, lets create their bank account."
 
-bank_account = Balanced::BankAccount.new(
+bank_account = marketplace.create_bank_account(
     :account_number => "1234567890",
     :bank_code => "12",
     :name => "Jack Q Merchant",
-).save
+)
 
 merchant = marketplace.create_merchant(
     :email_address => "merchant@example.org",
@@ -100,9 +101,9 @@ merchant = marketplace.create_merchant(
     :name => "Jack Q Merchant",
 )
 
-puts "oh our buyer is interested in buying something for 130.00$"
+puts "oh our buyer is interested in buying something for 530.00$"
 another_debit = buyer.debit(
-    :amount => 13000,
+    :amount => 53000,
     :appears_on_statement_as => "MARKETPLACE.COM"
 )
 
@@ -127,3 +128,32 @@ puts "invalidating a bank account"
 bank_account.invalidate
 
 raise "This card is INCORRECTLY VALID" if bank_account.is_valid
+
+puts "let's create a bank account not associated to an account"
+bank_account = Balanced::BankAccount.new(
+    :account_number => "9876543210",
+    :routing_number => "021000021",
+    :name => "Jake Skellington",
+    :type => "checking"
+).save
+
+puts "now let's credit it, the super-simple way"
+credit = bank_account.credit(
+    :amount => 500
+)
+
+raise "Incorrect value for credit" if credit.amount != 500
+
+puts "That was still too hard -- let's credit without creating a bank account first"
+credit = Balanced::Credit.new(
+    :amount => 700,
+    :description => "Amazing",
+    :bank_account => {
+        :account_number => "55555555",
+        :bank_code => "021000021",
+        :name => "Wanda Wandy",
+        :type => "checking"
+    }
+).save
+raise "OOPS -- that was hard after all" if (credit.amount != 700 or
+                                            credit.created_at.nil?)

data/lib/balanced.rb

@@ -25,7 +25,8 @@ module Balanced
     attr_accessor :config
 
     def configure(api_key=nil, options={})
-      @client = Balanced::Client.new(api_key, @config.merge(options))
+      @config = @config.merge(options)
+      @client = Balanced::Client.new(api_key, @config)
     end
 
     def is_configured_with_api_key?

data/lib/balanced/client.rb

@@ -16,7 +16,8 @@ module Balanced
       :logging_level => 'WARN',
       :connection_timeout => 2,
       :read_timeout => 5,
-      :logger => nil
+      :logger => nil,
+      :ssl_verify => true
     }
 
     attr_reader :conn
@@ -43,6 +44,9 @@ module Balanced
         :request => {
           :open_timeout => config[:connection_timeout],
           :timeout => config[:read_timeout]
+        },
+        :ssl => {
+          :verify => @config[:ssl_verify] # Only set this to false for testing
         }
       }
       @conn = Faraday.new(url, options) do |cxn|
@@ -63,20 +67,34 @@ module Balanced
     #end
 
     def url
-      URI::HTTPS.build :host => config[:host], :port => config[:port]
-    end
+      builder = (config[:scheme] == 'http') ? URI::HTTP : URI::HTTPS
 
-    private
+      builder.build ({:host => config[:host],
+                         :port => config[:port],
+                         :scheme => config[:scheme]})
+    end
 
     def method_missing(method, *args, &block)
-      case method
-      when :get, :post, :put, :delete
+      if is_http_method? method
         conn.basic_auth(api_key, '') unless api_key.nil?
         conn.send method, *args
       else
-        super
+        super method, *args, &block
       end
     end
 
+    private
+
+    def is_http_method? method
+      [:get, :post, :put, :delete].include? method
+    end
+
+    def respond_to?(method, include_private = false)
+      if is_http_method? method
+        true
+      else
+        super method, include_private
+      end
+    end
   end
 end

data/lib/balanced/error.rb

@@ -1,16 +1,21 @@
 module Balanced
 
-  # Custom error class for rescuing from all Balanced errors
-  class Error < StandardError
+  # Custom error class for rescuing from all API response-related Balanced errors
+  class Error < ::StandardError
     attr_reader :response
 
+    # @param [Hash] response the decoded json response body
     def initialize(response)
       @response = response
       super error_message
     end
 
+    # @return [Hash]
     def body
-      Utils.hash_with_indifferent_read_access response[:body]
+      @body ||= begin
+        return {} unless response[:body]
+        Utils.hash_with_indifferent_read_access(response[:body])
+      end
     end
 
     def error_message
@@ -26,12 +31,22 @@ module Balanced
       body.keys.each do |name|
         self.class.instance_eval {
           define_method(name) { body[name] }                       # Get.
-          define_method("#{name}?") { !!body[name].nil? }          # Present.
+          define_method("#{name}?") { !!body[name] }               # Present.
         }
       end
     end
   end
 
+  # General error class for non API response exceptions
+  class StandardError < Error
+    attr_reader :message
+    alias :error_message :message
+
+    def initialize(message)
+      @message = message
+    end
+  end
+
   class MoreInformationRequired < Error
     def redirect_uri
       response.headers['Location']

data/lib/balanced/resources/account.rb

@@ -29,9 +29,11 @@ module Balanced
     #
     # @return [Debit]
     def debit *args
+      warn_on_positional args
+
       options = args.last.is_a?(Hash) ? args.pop : {}
       amount = args[0] || options.fetch(:amount) { nil }
-      soft_descriptor = args[1] || options.fetch(:appears_on_statement_as) { 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[4] || options.fetch(:description) { nil }
@@ -40,7 +42,7 @@ module Balanced
       debit = Debit.new(
           :uri => self.debits_uri,
           :amount => amount,
-          :appears_on_statement_as => soft_descriptor,
+          :appears_on_statement_as => appears_on_statement_as,
           :hold_uri => hold_uri,
           :meta => meta,
           :description => description,
@@ -59,6 +61,8 @@ module Balanced
     # @return [Hold] A Hold representing the reservation of funds from
     #    this Account to your Marketplace.
     def hold *args
+      warn_on_positional args
+
       options = args.last.is_a?(Hash) ? args.pop : {}
       amount = args[0] || options.fetch(:amount) { }
       meta = args[1] || options.fetch(:meta) { nil }
@@ -81,20 +85,14 @@ module Balanced
     # @return [Credit] A Credit representing the transfer of funds from
     #    your Marketplace to this Account.
     def credit *args
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      amount = args[0] || options.fetch(:amount) { }
-      description = args[1] || options.fetch(:description) { nil }
-      meta = args[2] || options.fetch(:meta) { nil }
-      destination_uri = args[3] || options.fetch(:destination_uri) { nil }
+      warn_on_positional args
 
-      credit = Credit.new(
-        :uri => self.credits_uri,
-        :amount => amount,
-        :meta => meta,
-        :description => description,
-        :destination_uri => destination_uri,
-      )
-      credit.save
+      if args.last.is_a? Hash
+        args.last.merge! uri: self.credits_uri
+      else
+        args << { uri: self.credits_uri }
+      end
+      Credit.new(*args).save
     end
 
     # Associates the Card represented by +card_uri+ with this Account.

data/lib/balanced/resources/bank_account.rb

@@ -7,6 +7,19 @@ module Balanced
   class BankAccount
     include Balanced::Resource
 
+    def self.has_account?
+      self.respond_to?('account') && !self.account.nil?
+    end
+
+    def self.uri
+      # Override the default nesting -- bank accounts can be toplevel now
+      if !self.has_account?
+         self.collection_path
+      else
+         self.class.uri
+      end
+    end
+
     def initialize attributes = {}
       Balanced::Utils.stringify_keys! attributes
       unless attributes.has_key? 'uri'
@@ -21,25 +34,39 @@ module Balanced
     #    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 }
-      soft_descriptor = args[1] || options.fetch(:appears_on_statement_as) { 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, soft_descriptor, meta, description, self.uri)
+      self.account.debit(amount, appears_on_statement_as, meta, description, self.uri)
     end
 
-    # Creates a Credit of funds from your Marketplace's escrow account to this Account.
+    # 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 }
-      meta = args[2] || options.fetch(:meta) { nil }
-
-      self.account.credit(amount, description, meta, self.uri)
+      if !self.class.has_account?
+        Credit.new(
+          :amount => amount,
+          :description => description,
+          :uri => self.credits_uri,
+        ).save
+      else
+        meta = args[2] || options.fetch(:meta) { nil }
+        appears_on_statement_as = args[3] || options.fetch(:appears_on_statement_as) { nil }
+        destination_url = args[4] || options.fetch(:destination_uri) { self.uri }
+        self.account.credit(amount, meta, description, destination_uri, appears_on_statement_as)
+      end
     end
 
     def invalidate

data/lib/balanced/resources/card.rb

@@ -20,25 +20,38 @@ module Balanced
     #
     # @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 }
-      holds_uri = args[2] || options.fetch(:holds_uri) { nil }
+      hold_uri = args[2] || options.fetch(:hold_uri) { nil }
       meta = args[3] || options.fetch(:meta) { nil }
       description = args[3] || options.fetch(:description) { nil }
 
-      self.account.debit(amount, appears_on_statement_as, holds_uri, meta, description, self.uri)
+      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
+      )
     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[3] || options.fetch(:meta) { nil }
+      meta = args[1] || options.fetch(:meta) { nil }
 
-      self.account.hold(amount, meta, self.uri)
+      self.account.hold(
+          :amount => amount,
+          :meta => meta,
+          :source_uri => self.uri
+      )
     end
 
     def invalidate

data/lib/balanced/resources/credit.rb

@@ -8,13 +8,40 @@ module Balanced
   #
   class Credit
     include Balanced::Resource
-    def initialize attributes = {}
-      Balanced::Utils.stringify_keys! attributes
-      unless attributes.has_key? 'uri'
-        attributes['uri'] = self.class.uri
+
+    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 }
+
+      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
   end
 end
-

data/lib/balanced/resources/debit.rb

@@ -28,6 +28,8 @@ module Balanced
     #
     # @return [Refund]
     def refund *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 }

data/lib/balanced/resources/hold.rb

@@ -38,6 +38,8 @@ module Balanced
     #
     # @return [Debit]
     def capture *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 }
@@ -45,7 +47,13 @@ module Balanced
       description = args[3] || options.fetch(:description) { nil }
 
       amount ||= self.amount
-      self.account.debit(amount, appears_on_statement_as, self.uri, meta, description)
+      self.account.debit(
+          :amount => amount,
+          :appears_on_statement_as => appears_on_statement_as,
+          :hold_uri => self.uri,
+          :meta => meta,
+          :description => description
+      )
     end
 
   end