balanced 0.5.4 → 0.5.5

data/README.md

@@ -3,6 +3,7 @@
 Online Marketplace Payments
 
 [![Build Status](https://secure.travis-ci.org/balanced/balanced-ruby.png)](http://travis-ci.org/balanced/balanced-ruby)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/balanced/balanced-ruby)
 
 ## Installation
 

data/examples/events_and_callbacks.rb

@@ -0,0 +1,80 @@
+"""
+Welcome weary traveller. Sick of polling for state changes? Well today have I
+got good news for you. Run this example below to see how to get yourself some
+callback goodness and to understand how events work.
+"""
+cwd = File.dirname(File.dirname(File.absolute_path(__FILE__)))
+$:.unshift(cwd + "/lib")
+require 'balanced'
+require 'net/http'
+require 'uri'
+require 'json'
+
+api_key = Balanced::ApiKey.new.save
+Balanced.configure(api_key.secret)
+marketplace = Balanced::Marketplace.new.save
+
+# mumble, let's create a requestb.in
+request_bin = Net::HTTP.post_form(URI.parse('http://requestb.in/api/v1/bins'), {})
+response = JSON.parse request_bin.body
+bin_name = response['name']
+callback_url = 'http://requestb.in/' + bin_name
+requests_url = 'http://requestb.in/api/v1/bins/%s/requests' % bin_name
+
+puts 'let\'s create a callback'
+marketplace.create_callback(
+    :url => callback_url
+)
+
+puts 'let\'s create a card and associate it with a new account'
+card = Balanced::Card.new(
+    :expiration_month => '12',
+    :security_code => '123',
+    :card_number => '5105105105105100',
+    :expiration_year => '2020'
+).save()
+buyer = Balanced::Account.new(
+    'card_uri' => card.uri
+).save()
+
+puts 'generate a debit (which implicitly creates and captures a hold)'
+buyer.debit(:amount => 100)
+
+puts 'event creation is an async operation, let\'s wait until we have ' \
+          'some events!'
+while Balanced::Event.find(:all).length == 0
+  puts 'Zzzz'
+  sleep(0)
+end
+
+  puts 'Woop, we got some events, let us see what there is to look at'
+for event in Balanced::Event.find(:all)
+  puts 'this was a %s event, it occurred at %s, the callback has a ' \
+            'status of %s' % [
+            event.type,
+            event.occurred_at,
+            event.callback_statuses
+        ]
+end
+
+puts 'you can inspect each event to see the logs'
+event = Balanced::Event.find(:first)
+for callback in event.callbacks
+  puts 'inspecting callback to %s for event %s' % [
+            callback.url,
+            event.type
+        ]
+
+  for log in callback.logs
+    puts 'this attempt to the callback has a status of %s' % [log.status]
+  end
+end
+
+puts 'ok, let\'s check with requestb.in to see if our callbacks fired at %s' % callback_url
+uri = URI.parse(requests_url)
+request_bin = Net::HTTP.get_response(uri)
+response = JSON.parse request_bin.body
+puts 'we received %s callbacks, you can view them at http://requestb.in/%s?inspect' % [
+    response.length,
+    bin_name,
+]

data/lib/balanced/client.rb

@@ -7,15 +7,15 @@ require "balanced_exception_middleware"
 
 module Balanced
   class Client
-
+  
     DEFAULTS = {
       :scheme => 'http',
       :host => 'localhost',
       :port => 5000,
       :version => '1',
       :logging_level => 'WARN',
-      :connection_timeout => 2,
-      :read_timeout => 5,
+      :connection_timeout => 30,
+      :read_timeout => 30,
       :logger => nil,
       :ssl_verify => true
     }

data/lib/balanced/resources.rb

@@ -11,3 +11,5 @@ require "marketplace"
 require "merchant"
 require "refund"
 require "transaction"
+require "callback"
+require "event"

data/lib/balanced/resources/account.rb

@@ -38,6 +38,19 @@ module Balanced
       meta = args[3] || options.fetch(:meta) { nil }
       description = args[4] || options.fetch(:description) { nil }
       source_uri = args[5] || options.fetch(:source_uri) { nil }
+      on_behalf_of = args[6] || options.fetch(:on_behalf_of) { nil }
+
+      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 an account URI'
+        end
+        if on_behalf_of == self.uri
+          raise ArgumentError, 'The on_behalf_of parameter MAY NOT be the same account as the account you are debiting!'
+        end
+      end
 
       debit = Debit.new(
           :uri => self.debits_uri,
@@ -47,6 +60,7 @@ module Balanced
           :meta => meta,
           :description => description,
           :source_uri => source_uri,
+          :on_behalf_of_uri => on_behalf_of,
       )
       debit.save
     end
@@ -146,8 +160,12 @@ module Balanced
     #       }
     #    }
     #
-    def promote_to_merchant merchant_data
-      self.merchant = merchant_data
+    def promote_to_merchant merchant
+      if merchant.is_a?(String)
+        self.merchant_uri = merchant
+      else
+        self.merchant = merchant
+      end
       save
     end
 

data/lib/balanced/resources/callback.rb

@@ -0,0 +1,11 @@
+module Balanced
+
+  # A Callback is a publicly accessible location that can receive POSTed JSON
+  # data whenever an Event is generated.
+  #
+  class Callback
+    include Balanced::Resource
+
+  end
+
+end

data/lib/balanced/resources/card.rb

@@ -18,6 +18,14 @@ module Balanced
     # 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
+    #
     # @return [Debit]
     def debit *args
       warn_on_positional args

data/lib/balanced/resources/credit.rb

@@ -9,6 +9,14 @@ module Balanced
   class Credit
     include Balanced::Resource
 
+    # @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 }

data/lib/balanced/resources/event.rb

@@ -0,0 +1,27 @@
+module Balanced
+
+  # An Event is a snapshot of another resource at a point in time when
+  # something significant occurred. Events are created when resources are
+  # created, updated, deleted or otherwise change state such as a Credit being
+  # marked as failed.
+  #
+  class Event
+    include Balanced::Resource
+
+  end
+
+  # Represents a single event being sent to a callback.
+  #
+  class EventCallback
+    include Balanced::Resource
+
+  end
+
+  # Represents a single log of an event sent to a callback.
+  #
+  class Log
+    include Balanced::Resource
+
+  end
+
+end

data/lib/balanced/resources/marketplace.rb

@@ -209,6 +209,19 @@ module Balanced
       card.save
     end
 
+    def create_callback *args
+      warn_on_positional args
+
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      url = args[0] || options.fetch(:url) { nil }
+
+      callback = Callback.new(
+          'uri' => self.callbacks_uri,
+          'url' => url
+      )
+      callback.save
+    end
+
   end
 
 end

data/lib/balanced/version.rb

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

data/spec/balanced/resources/account_spec.rb

@@ -461,6 +461,36 @@ describe Balanced::Account do
         debit.amount.should eql 500
         debit.appears_on_statement_as.should eql "BOBS BURGERS"
       end
+      it "accepts on_behalf_of parameter" do
+        merchant = Balanced::Account.new.save
+        debit = @buyer.debit(
+          :amount => 500,
+          :on_behalf_of => merchant
+        )
+        debit.should be_instance_of Balanced::Debit
+        debit.amount.should eql 500
+        # TODO: once the API returns on_behalf_of in the response, make sure it shows up. For now we just make sure the debit didn't fail.
+      end
+      it "accepts URI for on_behalf_of" do
+        merchant = Balanced::Account.new.save
+        debit = @buyer.debit(
+          :amount => 500,
+          :on_behalf_of => merchant.uri
+        )
+        debit.should be_instance_of Balanced::Debit
+        debit.amount.should eql 500
+        # TODO: once the API returns on_behalf_of in the response, make sure it shows up. For now we just make sure the debit didn't fail.
+      end
+
+      it "fails with bad on_behalf_of parameter" do
+        expect {
+          @buyer.debit(
+            :amount => 500,
+            :on_behalf_of => @buyer
+          )
+        }.to raise_error ArgumentError
+      end
+
       # this is deprecated
       it "takes positional parameters" do
         debit = @buyer.debit(500, "FOO FIGHTER")

data/spec/balanced/resources/callback_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe Balanced::Callback do
+  use_vcr_cassette
+
+  before do
+    api_key = Balanced::ApiKey.new.save
+    Balanced.configure api_key.secret
+
+    @marketplace = Balanced::Marketplace.new.save
+
+  end
+
+  describe "create" do
+    use_vcr_cassette
+
+    before do
+      @callback = @marketplace.create_callback(
+          :url => "http://www.example.com/balanced_callback"
+      )
+    end
+
+    context 'check url' do
+
+      subject { @callback.url}
+      it { should eql "http://www.example.com/balanced_callback" }
+
+    end
+
+  end
+
+  describe "delete" do
+    use_vcr_cassette
+
+    before do
+      @callback = @marketplace.create_callback(
+          :url => "http://www.example.com/balanced_callback"
+      )
+    end
+
+    context 'delete' do
+      it "should delete without an error" do
+
+        @callback.destroy
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: balanced
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -47,7 +47,8 @@ description: ! "Balanced is the payments platform for marketplaces.\n    Integra
   a payments experience just like Amazon for your marketplace.\n    Forget about dealing
   with banking systems, compliance, fraud, and security.\n    "
 email:
-- mahmoud@poundpay.com
+- !binary |-
+  bWFobW91ZEBwb3VuZHBheS5jb20=
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -73,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/events_and_callbacks.rb
 - examples/examples.rb
 - lib/balanced.rb
 - lib/balanced/client.rb
@@ -82,9 +84,11 @@ files:
 - lib/balanced/resources/account.rb
 - lib/balanced/resources/api_key.rb
 - lib/balanced/resources/bank_account.rb
+- lib/balanced/resources/callback.rb
 - lib/balanced/resources/card.rb
 - lib/balanced/resources/credit.rb
 - lib/balanced/resources/debit.rb
+- lib/balanced/resources/event.rb
 - lib/balanced/resources/hold.rb
 - lib/balanced/resources/marketplace.rb
 - lib/balanced/resources/merchant.rb
@@ -99,6 +103,7 @@ files:
 - spec/balanced/resources/account_spec.rb
 - spec/balanced/resources/api_key_spec.rb
 - spec/balanced/resources/bank_account_spec.rb
+- spec/balanced/resources/callback_spec.rb
 - spec/balanced/resources/credit_spec.rb
 - spec/balanced/resources/hold_spec.rb
 - spec/balanced/resources/marketplace_spec.rb
@@ -131,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sign up on https://balancedpayments.com/
@@ -141,6 +146,7 @@ test_files:
 - spec/balanced/resources/account_spec.rb
 - spec/balanced/resources/api_key_spec.rb
 - spec/balanced/resources/bank_account_spec.rb
+- spec/balanced/resources/callback_spec.rb
 - spec/balanced/resources/credit_spec.rb
 - spec/balanced/resources/hold_spec.rb
 - spec/balanced/resources/marketplace_spec.rb