paypal-recurring 0.1.4 → 0.1.5

data/Gemfile.lock

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

data/lib/paypal/recurring.rb

@@ -11,6 +11,7 @@ module PayPal
     autoload :Request, "paypal/recurring/request"
     autoload :Response, "paypal/recurring/response"
     autoload :Version, "paypal/recurring/version"
+    autoload :Utils, "paypal/recurring/utils"
 
     ENDPOINTS = {
        :sandbox => {

data/lib/paypal/recurring/notification.rb

@@ -1,8 +1,26 @@
 module PayPal
   module Recurring
     class Notification
+      extend PayPal::Recurring::Utils
+
       attr_reader :params
 
+      mapping({
+        :type           => :txn_type,
+        :transaction_id => :txn_id,
+        :fee            => [:mc_fee, :payment_fee],
+        :reference      => [:rp_invoice_id, :custom, :invoice],
+        :payment_id     => :recurring_payment_id,
+        :amount         => [:amount, :mc_gross, :payment_gross],
+        :currency       => :mc_currency,
+        :status         => :payment_status,
+        :payment_date   => [:time_created, :payment_date],
+        :seller_id      => :receiver_id,
+        :email          => :receiver_email,
+        :initial_amount => :initial_payment_amount,
+        :payer_email    => :payer_email
+      })
+
       def initialize(params = {})
         self.params = params
       end
@@ -13,10 +31,6 @@ module PayPal
         end
       end
 
-      def type
-        params[:txn_type]
-      end
-
       def express_checkout?
         type == "express_checkout"
       end
@@ -25,6 +39,10 @@ module PayPal
         type == "recurring_payment"
       end
 
+      def recurring_payment_profile?
+        type == "recurring_payment_profile_created"
+      end
+
       def request
         @request ||= PayPal::Recurring::Request.new.tap do |request|
           request.uri = URI.parse("#{PayPal::Recurring.site_endpoint}?cmd=_notify-validate")
@@ -36,47 +54,19 @@ module PayPal
       end
 
       def valid?
-        completed? && verified? && params[:receiver_email] == PayPal::Recurring.email && params[:receiver_id] == PayPal::Recurring.seller_id
+        completed? && verified? && email == PayPal::Recurring.email && seller_id == PayPal::Recurring.seller_id
       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]
+        self.class.convert_to_time(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]
+        self.class.convert_to_time(payment_date) if payment_date
       end
 
       def verified?

data/lib/paypal/recurring/response/base.rb

@@ -2,24 +2,9 @@ module PayPal
   module Recurring
     module Response
       class Base
-        attr_accessor :response
+        extend PayPal::Recurring::Utils
 
-        def self.mapping(options = {})
-          options.each do |to, from|
-            class_eval <<-RUBY
-              def #{to}
-                @#{to} ||= begin
-                  from = [#{from.inspect}].flatten
-                  name = from.find {|name| params[name]}
-                  value = nil
-                  value = params[name] if name
-                  value = send("build_#{to}", value) if respond_to?("build_#{to}", true)
-                  value
-                end
-              end
-            RUBY
-          end
-        end
+        attr_accessor :response
 
         mapping(
           :token           => :TOKEN,

data/lib/paypal/recurring/utils.rb

@@ -0,0 +1,26 @@
+module PayPal
+  module Recurring
+    module Utils
+      def convert_to_time(string)
+        DateTime.strptime(string, "%H:%M:%S %b %e, %Y %Z").new_offset(0)
+      end
+
+      def mapping(options = {})
+        options.each do |to, from|
+          class_eval <<-RUBY
+            def #{to}
+              @#{to} ||= begin
+                from = [#{from.inspect}].flatten
+                name = from.find {|name| params[name]}
+                value = nil
+                value = params[name] if name
+                value = send("build_#{to}", value) if respond_to?("build_#{to}", true)
+                value
+              end
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/paypal/recurring/version.rb

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

data/spec/fixtures/ipn/express_checkout.json

@@ -0,0 +1,35 @@
+{
+  "mc_gross":"9.00",
+  "invoice":"1234",
+  "protection_eligibility":"Ineligible",
+  "payer_id":"6KAQNBYBZ6KAC",
+  "tax":"0.00",
+  "payment_date":"20:37:01 Jul 04, 2011 PDT",
+  "payment_status":"Completed",
+  "charset":"windows-1252",
+  "first_name":"Test",
+  "mc_fee":"0.56",
+  "notify_version":"3.1",
+  "custom":"1234",
+  "payer_status":"verified",
+  "quantity":"1",
+  "verify_sign":"AZP9aUnslyCXgo2.9xWwtk8th8HXAnLqF6TgvmD3ME7fM.iCQhnQ0iRS",
+  "payer_email":"buyer_1309779460_per@simplesideias.com.br",
+  "txn_id":"8JD75017U43409907",
+  "payment_type":"instant",
+  "last_name":"User",
+  "receiver_email":"seller_1308793919_biz_api1.simplesideias.com.br",
+  "payment_fee":"0.56",
+  "receiver_id":"GSZCRUB62BL5L",
+  "txn_type":"express_checkout",
+  "item_name":"Awesome - Monthly Subscription",
+  "mc_currency":"USD",
+  "item_number":"",
+  "residence_country":"US",
+  "test_ipn":"1",
+  "handling_amount":"0.00",
+  "transaction_subject":"",
+  "payment_gross":"9.00",
+  "shipping":"0.00",
+  "ipn_track_id":"sAEWZiSm95ZxQfYHq-RE8w"
+}

data/spec/fixtures/ipn/recurring_payment.json

@@ -0,0 +1,44 @@
+{
+  "mc_gross":"9.00",
+  "period_type":" Regular",
+  "outstanding_balance":"0.00",
+  "next_payment_date":"03:00:00 Jul 06, 2011 PDT",
+  "protection_eligibility":"Ineligible",
+  "payment_cycle":"Daily",
+  "tax":"0.00",
+  "payer_id":"6KAQNBYBZ6KAC",
+  "payment_date":"03:06:59 Jul 05, 2011 PDT",
+  "payment_status":"Completed",
+  "product_name":"Awesome - Monthly Subscription",
+  "charset":"windows-1252",
+  "rp_invoice_id":"1234",
+  "recurring_payment_id":"I-E9EJKE50EPPY",
+  "first_name":"Test",
+  "mc_fee":"0.56",
+  "notify_version":"3.1",
+  "amount_per_cycle":"9.00",
+  "payer_status":"verified",
+  "currency_code":"USD",
+  "business":"seller_1308793919_biz_api1.simplesideias.com.br",
+  "verify_sign":"A31F-vcNTWfrBDr18m0ZsQO28jDTAvPYHS7RmO4dZDD-ObUm6mgY-vS1",
+  "payer_email":"buyer_1309779460_per@simplesideias.com.br",
+  "initial_payment_amount":"0.00",
+  "profile_status":"Active",
+  "amount":"9.00",
+  "txn_id":"8UT11014H0627171P",
+  "payment_type":"instant",
+  "last_name":"User",
+  "receiver_email":"seller_1308793919_biz_api1.simplesideias.com.br",
+  "payment_fee":"0.56",
+  "receiver_id":"GSZCRUB62BL5L",
+  "txn_type":"recurring_payment",
+  "mc_currency":"USD",
+  "residence_country":"US",
+  "test_ipn":"1",
+  "transaction_subject":"",
+  "payment_gross":"9.00",
+  "shipping":"0.00",
+  "product_type":"1",
+  "time_created":"20:37:06 Jul 04, 2011 PDT",
+  "ipn_track_id":"ZuDCTZrTVSGEOmiIJmdZ8Q"
+}

data/spec/fixtures/ipn/recurring_payment_profile_created.json

@@ -0,0 +1,31 @@
+{
+  "payment_cycle":"Daily",
+  "txn_type":"recurring_payment_profile_created",
+  "last_name":"User",
+  "next_payment_date":"03:00:00 Jul 05, 2011 PDT",
+  "residence_country":"US",
+  "initial_payment_amount":"0.00",
+  "rp_invoice_id":"1234",
+  "currency_code":"USD",
+  "time_created":"20:37:06 Jul 04, 2011 PDT",
+  "verify_sign":"AKAZgvqH1r0IxFcG2KYlwYC.bd7rAhHiMcfsQu1D8ouxLCbt2THiAy6E",
+  "period_type":" Regular",
+  "payer_status":"verified",
+  "test_ipn":"1",
+  "tax":"0.00",
+  "payer_email":"buyer_1309779460_per@simplesideias.com.br",
+  "first_name":"Test",
+  "receiver_email":"seller_1308793919_biz_api1.simplesideias.com.br",
+  "payer_id":"6KAQNBYBZ6KAC",
+  "product_type":"1",
+  "shipping":"0.00",
+  "amount_per_cycle":"9.00",
+  "profile_status":"Active",
+  "charset":"windows-1252",
+  "notify_version":"3.1",
+  "amount":"9.00",
+  "outstanding_balance":"0.00",
+  "recurring_payment_id":"I-E9EJKE50EPPY",
+  "product_name":"Awesome - Monthly Subscription",
+  "ipn_track_id":"aWXcwC-7TDo7InmzVuuRrQ"
+}

data/spec/fixtures/ipn/recurring_payment_profile_created_with_initial_amount.json

@@ -0,0 +1,33 @@
+{
+  "payment_cycle":"Daily",
+  "txn_type":"recurring_payment_profile_created",
+  "last_name":"User",
+  "initial_payment_status":"Completed",
+  "next_payment_date":"03:00:00 Jul 05, 2011 PDT",
+  "residence_country":"US",
+  "initial_payment_amount":"9.00",
+  "rp_invoice_id":"1234",
+  "currency_code":"USD",
+  "time_created":"05:40:02 Jul 05, 2011 PDT",
+  "verify_sign":"AhkQm37iumIaDqpU.GmMvkOH76DtA5R4Y1kgjo4B5u43tAt9yNOaY9H5",
+  "period_type":" Regular",
+  "payer_status":"verified",
+  "test_ipn":"1",
+  "tax":"0.00",
+  "payer_email":"buyer_1309779460_per@simplesideias.com.br",
+  "first_name":"Test",
+  "receiver_email":"seller_1309778833_biz@simplesideias.com.br",
+  "payer_id":"6KAQNBYBZ6KAC",
+  "product_type":"1",
+  "initial_payment_txn_id":"13V89154YA849712L",
+  "shipping":"0.00",
+  "amount_per_cycle":"9.00",
+  "profile_status":"Active",
+  "charset":"windows-1252",
+  "notify_version":"3.1",
+  "amount":"9.00",
+  "outstanding_balance":"0.00",
+  "recurring_payment_id":"I-NYWX42K14ES6",
+  "product_name":"Awesome - Monthly Subscription",
+  "ipn_track_id":"mLafq7gjIItS.n58DnlbIg"
+}

data/spec/fixtures/ipn/recurring_payment_with_initial_amount.json

@@ -0,0 +1,44 @@
+{
+  "mc_gross":"9.00",
+  "period_type":" Regular",
+  "outstanding_balance":"0.00",
+  "next_payment_date":"03:00:00 Jul 06, 2011 PDT",
+  "protection_eligibility":"Ineligible",
+  "payment_cycle":"Daily",
+  "tax":"0.00",
+  "payer_id":"6KAQNBYBZ6KAC",
+  "payment_date":"05:40:47 Jul 05, 2011 PDT",
+  "payment_status":"Completed",
+  "product_name":"Awesome - Monthly Subscription",
+  "charset":"windows-1252",
+  "rp_invoice_id":"1234",
+  "recurring_payment_id":"I-NYWX42K14ES6",
+  "first_name":"Test",
+  "mc_fee":"0.56",
+  "notify_version":"3.1",
+  "amount_per_cycle":"9.00",
+  "payer_status":"verified",
+  "currency_code":"USD",
+  "business":"seller_1309778833_biz@simplesideias.com.br",
+  "verify_sign":"AY-Nybk0IAfkhZd8.NnjoCJhyPXTAMk10-hj23D6C6FuZpclLam-uxRI",
+  "payer_email":"buyer_1309779460_per@simplesideias.com.br",
+  "initial_payment_amount":"9.00",
+  "profile_status":"Active",
+  "amount":"9.00",
+  "txn_id":"8C0558302N704203M",
+  "payment_type":"instant",
+  "last_name":"User",
+  "receiver_email":"seller_1309778833_biz@simplesideias.com.br",
+  "payment_fee":"0.56",
+  "receiver_id":"GSZCRUB62BL5L",
+  "txn_type":"recurring_payment",
+  "mc_currency":"USD",
+  "residence_country":"US",
+  "test_ipn":"1",
+  "transaction_subject":"",
+  "payment_gross":"9.00",
+  "shipping":"0.00",
+  "product_type":"1",
+  "time_created":"05:40:02 Jul 05, 2011 PDT",
+  "ipn_track_id":"kmiVwXjypSUWUOeF0F1URA"
+}

data/spec/paypal/notification_spec.rb

@@ -11,6 +11,79 @@ describe PayPal::Recurring::Notification do
     subject.should be_recurring_payment
   end
 
+  it "detects recurring payment profile" do
+    subject.params[:txn_type] = "recurring_payment_profile_created"
+    subject.should be_recurring_payment_profile
+  end
+
+  it "normalizes payment date" do
+    subject.params[:payment_date] = "20:37:06 Jul 04, 2011 PDT" # PDT = -0700
+    subject.paid_at.strftime("%Y-%m-%d %H:%M:%S").should == "2011-07-05 03:37:06"
+  end
+
+  it "returns currency" do
+    subject.params[:mc_currency] = "BRL"
+    subject.currency.should == "BRL"
+  end
+
+  describe "#payment_date" do
+    it "returns date from time_created field" do
+      subject.params[:time_created] = "2011-07-05"
+      subject.payment_date.should == "2011-07-05"
+    end
+
+    it "returns date from payment_date field" do
+      subject.params[:payment_date] = "2011-07-05"
+      subject.payment_date.should == "2011-07-05"
+    end
+  end
+
+  describe "#fee" do
+    it "returns fee from mc_fee field" do
+      subject.params[:mc_fee] = "0.56"
+      subject.fee.should == "0.56"
+    end
+
+    it "returns fee from payment_fee field" do
+      subject.params[:payment_fee] = "0.56"
+      subject.fee.should == "0.56"
+    end
+  end
+
+  describe "#amount" do
+    it "returns amount from amount field" do
+      subject.params[:amount] = "9.00"
+      subject.amount.should == "9.00"
+    end
+
+    it "returns amount from mc_gross field" do
+      subject.params[:mc_gross] = "9.00"
+      subject.amount.should == "9.00"
+    end
+
+    it "returns amount from payment_gross field" do
+      subject.params[:payment_gross] = "9.00"
+      subject.amount.should == "9.00"
+    end
+  end
+
+  describe "#reference" do
+    it "returns from recurring IPN" do
+      subject.params[:rp_invoice_id] = "abc"
+      subject.reference.should == "abc"
+    end
+
+    it "returns from custom field" do
+      subject.params[:custom] = "abc"
+      subject.reference.should == "abc"
+    end
+
+    it "returns from invoice field" do
+      subject.params[:invoice] = "abc"
+      subject.reference.should == "abc"
+    end
+  end
+
   context "when successful" do
     use_vcr_cassette "notification/success"
 

data/spec/spec_helper.rb

@@ -19,6 +19,8 @@ RSpec.configure do |config|
       config.username = "seller_1308793919_biz_api1.simplesideias.com.br"
       config.password = "1308793931"
       config.signature = "AFcWxV21C7fd0v3bYYYRCpSSRl31AzaB6TzXx5amObyEghjU13.0av2Y"
+      config.seller_id = "GSZCRUB62BL5L"
+      config.email = "seller_1308793919_biz_api1.simplesideias.com.br"
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: paypal-recurring
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Nando Vieira
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 Z
+date: 2011-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -98,6 +98,7 @@ files:
 - lib/paypal/recurring/response/manage_profile.rb
 - lib/paypal/recurring/response/payment.rb
 - lib/paypal/recurring/response/profile.rb
+- lib/paypal/recurring/utils.rb
 - lib/paypal/recurring/version.rb
 - paypal-recurring.gemspec
 - spec/fixtures/checkout/failure.yml
@@ -107,6 +108,11 @@ files:
 - spec/fixtures/details/cancelled.yml
 - spec/fixtures/details/failure.yml
 - spec/fixtures/details/success.yml
+- spec/fixtures/ipn/express_checkout.json
+- spec/fixtures/ipn/recurring_payment.json
+- spec/fixtures/ipn/recurring_payment_profile_created.json
+- spec/fixtures/ipn/recurring_payment_profile_created_with_initial_amount.json
+- spec/fixtures/ipn/recurring_payment_with_initial_amount.json
 - spec/fixtures/notification/failure.yml
 - spec/fixtures/notification/success.yml
 - spec/fixtures/payment/failure.yml
@@ -143,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4517482826422449883
+      hash: -54874171068176103
       segments: 
       - 0
       version: "0"
@@ -152,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4517482826422449883
+      hash: -54874171068176103
       segments: 
       - 0
       version: "0"
@@ -171,6 +177,11 @@ test_files:
 - spec/fixtures/details/cancelled.yml
 - spec/fixtures/details/failure.yml
 - spec/fixtures/details/success.yml
+- spec/fixtures/ipn/express_checkout.json
+- spec/fixtures/ipn/recurring_payment.json
+- spec/fixtures/ipn/recurring_payment_profile_created.json
+- spec/fixtures/ipn/recurring_payment_profile_created_with_initial_amount.json
+- spec/fixtures/ipn/recurring_payment_with_initial_amount.json
 - spec/fixtures/notification/failure.yml
 - spec/fixtures/notification/success.yml
 - spec/fixtures/payment/failure.yml