paypal-recurring 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paypal-recurring (0.1.0)
+    paypal-recurring (0.1.1)
 
 GEM
   remote: http://rubygems.org/

data/lib/paypal/recurring.rb

@@ -1,13 +1,13 @@
 require "net/https"
 require "cgi"
 require "uri"
-require "logger"
 require "ostruct"
 require "time"
 
 module PayPal
   module Recurring
     autoload :Base, "paypal/recurring/base"
+    autoload :Notification, "paypal/recurring/notification"
     autoload :Request, "paypal/recurring/request"
     autoload :Response, "paypal/recurring/response"
     autoload :Version, "paypal/recurring/version"
@@ -44,12 +44,15 @@ module PayPal
       #
       attr_accessor :signature
 
-      # Set application logger. By default, will send output to +STDOUT+.
+      # Set seller id. Will be used to verify IPN.
       #
-      attr_accessor :logger
-    end
+      #
+      attr_accessor :seller_id
 
-    self.logger = Logger.new(STDOUT)
+      # The seller e-mail. Will be used to verify IPN.
+      #
+      attr_accessor :email
+    end
 
     # Just a shortcut for <tt>PayPal::Recurring::Base.new</tt>.
     #

data/lib/paypal/recurring/base.rb

@@ -44,7 +44,7 @@ module PayPal
       #
       def checkout
         params = collect(:amount, :return_url, :cancel_url, :currency, :description, :ipn_url).merge(:payment_action => "Authorization", :no_shipping => 1, :L_BILLINGTYPE0 => "RecurringPayments")
-        request.post(:checkout, params)
+        request.run(:checkout, params)
       end
 
       # Suspend a recurring profile.
@@ -54,7 +54,7 @@ module PayPal
       #   response = ppr.suspend
       #
       def suspend
-        request.post(:manage_profile, :action => :suspend, :profile_id => profile_id)
+        request.run(:manage_profile, :action => :suspend, :profile_id => profile_id)
       end
 
       # Reactivate a suspended recurring profile.
@@ -63,7 +63,7 @@ module PayPal
       #   response = ppr.reactivate
       #
       def reactivate
-        request.post(:manage_profile, :action => :reactivate, :profile_id => profile_id)
+        request.run(:manage_profile, :action => :reactivate, :profile_id => profile_id)
       end
 
       # Cancel a recurring profile.
@@ -73,7 +73,7 @@ module PayPal
       #   response = ppr.cancel
       #
       def cancel
-        request.post(:manage_profile, :action => :cancel, :profile_id => profile_id)
+        request.run(:manage_profile, :action => :cancel, :profile_id => profile_id)
       end
 
       # Return checkout details.
@@ -82,7 +82,7 @@ module PayPal
       #   response = ppr.checkout_details
       #
       def checkout_details
-        request.post(:details, :token => token)
+        request.run(:details, :token => token)
       end
 
       # Request payment.
@@ -98,7 +98,7 @@ module PayPal
       #
       def request_payment
         params = collect(:amount, :return_url, :cancel_url, :ipn_url, :currency, :description, :payer_id, :token).merge(:payment_action => "Sale")
-        request.post(:payment, params)
+        request.run(:payment, params)
       end
 
       # Create a recurring billing profile.
@@ -122,7 +122,7 @@ module PayPal
       #
       def create_recurring_profile
         params = collect(:amount, :currency, :description, :payer_id, :token, :reference, :start_at, :failed, :outstanding, :ipn_url, :frequency, :period, :email)
-        request.post(:create_profile, params)
+        request.run(:create_profile, params)
       end
 
       # Retrieve information about existing recurring profile.
@@ -131,7 +131,7 @@ module PayPal
       #   response = ppr.profile
       #
       def profile
-        request.post(:profile, :profile_id => profile_id)
+        request.run(:profile, :profile_id => profile_id)
       end
 
       private

data/lib/paypal/recurring/notification.rb

@@ -0,0 +1,75 @@
+module PayPal
+  module Recurring
+    class Notification
+      attr_reader :params
+
+      def initialize(params = {})
+        self.params = params
+      end
+
+      def params=(params)
+        @params = params.inject({}) do |buffer, (name,value)|
+          buffer.merge(name.to_sym => value)
+        end
+      end
+
+      def request
+        @request ||= PayPal::Recurring::Request.new.tap do |request|
+          request.uri = URI.parse("#{PayPal::Recurring.site_endpoint}?cmd=_notify-validate")
+        end
+      end
+
+      def response
+        @response ||= request.post(params.merge(:cmd => "_notify-validate"))
+      end
+
+      def valid?
+        completed? && verified? && params[:receiver_email] == PayPal::Recurring.email && params[:receiver_id] == PayPal::Recurring.seller_id && params[:txn_type] == "recurring_payment"
+      end
+
+      def completed?
+        status == "Completed"
+      end
+
+      def transaction_id
+        params[:txn_id]
+      end
+
+      def fee
+        params[:mc_currency]
+      end
+
+      def reference
+        params[:rp_invoice_id]
+      end
+
+      def payment_id
+        params[:recurring_payment_id]
+      end
+
+      def next_payment_date
+        Time.parse(params[:next_payment_date]) if params[:next_payment_date]
+      end
+
+      def paid_at
+        Time.parse params[:time_created] if params[:time_created]
+      end
+
+      def amount
+        params[:amount]
+      end
+
+      def currency
+        params[:mc_currency]
+      end
+
+      def status
+        params[:payment_status]
+      end
+
+      def verified?
+        response.body == "VERIFIED"
+      end
+    end
+  end
+end

data/lib/paypal/recurring/request.rb

@@ -57,12 +57,14 @@ module PayPal
 
       CA_FILE = File.dirname(__FILE__) + "/cacert.pem"
 
+      attr_accessor :uri
+
       # Do a POST request to PayPal API.
       # The +method+ argument is the name of the API method you want to invoke.
       # For instance, if you want to request a new checkout token, you may want
       # to do something like:
       #
-      #   response = request.post(:express_checkout)
+      #   response = request.run(:express_checkout)
       #
       # We normalize the methods name. For a list of what's being covered, refer to
       # PayPal::Recurring::Request::METHODS constant.
@@ -70,15 +72,27 @@ module PayPal
       # The params hash can use normalized names. For a list, check the
       # PayPal::Recurring::Request::ATTRIBUTES constant.
       #
-      def post(method, params = {})
+      def run(method, params = {})
         params = prepare_params(params.merge(:method => METHODS.fetch(method, method.to_s)))
-        request = Net::HTTP::Post.new(uri.request_uri)
-        request["User-Agent"] = "PayPal::Recurring/#{PayPal::Recurring::Version::STRING}"
-        request.form_data = params
-        response = client.request(request)
+        response = post(params)
         Response.process(method, response)
       end
 
+      #
+      #
+      def request
+        @request ||= Net::HTTP::Post.new(uri.request_uri).tap do |http|
+          http["User-Agent"] = "PayPal::Recurring/#{PayPal::Recurring::Version::STRING}"
+        end
+      end
+
+      #
+      #
+      def post(params = {})
+        request.form_data = params
+        client.request(request)
+      end
+
       # Join params and normalize attribute names.
       #
       def prepare_params(params) # :nodoc:

data/lib/paypal/recurring/version.rb

@@ -3,7 +3,7 @@ module PayPal
     module Version
       MAJOR = 0
       MINOR = 1
-      PATCH = 0
+      PATCH = 1
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
   end

data/spec/fixtures/notification/failure.yml

@@ -0,0 +1,32 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://www.sandbox.paypal.com:443/cgi-bin/webscr?cmd=_notify-validate
+    body: cmd=_notify-validate
+    headers: 
+      user-agent: 
+      - PayPal::Recurring/0.1.0
+      content-type: 
+      - application/x-www-form-urlencoded
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      date: 
+      - Mon, 27 Jun 2011 17:39:42 GMT
+      server: 
+      - Apache
+      set-cookie: 
+      - c9MWDuvPtT9GIMyPc3jwol1VSlO=FYMA2gxaecqXl8Q9SSeevuaQcqfcQcwNGw_shFaqV4wYiWT3ZUcQ4O8NLvXqevPJfliR0yse8Z4bzZ8A37MQKM6Q_ci6wnYOkfGZSxZYa_hNLMvR6QHnGyW6u94YxhYQpgu0VG%7cySXso7WZVjU8pXiTJS488DAO3YqW5S6DsAZMY8TN22H5J8gW1As5DlqX1pm60R5dWee5wm%7cdMLFsFZz_xjN2U4nbQ71pdvMUEch5_rqq4NReBSNMz7j3ry9JJhQ1J0X6pqjinKs-kO5NG%7c1309196387; domain=.paypal.com; path=/; Secure; HttpOnly
+      - cookie_check=yes; expires=Thu, 24-Jun-2021 17:39:47 GMT; domain=.paypal.com; path=/; Secure; HttpOnly
+      - navcmd=_notify-validate; domain=.paypal.com; path=/; Secure; HttpOnly
+      - navlns=0.0; expires=Sun, 22-Jun-2031 17:39:47 GMT; domain=.paypal.com; path=/; Secure; HttpOnly
+      - Apache=10.72.109.11.1309196382543853; path=/; expires=Wed, 19-Jun-41 17:39:42 GMT
+      transfer-encoding: 
+      - chunked
+      content-type: 
+      - text/html; charset=UTF-8
+    body: INVALID
+    http_version: "1.1"

data/spec/fixtures/notification/success.yml

@@ -0,0 +1,32 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://www.sandbox.paypal.com:443/cgi-bin/webscr?cmd=_notify-validate
+    body: test_ipn=1&payment_type=echeck&payment_date=06%3a16%3a11%20Jun%2027%2c%202011%20PDT&payment_status=Completed&pending_reason=echeck&address_status=confirmed&payer_status=verified&first_name=John&last_name=Smith&payer_email=buyer%40paypalsandbox.com&payer_id=TESTBUYERID01&address_name=John%20Smith&address_country=United%20States&address_country_code=US&address_zip=95131&address_state=CA&address_city=San%20Jose&address_street=123%2c%20any%20street&business=seller%40paypalsandbox.com&receiver_email=seller%40paypalsandbox.com&receiver_id=TESTSELLERID1&residence_country=US&item_name=something&item_number=AK-1234&quantity=1&shipping=3.04&tax=2.02&mc_currency=USD&mc_fee=0.44&mc_gross=12.34&txn_type=web_accept&txn_id=116271316&notify_version=2.1&custom=xyz123&invoice=abc1234&charset=windows-1252&verify_sign=AvgHA1TpBJYQMa-x3XsZYuQd7MkKAMUFy7f2a9G4UNFmNHHXGnfAFi3l&cmd=_notify-validate
+    headers:
+      user-agent:
+      - PayPal::Recurring/0.1.0
+      content-type:
+      - application/x-www-form-urlencoded
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 27 Jun 2011 17:37:09 GMT
+      server:
+      - Apache
+      set-cookie:
+      - c9MWDuvPtT9GIMyPc3jwol1VSlO=EShGvdSJTkQTmhIi4jIAvW9REPYfLjRSo3BqPdRvBymVBvHIai4jnMHE9UzQDrz7FgAtLCUw0V0VroudhtcfoaNLca2TZq61mMSzEHPHgwAj5ON8rmHCr_IjY_AkKI885AFFLW%7c-PiLEQg9LK_E6xg7biKrMLHv97B5cP5yT2R1l6g_ZNq-3SDSCAm-9VQdvpJSnrGNtfsrrG%7cvdBU3UXz8sDrfFIOKP_zwmNkSm8nNcKCATxNvMpGb4VOdGI4Sjia0YCorXMBWxpjKuAip0%7c1309196230; domain=.paypal.com; path=/; Secure; HttpOnly
+      - cookie_check=yes; expires=Thu, 24-Jun-2021 17:37:10 GMT; domain=.paypal.com; path=/; Secure; HttpOnly
+      - navcmd=_notify-validate; domain=.paypal.com; path=/; Secure; HttpOnly
+      - navlns=0.0; expires=Sun, 22-Jun-2031 17:37:10 GMT; domain=.paypal.com; path=/; Secure; HttpOnly
+      - Apache=10.72.109.11.1309196229102128; path=/; expires=Wed, 19-Jun-41 17:37:09 GMT
+      transfer-encoding:
+      - chunked
+      content-type:
+      - text/html; charset=UTF-8
+    body: VERIFIED
+    http_version: "1.1"

data/spec/paypal/notification_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe PayPal::Recurring::Notification do
+  context "when successful" do
+    use_vcr_cassette "notification/success"
+
+    it "verifies notification" do
+      subject.params = {"test_ipn"=>"1", "payment_type"=>"echeck", "payment_date"=>"06:16:11 Jun 27, 2011 PDT", "payment_status"=>"Completed", "pending_reason"=>"echeck", "address_status"=>"confirmed", "payer_status"=>"verified", "first_name"=>"John", "last_name"=>"Smith", "payer_email"=>"buyer@paypalsandbox.com", "payer_id"=>"TESTBUYERID01", "address_name"=>"John Smith", "address_country"=>"United States", "address_country_code"=>"US", "address_zip"=>"95131", "address_state"=>"CA", "address_city"=>"San Jose", "address_street"=>"123, any street", "business"=>"seller@paypalsandbox.com", "receiver_email"=>"seller@paypalsandbox.com", "receiver_id"=>"TESTSELLERID1", "residence_country"=>"US", "item_name"=>"something", "item_number"=>"AK-1234", "quantity"=>"1", "shipping"=>"3.04", "tax"=>"2.02", "mc_currency"=>"USD", "mc_fee"=>"0.44", "mc_gross"=>"12.34", "txn_type"=>"web_accept", "txn_id"=>"116271316", "notify_version"=>"2.1", "custom"=>"xyz123", "invoice"=>"abc1234", "charset"=>"windows-1252", "verify_sign"=>"A12AYqq6LElPcpXaQx48GiroLHnMAoQPnK0Z7aRwXUOpg1GfDaE15mFN"}
+      subject.should be_verified
+      subject.should be_completed
+    end
+  end
+
+  context "when failure" do
+    use_vcr_cassette "notification/failure"
+
+    it "verifies notification" do
+      subject.params = {}
+      subject.should_not be_verified
+      subject.should_not be_completed
+    end
+  end
+end

data/spec/paypal/recurring_spec.rb

@@ -1,12 +1,6 @@
 require "spec_helper"
 
 describe PayPal::Recurring do
-  describe ".logger" do
-    it "has a default logging" do
-      PayPal::Recurring.logger.should be_a(Logger)
-    end
-  end
-
   describe ".new" do
     it "instantiates PayPal::Recurring::Base" do
       PayPal::Recurring.new.should be_a(PayPal::Recurring::Base)

data/spec/paypal/request_spec.rb

@@ -19,7 +19,7 @@ describe PayPal::Recurring::Request do
   describe "#post" do
     let(:request) {
       FakeWeb.register_uri :post, "https://api-3t.sandbox.paypal.com/nvp", :status => 200
-      subject.post(:checkout)
+      subject.run(:checkout)
       CGI.parse(FakeWeb.last_request.body)
     }
 

metadata

@@ -2,7 +2,7 @@
 name: paypal-recurring
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 Z
+date: 2011-06-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -89,6 +89,7 @@ files:
 - lib/paypal/recurring.rb
 - lib/paypal/recurring/base.rb
 - lib/paypal/recurring/cacert.pem
+- lib/paypal/recurring/notification.rb
 - lib/paypal/recurring/request.rb
 - lib/paypal/recurring/response.rb
 - lib/paypal/recurring/response/base.rb
@@ -106,6 +107,8 @@ files:
 - spec/fixtures/details/cancelled.yml
 - spec/fixtures/details/failure.yml
 - spec/fixtures/details/success.yml
+- spec/fixtures/notification/failure.yml
+- spec/fixtures/notification/success.yml
 - spec/fixtures/payment/failure.yml
 - spec/fixtures/payment/success.yml
 - spec/fixtures/profile/cancel/failure.yml
@@ -116,6 +119,7 @@ files:
 - spec/fixtures/profile/success.yml
 - spec/fixtures/profile/suspend/failure.yml
 - spec/fixtures/profile/suspend/success.yml
+- spec/paypal/notification_spec.rb
 - spec/paypal/recurring_spec.rb
 - spec/paypal/request_spec.rb
 - spec/paypal/response/checkout_details_spec.rb
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1993102493723648975
+      hash: -1456604981268972750
       segments: 
       - 0
       version: "0"
@@ -147,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1993102493723648975
+      hash: -1456604981268972750
       segments: 
       - 0
       version: "0"
@@ -166,6 +170,8 @@ test_files:
 - spec/fixtures/details/cancelled.yml
 - spec/fixtures/details/failure.yml
 - spec/fixtures/details/success.yml
+- spec/fixtures/notification/failure.yml
+- spec/fixtures/notification/success.yml
 - spec/fixtures/payment/failure.yml
 - spec/fixtures/payment/success.yml
 - spec/fixtures/profile/cancel/failure.yml
@@ -176,6 +182,7 @@ test_files:
 - spec/fixtures/profile/success.yml
 - spec/fixtures/profile/suspend/failure.yml
 - spec/fixtures/profile/suspend/success.yml
+- spec/paypal/notification_spec.rb
 - spec/paypal/recurring_spec.rb
 - spec/paypal/request_spec.rb
 - spec/paypal/response/checkout_details_spec.rb