paypal_adaptive 0.0.2 → 0.0.3

data/README.markdown

@@ -3,7 +3,7 @@ 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 and IPNGuide.pdf from the Paypal's dev site http://x.com
+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.  
 
 ## HOWTO
@@ -31,7 +31,7 @@ Create paypal_adaptive.yml to your config folder:
 
 Make the payment request:
 
-    pay_request = PaypalAdaptive::PayRequest.new
+    pay_request = PaypalAdaptive::Request.new
 
     data = {
     "returnUrl" => "http://testserver.com/payments/completed_payment_request", 
@@ -62,8 +62,15 @@ They can also click cancel to go to http://testserver.com/payments/canceled_paym
 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.
 
+Additionally, you can make calls to Paypal Adaptive's other APIs:
+    payment_details, preapproval, preapproval_details, cancel_preapproval, convert_currency, refund
+
+Input is just a Hash just like the pay method. Refer to the Paypal manual for more details.
 
 ## Changelog
+0.0.3
+Renamed PayRequest, PayResponse into Request, Response since other api calls use the class as well.
+
 0.0.2
 Fixed initialized constant warning.   
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/paypal_adaptive.rb

@@ -1,4 +1,4 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "config"))
-require File.expand_path(File.join(File.dirname(__FILE__), "pay_request"))
-require File.expand_path(File.join(File.dirname(__FILE__), "pay_response"))
+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/{pay_request.rb → request.rb}

@@ -1,85 +1,84 @@
-require 'net/http'
-require 'net/https'
 require 'json'
 require 'config'
-require 'pay_response'
+require 'net/http'
+require 'net/https'
+require 'response'
 
 module PaypalAdaptive
   class NoDataError < Exception
   end
-  
-  class PayRequest
-    attr_accessor :pay_key
-    attr_accessor :errors
-    attr_accessor :env
-    
+
+  class Request
     def initialize(env = nil)
       @env = env
       @@config ||= PaypalAdaptive::Config.new(@env)
-      @@api_base_url ||= @@config.api_base_url 
+      @@api_base_url ||= @@config.api_base_url
       @@headers ||= @@config.headers
     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
-      
-      call_api(data, "/AdaptivePayments/Pay")
+
+      response_data = call_api(data, "/AdaptivePayments/Pay")
+      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
-      
+
       call_api(data, "/AdaptivePayments/Preapproval")
     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 = (url.scheme == 'https')
-      
+
       resp, response_data = http.post(path, api_request_data, @@headers)
-      pp_response = PaypalAdaptive::PayResponse.new(response_data, @env)
+
+      JSON.parse(response_data)
     end
   end
+
 end

data/lib/{pay_response.rb → response.rb}

@@ -1,32 +1,27 @@
-require 'json'
-
 module PaypalAdaptive
-  class PayResponse
+  class Response < Hash    
     def initialize(response, env=nil)
       @@config ||= PaypalAdaptive::Config.new(env)
       @@paypal_base_url ||= @@config.paypal_base_url
       
-      @json_response = JSON.parse(response)
+      self.merge!(response)
     end
     
     def success?
-      @json_response['responseEnvelope']['ack'] == 'Success'
-    end
-    
-    def pay_key
-      @json_response['payKey']
+      self['responseEnvelope']['ack'] == 'Success'
     end
     
     def errors
       if success?
         return []
       else
-        @json_response['error']
+        self['error']
       end
     end
     
     def approve_paypal_payment_url
-      "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{pay_key}"
+      "#{@@paypal_base_url}/webscr?cmd=_ap-payment&paykey=#{self['payKey']}"
     end
+
   end
 end

data/paypal_adaptive.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paypal_adaptive}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tommy Chheng"]
@@ -25,10 +25,10 @@ Gem::Specification.new do |s|
      "config/paypal_adaptive.yml",
      "lib/config.rb",
      "lib/ipn_notification.rb",
-     "lib/pay_request.rb",
      "lib/pay_request_schema.json",
-     "lib/pay_response.rb",
      "lib/paypal_adaptive.rb",
+     "lib/request.rb",
+     "lib/response.rb",
      "paypal_adaptive.gemspec",
      "templates/paypal_ipn.rb",
      "test/data/invalid_chain_pay_request.json",
@@ -39,7 +39,8 @@ Gem::Specification.new do |s|
      "test/data/valid_simple_pay_request_1.json",
      "test/helper.rb",
      "test/pay_request_schema_test.rb",
-     "test/pay_request_test.rb"
+     "test/pay_request_test.rb",
+     "test/payment_details_test.rb"
   ]
   s.homepage = %q{http://github.com/tc/paypal_adaptive}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -49,7 +50,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/pay_request_schema_test.rb",
-     "test/pay_request_test.rb"
+     "test/pay_request_test.rb",
+     "test/payment_details_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/data/valid_chain_pay_request.json

@@ -4,8 +4,7 @@
 "currencyCode":"USD",  
 "receiverList":{"receiver":[
             {"email":"testpp_1261697850_per@nextsprocket.com", "amount":"100.00", "primary": "true"},
-            {"email":"sender_1261713739_per@nextsprocket.com", "amount":"50.00", "primary": "false"},
-            {"email":"ppsell_1261697921_biz@nextsprocket.com", "amount":"50.00", "primary": "false"}
+            {"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/helper.rb

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

data/test/pay_request_test.rb

@@ -1,9 +1,9 @@
 require 'helper'
-require '../lib/pay_request'
+require '../lib/request'
 
 class PayRequestTest < Test::Unit::TestCase
   def setup
-    @pay_request = PaypalAdaptive::PayRequest.new("test")
+    @pay_request = PaypalAdaptive::Request.new("test")
   end
   
   def test_valid_simple_pay
@@ -36,6 +36,11 @@ 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}"
+
+    unless pp_response.success?
+      puts pp_response.errors
+    end
+    
     assert pp_response.success?
   end
 
@@ -69,9 +74,6 @@ class PayRequestTest < Test::Unit::TestCase
     assert pp_response.success? == false
   end
   
-  def test_payment_details
-    #TODO
-  end
   
   def test_preapproval
     #TODO

data/test/payment_details_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+require '../lib/request'
+
+class PaymentDetailsTest < Test::Unit::TestCase
+  def setup
+    @pay_request = PaypalAdaptive::Request.new("test")
+    @payment_details_request = PaypalAdaptive::Request.new("test")
+  end
+  
+  def test_payment_details
+    puts "-------"
+    puts "payment details"
+    data_filepath =  "../test/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?
+
+    data = {"requestEnvelope"=>{"errorLanguage"=>"en_US"}, "payKey" => pp_response['payKey']}
+     
+   response =  @payment_details_request.payment_details(data)
+   assert_equal 'CREATED', response['status']
+  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.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tommy Chheng
@@ -50,10 +50,10 @@ files:
 - config/paypal_adaptive.yml
 - lib/config.rb
 - lib/ipn_notification.rb
-- lib/pay_request.rb
 - lib/pay_request_schema.json
-- lib/pay_response.rb
 - lib/paypal_adaptive.rb
+- lib/request.rb
+- lib/response.rb
 - paypal_adaptive.gemspec
 - templates/paypal_ipn.rb
 - test/data/invalid_chain_pay_request.json
@@ -65,6 +65,7 @@ files:
 - test/helper.rb
 - test/pay_request_schema_test.rb
 - test/pay_request_test.rb
+- test/payment_details_test.rb
 has_rdoc: true
 homepage: http://github.com/tc/paypal_adaptive
 licenses: []
@@ -97,3 +98,4 @@ test_files:
 - test/helper.rb
 - test/pay_request_schema_test.rb
 - test/pay_request_test.rb
+- test/payment_details_test.rb