georgedrummond-active_paypal_adaptive_payment 0.3.9

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+## 0 0.3.3 (16/Nov/11)
+
+  - add functionality to allow a user to redirect to the correct URL
+    when creating a pre-approval request. In addition, the
+    setup_purchase now allows for the preapproval_key to be submitted
+    and passed along to paypal. (LeviRosol (<https://github.com/LeviRosol>))
+
+## 0.3.2
+
+  - build_adaptive_payment_details_request pay_key fix.
+
+## 0.3.1
+
+  - Add Support of ExecutePayment.
+
+## 0.3.0
+
+  - IPN implemeted
+
+## 0.2.5
+
+  - Added custom filed to the request builder.
+
+## 0.2.4
+
+  - renamed the pay method to setup_purchase, again, more like active_merchant.
+  - added paypal_adaptive_payment_common.rb for handling the redirects more like active_merchant
+  - removed the autoloads, they look kind of messy
+
+## 0.2.3
+
+  - `autoload` the helper libs.
+
+## 0.2.2
+
+  - Array fix https://github.com/lsegal/yard/issues/370
+
+## 0.2.1
+
+   - Removed action pack as a dependency
+
+## 0.2.0
+
+ - Fix tests.
+ - Added fixtures.yml.
+
+## 0.1.2
+
+ - Few typo fixes by LeviRosol

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jose Pablo Barrantes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,187 @@
+# Active PayPal Adaptive Payment
+
+This library is meant to interface with PayPal's Adaptive Payment Gateway.
+
+[Active Merchant]:http://www.activemerchant.org
+
+![Active PayPal Adaptive Payment](https://github.com/jpablobr/active_paypal_adaptive_payment/raw/master/doc/split.jpg)
+
+## Supported
+
+* Payments
+* Peapprovals
+* Refunds
+* Currency conversions
+* getting/setting payment options
+* getting shipping addresses
+* getting a redirect for the embedded pay flow
+* More soon!
+
+## Installation
+
+Add the following line to your app Gemfile:
+
+    gem "active_paypal_adaptive_payment"
+
+    bundle install
+
+## Implementation
+
+See [iAuction: An Adaptive Payments Tutorial Featuring Parallel Payments](https://www.x.com/docs/DOC-2505) tutorial for more info.
+
+### Init
+
+    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" )
+
+### Cancel pre-approved payment
+
+     gateway.cancel_preapproval(:preapproval_key => "preapprovalkey")
+
+### Chained payments
+
+    def checkout
+      recipients = [{:email => 'receiver_email',
+                     :amount => some_amount,
+                     :primary => true},
+                    {:email => 'receiver_email',
+                     :amount => recipient_amount,
+                     :primary => false}
+                     ]
+      response = gateway.setup_purchase(
+        :return_url => url_for(:action => 'action', :only_path => false),
+        :cancel_url => url_for(:action => 'action', :only_path => false),
+        :ipn_notification_url => url_for(:action => 'notify_action', :only_path => false),
+        :receiver_list => recipients
+      )
+
+      # for redirecting the customer to the actual paypal site to finish the payment.
+      redirect_to (gateway.redirect_url_for(response["payKey"]))
+    end
+
+Set the `:primary` flag to `false` for each recipient for a split payment.
+
+Maybe also check the tests for a sample implementation.
+
+Notes:
+
+In `development` environment it's very important to define
+ActiveMerchant environment you will be using to test your app like so:
+
+```ruby
+#config/environments/{environment.rb}
+App::Application.configure do
+  config.setting...
+end
+ActiveMerchant::Billing::Base.mode = :test
+```
+
+## Testing
+
+First modify the `test/fixtures.yml` to fit your app credentials (You
+will need at least a PayPal developer account).
+
+After that you can run them like this:
+
+    $ ruby -Ilib test/test_paypal_adaptive_payment.rb
+
+## Debugging
+
+Use either gateway.debug or response.debug this gives you the json
+response, the xml sent and the url it was posted to.
+
+From the Rails console it can be accessed like such:
+
+    ActiveMerchant::Billing::PaypalAdaptivePayment
+
+`PaypalAdaptivePayment#debug` or `AdaptivePaymentResponse#debug` return the raw
+xml request, raw json response and the URL of the endpoint.
+
+## TODO
+
+* 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
+
+* Jose Pablo Barrantes (<http://jpablobr.com/>)
+* Zarne Dravitzki (<http://github.com/zarno>)
+* LeviRosol (<https://github.com/LeviRosol>)
+* Florian95 (<https://github.com/Florian95>)
+* akichatov (<https://github.com/akichatov>)
+* Patrick Sinclair (<https://github.com/metade>)
+* Mike Pence (<https://github.com/mikepence>)
+
+## Other previous contributors where some code was taken from.
+
+* [Tommy Chheng](http://tommy.chheng.com)
+  - [Paypal Adaptive Ruby Gem Released](http://tommy.chheng.com/2009/12/29/paypal-adaptive-ruby-gem-released/)
+  - [paypal_adaptive](https://github.com/tc/paypal_adaptive)
+
+* [lamp (Matt)](https://github.com/lamp)
+  - [paypal_adaptive_gateway](https://github.com/lamp/paypal_adaptive_gateway)
+
+* [sentientmonkey (Scott Windsor)](https://github.com/sentientmonkey)
+  - [active_merchant](https://github.com/sentientmonkey/active_merchant)
+
+* [sijokg](https://github.com/sijokg)
+  - [active_merchant](https://github.com/sijokg/active_merchant)
+
+## Some PayPal Adaptive payment resources.
+
+* [Adaptive Payment Fee Calculation Analysis](https://www.x.com/docs/DOC-2401)
+* [ActiveMerchant paypaladaptive payments gateway](http://www.rorexperts.com/activemerchant-paypaladaptive-payments-gateway-t2245.html)
+* [Trying to use with Paypal adaptive payments](http://groups.google.com/group/activemerchant/browse_thread/thread/866ad7dc5019c199/2a280b7dc396c41b?lnk=gst&q=adaptive+payment#2a280b7dc396c41b)
+* [adpative payments (chained)](http://groups.google.com/group/activemerchant/browse_thread/thread/165c3e0bf4d10c02/aa8dd082b58354d9?lnk=gst&q=adaptive+payment#aa8dd082b58354d9)
+* [Testing with a sandbox account without being logged on developer.paypal.com](http://groups.google.com/group/activemerchant/browse_thread/thread/ad69fc8116bfdf64/483f22071bb25e25?lnk=gst&q=adaptive+payment#483f22071bb25e25)
+* [Split a transaction to distribute funds to two accounts?](http://groups.google.com/group/activemerchant/browse_thread/thread/e1f53087aee9d0c/2cd63df363861ce1?lnk=gst&q=adaptive+payment#2cd63df363861ce1)
+
+## Note on Patches/Pull Requests:
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright:
+
+(The MIT License)
+
+Copyright 2011 Jose Pablo Barrantes. MIT Licence, so go for it.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, an d/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

@@ -0,0 +1,374 @@
+# -*- coding: utf-8 -*-
+require 'money'
+require File.dirname(__FILE__) + '/paypal_adaptive_payments/ext'
+require File.dirname(__FILE__) + '/paypal_adaptive_payment_common'
+require File.dirname(__FILE__) + '/paypal_adaptive_payments/exceptions'
+require File.dirname(__FILE__) + '/paypal_adaptive_payments/adaptive_payment_response'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+
+    class PaypalAdaptivePayment < Gateway # :nodoc
+      include PaypalAdaptivePaymentCommon
+
+      TEST_URL = 'https://svcs.sandbox.paypal.com/AdaptivePayments/'
+      LIVE_URL = 'https://svcs.paypal.com/AdaptivePayments/'
+
+      EMBEDDED_FLOW_TEST_URL = 'https://www.sandbox.paypal.com/webapps/adaptivepayment/flow/pay'
+      EMBEDDED_FLOW_LIVE_URL = 'https://www.paypal.com/webapps/adaptivepayment/flow/pay'
+
+      module FeesPayer
+        OPTIONS = %w(SENDER PRIMARYRECEIVER EACHRECEIVER SECONDARYONLY)
+        OPTIONS.each { |opt| const_set(opt, opt) }
+      end
+
+      module PaymentType
+        TYPES = %w(DIGITALGOODS)
+        TYPES.each { |pt| const_set(pt, pt) }
+      end
+
+	    self.test_redirect_url= "https://www.sandbox.paypal.com/webscr?cmd=_ap-payment&paykey="
+      self.test_redirect_pre_approval_url= "https://www.sandbox.paypal.com/webscr?cmd=_ap-preapproval&preapprovalkey="
+      self.supported_countries = ['US']
+      self.homepage_url = 'http://x.com/'
+      self.display_name = 'Paypal Adaptive Payments'
+
+      def initialize(config = {})
+        requires!(config, :login, :password, :signature, :appid)
+        @config = config.dup
+        super
+      end
+
+      def setup_purchase(options)
+        commit('Pay', build_adaptive_payment_pay_request(options))
+      end
+
+      def details_for_payment(options)
+        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
+
+      def execute_payment(options)
+        commit('ExecutePayment', build_adaptive_execute_payment_request(options))
+      end
+
+      def preapprove_payment(options)
+        commit('Preapproval', build_preapproval_payment(options))
+      end
+
+      def cancel_preapproval(options)
+        commit('CancelPreapproval', build_cancel_preapproval(options))
+      end
+
+      def preapproval_details_for(options)
+        commit('PreapprovalDetails', build_preapproval_details(options))
+      end
+
+      def convert_currency(options)
+        commit('ConvertCurrency', build_currency_conversion(options))
+      end
+
+      def embedded_flow_url
+        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
+
+      private
+
+      def build_adaptive_payment_pay_request(opts)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.PayRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+          end
+          x.actionType 'PAY'
+          x.preapprovalKey opts[:preapproval_key] if opts.key?(:preapproval_key)
+          x.senderEmail opts[:sender_email] if opts.key?(:sender_email)
+          x.cancelUrl opts[:cancel_url]
+          x.returnUrl opts[:return_url]
+          x.ipnNotificationUrl opts[:ipn_notification_url] if
+            opts[:ipn_notification_url]
+          x.memo opts[:memo] if opts.key?(:memo)
+          x.custom opts[:custom] if opts.key?(:custom)
+          x.feesPayer opts[:fees_payer] if opts[:fees_payer]
+          x.pin opts[:pin] if opts[:pin]
+          x.currencyCode opts[:currency_code] ||= 'USD'
+          x.receiverList do |x|
+            opts[:receiver_list].each do |receiver|
+              x.receiver do |x|
+                x.email receiver[:email]
+                x.amount receiver[:amount].to_s
+                x.primary receiver[:primary] if receiver.key?(:primary)
+                x.paymentType receiver[:payment_type] if
+                  receiver.key?(:payment_type)
+                x.invoiceId receiver[:invoice_id] if
+                  receiver.key?(:invoice_id)
+              end
+            end
+          end
+          x.reverseAllParallelPaymentsOnError(
+            opts[:reverse_all_parallel_payments_on_error] || 'false')
+          x.trackingId opts[:tracking_id] if opts[:tracking_id]
+         end
+      end
+
+    def build_adaptive_execute_payment_request(opts)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.ExecutePaymentRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+          end
+          x.payKey opts[:pay_key] if opts.key?(:pay_key)
+          x.fundingPlanId opts[:funding_plan_id] if opts[:funding_plan_id]
+         end
+      end
+
+      def build_adaptive_payment_details_request(opts)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.PayRequest 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_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
+        xml.instruct!
+        xml.RefundRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage options[:error_language] ||= 'en_US'
+          end
+          x.actionType 'REFUND'
+          if options[:pay_key]
+            x.payKey options[:pay_key]
+          end
+          if options[:transaction_id]
+            x.payKey options[:transaction_id]
+          end
+          if options[:tracking_id]
+            x.trackingId options[:tracking_id]
+          end
+          x.cancelUrl options[:cancel_url]
+          x.returnUrl options[:return_url]
+          x.currencyCode options[:currency_code] ||= 'USD'
+          x.receiverList do |x|
+            options[:receiver_list].each do |receiver|
+              x.receiver do |x|
+                x.amount receiver[:amount]
+                x.paymentType receiver[:payment_type] ||= 'GOODS'
+                x.invoiceId receiver[:invoice_id] if receiver[:invoice_id]
+                x.email receiver[:email]
+              end
+            end
+          end
+          x.feesPayer options[:fees_payer] ||= 'EACHRECEIVER'
+        end
+      end
+
+      def build_preapproval_payment(options)
+        opts = {
+          :currency_code => "USD",
+          :start_date => DateTime.current
+        }.update(options)
+
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.PreapprovalRequest do |x|
+          # request envelope
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage opts[:error_language] ||= 'en_US'
+            x.senderEmail opts[:senderEmail] if opts.has_key?(:senderEmail)
+          end
+
+          # required preapproval fields
+          x.endingDate opts[:end_date].strftime("%Y-%m-%dT%H:%M:%S")
+          x.startingDate opts[:start_date].strftime("%Y-%m-%dT%H:%M:%S")
+          x.maxTotalAmountOfAllPayments opts[:max_amount]
+          x.maxAmountPerPayment opts[:maxAmountPerPayment] if opts.has_key?(:maxAmountPerPayment)
+          x.memo opts[:memo] if opts.has_key?(:memo)
+          x.maxNumberOfPayments opts[:maxNumberOfPayments] if
+            opts.has_key?(:maxNumberOfPayments)
+          x.currencyCode options[:currency_code]
+          x.cancelUrl opts[:cancel_url]
+          x.returnUrl opts[:return_url]
+
+          # notify url
+          x.ipnNotificationUrl opts[:notify_url] if
+            opts.has_key?(:notify_url)
+        end
+      end
+
+      def build_preapproval_details(options)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.PreapprovalDetailsRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage options[:error_language] ||= 'en_US'
+          end
+          x.preapprovalKey options[:preapproval_key]
+          x.getBillingAddress options[:get_billing_address] if
+            options[:get_billing_address]
+        end
+      end
+
+      def build_cancel_preapproval(options)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.PreapprovalDetailsRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage options[:error_language] ||= 'en_US'
+          end
+          x.preapprovalKey options[:preapproval_key]
+        end
+      end
+
+      def build_currency_conversion(options)
+        @xml = ''
+        xml = Builder::XmlMarkup.new :target => @xml, :indent => 2
+        xml.instruct!
+        xml.ConvertCurrencyRequest do |x|
+          x.requestEnvelope do |x|
+            x.detailLevel 'ReturnAll'
+            x.errorLanguage options[:error_language] ||= 'en_US'
+          end
+          x.baseAmountList do |x|
+            options[:currency_list].each do |currency|
+              x.currency do |x|
+                x.amount currency[:amount]
+                x.code currency[:code ]
+              end
+            end
+          end
+          x.convertToCurrencyList do |x|
+            options[:to_currencies].each do |k,v|
+              x.currencyCode "#{v}"
+            end
+          end
+        end
+      end
+
+      def commit(action, data)
+        @response = AdaptivePaymentResponse.new(post_through_ssl(action, data))
+      end
+
+      def post_through_ssl(action, parameters = {})
+        headers = {
+          "X-PAYPAL-REQUEST-DATA-FORMAT" => "XML",
+          "X-PAYPAL-RESPONSE-DATA-FORMAT" => "JSON",
+          "X-PAYPAL-SECURITY-USERID" => @config[:login],
+          "X-PAYPAL-SECURITY-PASSWORD" => @config[:password],
+          "X-PAYPAL-SECURITY-SIGNATURE" => @config[:signature],
+          "X-PAYPAL-APPLICATION-ID" => @config[:appid],
+        }
+        action_url(action)
+        request = Net::HTTP::Post.new(@url.path)
+        request.body = @xml
+        headers.each_pair { |k,v| request[k] = v }
+        request.content_type = 'text/xml'
+        server = Net::HTTP.new(@url.host, 443)
+        server.use_ssl = true
+        server.start { |http| http.request(request) }.body
+      end
+
+      def endpoint_url
+        test? ? TEST_URL : LIVE_URL
+      end
+
+      def test?
+        @config[:test] || Base.gateway_mode == :test
+      end
+
+      def action_url(action)
+        @url = URI.parse(endpoint_url + action)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module ActiveMerchant
+  module Billing
+    module PaypalAdaptivePaymentCommon
+      def self.included(base)
+        base.cattr_accessor :test_redirect_url
+        base.cattr_accessor :live_redirect_url
+        base.cattr_accessor :test_redirect_pre_approval_url
+        base.cattr_accessor :live_redirect_pre_approval_url
+        base.live_redirect_url = 'https://www.paypal.com/webscr?cmd=_ap-payment&paykey='
+        base.live_redirect_pre_approval_url = 'https://www.paypal.com/webscr?cmd=_ap-preapproval&preapprovalkey='
+      end
+
+      def redirect_url
+        test? ? test_redirect_url : live_redirect_url
+      end
+
+      # TODO: validate the token presence
+      def redirect_url_for(token)
+        "#{redirect_url}#{token}"
+      end
+
+      def redirect_pre_approval_url
+        test? ? test_redirect_pre_approval_url : live_redirect_pre_approval_url
+      end
+
+      def redirect_pre_approval_url_for(token)
+        "#{redirect_pre_approval_url}#{token}"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'multi_json'
+require 'hashie'
+
+module ActiveMerchant
+  module Billing
+    class AdaptivePaymentResponse < Response
+
+      SUCCESS = 'Success'.freeze
+
+      attr_reader :json
+      alias :raw :json
+
+      def initialize(json)
+        @json = json
+        @response_rash = Hashie::Rash.new(MultiJson.decode(json))
+      end
+
+      def method_missing(method, *args, &block)
+        @response_rash.send(method, *args, &block)
+      end
+
+      # def redirect_url_for
+      #   Base.gateway_mode == :test ? (TEST_REDIRECT_URL + pay_key) : (REDIRECT_URL + pay_key)
+      # end
+
+      def ack
+        response_envelope.ack
+      end
+
+      def timestamp
+        response_envelope.timestamp
+      end
+
+      def build
+        response_envelope.build
+      end
+
+      def correlation_id
+        response_envelope.correlation_id
+      end
+      alias :correlationId :correlation_id
+
+      def success?
+        ack == SUCCESS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+class ConfigDoesNotExist < StandardError; end;
+class AttributenotFound < StandardError; end;
+
+class PaypalAdaptivePaymentsApiError < StandardError
+
+  attr_reader :response
+
+  def initialize response
+    @response = response
+  end
+
+  def debug
+    @response.inspect
+  end
+
+end

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

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+# https://github.com/tallgreentree/rash/blob/master/lib/hashie/rash.rb
+
+require 'hashie/mash'
+
+module Hashie
+  class Rash < Mash
+
+    protected
+
+      def convert_key(key)
+        underscore_string(key.to_s)
+      end
+
+      # converts a camel_cased string to a underscore string
+      # subs spaces with underscores, strips whitespace
+      # Same way ActiveSupport does string.underscore
+      def underscore_string(str)
+        str.to_s.strip.
+          gsub(' ', '_').
+          gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          squeeze("_").
+          downcase
+      end
+
+  end
+end

data/lib/active_merchant/billing/integrations/notification.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      class Notification
+
+        private
+
+        # Take the posted data and move the relevant data into a hash
+        def parse(post)
+          @raw = post.to_s
+          for line in @raw.split('&')
+            key, value = CGI.unescape(*line).scan( %r{^([A-Za-z0-9_.\[\]]+)\=(.*)$} ).flatten
+            params[key] = value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PaypalAdaptivePayment
+        autoload :Return, 'active_merchant/billing/integrations/paypal_adaptive_payment/return.rb'
+        autoload :Helper, 'active_merchant/billing/integrations/paypal_adaptive_payment/helper.rb'
+        autoload :Notification, 'active_merchant/billing/integrations/paypal_adaptive_payment/notification.rb'
+
+        # Overwrite this if you want to change the Paypal test url
+        mattr_accessor :test_url
+        self.test_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+
+        # Overwrite this if you want to change the Paypal production url
+        mattr_accessor :production_url
+        self.production_url = 'https://www.paypal.com/cgi-bin/webscr'
+
+        def self.service_url
+          mode = ActiveMerchant::Billing::Base.integration_mode
+          case mode
+          when :production
+            self.production_url
+          when :test
+            self.test_url
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+          end
+        end
+
+        def self.notification(post, options = {})
+          Notification.new(post)
+        end
+
+        def self.return(query_string, options = {})
+          Return.new(query_string)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/paypal_adaptive_payment/helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PaypalAdaptivePayment
+        class Helper < ActiveMerchant::Billing::Integrations::Paypal::Helper
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/paypal_adaptive_payment/notification.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PaypalAdaptivePayment
+        # Parser and handler for incoming Instant payment notifications from paypal.
+        # The Example shows a typical handler in a rails application. Note that this
+        # is an example, please read the Paypal API documentation for all the details
+        # on creating a safe payment controller.
+        #
+        # Example
+        #
+        #   class BackendController < ApplicationController
+        #     include ActiveMerchant::Billing::Integrations
+        #
+        #     def paypal_ipn
+        #       notify = PaypalAdaptivePayment::Notification.new(request.raw_post)
+        #
+        #       order = Order.find(notify.item_id)
+        #
+        #       if notify.acknowledge
+        #         begin
+        #
+        #           if notify.complete? and order.total == notify.amount
+        #             order.status = 'COMPLETED'
+        #
+        #             shop.ship(order)
+        #           else
+        #             logger.error("Failed to verify Paypal's notification, please investigate")
+        #           end
+        #
+        #         rescue => e
+        #           order.status = 'ERROR'
+        #           raise
+        #         ensure
+        #           order.save
+        #         end
+        #       end
+        #
+        #       render :nothing
+        #     end
+        #   end
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include PostsData
+
+          # Was the transaction complete?
+          def complete?
+            status == "COMPLETED"
+          end
+
+          # Status of transaction. List of possible values:
+          # <tt>CREATED</tt>::
+          # <tt>COMPLETED</tt>::
+          # <tt>INCOMPLETE</tt>::
+          # <tt>ERROR</tt>::
+          # <tt>REVERSALERROR</tt>::
+          # <tt>PROCESSING</tt>::
+          # <tt>PENDING</tt>::
+          def status
+            params['status']
+          end
+
+          # Id of this transaction (paypal number)
+          def transaction_id
+            params['transaction[0].id_for_sender_txn']
+          end
+
+          def type
+            params['action_type']
+          end
+
+          # This is the item number which we submitted to paypal
+          # The custom field is also mapped to item_id because PayPal
+          # doesn't return item_number in dispute notifications
+          def item_id
+            params['item_number'] || params['custom']
+          end
+
+          # This is the invoice which you passed to paypal
+          def invoice
+            params['transaction[0].invoiceId']
+          end
+
+          # This is the amount which you passed to paypal
+          def amount
+            params['transaction[0].amount']
+          end
+
+          # Was this a test transaction?
+          def test?
+            params['test_ipn'] == '1'
+          end
+
+          def account
+            params['business'] || params['transaction[0].receiver']
+          end
+
+          # Acknowledge the transaction to paypal. This method has to be called after a new
+          # ipn arrives. Paypal will verify that all the information we received are correct and will return a
+          # ok or a fail.
+          #
+          # Example:
+          #
+          #   def paypal_ipn
+          #     notify = PaypalAdaptivePaymentNotification.new(request.raw_post)
+          #
+          #     if notify.acknowledge
+          #       ... process order ... if notify.complete?
+          #     else
+          #       ... log possible hacking attempt ...
+          #     end
+          def acknowledge
+            payload =  raw
+
+            response = ssl_post(Paypal.service_url + '?cmd=_notify-validate', payload,
+              'Content-Length' => "#{payload.size}",
+              'User-Agent'     => "Active Merchant -- http://activemerchant.org"
+            )
+
+            raise StandardError.new("Faulty paypal result: #{response}") unless ["VERIFIED", "INVALID"].include?(response)
+
+            response == "VERIFIED"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/paypal_adaptive_payment/return.rb

@@ -0,0 +1,10 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PaypalAdaptivePayment
+        class Return < ActiveMerchant::Billing::Integrations::Return
+	      end
+      end
+    end
+  end
+end

data/lib/active_paypal_adaptive_payment.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require 'active_merchant'
+require File.dirname(__FILE__) + '/active_merchant/billing/gateways/paypal_adaptive_payment'
+require File.dirname(__FILE__) + '/active_merchant/billing/integrations/paypal_adaptive_payment'
+require File.dirname(__FILE__) + '/active_merchant/billing/integrations/notification'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: georgedrummond-active_paypal_adaptive_payment
+version: !ruby/object:Gem::Version
+  version: 0.3.9
+  prerelease: 
+platform: ruby
+authors:
+- Jose Pablo Barrantes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: &70339597920540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339597920540
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70339597920040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339597920040
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70339597919500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339597919500
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: &70339597919000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339597919000
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70339597918480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339597918480
+description: ! '    This library is meant to interface with PayPal''s Adaptive Payment
+  Gateway.
+
+'
+email:
+- xjpablobrx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_merchant/billing/gateways/paypal_adaptive_payment.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payment_common.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payments/adaptive_payment_response.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/integrations/notification.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment/helper.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment/notification.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment/return.rb
+- lib/active_merchant/billing/integrations/paypal_adaptive_payment.rb
+- lib/active_paypal_adaptive_payment.rb
+- MIT-LICENSE
+- README.md
+- CHANGELOG.md
+homepage: http://github.com/jpablobr/active_paypal_adaptive_payment
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- - lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ActiveMercant PayPal Adaptive Payment Library
+test_files: []