paypal_adaptive 0.2.3 → 0.2.4

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.4
+Support for embedded payments. Issue #21 thanks rafaelivan. Shipping address, wrapper methods has return response object. Issue #22 thanks tsmango.
+
 0.2.3
 Using bundler for gem creation. Moved all code to paypal_adaptive dir.  Added ExecutePayment call to request. Thanks Roger Neel.
 

data/lib/paypal_adaptive/request.rb

@@ -26,63 +26,56 @@ module PaypalAdaptive
     end
 
     def pay(data)
-      raise NoDataError unless data
+      wrap_post(data, "/AdaptivePayments/Pay")
+    end
 
-      response_data = call_api(data, "/AdaptivePayments/Pay")
-      PaypalAdaptive::Response.new(response_data, @env)
+    def payment_details(data)
+      wrap_post(data, "/AdaptivePayments/PaymentDetails")
     end
 
     def set_payment_options(data)
-      raise NoDataError unless data
-
-      response_data = call_api(data, "/AdaptivePayments/SetPaymentOptions")
-      PaypalAdaptive::Response.new(response_data, @env)
+      wrap_post(data, "/AdaptivePayments/SetPaymentOptions")
     end
 
-    def payment_details(data)
-      raise NoDataError unless data
+    def get_payment_options(data)
+      wrap_post(data, "/AdaptivePayments/GetPaymentOptions")
+    end
 
-      call_api(data, "/AdaptivePayments/PaymentDetails")
+    def get_shipping_addresses(data)
+      wrap_post(data, "/AdaptivePayments/GetShippingAddresses")
     end
 
     def preapproval(data)
-      raise NoDataError unless data
-
-      response_data = call_api(data, "/AdaptivePayments/Preapproval")
-      PaypalAdaptive::Response.new(response_data, @env)
+      wrap_post(data, "/AdaptivePayments/Preapproval")
     end
 
     def preapproval_details(data)
-      raise NoDataError unless data
-
-      call_api(data, "/AdaptivePayments/PreapprovalDetails")
+      wrap_post(data, "/AdaptivePayments/PreapprovalDetails")
     end
 
     def cancel_preapproval(data)
-      raise NoDataError unless data
-
-      call_api(data, "/AdaptivePayments/CancelPreapproval")
+      wrap_post(data, "/AdaptivePayments/CancelPreapproval")
     end
 
     def convert_currency(data)
-      raise NoDataError unless data
-
-      call_api(data, "/AdaptivePayments/ConvertCurrency")
+      wrap_post(data, "/AdaptivePayments/ConvertCurrency")
     end
 
     def refund(data)
-      raise NoDataError unless data
-
-      call_api(data, "/AdaptivePayments/Refund")
+      wrap_post(data, "/AdaptivePayments/Refund")
     end
 
     def execute_payment(data)
+      wrap_post(data, "/AdaptivePayments/ExecutePayment")
+    end
+
+    def wrap_post(data, path)
       raise NoDataError unless data
 
-      call_api(data, "/AdaptivePayments/ExecutePayment")
+      PaypalAdaptive::Response.new(post(data, path), @env)
     end
 
-    def call_api(data, path)
+    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

data/lib/paypal_adaptive/response.rb

@@ -27,8 +27,14 @@ module PaypalAdaptive
       end
     end
 
-    def approve_paypal_payment_url
-      self['payKey'].nil? ? nil : "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{self['payKey']}"
+    def approve_paypal_payment_url(type=nil)
+      if self['payKey'].nil?
+        return nil
+      elsif ['mini', 'embedded'].include?(type.to_s)
+        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']}"
     end
 
     def preapproval_paypal_payment_url

data/lib/paypal_adaptive/version.rb

@@ -1,4 +1,4 @@
 module PaypalAdaptive
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end
 

data/test/data/valid_get_payment_options_request.json

@@ -0,0 +1,7 @@
+{
+  "payKey": "REPLACE-WITH-VALID-PAY-KEY",
+
+  "requestEnvelope": {
+    "errorLanguage": "en_US"
+  }
+}

data/test/data/valid_get_shipping_addresses_request.json

@@ -0,0 +1,7 @@
+{
+  "payKey": "REPLACE-WITH-VALID-PAY-KEY",
+
+  "requestEnvelope": {
+    "errorLanguage": "en_US"
+  }
+}

data/test/data/valid_payment_details_request.json

@@ -0,0 +1,7 @@
+{
+  "payKey": "REPLACE-WITH-VALID-PAY-KEY",
+
+  "requestEnvelope": {
+    "errorLanguage": "en_US"
+  }
+}

data/test/data/valid_set_payment_options_request.json

@@ -0,0 +1,29 @@
+{
+  "payKey": "REPLACE-WITH-VALID-PAY-KEY",
+
+  "senderOptions": {
+    "requireShippingAddressSelection": "true"
+  },
+
+  "receiverOptions": {
+    "invoiceData": {
+      "item": [
+        {
+          "identifier": "1",
+          "name": "Sample Product",
+          "itemCount": "1",
+          "itemPrice": "10.00",
+          "price": "10.00"
+        }
+      ],
+      "totalShipping": "0.00"
+    },
+    "receiver": {
+      "email": "testpp_1261697850_per@nextsprocket.com"
+    }
+  },
+
+  "requestEnvelope": {
+    "errorLanguage": "en_US"
+  }
+}

data/test/unit/get_shipping_addresses_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class GetShippingAddressesTest < Test::Unit::TestCase
+  def setup
+    @pay_key     = nil
+    @pay_request = PaypalAdaptive::Request.new("test")
+  end
+
+  def test_get_shipping_addresses
+    puts "-------"
+    puts "get shipping addresses"
+
+    # /Pay
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_simple_pay_request_1.json")
+
+    data = read_json_file(data_filepath)
+    data["actionType"] = "CREATE"
+
+    pp_response = @pay_request.pay(data)
+    @pay_key = pp_response['payKey']
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    # /SetPaymentOptions
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_set_payment_options_request.json")
+
+    data = read_json_file(data_filepath)
+    data["payKey"] = @pay_key
+
+    pp_response = @pay_request.set_payment_options(data)
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    # /GetShippingAddresses
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_get_shipping_addresses_request.json")
+
+    data = read_json_file(data_filepath)
+    data["key"] = @pay_key
+
+    pp_response = @pay_request.get_shipping_addresses(data)
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+  end
+
+  def read_json_file(filepath)
+    File.open(filepath,   "rb"){|f| JSON.parse(f.read)}
+  end
+end

data/test/unit/pay_request_test.rb

@@ -73,10 +73,6 @@ class PayRequestTest < Test::Unit::TestCase
     assert pp_response.success? == false
   end
   
-  def test_set_payment_options
-    #TODO
-  end
-  
   def test_preapproval
     #TODO
   end

data/test/unit/payment_details_test.rb

@@ -2,18 +2,35 @@ require 'test_helper'
 
 class PaymentDetailsTest < Test::Unit::TestCase
   def setup
+    @pay_key     = nil
     @pay_request = PaypalAdaptive::Request.new("test")
-    @payment_details_request = PaypalAdaptive::Request.new("test")
   end
-  
+
   def test_payment_details
     puts "-------"
     puts "payment details"
+
+    # /Pay
     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}"
+    @pay_key = pp_response['payKey']
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    # /PaymentDetails
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_payment_details_request.json")
+
+    data = read_json_file(data_filepath)
+    data["payKey"] = @pay_key
+
+    pp_response = @pay_request.payment_details(data)
 
     unless pp_response.success?
       puts pp_response.errors
@@ -21,14 +38,10 @@ class PaymentDetailsTest < Test::Unit::TestCase
 
     assert pp_response.success?
 
-    data = {"requestEnvelope"=>{"errorLanguage"=>"en_US"}, "payKey" => pp_response['payKey']}
-     
-   response =  @payment_details_request.payment_details(data)
-   assert_equal 'CREATED', response['status']
+    assert_equal 'CREATED', pp_response['status']
   end
 
   def read_json_file(filepath)
     File.open(filepath,   "rb"){|f| JSON.parse(f.read)}
   end
-
 end

data/test/unit/payment_options_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class PaymentOptionsTest < Test::Unit::TestCase
+  def setup
+    @pay_key     = nil
+    @pay_request = PaypalAdaptive::Request.new("test")
+  end
+
+  def test_payment_options
+    puts "-------"
+    puts "set payment options"
+
+    # /Pay
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_simple_pay_request_1.json")
+
+    data = read_json_file(data_filepath)
+    data["actionType"] = "CREATE"
+
+    pp_response = @pay_request.pay(data)
+    @pay_key = pp_response['payKey']
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    # /SetPaymentOptions
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_set_payment_options_request.json")
+
+    data = read_json_file(data_filepath)
+    data["payKey"] = @pay_key
+
+    pp_response = @pay_request.set_payment_options(data)
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    puts "-------"
+    puts "get payment options"
+
+    # /GetPaymentOptions
+    data_filepath =  File.join(File.dirname(__FILE__),"..", "data","valid_get_payment_options_request.json")
+
+    data = read_json_file(data_filepath)
+    data["payKey"] = @pay_key
+
+    pp_response = @pay_request.get_payment_options(data)
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+
+    assert pp_response.success?
+
+    assert_equal pp_response["senderOptions"]["requireShippingAddressSelection"],                 "true"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["item"].first["identifier"], "1"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["item"].first["name"],       "Sample Product"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["item"].first["itemCount"],  "1"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["item"].first["itemPrice"],  "10.00"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["item"].first["price"],      "10.00"
+    assert_equal pp_response["receiverOptions"].first["invoiceData"]["totalShipping"],            "0.00"
+  end
+
+  def read_json_file(filepath)
+    File.open(filepath,   "rb"){|f| JSON.parse(f.read)}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal_adaptive
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000Z
+date: 2011-10-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70366761922980 !ruby/object:Gem::Requirement
+  requirement: &70330139945400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70366761922980
+  version_requirements: *70330139945400
 - !ruby/object:Gem::Dependency
   name: jsonschema
-  requirement: &70366761921940 !ruby/object:Gem::Requirement
+  requirement: &70330139944900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70366761921940
+  version_requirements: *70330139944900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70366761920820 !ruby/object:Gem::Requirement
+  requirement: &70330139944440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70366761920820
+  version_requirements: *70330139944440
 description: Lightweight wrapper for Paypal's Adaptive Payments API
 email:
 - tommy.chheng@gmail.com
@@ -73,14 +73,20 @@ files:
 - test/data/invalid_preapproval.json
 - test/data/invalid_simple_pay_request_1.json
 - test/data/valid_chain_pay_request.json
+- test/data/valid_get_payment_options_request.json
+- test/data/valid_get_shipping_addresses_request.json
 - test/data/valid_parallel_pay_request.json
+- test/data/valid_payment_details_request.json
 - test/data/valid_preapproval.json
+- test/data/valid_set_payment_options_request.json
 - test/data/valid_simple_pay_request_1.json
 - test/test_helper.rb
 - test/unit/config_test.rb
+- test/unit/get_shipping_addresses_test.rb
 - test/unit/pay_request_schema_test.rb
 - test/unit/pay_request_test.rb
 - test/unit/payment_details_test.rb
+- test/unit/payment_options_test.rb
 - test/unit/preapproval_test.rb
 homepage: http://github.com/tc/paypal_adaptive
 licenses: []
@@ -112,12 +118,18 @@ test_files:
 - test/data/invalid_preapproval.json
 - test/data/invalid_simple_pay_request_1.json
 - test/data/valid_chain_pay_request.json
+- test/data/valid_get_payment_options_request.json
+- test/data/valid_get_shipping_addresses_request.json
 - test/data/valid_parallel_pay_request.json
+- test/data/valid_payment_details_request.json
 - test/data/valid_preapproval.json
+- test/data/valid_set_payment_options_request.json
 - test/data/valid_simple_pay_request_1.json
 - test/test_helper.rb
 - test/unit/config_test.rb
+- test/unit/get_shipping_addresses_test.rb
 - test/unit/pay_request_schema_test.rb
 - test/unit/pay_request_test.rb
 - test/unit/payment_details_test.rb
+- test/unit/payment_options_test.rb
 - test/unit/preapproval_test.rb