active_paypal_adaptive_payment 0.3.4 → 0.3.6

data/README.md

@@ -12,6 +12,9 @@ This library is meant to interface with PayPal's Adaptive Payment Gateway.
 * Peapprovals
 * Refunds
 * Currency conversions
+* getting/setting payment options
+* getting shipping addresses
+* getting a redirect for the embedded pay flow
 * More soon!
 
 ## Installation
@@ -28,24 +31,23 @@ See [iAuction: An Adaptive Payments Tutorial Featuring Parallel Payments](https:
 
 ### Init
 
-    gateway =
-          ActiveMerchant::Billing::PaypalAdaptivePayment.new(
-             :login => "acutio_1313133342_biz_api1.gmail.com",
-             :password => "1255043567",
-             :signature => "Abg0gYcQlsdkls2HDJkKtA-p6pqhA1k-KTYE0Gcy1diujFio4io5Vqjf",
-             :appid => "APP-80W284485P519543T" )
+    gateway =  ActiveMerchant::Billing::PaypalAdaptivePayment.new(
+      :login => "acutio_1313133342_biz_api1.gmail.com",
+      :password => "1255043567",
+      :signature => "Abg0gYcQlsdkls2HDJkKtA-p6pqhA1k-KTYE0Gcy1diujFio4io5Vqjf",
+      :appid => "APP-80W284485P519543T" )
 
 ### Pre-approved paymen
 
-      gateway.preapprove_payment (
-         :return_url => "returnURL",
-         :cancel_url => "cancelURL",
-         :senderEmail =>"email address of sender",
-         :start_date => Time.now,
-         :end_date => Time.now + (60*60*24) * 30,
-         :currency_code =>"currency code",
-         :max_amount => "maxTotalAmountOfAllPayments",
-         :maxNumberOfPayments => "maxNumberOfPayments" )
+    gateway.preapprove_payment (
+      :return_url => "returnURL",
+      :cancel_url => "cancelURL",
+      :senderEmail =>"email address of sender",
+      :start_date => Time.now,
+      :end_date => Time.now + (60*60*24) * 30,
+      :currency_code =>"currency code",
+      :max_amount => "maxTotalAmountOfAllPayments",
+      :maxNumberOfPayments => "maxNumberOfPayments" )
 
 ### Cancel pre-approved payment
 
@@ -69,7 +71,7 @@ See [iAuction: An Adaptive Payments Tutorial Featuring Parallel Payments](https:
       )
 
       # for redirecting the customer to the actual paypal site to finish the payment.
-     redirect_to (gateway.redirect_url_for(response["payKey"]))
+      redirect_to (gateway.redirect_url_for(response["payKey"]))
     end
 
 Set the `:primary` flag to `false` for each recipient for a split payment.
@@ -78,9 +80,12 @@ Maybe also check the tests for a sample implementation.
 
 ## Testing
 
-First modify the values in `test/fixtures.yml` to fit your app credentials.
+First modify the `test/fixtures.yml` to fit your app credentials (You
+will need at least a PayPal developer account).
 
-After that you can just execute them via `autotest`.
+After that you can run them like this:
+
+    $ ruby -Ilib test/test_paypal_adaptive_payment.rb
 
 ## Debugging
 
@@ -96,8 +101,12 @@ xml request, raw json response and the URL of the endpoint.
 
 ## TODO
 
-* Documentation
-* More tests
+* More/better Documentation.
+* Improve/change the tests implementation by maybe run them off
+  fixture data and use a separate script/test for actually invoking
+  requests to PayPal. This will allow other developers to implement
+  the without being required to set and request the credentials from
+  PayPal process.
 
 ## Contributors
 
@@ -106,6 +115,7 @@ xml request, raw json response and the URL of the endpoint.
 * LeviRosol (<https://github.com/LeviRosol>)
 * Florian95 (<https://github.com/Florian95>)
 * akichatov (<https://github.com/akichatov>)
+* Patrick Sinclair (<https://github.com/metade>)
 
 ## Other previous contributors where some code was taken from.
 

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

@@ -47,6 +47,18 @@ module ActiveMerchant #:nodoc:
         commit('PaymentDetails', build_adaptive_payment_details_request(options))
       end
 
+      def get_shipping_addresses(options)
+        commit('GetShippingAddresses', build_adaptive_get_shipping_addresses_request(options))
+      end
+
+      def get_payment_options(options)
+        commit('GetPaymentOptions', build_adaptive_get_payment_options_request(options))
+      end
+
+      def set_payment_options(options)
+        commit('SetPaymentOptions', build_adaptive_set_payment_options_request(options))
+      end
+
       def refund(options)
         commit('Refund', build_adaptive_refund_details(options))
       end
@@ -75,6 +87,10 @@ module ActiveMerchant #:nodoc:
         test? ? EMBEDDED_FLOW_TEST_URL : EMBEDDED_FLOW_LIVE_URL
       end
 
+      def embedded_flow_url_for(token)
+        "#{embedded_flow_url}?paykey=#{token}"
+      end
+
       def debug
         "Url: #{@url}\n\n Request: #{@xml} \n\n Response: #{@response.json}"
       end
@@ -148,6 +164,52 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def build_adaptive_get_shipping_addresses_request(opts)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.GetShippingAddressesRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+          end
+          x.key opts[:pay_key]
+        end
+      end
+
+      def build_adaptive_get_payment_options_request(opts)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.GetPaymentOptionsRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+          end
+          x.payKey opts[:pay_key]
+        end
+      end
+
+      def build_adaptive_set_payment_options_request(opts)
+        opts[:sender] ||= {}
+        
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.SetPaymentOptionsRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+          end
+          x.senderOptions do |x|
+            x.shareAddress opts[:sender][:share_address] if opts[:sender][:share_address]
+            x.sharePhoneNumber opts[:sender][:share_phone_number] if opts[:sender][:share_phone_number]
+            x.requireShippingAddressSelection opts[:sender][:require_shipping_address_selection] if opts[:sender][:require_shipping_address_selection]
+          end
+          x.payKey opts[:pay_key]
+        end
+      end
+
       def build_adaptive_refund_details(options)
         @xml = ''
         xml = Builder::XmlMarkup.new :target => @xml, :indent => 2

data/lib/active_merchant/billing/gateways/paypal_adaptive_payments/adaptive_payment_response.rb

@@ -1,6 +1,5 @@
 require 'multi_json'
 require 'hashie'
-require 'rash'
 
 module ActiveMerchant
   module Billing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_paypal_adaptive_payment
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-16 00:00:00.000000000Z
+date: 2011-11-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemerchant
-  requirement: &19405340 !ruby/object:Gem::Requirement
+  requirement: &80394670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *19405340
+  version_requirements: *80394670
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &19404680 !ruby/object:Gem::Requirement
+  requirement: &80394430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *19404680
+  version_requirements: *80394430
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &19403760 !ruby/object:Gem::Requirement
+  requirement: &80394190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *19403760
+  version_requirements: *80394190
 - !ruby/object:Gem::Dependency
   name: money
-  requirement: &19403100 !ruby/object:Gem::Requirement
+  requirement: &80393950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *19403100
+  version_requirements: *80393950
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &19402360 !ruby/object:Gem::Requirement
+  requirement: &80393710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *19402360
+  version_requirements: *80393710
 description: ! '    This library is meant to interface with PayPal''s Adaptive Payment
   Gateway.
 
@@ -76,17 +76,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/active_paypal_adaptive_payment.rb
-- lib/active_merchant/billing/integrations/paypal_adaptive_payment.rb
-- lib/active_merchant/billing/integrations/paypal_adaptive_payment/helper.rb
 - lib/active_merchant/billing/integrations/paypal_adaptive_payment/return.rb
 - lib/active_merchant/billing/integrations/paypal_adaptive_payment/notification.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment/helper.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment.rb
 - lib/active_merchant/billing/integrations/notification.rb
-- lib/active_merchant/billing/gateways/paypal_adaptive_payment.rb
-- lib/active_merchant/billing/gateways/paypal_adaptive_payments/ext.rb
 - lib/active_merchant/billing/gateways/paypal_adaptive_payments/exceptions.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payments/ext.rb
 - lib/active_merchant/billing/gateways/paypal_adaptive_payments/adaptive_payment_response.rb
 - lib/active_merchant/billing/gateways/paypal_adaptive_payment_common.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payment.rb
+- lib/active_paypal_adaptive_payment.rb
 - MIT-LICENSE
 - README.md
 - CHANGELOG.md