paypal_adaptive 0.0.3 → 0.0.4

data/README.markdown

@@ -3,8 +3,10 @@ This gem is a lightweight wrapper for the paypal adaptive payments API.
 
 This is very much a work in progress! Use at your own risk or submit bug fixes :)
 
-Before you need start, download pp_adaptivepayments.pdf from the Paypal's dev site http://x.com
-It'll be invaluable for parameters and error messages.  
+Before you need start, read the API manual https://www.x.com/docs/DOC-1531 and check out the forums on http://x.com
+It'll be invaluable for parameters and error messages. The gem keeps the request/response as hashes so you will have to
+read the manual to make the proper calls. I made a few test cases for further examples at http://github.com/tc/paypal_adaptive/tree/master/test/
+
 
 ## HOWTO
 Create paypal_adaptive.yml to your config folder:
@@ -60,7 +62,7 @@ Upon payment completion page, they will be redirected to http://testserver.com/p
 They can also click cancel to go to http://testserver.com/payments/canceled_payment_request
 
 The actual payment details will be sent to your server via "ipnNotificationUrl"
-You have to create a listener to receive POST messages from paypal. I added a Rails metal template in the templates folder which handles the callbcak.
+You have to create a listener to receive POST messages from paypal. I added a Rails metal template in the templates folder which handles the callback.
 
 Additionally, you can make calls to Paypal Adaptive's other APIs:
     payment_details, preapproval, preapproval_details, cancel_preapproval, convert_currency, refund
@@ -68,6 +70,9 @@ Additionally, you can make calls to Paypal Adaptive's other APIs:
 Input is just a Hash just like the pay method. Refer to the Paypal manual for more details.
 
 ## Changelog
+0.0.4
+Preapproval now returns a PaypalAdaptive::Response class. Added preapproval test cases.
+
 0.0.3
 Renamed PayRequest, PayResponse into Request, Response since other api calls use the class as well.
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/request.rb

@@ -41,7 +41,8 @@ module PaypalAdaptive
     def preapproval(data)
       raise NoDataError unless data
 
-      call_api(data, "/AdaptivePayments/Preapproval")
+      response_data = call_api(data, "/AdaptivePayments/Preapproval")
+      PaypalAdaptive::Response.new(response_data, @env)
     end
 
     def preapproval_details(data)

data/lib/response.rb

@@ -18,7 +18,15 @@ module PaypalAdaptive
         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
       "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{self['payKey']}"
     end

data/paypal_adaptive.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paypal_adaptive}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tommy Chheng"]
-  s.date = %q{2009-12-28}
+  s.date = %q{2009-12-29}
   s.description = %q{Lightweight wrapper for Paypal's Adaptive Payments API.}
   s.email = %q{tommy.chheng@gmail.com}
   s.extra_rdoc_files = [
@@ -33,14 +33,17 @@ Gem::Specification.new do |s|
      "templates/paypal_ipn.rb",
      "test/data/invalid_chain_pay_request.json",
      "test/data/invalid_parallel_pay_request.json",
+     "test/data/invalid_preapproval.json",
      "test/data/invalid_simple_pay_request_1.json",
      "test/data/valid_chain_pay_request.json",
      "test/data/valid_parallel_pay_request.json",
+     "test/data/valid_preapproval.json",
      "test/data/valid_simple_pay_request_1.json",
      "test/helper.rb",
      "test/pay_request_schema_test.rb",
      "test/pay_request_test.rb",
-     "test/payment_details_test.rb"
+     "test/payment_details_test.rb",
+     "test/preapproval_test.rb"
   ]
   s.homepage = %q{http://github.com/tc/paypal_adaptive}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -51,7 +54,8 @@ Gem::Specification.new do |s|
     "test/helper.rb",
      "test/pay_request_schema_test.rb",
      "test/pay_request_test.rb",
-     "test/payment_details_test.rb"
+     "test/payment_details_test.rb",
+     "test/preapproval_test.rb"
   ]
 
   if s.respond_to? :specification_version then

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/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":"2010-07-13T07:00:00.000Z",
+ "endingDate":"2010-12-13T07:00:00.000Z" 
+}
+

data/test/preapproval_test.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require '../lib/request'
+
+class PreapprovalTest < Test::Unit::TestCase
+  def setup
+    @preapproval_request = PaypalAdaptive::Request.new("test")
+  end
+
+  def test_preapproval
+    puts "-------"
+    puts "valid test"
+    data_filepath =  "../test/data/valid_preapproval.json"
+
+    data = read_json_file(data_filepath)
+    pp_response = @preapproval_request.preapproval(data)
+    puts "preapproval code is #{pp_response['preapprovalKey']}"
+
+    assert_not_nil pp_response['preapprovalKey']
+  end
+
+
+  def test_invalid_preapproval
+    puts "-------"
+    puts "invalid"
+    data_filepath =  "../test/data/invalid_preapproval.json"
+
+    data = read_json_file(data_filepath)
+    pp_response = @preapproval_request.preapproval(data)
+    puts "error message is #{pp_response.error_message}"
+
+    assert_nil pp_response['preapprovalKey']
+  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.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Tommy Chheng
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-28 00:00:00 -08:00
+date: 2009-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,14 +58,17 @@ files:
 - templates/paypal_ipn.rb
 - test/data/invalid_chain_pay_request.json
 - test/data/invalid_parallel_pay_request.json
+- test/data/invalid_preapproval.json
 - test/data/invalid_simple_pay_request_1.json
 - test/data/valid_chain_pay_request.json
 - test/data/valid_parallel_pay_request.json
+- test/data/valid_preapproval.json
 - test/data/valid_simple_pay_request_1.json
 - test/helper.rb
 - test/pay_request_schema_test.rb
 - test/pay_request_test.rb
 - test/payment_details_test.rb
+- test/preapproval_test.rb
 has_rdoc: true
 homepage: http://github.com/tc/paypal_adaptive
 licenses: []
@@ -99,3 +102,4 @@ test_files:
 - test/pay_request_schema_test.rb
 - test/pay_request_test.rb
 - test/payment_details_test.rb
+- test/preapproval_test.rb