active_paypal_adaptive_payment 0.3.11 → 0.3.12

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0 0.3.12 (2012-05-02)
+
+  - Add displayOptions and receiverOptions support to
+    SetPaymentOptionsRequest (Niels Ganser) 597ecad
+  
 ## 0 0.3.11 (2012-04-28)
 
   - Added option :action_type to build_adaptive_payment_pay_request to enable delayed chained payments (3df6948) by eldoy

data/README.md

@@ -9,7 +9,7 @@ This library is meant to interface with PayPal's Adaptive Payment Gateway.
 ## Supported
 
 * Payments
-* Peapprovals
+* Preapprovals
 * Refunds
 * Currency conversions
 * getting/setting payment options
@@ -37,7 +37,7 @@ See [iAuction: An Adaptive Payments Tutorial Featuring Parallel Payments](https:
       :signature => "Abg0gYcQlsdkls2HDJkKtA-p6pqhA1k-KTYE0Gcy1diujFio4io5Vqjf",
       :appid => "APP-80W284485P519543T" )
 
-### Pre-approved paymen
+### Pre-approved payment
 
     gateway.preapprove_payment (
       :return_url => "returnURL",
@@ -91,6 +91,54 @@ end
 ActiveMerchant::Billing::Base.mode = :test
 ```
 
+### Setting advanced payment and invoice options
+
+To be able to set additional payment and invoice options, such as item names,
+shipping costs, custom logos, etc., you must first create a payment, then set
+the options and then direct the user to the payment page:
+
+```ruby
+purchase = gateway.setup_purchase(
+  :action_type => "CREATE", # This is in contrast to the default PAY action
+  …                         # as above
+)
+
+gateway.set_payment_options(
+  :display_options => {
+    :business_name    => "Your Business",
+    :header_image_url => "http://cdn.yourbusiness.com/logo-for-paypal.png"
+  },
+  :pay_key => purchase["payKey"],
+  :receiver_options => [
+    {
+      :description => "Your purchase of XYZ",
+      :invoice_data => {
+        :item => [
+          { :name => "Item #1", :item_count => 1, :item_price => 100, :price => 100 },
+          { :name => "Item #2", :item_count => 2, :item_price => 10, :price => 20 }
+        ],
+        :total_shipping => 5,
+        :total_tax => 10
+      },
+      :receiver => { :email => "receiver1@example.com" }
+    },
+    {
+      :description => "XYZ Processing fee",
+      :invoice_data => {
+        :item => [{ :name => "Fee", :item_count => 1, :item_price => 10, :price => 10 }]
+      },
+      :receiver => { :email => "receiver2@example.com" }
+    }
+  ]
+)
+
+redirect_to(gateway.redirect_url_for(purchase["payKey"]))
+```
+
+See the implementation of ActiveMerchant::Billing::PaypalAdaptivePayment#build_adaptive_set_payment_options_request
+for all available options and [Operation SetPaymentOptions API](https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_AdaptivePayments.pdf)
+for a description of them.
+
 ## Testing
 
 First modify the `test/fixtures.yml` to fit your app credentials (You
@@ -132,6 +180,7 @@ xml request, raw json response and the URL of the endpoint.
 * Mike Pence (<https://github.com/mikepence>)
 * Nicola Junior Vitto (<https://github.com/njvitto>)
 * Vidar Eldøy (https://github.com/eldoy)
+* Niels Ganser (https://github.com/Nielsomat)
 
 ## Other previous contributors where some code was taken from.
 

data/lib/active_merchant/billing/gateways/paypal_adaptive_payment.rb

@@ -207,6 +207,46 @@ module ActiveMerchant
             x.requireShippingAddressSelection opts[:sender][:require_shipping_address_selection] if opts[:sender][:require_shipping_address_selection]
             x.referrerCode opts[:sender][:referrerCode] if opts[:sender][:referrerCode]
           end
+          unless opts[:display_options].blank?
+            x.displayOptions do |x|
+              x.emailHeaderImageUrl opts[:display_options][:email_header_image_url] if opts[:display_options][:email_header_image_url]
+              x.emailMarketingImageUrl opts[:display_options][:email_marketing_image_url] if opts[:display_options][:email_marketing_image_url]
+              x.headerImageUrl opts[:display_options][:header_image_url] if opts[:display_options][:header_image_url]
+              x.businessName opts[:display_options][:business_name] if opts[:display_options][:business_name]
+            end
+          end
+          opts[:receiver_options].try(:each) do |receiver_options|
+            x.receiverOptions do |x|
+              x.description receiver_options[:description] if receiver_options[:description]
+              x.customId receiver_options[:custom_id] if receiver_options[:custom_id]
+              unless receiver_options[:invoice_data].blank?
+                x.invoiceData do |x|
+                  receiver_options[:invoice_data][:item].try(:each) do |item|
+                    x.item do |x|
+                      x.name item[:name] if item[:name]
+                      x.identifier item[:identifier] if item[:identifier]
+                      x.price item[:price] if item[:price]
+                      x.itemPrice item[:item_price] if item[:item_price]
+                      x.itemCount item[:item_count] if item[:item_count]
+                    end
+                  end
+                  x.totalTax receiver_options[:invoice_data][:total_tax] if receiver_options[:invoice_data][:total_tax]
+                  x.totalShipping receiver_options[:invoice_data][:total_shipping] if receiver_options[:invoice_data][:total_shipping]
+                end
+              end
+              x.receiver do |x|
+                x.email receiver_options[:receiver][:email] if receiver_options[:receiver][:email]
+                unless receiver_options[:receiver][:phone].blank?
+                  x.phone do |x|
+                    x.countryCode receiver_options[:receiver][:phone][:country_code]
+                    x.phoneNumber receiver_options[:receiver][:phone][:phone_number]
+                    x.extension receiver_options[:receiver][:phone][:extension] if receiver_options[:receiver][:phone][:extension]
+                  end
+                end
+              end
+              x.referrerCode receiver_options[:referrer_code] if receiver_options[:referrer_code]
+            end
+          end
           x.payKey opts[:pay_key]
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_paypal_adaptive_payment
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemerchant
-  requirement: &89014680 !ruby/object:Gem::Requirement
+  requirement: &90760330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *89014680
+  version_requirements: *90760330
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &89030830 !ruby/object:Gem::Requirement
+  requirement: &90760090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *89030830
+  version_requirements: *90760090
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &89030590 !ruby/object:Gem::Requirement
+  requirement: &90759850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *89030590
+  version_requirements: *90759850
 - !ruby/object:Gem::Dependency
   name: money
-  requirement: &89030350 !ruby/object:Gem::Requirement
+  requirement: &90759610 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *89030350
+  version_requirements: *90759610
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &89030110 !ruby/object:Gem::Requirement
+  requirement: &90775770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *89030110
+  version_requirements: *90775770
 description: ! '    This library is meant to interface with PayPal''s Adaptive Payment
   Gateway.