paypal-recurring 0.1.6 → 1.0.0

data/.gitignore

@@ -2,3 +2,15 @@
 pkg
 tmp
 examples
+.bundle
+db/*.sqlite3*
+log/*.log
+*.log
+tmp/**/*
+tmp/*
+doc/api
+doc/app
+*.swp
+*~
+.DS_Store
+.rvmrc

data/Gemfile.lock

@@ -1,45 +1,46 @@
 PATH
   remote: .
   specs:
-    paypal-recurring (0.1.6)
+    paypal-recurring (1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    archive-tar-minitar (0.5.2)
-    columnize (0.3.3)
-    diff-lcs (1.1.2)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.0.2)
+    coderay (1.0.6)
+    diff-lcs (1.1.3)
     fakeweb (1.3.0)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
-    rake (0.8.7)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
-    vcr (1.10.0)
+    i18n (0.6.0)
+    method_source (0.7.1)
+    multi_json (1.3.2)
+    pry (0.9.9.3)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    slop (2.4.4)
+    vcr (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakeweb (~> 1.3.0)
+  activesupport
+  awesome_print
+  fakeweb
   paypal-recurring!
-  rake (~> 0.8.7)
-  rspec (~> 2.6)
-  ruby-debug19
-  vcr (~> 1.10)
+  pry
+  rake
+  rspec
+  vcr

data/README.rdoc

@@ -77,6 +77,26 @@ Finally, you need to create a new recurring profile.
   response = ppr.create_recurring_profile
   puts response.profile_id
 
+(Optionally) You can specify a trial period, frequency, and length.
+
+  ppr = PayPal::Recurring.new({
+    :amount          => "9.00",
+    :currency        => "USD",
+    :description     => "Awesome - Monthly Subscription",
+    :ipn_url         => "http://example.com/paypal/ipn",
+    :frequency       => 1,
+    :token           => "EC-05C46042TU8306821",
+    :period          => :monthly,
+    :reference       => "1234",
+    :payer_id        => "WTTS5KC2T46YU",
+    :start_at        => Time.now,
+    :failed          => 1,
+    :outstanding     => :next_billing,
+    :trial_length    => 1,
+    :trial_period    => :monthly,
+    :trial_frequency => 1
+  })
+
 You can manage your recurring profile.
 
   ppr = PayPal::Recurring.new(:profile_id => "I-VCEL6TRG35CU")
@@ -91,15 +111,11 @@ You should save two paramaters to your database: <tt>TOKEN</tt> and <tt>PROFILEI
 <tt>TOKEN</tt> is required when user returns to your website after he authorizes (or not) the billing process. You
 need to save it so you can find him later. You can remove this info after payment and recurring profile are set.
 
-The <tt>PROFILEID</tt> allows you to manage the recurring profile, like canceling billing when an user don't
+The <tt>PROFILEID</tt> allows you to manage the recurring profile, like cancelling billing when an user don't
 want to use your service anymore.
 
 <b>NOTE:</b> TOKEN will expire after approximately 3 hours.
 
-== TO-DO
-
-* handle Instant Payment Notifications (IPN)
-
 == Maintainer
 
 * Nando Vieira (http://nandovieira.com.br)

data/lib/paypal/recurring/base.rb

@@ -5,6 +5,7 @@ module PayPal
       attr_accessor :cancel_url
       attr_accessor :currency
       attr_accessor :description
+      attr_accessor :note
       attr_accessor :email
       attr_accessor :failed
       attr_accessor :frequency
@@ -17,9 +18,19 @@ module PayPal
       attr_accessor :period
       attr_accessor :profile_id
       attr_accessor :reference
+      attr_accessor :refund_type
       attr_accessor :return_url
       attr_accessor :start_at
       attr_accessor :token
+      attr_accessor :transaction_id
+      attr_accessor :item_category
+      attr_accessor :item_name
+      attr_accessor :item_amount
+      attr_accessor :item_quantity
+      attr_accessor :trial_frequency
+      attr_accessor :trial_length
+      attr_accessor :trial_period
+      attr_accessor :trial_amount
 
       def initialize(options = {})
         options.each {|name, value| send("#{name}=", value)}
@@ -53,7 +64,11 @@ module PayPal
           :cancel_url,
           :currency,
           :description,
-          :ipn_url
+          :ipn_url,
+          :item_category,
+          :item_name,
+          :item_amount,
+          :item_quantity
         ).merge(
           :payment_action => "Authorization",
           :no_shipping => 1,
@@ -113,7 +128,22 @@ module PayPal
       #   response.completed? && response.approved?
       #
       def request_payment
-        params = collect(:amount, :return_url, :cancel_url, :ipn_url, :currency, :description, :payer_id, :token, :reference).merge(:payment_action => "Sale")
+        params = collect(
+          :amount,
+          :return_url,
+          :cancel_url,
+          :ipn_url,
+          :currency,
+          :description,
+          :payer_id,
+          :token,
+          :reference,
+          :item_category,
+          :item_name,
+          :item_amount,
+          :item_quantity
+        ).merge(:payment_action => "Sale")
+
         request.run(:payment, params)
       end
 
@@ -133,16 +163,77 @@ module PayPal
       #     :payer_id              => "WTTS5KC2T46YU",
       #     :start_at              => Time.now,
       #     :failed                => 1,
-      #     :outstanding           => :next_billing
+      #     :outstanding           => :next_billing,
+      #     :trial_period          => :monthly,
+      #     :trial_length          => 1,
+      #     :trial_frequency       => 1,
+      #     :trial_amount          => 0.00
       #   })
       #
       #   response = ppr.create_recurring_profile
       #
       def create_recurring_profile
-        params = collect(:amount, :initial_amount, :initial_amount_action, :currency, :description, :payer_id, :token, :reference, :start_at, :failed, :outstanding, :ipn_url, :frequency, :period, :email)
+        params = collect(
+          :amount,
+          :initial_amount,
+          :initial_amount_action,
+          :currency,
+          :description,
+          :payer_id,
+          :token,
+          :reference,
+          :start_at,
+          :failed,
+          :outstanding,
+          :ipn_url,
+          :frequency,
+          :period,
+          :email,
+          :trial_length,
+          :trial_period,
+          :trial_frequency,
+          :trial_amount,
+          :item_category,
+          :item_name,
+          :item_amount,
+          :item_quantity
+        )
         request.run(:create_profile, params)
       end
 
+      # Update a recurring billing profile.
+      #
+      #   ppr = PayPal::Recurring.new({
+      #     :amount                => "99.00",
+      #     :currency              => "USD",
+      #     :description           => "Awesome - Monthly Subscription",
+      #     :note                  => "Changed plan to Gold",
+      #     :ipn_url               => "http://example.com/paypal/ipn",
+      #     :reference             => "1234",
+      #     :profile_id            => "I-VCEL6TRG35CU",
+      #     :start_at              => Time.now,
+      #     :outstanding           => :next_billing
+      #   })
+      #
+      #   response = ppr.update_recurring_profile
+      #
+      def update_recurring_profile
+        params = collect(
+          :amount,
+          :currency,
+          :description,
+          :note,
+          :profile_id,
+          :reference,
+          :start_at,
+          :outstanding,
+          :ipn_url,
+          :email
+        )
+
+        request.run(:update_profile, params)
+      end
+
       # Retrieve information about existing recurring profile.
       #
       #   ppr = PayPal::Recurring.new(:profile_id => "I-VCEL6TRG35CU")
@@ -152,6 +243,30 @@ module PayPal
         request.run(:profile, :profile_id => profile_id)
       end
 
+      # Request a refund.
+      #   ppr = PayPal::Recurring.new({
+      #     :profile_id => "I-VCEL6TRG35CU",
+      #     :transaction_id => "ABCEDFGH",
+      #     :reference      => "1234",
+      #     :refund_type    => :partial,
+      #     :amount         => "9.00",
+      #     :currency       => "USD"
+      #   })
+      #   response = ppr.refund
+      #
+      def refund
+        params = collect(
+          :transaction_id,
+          :reference,
+          :refund_type,
+          :amount,
+          :currency,
+          :note
+        )
+
+        request.run(:refund, params)
+      end
+
       private
       # Collect specified attributes and build a hash out of it.
       #

data/lib/paypal/recurring/notification.rb

@@ -6,19 +6,21 @@ module PayPal
       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
+        :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,
+        :pending_reason   => :pending_reason,
+        :profile_status   => :profile_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 = {})

data/lib/paypal/recurring/request.rb

@@ -7,7 +7,9 @@ module PayPal
         :details        => "GetExpressCheckoutDetails",
         :create_profile => "CreateRecurringPaymentsProfile",
         :profile        => "GetRecurringPaymentsProfileDetails",
-        :manage_profile => "ManageRecurringPaymentsProfileStatus"
+        :manage_profile => "ManageRecurringPaymentsProfileStatus",
+        :update_profile => "UpdateRecurringPaymentsProfile",
+        :refund         => "RefundTransaction"
       }
 
       INITIAL_AMOUNT_ACTIONS = {
@@ -23,15 +25,30 @@ module PayPal
 
       PERIOD = {
         :daily   => "Day",
+        :weekly  => "Weekly",
         :monthly => "Month",
         :yearly  => "Year"
       }
 
+      TRIAL_PERIOD = {
+        :daily    => "Day",
+        :weekly   => "Weekly",
+        :monthly  => "Month",
+        :yearly   => "Year"
+      }
+
       OUTSTANDING = {
         :next_billing => "AddToNextBilling",
         :no_auto      => "NoAutoBill"
       }
 
+      REFUND_TYPE  = {
+        :full     => "Full",
+        :partial  => "Partial",
+        :external => "ExternalDispute",
+        :other    => "Other"
+      }
+
       ATTRIBUTES = {
         :action                => "ACTION",
         :amount                => ["PAYMENTREQUEST_0_AMT", "AMT"],
@@ -39,6 +56,11 @@ module PayPal
         :cancel_url            => "CANCELURL",
         :currency              => ["PAYMENTREQUEST_0_CURRENCYCODE", "CURRENCYCODE"],
         :description           => ["DESC", "PAYMENTREQUEST_0_DESC", "L_BILLINGAGREEMENTDESCRIPTION0"],
+        :note                  => "NOTE",
+        :item_category         => "L_PAYMENTREQUEST_0_ITEMCATEGORY0",
+        :item_name             => "L_PAYMENTREQUEST_0_NAME0",
+        :item_amount           => "L_PAYMENTREQUEST_0_AMT0",
+        :item_quantity         => "L_PAYMENTREQUEST_0_QTY0",
         :email                 => "EMAIL",
         :failed                => "MAXFAILEDPAYMENTS",
         :frequency             => "BILLINGFREQUENCY",
@@ -55,12 +77,18 @@ module PayPal
         :period                => "BILLINGPERIOD",
         :profile_id            => "PROFILEID",
         :reference             => ["PROFILEREFERENCE", "PAYMENTREQUEST_0_CUSTOM", "PAYMENTREQUEST_0_INVNUM"],
+        :refund_type           => "REFUNDTYPE",
         :return_url            => "RETURNURL",
         :signature             => "SIGNATURE",
         :start_at              => "PROFILESTARTDATE",
         :token                 => "TOKEN",
+        :transaction_id        => "TRANSACTIONID",
+        :trial_amount          => "TRIALAMT",
+        :trial_frequency       => "TRIALBILLINGFREQUENCY",
+        :trial_length          => "TRIALTOTALBILLINGCYCLES",
+        :trial_period          => "TRIALBILLINGPERIOD",
         :username              => "USER",
-        :version               => "VERSION",
+        :version               => "VERSION"
       }
 
       CA_FILE = File.dirname(__FILE__) + "/cacert.pem"
@@ -149,6 +177,10 @@ module PayPal
         PERIOD.fetch(value.to_sym, value) if value
       end
 
+      def build_trial_period(value)
+        TRIAL_PERIOD.fetch(value.to_sym, value) if value
+      end
+
       def build_start_at(value) # :nodoc:
         value.respond_to?(:strftime) ? value.strftime("%Y-%m-%dT%H:%M:%SZ") : value
       end
@@ -157,6 +189,10 @@ module PayPal
         OUTSTANDING.fetch(value.to_sym, value) if value
       end
 
+      def build_refund_type(value) # :nodoc:
+        REFUND_TYPE.fetch(value.to_sym, value) if value
+      end
+
       def build_action(value) # :nodoc:
         ACTIONS.fetch(value.to_sym, value) if value
       end

data/lib/paypal/recurring/response.rb

@@ -7,6 +7,7 @@ module PayPal
       autoload :Payment, "paypal/recurring/response/payment"
       autoload :ManageProfile, "paypal/recurring/response/manage_profile"
       autoload :Profile, "paypal/recurring/response/profile"
+      autoload :Refund,  "paypal/recurring/response/refund"
 
       RESPONDERS = {
         :checkout       => "Checkout",
@@ -14,7 +15,9 @@ module PayPal
         :payment        => "Payment",
         :profile        => "Profile",
         :create_profile => "ManageProfile",
-        :manage_profile => "ManageProfile"
+        :manage_profile => "ManageProfile",
+        :update_profile => "ManageProfile",
+        :refund         => "Refund"
       }
 
       def self.process(method, response)