didil-paypal-recurring 1.1.1

data/lib/paypal/recurring/notification.rb

@@ -0,0 +1,84 @@
+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,
+        :pending_reason   => :pending_reason,
+        :profile_status   => :profile_status,
+        :payment_date     => :payment_date,
+        :time_created     => :time_created,
+        :seller_id        => :receiver_id,
+        :email            => :receiver_email,
+        :initial_amount   => :initial_payment_amount,
+        :payer_email      => :payer_email
+      })
+
+      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 express_checkout?
+        type == "express_checkout"
+      end
+
+      def recurring_payment?
+        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")
+        end
+      end
+
+      def response
+        @response ||= request.post(params.merge(:cmd => "_notify-validate"))
+      end
+
+      def valid?
+        completed? && verified? && email == PayPal::Recurring.email && seller_id == PayPal::Recurring.seller_id
+      end
+
+      def completed?
+        status == "Completed"
+      end
+
+      def next_payment_date
+        self.class.convert_to_time(params[:next_payment_date]) if params[:next_payment_date]
+      end
+
+      def paid_at
+        self.class.convert_to_time(payment_date) if payment_date
+      end
+
+      def created_at
+        self.class.convert_to_time(time_created) if time_created
+      end
+
+      def verified?
+        response.body == "VERIFIED"
+      end
+    end
+  end
+end

data/lib/paypal/recurring/request.rb

@@ -0,0 +1,211 @@
+module PayPal
+  module Recurring
+    class Request
+      METHODS = {
+        :checkout       => "SetExpressCheckout",
+        :payment        => "DoExpressCheckoutPayment",
+        :details        => "GetExpressCheckoutDetails",
+        :create_profile => "CreateRecurringPaymentsProfile",
+        :profile        => "GetRecurringPaymentsProfileDetails",
+        :manage_profile => "ManageRecurringPaymentsProfileStatus",
+        :update_profile => "UpdateRecurringPaymentsProfile",
+        :refund         => "RefundTransaction"
+      }
+
+      INITIAL_AMOUNT_ACTIONS = {
+        :cancel   => "CancelOnFailure",
+        :continue => "ContinueOnFailure"
+      }
+
+      ACTIONS = {
+        :cancel     => "Cancel",
+        :suspend    => "Suspend",
+        :reactivate => "Reactivate"
+      }
+
+      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"],
+        :billing_type          => "L_BILLINGTYPE0",
+        :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",
+        :initial_amount        => "INITAMT",
+        :initial_amount_action => "FAILEDINITAMTACTION",
+        :ipn_url               => ["PAYMENTREQUEST_0_NOTIFYURL", "NOTIFYURL"],
+        :locale                => "LOCALECODE",
+        :method                => "METHOD",
+        :no_shipping           => "NOSHIPPING",
+        :outstanding           => "AUTOBILLOUTAMT",
+        :password              => "PWD",
+        :payer_id              => "PAYERID",
+        :payment_action        => "PAYMENTREQUEST_0_PAYMENTACTION",
+        :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",
+        :brand_name            => "BRANDNAME",
+        :page_style            => "PAGESTYLE",
+      }
+
+      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.run(:express_checkout)
+      #
+      # We normalize the methods name. For a list of what's being covered, refer to
+      # PayPal::Recurring::Request::METHODS constant.
+      #
+      # The params hash can use normalized names. For a list, check the
+      # PayPal::Recurring::Request::ATTRIBUTES constant.
+      #
+      def run(method, params = {})
+        params = prepare_params(params.merge(:method => METHODS.fetch(method, method.to_s)))
+        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:
+        normalize_params default_params.merge(params)
+      end
+
+      # Parse current API url.
+      #
+      def uri # :nodoc:
+        @uri ||= URI.parse(PayPal::Recurring.api_endpoint)
+      end
+
+      def client
+        @client ||= begin
+          Net::HTTP.new(uri.host, uri.port).tap do |http|
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            http.ca_file = CA_FILE
+          end
+        end
+      end
+
+      def default_params
+        {
+          :username    => PayPal::Recurring.username,
+          :password    => PayPal::Recurring.password,
+          :signature   => PayPal::Recurring.signature,
+          :version     => PayPal::Recurring.api_version
+        }
+      end
+
+      def normalize_params(params)
+        params.inject({}) do |buffer, (name, value)|
+          attr_names = [ATTRIBUTES[name.to_sym]].flatten.compact
+          attr_names << name if attr_names.empty?
+
+          attr_names.each do |attr_name|
+            buffer[attr_name.to_sym] = respond_to?("build_#{name}") ? send("build_#{name}", value) : value
+          end
+
+          buffer
+        end
+      end
+
+      def build_period(value) # :nodoc:
+        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
+
+      def build_outstanding(value) # :nodoc:
+        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
+
+      def build_initial_amount_action(value) # :nodoc:
+        INITIAL_AMOUNT_ACTIONS.fetch(value.to_sym, value) if value
+      end
+
+      def build_locale(value) # :nodoc:
+        value.to_s.upcase
+      end
+    end
+  end
+end

data/lib/paypal/recurring/response.rb

@@ -0,0 +1,29 @@
+module PayPal
+  module Recurring
+    module Response
+      autoload :Base, "paypal/recurring/response/base"
+      autoload :Checkout, "paypal/recurring/response/checkout"
+      autoload :Details, "paypal/recurring/response/details"
+      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",
+        :details        => "Details",
+        :payment        => "Payment",
+        :profile        => "Profile",
+        :create_profile => "ManageProfile",
+        :manage_profile => "ManageProfile",
+        :update_profile => "ManageProfile",
+        :refund         => "Refund"
+      }
+
+      def self.process(method, response)
+        response_class = PayPal::Recurring::Response.const_get(RESPONDERS[method])
+        response_class.new(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module PayPal
+  module Recurring
+    module Response
+      class Base
+        extend PayPal::Recurring::Utils
+
+        attr_accessor :response
+
+        mapping(
+          :token           => :TOKEN,
+          :ack             => :ACK,
+          :version         => :VERSION,
+          :build           => :BUILD,
+          :correlaction_id => :CORRELATIONID,
+          :requested_at    => :TIMESTAMP
+        )
+
+        def initialize(response = nil)
+          @response = response
+        end
+
+        def params
+          @params ||= CGI.parse(response.body).inject({}) do |buffer, (name, value)|
+            buffer.merge(name.to_sym => value.first)
+          end
+        end
+
+        def errors
+          @errors ||= begin
+            index = 0
+            [].tap do |errors|
+              while params[:"L_ERRORCODE#{index}"]
+                errors << {
+                  :code => params[:"L_ERRORCODE#{index}"],
+                  :messages => [
+                    params[:"L_SHORTMESSAGE#{index}"],
+                    params[:"L_LONGMESSAGE#{index}"]
+                  ]
+                }
+
+                index += 1
+              end
+            end
+          end
+        end
+
+        def success?
+          ack == "Success"
+        end
+
+        def valid?
+          errors.empty? && success?
+        end
+
+        private
+        def build_requested_at(stamp) # :nodoc:
+          Time.parse(stamp)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PayPal
+  module Recurring
+    module Response
+      class Checkout < Base
+        def checkout_url
+          "#{PayPal::Recurring.site_endpoint}?cmd=_express-checkout&token=#{token}&useraction=commit"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module PayPal
+  module Recurring
+    module Response
+      class Details < Base
+        mapping(
+          :status       => :CHECKOUTSTATUS,
+          :email        => :EMAIL,
+          :email        => :EMAIL,
+          :payer_id     => :PAYERID,
+          :payer_status => :PAYERSTATUS,
+          :first_name   => :FIRSTNAME,
+          :last_name    => :LASTNAME,
+          :country      => :COUNTRYCODE,
+          :currency     => :CURRENCYCODE,
+          :amount       => :AMT,
+          :description  => :DESC,
+          :ipn_url      => :NOTIFYURL
+        )
+
+        def agreed?
+          params[:BILLINGAGREEMENTACCEPTEDSTATUS] == "1"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module PayPal
+  module Recurring
+    module Response
+      class ManageProfile < Base
+        mapping(
+          :profile_id => :PROFILEID,
+          :status     => :PROFILESTATUS
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module PayPal
+  module Recurring
+    module Response
+      class Payment < Base
+        mapping(
+          :status         => :PAYMENTINFO_0_PAYMENTSTATUS,
+          :amount         => :PAYMENTINFO_0_AMT,
+          :fees           => :PAYMENTINFO_0_FEEAMT,
+          :transaction_id => :PAYMENTINFO_0_TRANSACTIONID,
+          :seller_id      => :PAYMENTINFO_0_SECUREMERCHANTACCOUNTID,
+          :reference      => [:PROFILEREFERENCE, :PAYMENTREQUEST_0_CUSTOM, :PAYMENTREQUEST_0_INVNUM]
+        )
+
+        def completed?
+          params[:PAYMENTINFO_0_PAYMENTSTATUS] == "Completed"
+        end
+
+        def approved?
+          params[:PAYMENTINFO_0_ACK] == "Success"
+        end
+      end
+    end
+  end
+end