tonyla-paypal_adaptive 0.1.0

data/config/paypal_adaptive.yml

@@ -0,0 +1,31 @@
+development:
+  environment: "sandbox"
+  username: "signupforuseratsandboxpaypal"
+  password: "signupforuseratsandboxpaypal"
+  signature: "signupforuseratsandboxpaypal"
+  application_id: "APP-TEST"
+  ssl_cert_file:
+
+test:
+  environment: "sandbox"
+  username: "signupforuseratsandboxpaypal"
+  password: "signupforuseratsandboxpaypal"
+  signature: "signupforuseratsandboxpaypal"
+  application_id: "APP-TEST"
+  ssl_cert_file:
+
+production:
+  environment: "production"
+  username: "my_production_username"
+  password: "my_production_password"
+  signature: "my_production_signature"
+  application_id: "my_production_app_id"
+  ssl_cert_file:
+
+with_erb_tags:
+  environment: "sandbox"
+  username: <%= ENV['paypal.username'] %>
+  password: <%= ENV['paypal.password'] %>
+  signature: "signupforuseratsandboxpaypal"
+  application_id: "APP-TEST"
+  ssl_cert_file:

data/lib/config.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+require 'erb'
+
+module PaypalAdaptive
+  class Config
+    PAYPAL_BASE_URL_MAPPING = {
+      :production => "https://www.paypal.com",
+      :sandbox => "https://www.sandbox.paypal.com",
+      :beta_sandbox => "https://www.beta-sandbox.paypal.com"
+    } unless defined? PAYPAL_BASE_URL_MAPPING
+
+    API_BASE_URL_MAPPING = {
+      :production => "https://svcs.paypal.com",
+      :sandbox => "https://svcs.sandbox.paypal.com",
+      :beta_sandbox => "https://svcs.beta-sandbox.paypal.com"
+    } unless defined? API_BASE_URL_MAPPING
+
+    attr_accessor :config_filepath, :paypal_base_url, :api_base_url, :headers, :ssl_ca_cert_path, :ssl_cert_file
+
+    def initialize(env=nil, config_override=nil)
+      if env
+        #non-rails env
+        @config_filepath = File.join(File.dirname(__FILE__), "..", "config", "paypal_adaptive.yml")
+        load(env, config_override)
+      else
+        @config_filepath = File.join(Rails.root, "config", "paypal_adaptive.yml")
+        load(Rails.env, config_override)
+      end
+    end
+
+    def load(environment, config_override)
+      config = YAML.load(ERB.new(File.new(@config_filepath).read).result)[environment]
+      config.merge!(config_override) unless config_override.nil?
+
+      if config["retain_requests_for_test"] == true
+        @retain_requests_for_test = true
+      else
+        pp_env = config['environment'].to_sym
+
+        @ssl_ca_cert_path = nil
+        @ssl_cert_file = nil
+        @paypal_base_url = PAYPAL_BASE_URL_MAPPING[pp_env]
+        @api_base_url = API_BASE_URL_MAPPING[pp_env]
+        @headers = {
+          "X-PAYPAL-SECURITY-USERID" => config['username'],
+          "X-PAYPAL-SECURITY-PASSWORD" => config['password'],
+          "X-PAYPAL-APPLICATION-ID" => config['application_id'],
+          "X-PAYPAL-REQUEST-DATA-FORMAT" => "JSON",
+          "X-PAYPAL-RESPONSE-DATA-FORMAT" => "JSON"
+        }
+
+        if config['ssl_cert_file'] && config['ssl_cert_file'].length > 0
+          @ssl_cert_file = config['ssl_cert_file']
+        end
+
+        if File.exists?("/etc/ssl/certs")
+          @ssl_ca_cert_path = "/etc/ssl/certs"
+        else
+          @ssl_ca_cert_path = File.join(File.dirname(__FILE__), "..", "cacert.pem")
+        end
+
+        @headers.merge!({
+          "X-PAYPAL-SECURITY-SIGNATURE" => config['signature']
+        }) if @ssl_cert_file.blank?
+
+      end
+    end
+
+    def retain_requests_for_test?
+      !!@retain_requests_for_test
+    end
+
+  end
+end

data/lib/ipn_notification.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'config'
+
+module PaypalAdaptive
+  class IpnNotification
+
+    def initialize(env=nil)
+      @env = env
+      @@config ||= PaypalAdaptive::Config.new(@env)
+      @@paypal_base_url ||= @@config.paypal_base_url
+      @@ssl_ca_cert_path ||= @@config.ssl_ca_cert_path
+      @@ssl_cert_file ||= @@config.ssl_cert_file
+    end
+
+    def send_back(data)
+      data = "cmd=_notify-validate&#{data}"
+      url = URI.parse @@paypal_base_url
+      http = Net::HTTP.new(url.host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.ca_path = @@ssl_ca_cert_path unless @@ssl_ca_cert_path.nil?
+      http.ca_file = @@ssl_cert_file unless @@ssl_cert_file.nil?
+
+      path = "#{@@paypal_base_url}/cgi-bin/webscr"
+      resp, response_data = http.post(path, data)
+
+      @verified = response_data == "VERIFIED"
+    end
+
+    def verified?
+      @verified
+    end
+
+  end
+end

data/lib/pay_request_schema.json

@@ -0,0 +1,39 @@
+{"description":"Paypal PayRequest API",
+ "type":"object",
+ "properties":
+  {
+    "actionType": {"type":"string", "options":[{"value":"PAY", "label":"PAY"}]},
+    "cancelUrl": {"type":"string"},
+    "clientDetails": {"type":"object", "optional": true},
+    "currencyCode": {"type":"string"},
+    "feesPayer": {"type":"string", "optional":true,
+                    "options":[
+                        {"value":"SENDER", "label":"SENDER"},
+                        {"value":"PRIMARYRECEIVER", "label":"PRIMARYRECEIVER"},
+                        {"value":"EACHRECEIVER", "label":"EACHRECEIVER"},
+                        {"value":"SECONDARYONLY", "label":"SECONDARYONLY"}
+												]},
+    "fundingConstraint": {"type":"object", "optional": true},
+    "ipnNotificationUrl": {"type":"string", "optional": true},
+    "memo": {"type":"string", "optional": true},
+    "pin": {"type":"string", "optional": true},
+    "preapprovalKey": {"type":"string", "optional": true},
+	  "receiverList": {
+											"type":"object", "properties":{
+	                    "receiver":{
+													"type":"array",  
+	                    		"items":{
+	                        	"email":{"type":"string"},
+	                        	"amount":{"type":"string"},
+	                        	"primary":{"type":"string","optional": true}}
+											    }
+											}
+										},
+										
+    "requestEnvelope": {"type":"object", "properties":{"errorLanguage":{"type":"string"}}},
+    "returnUrl": {"type":"string"},
+    "reverseAllParallelPaymentsOnError": {"type":"boolean", "optional": true},
+    "senderEmail": {"type":"string", "optional": true},
+    "trackingId": {"type":"string", "optional": true}
+  }
+}

data/lib/paypal_adaptive.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "config"))
+require File.expand_path(File.join(File.dirname(__FILE__), "request"))
+require File.expand_path(File.join(File.dirname(__FILE__), "response"))
+require File.expand_path(File.join(File.dirname(__FILE__), "ipn_notification"))

data/lib/request.rb

@@ -0,0 +1,102 @@
+require 'json'
+require 'config'
+require 'net/http'
+require 'net/https'
+require 'response'
+
+module PaypalAdaptive
+  class NoDataError < Exception
+  end
+
+  class Request
+    def initialize(env = nil)
+      @env = env
+      @@config ||= PaypalAdaptive::Config.new(@env)
+      @@api_base_url ||= @@config.api_base_url
+      @@headers ||= @@config.headers
+      @@ssl_cert_file ||= @@config.ssl_cert_file
+      @@ssl_ca_cert_path ||= @@config.ssl_ca_cert_path
+    end
+
+    def validate
+      #TODO the receiverList field not validating properly
+
+      # @@schema_filepath = "../lib/pay_request_schema.json"
+      # @@schema = File.open(@@schema_filepath, "rb"){|f| JSON.parse(f.read)}
+      # see page 42 of PP Adaptive Payments PDF for explanation of all fields.
+      #JSON::Schema.validate(@data, @@schema)
+    end
+
+    def pay(data)
+      raise NoDataError unless data
+
+      response_data = call_api(data, "/AdaptivePayments/Pay")
+      PaypalAdaptive::Response.new(response_data, @env)
+    end
+
+    def set_payment_options(data)
+      raise NoDataError unless data
+
+      response_data = call_api(data, "/AdaptivePayments/SetPaymentOptions")
+      PaypalAdaptive::Response.new(response_data, @env)
+    end
+
+    def payment_details(data)
+      raise NoDataError unless data
+
+      call_api(data, "/AdaptivePayments/PaymentDetails")
+    end
+
+    def preapproval(data)
+      raise NoDataError unless data
+
+      response_data = call_api(data, "/AdaptivePayments/Preapproval")
+      PaypalAdaptive::Response.new(response_data, @env)
+    end
+
+    def preapproval_details(data)
+      raise NoDataError unless data
+
+      call_api(data, "/AdaptivePayments/PreapprovalDetails")
+    end
+
+    def cancel_preapproval(data)
+      raise NoDataError unless data
+
+      call_api(data, "/AdaptivePayments/CancelPreapproval")
+    end
+
+    def convert_currency(data)
+      raise NoDataError unless data
+
+      call_api(data, "/AdaptivePayments/ConvertCurrency")
+    end
+
+    def refund(data)
+      raise NoDataError unless data
+
+      call_api(data, "/AdaptivePayments/Refund")
+    end
+
+    def call_api(data, path)
+      #hack fix: JSON.unparse doesn't work in Rails 2.3.5; only {}.to_json does..
+      api_request_data = JSON.unparse(data) rescue data.to_json
+      url = URI.parse @@api_base_url
+      http = Net::HTTP.new(url.host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      if @@ssl_ca_cert_path
+        cert = File.read(@@ssl_cert_file)
+        http.cert = OpenSSL::X509::Certificate.new(cert)
+        http.key = OpenSSL::PKey::RSA.new(cert)
+        http.ca_path = @@ssl_ca_cert_path unless @@ssl_ca_cert_path.nil? #/etc/ssl/certs'
+      end
+
+      resp, response_data = http.post(path, api_request_data, @@headers)
+
+      JSON.parse(response_data)
+    end
+  end
+
+end

data/lib/response.rb

@@ -0,0 +1,38 @@
+module PaypalAdaptive
+  class Response < Hash    
+    def initialize(response, env=nil)
+      @@config ||= PaypalAdaptive::Config.new(env)
+      @@paypal_base_url ||= @@config.paypal_base_url
+      
+      self.merge!(response)
+    end
+    
+    def success?
+      self['responseEnvelope']['ack'] == 'Success'
+    end
+    
+    def errors
+      if success?
+        return []
+      else
+        self['error']
+      end
+    end
+
+    def error_message
+      if success?
+        return nil
+      else
+        self['error'].first['message'] rescue nil
+      end
+    end
+
+    def approve_paypal_payment_url
+      self['payKey'].nil? ? nil : "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{self['payKey']}"
+    end
+
+    def preapproval_paypal_payment_url
+      self['preapprovalKey'].nil? ? nil : "#{@@paypal_base_url}/webscr?cmd=_ap-preapproval&preapprovalkey=#{self['preapprovalKey']}"
+    end
+  end
+end

data/templates/paypal_ipn.rb

@@ -0,0 +1,25 @@
+# Allow the metal piece to run in isolation
+require(File.dirname(__FILE__) + "/../../config/environment") unless defined?(Rails)
+
+class PaypalIpn
+  def self.call(env)
+    if env["PATH_INFO"] =~ /^\/paypal_ipn/
+      request = Rack::Request.new(env)
+      params = request.params
+      
+      ipn = PaypalAdaptive::IpnNotification.new
+      ipn.send_back(env['rack.request.form_vars'])
+      if ipn.verified?
+        #mark transaction as completed in your DB
+        output = "Verified."
+      else
+        output = "Not Verified."
+      end
+
+      [200, {"Content-Type" => "text/html"}, [output]]
+    else
+      [404, {"Content-Type" => "text/html"}, ["Not Found"]]
+    end
+  end
+  
+end

data/test/data/invalid_chain_pay_request.json

@@ -0,0 +1,13 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[
+            {"email":"testpp_1261697850_per@nextsprocket.com", "amount":"50.00", "primary": "true"},
+            {"email":"sender_1261713739_per@nextsprocket.com", "amount":"100.00", "primary": "false"},
+            {"email":"ppsell_1261697921_biz@nextsprocket.com", "amount":"100.00", "primary": "false"}
+            ]},
+"cancelUrl":"http://127.0.0.1:3000/payments/cancelled_payment",
+ "actionType":"PAY"
+}
+

data/test/data/invalid_parallel_pay_request.json

@@ -0,0 +1,13 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[
+            {"email":"dummy@account.com", "amount":"100.00"},
+            {"email":"dummy@account.com", "amount":"50.00"},
+            {"email":"dummy@account.com", "amount":"50.00"}
+            ]},
+"cancelUrl":"http://127.0.0.1:3000/payments/cancelled_payment",
+ "actionType":"PAY"
+}
+

data/test/data/invalid_preapproval.json

@@ -0,0 +1,12 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment_request",
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment_request",
+ "actionType":"PAY",
+ "maxTotalAmountOfAllPayments": "1500.00",
+  "maxNumberOfPayments":"30",
+ "startingDate":"2010-07-13T07sdf00.000Z",
+ "endingDate":"2010-12-13T07dfg0000.000Z"
+}
+

data/test/data/invalid_simple_pay_request_1.json

@@ -0,0 +1,8 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[{"email":"testpp_1261697850_per@nextsprocket.com", "amount":"10.0"}]},
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment",
+ "actionType":1
+}

data/test/data/valid_chain_pay_request.json

@@ -0,0 +1,12 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment_request", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[
+            {"email":"testpp_1261697850_per@nextsprocket.com", "amount":"100.00", "primary": "true"},
+            {"email":"ppsell_1261697921_biz@nextsprocket.com", "amount":"90.00", "primary": "false"}
+            ]},
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment_request", 
+ "actionType":"PAY"
+}
+

data/test/data/valid_parallel_pay_request.json

@@ -0,0 +1,14 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment_request", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[
+            {"email":"testpp_1261697850_per@nextsprocket.com", "amount":"100.00"},
+            {"email":"sender_1261713739_per@nextsprocket.com", "amount":"50.00"},
+            {"email":"ppsell_1261697921_biz@nextsprocket.com", "amount":"50.00"}
+            ]},
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment_request", 
+ "actionType":"PAY",
+ "senderEmail": "a@a.com"
+}
+

data/test/data/valid_preapproval.json

@@ -0,0 +1,11 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment_request",
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD", 
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment_request",
+ "maxTotalAmountOfAllPayments": "1500.00",
+  "maxNumberOfPayments":"30",
+ "startingDate":"2020-07-13T07:00:00.000Z",
+ "endingDate":"2020-12-13T07:00:00.000Z" 
+}
+

data/test/data/valid_simple_pay_request_1.json

@@ -0,0 +1,9 @@
+{
+"returnUrl":"http://127.0.0.1:3000/payments/completed_payment_request", 
+"requestEnvelope":{"errorLanguage":"en_US"},
+"currencyCode":"USD",  
+"receiverList":{"receiver":[{"email":"testpp_1261697850_per@nextsprocket.com", "amount":"10.00"}]},
+"cancelUrl":"http://127.0.0.1:3000/payments/canceled_payment_request",
+ "actionType":"PAY",
+ "ipnNotificationUrl":"http://127.0.0.1:3000/payments/ipn_notification"
+}

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'JSON'
+require 'test/unit'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'paypal_adaptive'

data/test/unit/config_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class ConfigTest < Test::Unit::TestCase
+  def test_set_ssl_cert_file
+    @config = PaypalAdaptive::Config.new("test", { "ssl_cert_file" => "/path/to/cacert.pem" })
+    assert_equal "/path/to/cacert.pem", @config.ssl_cert_file
+    assert_equal nil, @config.ssl_ca_cert_path
+  end
+
+  def test_default_ssl_cert_file
+    @config = PaypalAdaptive::Config.new("test", { "ssl_cert_file" => "" })
+    assert File.exists?(@config.ssl_cert_file)
+    assert_equal nil, @config.ssl_ca_cert_path
+  end
+
+  def test_erb_tags
+    ENV['paypal.username'] = 'account@email.com'
+    ENV['paypal.password'] = 's3krit'
+
+    config = PaypalAdaptive::Config.new("with_erb_tags")
+    assert_equal 'account@email.com', config.headers["X-PAYPAL-SECURITY-USERID"]
+    assert_equal 's3krit', config.headers["X-PAYPAL-SECURITY-PASSWORD"]
+  end
+end

data/test/unit/pay_request_schema_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'json'
+require 'jsonschema'
+
+class PayRequestSchemaTest < Test::Unit::TestCase
+  def setup
+    @schema_filepath =  File.join(File.dirname(__FILE__),"..", "..", "lib","pay_request_schema.json")
+    @schema = File.open(@schema_filepath, "rb"){|f| JSON.parse(f.read)}
+  end
+  
+ def test_valid_simple_pay
+    data_filepath = File.join(File.dirname(__FILE__),"..", "data","valid_simple_pay_request_1.json")
+    data   = read_json_file(data_filepath)
+    
+    #receiverList not validating correctly, is it due to the schema or jsonschema parsing?
+    assert_nothing_raised do 
+      JSON::Schema.validate(data, @schema)
+    end
+  end
+  
+  def test_invalid_simple_pay
+    data_filepath = File.join(File.dirname(__FILE__),"..", "data","invalid_simple_pay_request_1.json")
+    data   = read_json_file(data_filepath)
+    
+    assert_raise JSON::Schema::ValueError do 
+      JSON::Schema.validate(data, @schema)
+    end
+  end
+  
+  def test_valid_chain_pay
+    #TODO
+  end
+
+  def test_invalid_chain_pay
+    #TODO
+  end
+
+  def test_valid_parallel_pay
+    #TODO
+  end
+
+  def test_invalid_parallel_pay
+    #TODO
+  end
+
+  def read_json_file(filepath)
+    File.open(filepath,   "rb"){|f| JSON.parse(f.read)}
+  end
+end

data/test/unit/pay_request_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+class PayRequestTest < Test::Unit::TestCase
+  def setup
+    @pay_request = PaypalAdaptive::Request.new("test")
+  end
+  
+  def test_valid_simple_pay
+    puts "-------"
+    puts "simple"
+
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_simple_pay_request_1.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+
+    puts "redirect url to\n #{pp_response.approve_paypal_payment_url}"
+    assert pp_response.success?
+  end
+  
+  def test_invalid_simple_pay
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","invalid_simple_pay_request_1.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+    puts pp_response.errors
+    assert pp_response.success? == false
+  end
+  
+  def test_valid_chain_pay
+    puts "-------"
+    puts "chain"
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_chain_pay_request.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+    puts "redirect url to\n #{pp_response.approve_paypal_payment_url}"
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+    
+    assert pp_response.success?
+  end
+
+  def test_invalid_chain_pay
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","invalid_chain_pay_request.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+    puts pp_response.errors
+    assert pp_response.success? == false
+  end
+
+  def test_valid_parallel_pay
+    puts "-------"
+    puts "parallel"
+
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_parallel_pay_request.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+    puts "redirect url to\n #{pp_response.approve_paypal_payment_url}"
+    assert pp_response.success?
+  end
+
+  def test_invalid_parallel_pay
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","invalid_parallel_pay_request.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @pay_request.pay(data)
+    puts pp_response.errors
+    assert pp_response.success? == false
+  end
+  
+  def test_set_payment_options
+    #TODO
+  end
+  
+  def test_preapproval
+    #TODO
+  end
+
+  def test_preapproval_details
+    #TODO
+  end
+  
+  def test_cancel_preapproval
+    #TODO
+  end
+
+  def test_convert_currency
+    #TODO
+  end
+
+  def test_refund
+    #TODO
+  end
+
+  def read_json_file(filepath)
+    File.open(filepath,   "rb"){|f| JSON.parse(f.read)}
+  end
+  
+end