poundpay 0.3.1 → 0.3.2

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "examples/marketplace/fe"]
+	path = examples/marketplace/fe
+	url = git@github.com:PoundPay/simplefe.git

data/README.rdoc

@@ -89,6 +89,7 @@ Poundpay is a payments platform for marketplaces
   payment.escrow                    # AUTHORIZED -> ESCROWED.  Credit card is charged
   payment.release                   # ESCROWED or PARTIALLY_RELEASED -> RELEASED.  Recipient receives money
   payment.cancel                    # ESCROWED or PARTIALLY_RELEASED -> CANCELED.  Payer receives refund
+  Poundpay::Payment.batch_update    # Batch update a list of payments.
 
 
 == Creating a charge permission
@@ -130,3 +131,77 @@ Poundpay is a payments platform for marketplaces
 
   charge_permission = Poundpay::ChargePermission.find(charge_permission_sid)
   charge_permission.deactivate      # CREATED or ACTIVE -> INACTIVE. Charge permission is deactivated and can no longer be used to authorize payments for the associated payer.
+
+
+== Batching
+
+In some cases you may wish to batch authorize and escrow a collection of
+payments. By doing so there will be only *one* payer charge for that collection
+of payments. Note that if you do batch authorize a collection of payments that
+it must *also* be batch escrowed.
+
+Batching is designed for shopping carts where you want a collection of payments
+to appear to appear as a single charge.
+
+In order to use batching you simply need to pass `sids` for *all* payments in
+the collection you want to batch to the IFrame
+
+  <script src="https://www.poundpay.com/js/poundpay.js"></script>
+
+    <div id="pound-root"></div>
+
+    <script>
+      function handlePaymentSuccess() {
+        // do something
+      }
+
+      function handlePaymentError() {
+        // handle error
+      }
+
+      PoundPay.init({
+        payment_sid: [
+            "<%= @payment1.sid %>"
+            "<%= @payment2.sid %>",
+            "<%= @payment3.sid %>"
+            ],
+        success: handlePaymentSuccess,
+        error: handlePaymentError,
+        first_name: "Fred", // Optional
+        last_name: "Nietzsche", // Optional
+        address_street: "990 Guerrero St", // Optional
+        address_city: "San Francisco", // Optional
+        address_state: "California", // Optional
+        address_zip: "94110", // Optional
+        server: "https://www-sandbox.poundpay.com"  // Exclude for production
+      });
+    </script>
+
+Alternatively if you are directly authorizing the payments using a charge
+permission
+
+    Poundpay::Payment.batch_update(
+        :sid => [payment1.sid, payment2.sid, payment3.sid],
+        :status => 'AUTHORIZED')
+
+Finally you'll need to batch escrow the payments
+
+    Poundpay::Payment.batch_update(
+        :sid => [payment1.sid, payment2.sid, payment3.sid],
+        :status => 'ESCROWED')
+
+Notice that if you did the following instead an error would be triggered since
+batched payments *must* be authorized and escrowed collectively
+
+    payment = Poundpay::Payment.find(payment1_sid)  
+    payment.escrow  # fails
+
+However if you cancel some of the payments prior to batch escrow you should
+exclude them from the batch call
+
+    payment1 = Poundpay::Payment.find(payment1_sid)  
+    payment1.cancel  # ok
+
+    Poundpay::Payment.batch_update(
+        :sid => [payment2.sid, payment3.sid],
+        :status => 'ESCROWED')

data/examples/{simple_application → marketplace}/application.rb

@@ -3,6 +3,7 @@ require 'poundpay'
 
 require './config'
 
+
 class SimpleController
   attr_reader :poundpay_client
 
@@ -45,17 +46,17 @@ class Payment < SimpleController
 
   def call env
     request = Rack::Request.new(env)
-    return_value = case request.path.gsub(/\/$/, '')  # trim trailing /
-      when '/payment' then request.post? ? create(request) : nil
-      when '/payment/release' then request.post? ? release(request) : nil
-      when '/payment/authorize' then request.post? ? authorize(request) : nil
-      when '/payment/cancel' then request.post? ? cancel(request) : nil
-      when '/payment/escrow' then request.post? ? escrow(request) : nil
+    return_value, mime_type = case request.path.gsub(/\/$/, '')  # trim trailing /
+      when '/payment' then request.post? ? create(request) : [nil, nil]
+      when '/payment/release' then request.post? ? release(request) : [nil, nil]
+      when '/payment/authorize' then request.post? ? authorize(request) : [nil, nil]
+      when '/payment/cancel' then request.post? ? cancel(request) : [nil, nil]
+      when '/payment/escrow' then request.post? ? escrow(request) : [nil, nil]
       else nil
     end
 
     if return_value
-      response = Rack::Response.new([return_value], 201, {"Content-Type" => "text/html"})
+      response = Rack::Response.new([return_value], 201, {"Content-Type" => mime_type})
       response.finish
     else
       return_404
@@ -64,35 +65,48 @@ class Payment < SimpleController
 
   def create request
     payment = Poundpay::Payment.create(request.POST)
-    payment.sid
+    payment.include_root_in_json = false
+    return payment.to_json(), "application/json"
   end
 
   def authorize request
-    payment = Poundpay::Payment.find(request.POST['sid'])
-    payment.authorize
-    payment.save
-    PP.pp(payment.schema, '')
+    if request.POST['sid'].kind_of?(Array)
+        payments = Poundpay::Payment.batch_update(:sid => request.POST['sid'], :status => 'authorized')
+        payments = payments.collect! {|p| p.schema }
+        return PP.pp(payments, ''), "text/html"
+    else
+        payment = Poundpay::Payment.find(request.POST['sid'])
+        payment.authorize
+        payment.save
+        return PP.pp(payment.schema, ''), "text/html"
+    end
   end
 
   def release request
     payment = Poundpay::Payment.find(request.POST['sid'])
     payment.release
     payment.save
-    PP.pp(payment.schema, '')
+    return PP.pp(payment.schema, ''), "text/html"
   end
 
   def cancel request
     payment = Poundpay::Payment.find(request.POST['sid'])
     payment.cancel
     payment.save
-    PP.pp(payment.schema, '')
+    return PP.pp(payment.schema, ''), "text/html"
   end
 
   def escrow request
-    payment = Poundpay::Payment.find(request.POST['sid'])
-    payment.escrow
-    payment.save
-    PP.pp(payment.schema, '')
+    if request.POST['sid'].kind_of?(Array)
+        payments = Poundpay::Payment.batch_update(:sid => request.POST['sid'], :status => 'escrowed')
+        payments = payments.collect! {|p| p.schema }
+        return PP.pp(payments, ''), "text/html"
+    else
+        payment = Poundpay::Payment.find(request.POST['sid'])
+        payment.escrow
+        payment.save
+        return PP.pp(payment.schema, ''), "text/html"
+    end
   end
 
 end
@@ -102,13 +116,13 @@ class User < SimpleController
 
   def call env
     request = Rack::Request.new(env)
-    return_value = case request.path.gsub(/\/$/, '')  # trim trailing /
-                     when '/user' then request.post? ? create(request) : nil
-                     else nil
-                   end
+    return_value, mime_type = case request.path.gsub(/\/$/, '')  # trim trailing /
+        when '/user' then request.post? ? create(request) : [nil, nil]
+        else [nil, nil]
+    end
 
     if return_value
-      response = Rack::Response.new([return_value], 201, {"Content-Type" => "text/html"})
+      response = Rack::Response.new([return_value], 201, {"Content-Type" => mime_type})
       response.finish
     else
       return_404
@@ -121,7 +135,7 @@ class User < SimpleController
          :last_name => request.POST['user_last_name'],
          :email_address => request.POST['user_email_address']
     })
-    PP.pp(user.schema, '')
+    return PP.pp(user.schema, ''), "text/html"
   end
 
 end
@@ -131,15 +145,15 @@ class ChargePermission < SimpleController
 
   def call env
     request = Rack::Request.new(env)
-    return_value = case request.path.gsub(/\/$/, '')  # trim trailing /
-                     when '/charge_permission' then request.post? ? create(request) : nil
-                     when '/charge_permission/find' then request.post? ? show(request) : nil
-                     when '/charge_permission/deactivate' then request.post? ? deactivate(request) : nil
-                     else nil
-                   end
+    return_value, mime_type = case request.path.gsub(/\/$/, '')  # trim trailing /
+        when '/charge_permission' then request.post? ? create(request) : [nil, nil]
+        when '/charge_permission/find' then request.post? ? show(request) : [nil, nil]
+        when '/charge_permission/deactivate' then request.post? ? deactivate(request) : [nil, nil]
+        else [nil, nil]
+    end
 
     if return_value
-      response = Rack::Response.new([return_value], 201, {"Content-Type" => "text/html"})
+      response = Rack::Response.new([return_value], 201, {"Content-Type" => mime_type})
       response.finish
     else
       return_404
@@ -148,22 +162,23 @@ class ChargePermission < SimpleController
 
   def create request
     charge_permission = Poundpay::ChargePermission.create(request.POST)
-    PP.pp(charge_permission.schema, '')
+    charge_permission.include_root_in_json = false
+    return charge_permission.to_json(), "application/json"
   end
 
   def show request
-    charge_permissions = Poundpay::ChargePermission.all(:email_address => request.POST['email_address'])
+    charge_permissions = Poundpay::ChargePermission.find(:all, :params => { :email_address => request.POST['email_address'] })
     if charge_permissions
-      PP.pp(charge_permissions.map {|cp| cp.schema}, '')
+      return PP.pp(charge_permissions.map {|cp| cp.schema}, ''), 'text/plain'
     else
-      nil
+      return [nil, nil]
     end
   end
 
   def deactivate request
     charge_permission = Poundpay::ChargePermission.find(request.POST['sid'])
     charge_permission.deactivate
-    PP.pp(charge_permission.schema, '')
+    return PP.pp(charge_permission.schema, ''), 'text/plain'
   end
 
 end

data/examples/{simple_application → marketplace}/config.rb

@@ -4,8 +4,8 @@ class SimpleApplication
       "api_url" => "https://api-sandbox.poundpay.com",
       "www_url" => "https://www-sandbox.poundpay.com",
       "version" => "silver",
-      "developer_sid" => "DV2f8a5168710c11e0aab3123140005921",
-      "auth_token" => "f309a5f600a630f7293c64783eaebc8b67a34428cfcd96e82599657a12769924",
+      "developer_sid" => "DVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+      "auth_token" => "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
       "callback_url" => '',
     },
     default_payment: {

data/examples/{simple_application → marketplace}/config.ru

@@ -6,7 +6,7 @@ require 'rack/urlmap'
 
 use Rack::ShowExceptions
 use Rack::Lint
-use Rack::Static, :urls => ["/static"]
+use Rack::Static, :urls => ["/static"], :root => "fe"
 
 require './application'
 

data/lib/poundpay/elements.rb

@@ -71,6 +71,12 @@ module Poundpay
 
   class Payment < Resource
 
+    def self.batch_update(params)
+      body = self.put('', {}, self.urlencode(params)).body
+      collection = self.format.decode(body)
+      return self.instantiate_collection(collection)
+    end
+
     def authorize
       unless status == 'STAGED'
         raise PaymentAuthorizeException.new "Payment status is #{status}.  Only STAGED payments may be AUTHORIZED."

data/lib/poundpay/resource.rb

@@ -27,6 +27,12 @@ module Poundpay
         remove_extension(path)
       end
 
+      # Modified default to not use an extension
+      def custom_method_collection_url(method_name, options = {})
+        path = super(method_name, options)
+        remove_extension(path)
+      end
+
       # Handle paginated collections
       def instantiate_collection(collection, prefix_options = {})
         # TODO: Consume pages
@@ -36,14 +42,14 @@ module Poundpay
 
       protected
         def remove_extension(path)
-          path.sub /(\.#{format.extension})$/, ""
+          path.sub /(\.#{format.extension})/, ""
         end
     end
 
     # Poundpay accepts urlencoded form parameters
     # Ideally we should override this functionality in the format, but it's not very straightforward to do so
     def encode
-      urlencode(@attributes)
+      Resource.urlencode(@attributes)
     end
 
     def collection_name
@@ -51,8 +57,14 @@ module Poundpay
     end
 
     protected
-      def urlencode(params)
-        params.to_a.collect! { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
-      end
+        def self.urlencode(params)
+          params.to_a.collect! { |k, v|
+              if v.kind_of?(Array)
+                v.collect! { |x| "#{k}=#{CGI.escape(x.to_s)}"}.join("&")
+              else
+                "#{k}=#{CGI.escape(v.to_s)}"
+              end 
+          }.join("&")
+        end
   end
 end

data/lib/poundpay/version.rb

@@ -1,3 +1,3 @@
 module Poundpay
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/poundpay/resource_spec.rb

@@ -29,6 +29,12 @@ describe Resource do
       FakeElement.collection_path.should == "/version/fake_elements"
     end
   end
+  
+  describe "#self.custom_method_collection_url" do
+    it "should not add a extension to the custom_method_collection_url" do
+      FakeElement.custom_method_collection_url("").should == "/version/fake_elements/"
+    end
+  end
 
   describe "#self.instantiate_collection" do
     it "should handle paginated responses" do
@@ -43,6 +49,10 @@ describe Resource do
       fake_element = FakeElement.new(:foo => "bar baz")
       fake_element.encode.should == "foo=bar+baz"
     end
+    it "should urlencode the attributes wuihtout brackets" do
+      fake_element = FakeElement.new(:foo => ["bar", "baz"])
+      fake_element.encode.should == "foo=bar&foo=baz"
+    end
   end
 
   describe "#collection_name" do

metadata

@@ -1,94 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: poundpay
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.2
   prerelease: 
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Matin Tamizi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-20 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activeresource
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &24260120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *24260120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &24259460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: wirble
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *24259460
+- !ruby/object:Gem::Dependency
+  name: wirble
+  requirement: &24259020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *24259020
 description: Payments platform for marketplaces
 email: devsupport@poundpay.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .autotest
 - .gitignore
+- .gitmodules
 - .rspec
 - .rvmrc
 - Gemfile
 - README.rdoc
 - Rakefile
-- examples/simple_application/.gems
-- examples/simple_application/.rvmrc
-- examples/simple_application/README
-- examples/simple_application/application.rb
-- examples/simple_application/config.rb
-- examples/simple_application/config.ru
-- examples/simple_application/index.html.erb
-- examples/simple_application/static/css/simplemp.css
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_diagonals-thick_18_b81900_40x40.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_diagonals-thick_20_666666_40x40.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_flat_10_000000_40x100.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_glass_100_f6f6f6_1x400.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_glass_100_fdf5ce_1x400.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_glass_65_ffffff_1x400.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_gloss-wave_35_f6a828_500x100.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_highlight-soft_100_eeeeee_1x100.png
-- examples/simple_application/static/css/ui-lightness/images/ui-bg_highlight-soft_75_ffe45c_1x100.png
-- examples/simple_application/static/css/ui-lightness/images/ui-icons_222222_256x240.png
-- examples/simple_application/static/css/ui-lightness/images/ui-icons_228ef1_256x240.png
-- examples/simple_application/static/css/ui-lightness/images/ui-icons_ef8c08_256x240.png
-- examples/simple_application/static/css/ui-lightness/images/ui-icons_ffd27a_256x240.png
-- examples/simple_application/static/css/ui-lightness/images/ui-icons_ffffff_256x240.png
-- examples/simple_application/static/css/ui-lightness/jquery-ui-1.8.13.custom.css
-- examples/simple_application/static/favicon.ico
-- examples/simple_application/static/js/jquery-1.6.1.js
-- examples/simple_application/static/js/jquery-ui-1.8.13.custom.min.js
-- examples/simple_application/static/js/simplemp.js
+- examples/marketplace/.gems
+- examples/marketplace/.rvmrc
+- examples/marketplace/README
+- examples/marketplace/application.rb
+- examples/marketplace/config.rb
+- examples/marketplace/config.ru
+- examples/marketplace/index.html.erb
 - lib/poundpay.rb
 - lib/poundpay/callback.rb
 - lib/poundpay/elements.rb
@@ -110,44 +86,28 @@ files:
 - spec/poundpay/rails_spec.rb
 - spec/poundpay/resource_spec.rb
 - spec/poundpay_spec.rb
-has_rdoc: true
 homepage: http://github.com/poundpay/poundpay-ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: poundpay
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Poundpay Ruby library
-test_files: 
-- spec/fixtures/callback.rb
-- spec/fixtures/charge_permissions.rb
-- spec/fixtures/developers.rb
-- spec/fixtures/payments.rb
-- spec/fixtures/poundpay.yml
-- spec/poundpay/callback_spec.rb
-- spec/poundpay/elements_spec.rb
-- spec/poundpay/exceptions_spec.rb
-- spec/poundpay/formats_spec.rb
-- spec/poundpay/rails_spec.rb
-- spec/poundpay/resource_spec.rb
-- spec/poundpay_spec.rb
+test_files: []