paypal_adaptive 0.2.6 → 0.2.7

data/README.markdown

@@ -92,6 +92,9 @@ If you don't set ssl_cert_file then paypal_adaptive will check for certificates
 this location exists, otherwise falling back to the cacert.pem file included with paypal_adaptive.
 
 ## Changelog
+0.2.7
+Refactored config file handling for better non-Rails support, thanks mreinsch and dave-thompson.
+
 0.2.6
 Fix for using correct status field in pre-approval, thanks nbibler. Fix for ruby 1.9.3, thanks deepj.
 

data/lib/paypal_adaptive/config.rb

@@ -15,23 +15,12 @@ module PaypalAdaptive
       :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_cert_path, :ssl_cert_file
+    attr_accessor :paypal_base_url, :api_base_url, :headers, :ssl_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?
+    def initialize(env=nil, config_override={})
+      config = YAML.load(ERB.new(File.new(config_filepath).read).result)[env]
       raise "Could not load settings from config file" unless config
+      config.merge!(config_override) unless config_override.nil?
 
       if config["retain_requests_for_test"] == true
         @retain_requests_for_test = true
@@ -42,6 +31,9 @@ module PaypalAdaptive
         @ssl_cert_file = nil
         @paypal_base_url = PAYPAL_BASE_URL_MAPPING[pp_env]
         @api_base_url = API_BASE_URL_MAPPING[pp_env]
+        
+        # http.rb requires headers to be strings. Protect against ints in paypal_adaptive.yml
+        config.update(config){ |key,v| v.to_s }
         @headers = {
           "X-PAYPAL-SECURITY-USERID" => config['username'],
           "X-PAYPAL-SECURITY-PASSWORD" => config['password'],
@@ -53,17 +45,36 @@ module PaypalAdaptive
 
         if config['ssl_cert_file'] && config['ssl_cert_file'].length > 0
           @ssl_cert_file = config['ssl_cert_file']
-        elsif File.exists?("/etc/ssl/certs")
-          @ssl_cert_path = "/etc/ssl/certs"
         else
           @ssl_cert_file = File.join(File.dirname(__FILE__), "..", "..", "cacert.pem")
         end
+        puts "warning: coulf not find file: #{@ssl_cert_file}" unless File.exists?(@ssl_cert_file.to_s)
+      end
+    end
+
+    def config_filepath
+      if defined?(Rails)
+        Rails.root.join("config", "paypal_adaptive.yml")
+      else
+        File.join(File.dirname(__FILE__), "..", "..", "config", "paypal_adaptive.yml")
       end
     end
 
     def retain_requests_for_test?
       !!@retain_requests_for_test
     end
+  end
+
+  def self.config(env = nil)
+    env ||= default_env_for_config
+    raise "Please provide an environment" unless env
+    @configs ||= Hash.new
+    @configs[env] ||= Config.new(env)
+  end
+
+  private
 
+  def self.default_env_for_config
+    defined?(Rails) ? Rails.env : nil
   end
 end

data/lib/paypal_adaptive/ipn_notification.rb

@@ -6,23 +6,22 @@ module PaypalAdaptive
   class IpnNotification
     
     def initialize(env=nil)
-      @env = env
-      @@config ||= PaypalAdaptive::Config.new(@env)
-      @@paypal_base_url ||= @@config.paypal_base_url
-      @@ssl_cert_path ||= @@config.ssl_cert_path
-      @@ssl_cert_file ||= @@config.ssl_cert_file
+      config = PaypalAdaptive.config(env)
+      @paypal_base_url = config.paypal_base_url
+      @ssl_cert_path = config.ssl_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
+      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_cert_path unless @@ssl_cert_path.nil?
-      http.ca_file = @@ssl_cert_file unless @@ssl_cert_file.nil?
+      http.ca_path = @ssl_cert_path unless @ssl_cert_path.nil?
+      http.ca_file = @ssl_cert_file unless @ssl_cert_file.nil?
       
-      path = "#{@@paypal_base_url}/cgi-bin/webscr"
+      path = "#{@paypal_base_url}/cgi-bin/webscr"
       response_data = http.post(path, data).body
       
       @verified = response_data == "VERIFIED"

data/lib/paypal_adaptive/request.rb

@@ -9,20 +9,20 @@ module PaypalAdaptive
   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_path ||= @@config.ssl_cert_path
-      @@ssl_cert_file ||= @@config.ssl_cert_file
+      config = PaypalAdaptive.config(env)
+      @api_base_url = config.api_base_url
+      @headers = config.headers
+      @ssl_cert_path = config.ssl_cert_path
+      @ssl_cert_file = config.ssl_cert_file
     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)}
+      # @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)
+      #JSON::Schema.validate(@data, @schema)
     end
 
     def pay(data)
@@ -78,14 +78,14 @@ module PaypalAdaptive
     def post(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
+      url = URI.parse @api_base_url
       http = Net::HTTP.new(url.host, 443)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      http.ca_path = @@ssl_cert_path unless @@ssl_cert_path.nil?
-      http.ca_file = @@ssl_cert_file unless @@ssl_cert_file.nil?
+      http.ca_path = @ssl_cert_path unless @ssl_cert_path.nil?
+      http.ca_file = @ssl_cert_file unless @ssl_cert_file.nil?
 
-      response_data = http.post(path, api_request_data, @@headers).body
+      response_data = http.post(path, api_request_data, @headers).body
 
       JSON.parse(response_data)
     end

data/lib/paypal_adaptive/response.rb

@@ -1,45 +1,43 @@
 module PaypalAdaptive
   class Response < Hash    
     def initialize(response, env=nil)
-      @@config ||= PaypalAdaptive::Config.new(env)
-      @@paypal_base_url ||= @@config.paypal_base_url
+      config = PaypalAdaptive.config(env)
+      @paypal_base_url = config.paypal_base_url
       
       self.merge!(response)
     end
     
     def success?
-      self['responseEnvelope']['ack'].to_s =~ /^Success$/i &&
-        !(self['paymentExecStatus'].to_s =~ /^ERROR$/i)
+      !! (self['responseEnvelope']['ack'].to_s =~ /^Success$/i &&
+        !(self['paymentExecStatus'].to_s =~ /^ERROR$/i))
     end
     
     def errors
       if success?
         return []
       else
-        self['error']
+        errors = self['error']
+        errors ||= self['payErrorList']['payError'].collect { |e| e['error'] } rescue nil
+        errors
       end
     end
 
     def error_message
-      if success?
-        return nil
-      else
-        self['error'].first['message'] rescue nil
-      end
+      message = errors.first['message'] rescue nil
     end
 
     def approve_paypal_payment_url(type=nil)
       if self['payKey'].nil?
         return nil
       elsif ['mini', 'light'].include?(type.to_s)
-        return "#{@@paypal_base_url}/webapps/adaptivepayment/flow/pay?expType=#{type.to_s}&paykey=#{self['payKey']}"
+        return "#{@paypal_base_url}/webapps/adaptivepayment/flow/pay?expType=#{type.to_s}&paykey=#{self['payKey']}"
       end
       
-      "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{self['payKey']}"
+      "#{@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']}"
+      self['preapprovalKey'].nil? ? nil : "#{@paypal_base_url}/webscr?cmd=_ap-preapproval&preapprovalkey=#{self['preapprovalKey']}"
     end
 
     # workaround for rails 3.1.1, see https://github.com/tc/paypal_adaptive/issues/23

data/lib/paypal_adaptive/version.rb

@@ -1,4 +1,4 @@
 module PaypalAdaptive
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end
 

data/test/data/invalid_preapproval_payment.json

@@ -0,0 +1,22 @@
+{
+  "responseEnvelope":{
+    "timestamp":"2011-11-28T08:02:09.070-08:00",
+    "ack":"Success",
+    "correlationId":"XXXXXXXXXXXXX",
+    "build":"2279004"},
+  "payKey":"XX-XXXXXXXXXXXXXXXXX",
+  "paymentExecStatus":"ERROR",
+  "payErrorList":{
+    "payError":[{
+      "receiver":{
+        "amount":"25.0",
+        "email":"test@test.test"},
+      "error":{
+        "errorId":"580036",
+        "domain":"PLATFORM",
+        "severity":"Error",
+        "category":"Application",
+        "message":"This transaction cannot be processed. Please enter a valid credit card number and type"}
+    }]
+  }
+}

data/test/unit/pay_request_test.rb

@@ -15,7 +15,7 @@ class PayRequestTest < Test::Unit::TestCase
     pp_response = @pay_request.pay(data)
 
     puts "redirect url to\n #{pp_response.approve_paypal_payment_url}"
-    assert pp_response.success?
+    assert_equal true, pp_response.success?
   end
   
   def test_invalid_simple_pay
@@ -24,7 +24,7 @@ class PayRequestTest < Test::Unit::TestCase
     data = read_json_file(data_filepath)
     pp_response = @pay_request.pay(data)
     puts pp_response.errors
-    assert pp_response.success? == false
+    assert_equal false, pp_response.success?
   end
   
   def test_valid_chain_pay
@@ -40,7 +40,7 @@ class PayRequestTest < Test::Unit::TestCase
       puts pp_response.errors
     end
     
-    assert pp_response.success?
+    assert_equal true, pp_response.success?
   end
 
   def test_invalid_chain_pay
@@ -49,7 +49,7 @@ class PayRequestTest < Test::Unit::TestCase
     data = read_json_file(data_filepath)
     pp_response = @pay_request.pay(data)
     puts pp_response.errors
-    assert pp_response.success? == false
+    assert_equal false, pp_response.success?
   end
 
   def test_valid_parallel_pay
@@ -61,7 +61,7 @@ class PayRequestTest < Test::Unit::TestCase
     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?
+    assert_equal true, pp_response.success?
   end
 
   def test_invalid_parallel_pay
@@ -70,7 +70,7 @@ class PayRequestTest < Test::Unit::TestCase
     data = read_json_file(data_filepath)
     pp_response = @pay_request.pay(data)
     puts pp_response.errors
-    assert pp_response.success? == false
+    assert_equal false, pp_response.success?
   end
   
   def test_preapproval

data/test/unit/preapproval_test.rb

@@ -48,6 +48,18 @@ class PreapprovalTest < Test::Unit::TestCase
     assert pp_response.success? == false
   end
 
+  def test_erred_preapproval_payment_message
+    puts "-------"
+    puts "invalid"
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","invalid_preapproval_payment.json")
+
+    data = read_json_file(data_filepath)
+    pp_response = @preapproval_request.preapproval(data)
+    puts "error message is #{pp_response.error_message}"
+
+    assert pp_response.error_message == "This transaction cannot be processed. Please enter a valid credit card number and type"
+  end
+
   def read_json_file(filepath)
     File.open(filepath, "rb"){|f| JSON.parse(f.read)}
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal_adaptive
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000 Z
+date: 2012-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70119519086160 !ruby/object:Gem::Requirement
+  requirement: &70239312828620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70119519086160
+  version_requirements: *70239312828620
 - !ruby/object:Gem::Dependency
   name: jsonschema
-  requirement: &70119519085000 !ruby/object:Gem::Requirement
+  requirement: &70239312840100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70119519085000
+  version_requirements: *70239312840100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70119519084120 !ruby/object:Gem::Requirement
+  requirement: &70239312838340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70119519084120
+  version_requirements: *70239312838340
 description: Lightweight wrapper for Paypal's Adaptive Payments API
 email:
 - tommy.chheng@gmail.com
@@ -71,6 +71,7 @@ files:
 - test/data/invalid_parallel_pay_request.json
 - test/data/invalid_preapproval.json
 - test/data/invalid_preapproval_error_execstatus.json
+- test/data/invalid_preapproval_payment.json
 - test/data/invalid_simple_pay_request_1.json
 - test/data/valid_chain_pay_request.json
 - test/data/valid_get_payment_options_request.json
@@ -117,6 +118,7 @@ test_files:
 - test/data/invalid_parallel_pay_request.json
 - test/data/invalid_preapproval.json
 - test/data/invalid_preapproval_error_execstatus.json
+- test/data/invalid_preapproval_payment.json
 - test/data/invalid_simple_pay_request_1.json
 - test/data/valid_chain_pay_request.json
 - test/data/valid_get_payment_options_request.json