active_paypal_adaptive_payment 0.1.1

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.markdown

@@ -0,0 +1,130 @@
+# Active PayPal Adaptive Payment
+
+This library is meant to interface with PayPal web services Adaptive Payment Gateway Library.
+
+[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
+* preapprovals
+* refunds
+* currency conversions
+* more soon!
+
+## Installation
+
+Add the following line to your app Gemfile:
+
+    gem "active_paypal_adaptive_payment", "~> 0.1.0"
+
+## Implementation
+
+In your { payment/order }_controller.rb
+
+    def gateway
+      @gateway ||= PaypalAdaptivePaymentGateway.new(
+       :login => 'your_email',
+       :password => 'your_password',
+       :signature => ' your_signature',
+       :appid => 'your_app_id'
+      )
+    end
+
+## Payment process
+
+### Chained payments
+
+    def checkout
+      recipients = [{:email => 'receiver_email',
+                     :amount => some_amount,
+                     :primary => true},
+                    {:email => 'receiver_email',
+                     :amount => recipient_amount,
+                     :primary => false}
+                     ]
+      response = gateway.pay(
+        :return_url => url_for(:action => 'action', :only_path => false),
+        :cancel_url => url_for(:action => 'action', :only_path => false),
+        :notify_url => url_for(:action => 'notify_action', :only_path => false),
+        :receiver_list => recipients
+      )
+      redirect_to response.redirect_url_for
+    end
+
+Set the `:primary` flag to `false` for each recipient for a split payment.
+
+## 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::PaypalAdaptivePaymentGateway
+
+## TODO
+
+* Better documentation
+
+## Contributors
+
+* Jose Pablo Barrantes (<http://jpablobr.com/>)
+* Zarne Dravitzki (<http://github.com/zarno>)
+
+## 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,310 @@
+# -*- coding: utf-8 -*-
+dir = File.dirname(__FILE__)
+require dir + '/paypal_adaptive_payments/exceptions.rb'
+require dir + '/paypal_adaptive_payments/adaptive_payment_response.rb'
+require dir + '/paypal_adaptive_payments/utils.rb'
+
+module ActiveMerchant
+  module Billing
+    class PaypalAdaptivePaymentGateway < Gateway
+
+      include AdaptivePaymentResponses
+      include AdaptiveUtils
+
+      TEST_URL = 'https://svcs.sandbox.paypal.com/AdaptivePayments/'
+      LIVE_URL = 'https://svcs.paypal.com/AdaptivePayments/'
+
+      # The countries the gateway supports merchants from as 2 digit ISO
+      # country codes
+      self.supported_countries = ['US']
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://x.com/'
+
+      # The name of the gateway
+      self.display_name = 'Paypal Adaptive Payments'
+
+      attr_accessor :config_path
+      @config_path = "#{::Rails.root.to_s}/config/paypal.yml"
+
+      def initialize(options = {})
+        @config = {}
+        if options.empty?
+          load_config
+        else
+          @config.merge! options
+        end
+      end
+
+      def pay(options)
+        commit 'Pay', build_adaptive_payment_pay_request(options)
+      end
+
+      def execute_payment(options)
+        commit 'ExecutePayment', build_adaptive_payment_execute_request(options)
+      end
+
+      def details_for_payment options
+        commit 'PaymentDetails', build_adaptive_payment_details_request(options)
+      end
+
+      def refund options
+        commit 'Refund', build_adaptive_refund_details(options)
+      end
+
+      # Send a preapproval request to pay pal
+      #
+      # ==== Options
+      #
+      # * +:end_date+ - _xs:datetime_ The ending date
+      # * +:start_date+ - _xs:datetime_ The start date (defaults: current)
+      # * +:max_amount+ - _xs:decimal_ The preapproved maximum total amount of all payments.
+      # * +:currency_code+ - The currency code (defaults: USD)
+      # * +:cancel_url+ - URL to redirect the sender’s browser to after canceling the preapproval
+      # * +:return_url+ - URL to redirect the sender’s browser to after the sender has logged into PayPal and confirmed the preapproval
+      # * +:notify_url+ - The URL to which you want all IPN messages for this preapproval to be sent. (Optional)
+      #
+      # To get more details on fields see +Paypal PreApproval API+ at https://www.x.com/docs/DOC-1419
+      def preapprove_payment options
+        commit 'Preapproval', build_preapproval_payment(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
+
+      #debug method, provides an easy to use debug method for the class
+      def debug
+        "Url: #{@url}\n\n JSON: #{@xml} \n\n Raw: #{@raw}"
+      end
+
+      private
+
+      #loads config from default file if it is not provided to the constructor
+      def load_config
+        raise ConfigDoesNotExist if !File.exists?(@config_path);
+        @config.merge! Yaml.load_file(@config_path)[Rails.env || RAILS_ENV].symbolize_keys!
+      end
+
+      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 opts[:pay_primary] ? 'PAY_PRIMARY' : 'PAY'
+          x.cancelUrl opts[:cancel_url]
+          x.returnUrl opts[:return_url]
+          if opts[:notify_url]
+            x.ipnNotificationUrl opts[:notify_url]
+          end
+          x.trackingId opts[:tracking_id] if opts[:tracking_id]
+          x.memo opts[:memo] if opts[:memo]
+          x.pin opts[:pin] if opts[:pin]
+          x.currencyCode opts[:currency_code] ||= 'USD'
+          x.senderEmail opts[:senders_email] if opts[:senders_email]
+          x.receiverList do |x|
+            opts[:receiver_list].each do |receiver|
+              x.receiver do |x|
+                x.email receiver[:email]
+                x.amount currency_to_two_places(receiver[:amount])
+                x.primary receiver[:primary] if receiver[:primary]
+                x.paymentType receiver[:payment_type] ||= 'GOODS'
+                x.invoiceId receiver[:invoice_id] if receiver[:invoice_id]
+              end
+            end
+          end
+          x.feesPayer opts[:fees_payer] ||= 'EACHRECEIVER'
+        end
+      end
+
+      def build_adaptive_payment_execute_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[:paykey]
+        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[:paykey]
+        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.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
+        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'
+          end
+
+          # required preapproval fields
+          x.endingDate opts[:end_date].strftime("%Y-%m-%dT%H:%M:%S%Z")
+          x.startingDate opts[:start_date].strftime("%Y-%m-%dT%H:%M:%S%Z")
+          x.maxTotalAmountOfAllPayments opts[:max_amount]
+          x.currencyCode opts[:currency_code]
+          x.cancelUrl opts[:cancel_url]
+          x.returnUrl opts[:return_url]
+
+          #optional preapproval fields
+          x.maxAmountPerPayment opts[:max_amount_per_payment] unless opts[:max_amount_per_payment].blank?
+          x.maxNumberOfPayments opts[:max_number_of_payments] unless opts[:max_number_of_payments].blank?
+          x.memo opts[:memo] unless opts[:memo].blank?
+
+          # notify url
+          if opts[:notify_url]
+            x.ipnNotificationUrl opts[:notify_url]
+          end
+        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 opts[: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_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 opts[:error_language] ||= 'en_US'
+          end
+          x.baseAmountList do |x|
+            x.currency do |x|
+              x.amount options[:amount]
+              x.code options[:currency_code] ||= 'USD'
+            end
+          end
+          x.convertoToCurrencyList do |x|
+            options[:currencies].each do |currency|
+              x.currency currency
+            end
+          end
+        end
+      end
+
+      def parse json
+        @raw = json
+        resp = JSON.parse json
+        if resp['responseEnvelope']['ack'] == 'Failure'
+          error = AdaptivePaypalErrorResponse.new(resp)
+          raise PaypalAdaptivePaymentsApiError.new(error)
+        else
+          AdaptivePaypalSuccessResponse.new(resp)
+        end
+      end
+
+      def commit(action, data)
+        @response = parse(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]
+        }
+        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.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        server.start { |http| http.request(request) }.body
+      end
+
+      def endpoint_url
+        test? ? TEST_URL : LIVE_URL
+      end
+
+      def test?
+        Base.gateway_mode == :test
+      end
+
+      def url action
+        @url = URI.parse(endpoint_url + action)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module ActiveMerchant
+  module Billing
+    module AdaptivePaymentResponses
+      
+      class AdaptivePaypalSuccessResponse
+        
+        BASE_REDIRECT_URL = 'https://www.paypal.com/webscr?cmd='
+        TEST_BASE_REDIRECT_URL = 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd='
+        PAY_COMMAND = '_ap-payment&paykey='
+        PREAPPROVAL_COMMAND = '_ap-preapproval&preapprovalkey='
+        
+        attr_reader :paykey, :preapprovalkey
+        
+        def initialize json
+          
+          @paykey = json['payKey']
+          @preapprovalkey = json['preapprovalKey']
+          @params = json
+        end
+        
+        def redirect_url_for
+          (Base.gateway_mode == :test ? TEST_BASE_REDIRECT_URL : BASE_REDIRECT_URL) + PAY_COMMAND + @paykey
+        end
+
+        def redirect_preapproval_url_for
+          (Base.gateway_mode == :test ? TEST_BASE_REDIRECT_URL : BASE_REDIRECT_URL) + PREAPPROVAL_COMMAND + @preapprovalkey
+        end
+        
+        def ack
+          @params['responseEnvelope']['ack']
+        end    
+        
+        def method_missing name
+          begin
+            @params[name.to_s]
+          rescue
+            raise AttributenotFound
+          end
+        end
+                  
+        def [](key)
+          return @params[key] if @params.include? key
+          raise AttributenotFound
+        end
+
+        def status
+          @params['status']
+        end
+
+        def refund_status
+          @params["refundInfoList"]["refundInfo"].first["refundStatus"]
+        end
+
+        def execute_status
+          @params['paymentExecStatus']
+        end
+
+        def refund_complete?
+          refund_status == 'REFUNDED' || refund_status == 'ALREADY_REVERSED_OR_REFUNDED'
+        end
+
+        def execute_complete?
+          execute_status == 'COMPLETED'
+        end
+
+      end
+      
+      class AdaptivePaypalErrorResponse
+        
+        def initialize error
+          @raw = error
+        end
+            
+        def debug
+          @raw.inspect
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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/utils.rb

@@ -0,0 +1,14 @@
+module ActiveMerchant
+  module Billing
+    
+    module AdaptiveUtils
+      
+      def currency_to_two_places amount
+        return 0.01 if amount < 0.01
+        ("%.2f" % amount).to_f
+      end
+      
+    end
+    
+  end 
+end

data/lib/active_paypal_adaptive_payment.rb

@@ -0,0 +1,13 @@
+$:.unshift File.dirname(__FILE__)
+
+begin
+  require 'active_support'
+  require 'active_merchant/common'
+rescue LoadError
+  require 'rubygems'
+  require 'active_support'
+  require 'active_merchant/common'
+end
+
+dir = File.dirname(__FILE__) + '/active_merchant/billing/gateways'
+require dir + '/paypal_adaptive_payment'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: active_paypal_adaptive_payment
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Jose Pablo Barrantes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-21 00:00:00.000000000 +10:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: &9269640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *9269640
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &9266120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *9266120
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &9265100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *9265100
+description: This library is meant to interface with PayPal web services Adaptive
+  Payment Gateway Library.
+email:
+- xjpablobrx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_paypal_adaptive_payment.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payments/exceptions.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payments/utils.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payments/adaptive_payment_response.rb
+- lib/active_merchant/billing/gateways/paypal_adaptive_payment.rb
+- MIT-LICENSE
+- README.markdown
+- CHANGELOG
+has_rdoc: true
+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.6.2
+signing_key: 
+specification_version: 3
+summary: ActiveMercant PayPal Adaptive Payment Library
+test_files: []