paypal-payment 0.1.2

data/lib/paypal/express_checkout/payment.rb

@@ -0,0 +1,76 @@
+module PayPal
+  module ExpressCheckout
+    class Payment < PayPal::ExpressCheckout::Base
+      has_fields :payment, :ship_to, :amount, :payment_items, :credit_card, :payer, :address, :search, :refund, :seller
+
+      has_many :payment_items
+
+      def search
+        params = collect(
+          :start_date,
+          :end_date,
+          :amount,
+          :currency,
+          :email,
+          :receiver,
+          :receipt_id,
+          :account,
+          :invoice_num,
+          :transaction_id,
+          :transaction_class,
+          :auction_item_num,
+          :status,
+          :profile_id,
+          :salutation,
+          :first_name,
+          :middle_name,
+          :last_name,
+          :suffix
+        )
+
+        run(:search, params)
+      end
+
+      def update_status
+        params = collect(
+          :transaction_id,
+          :action
+        )
+
+        run(:update_status, params)
+      end
+
+      def refund
+        params = group_collect(
+          :transaction_id,
+          :amount,
+          :refund,
+          :msg_sub_id,
+          :store_id,
+          :terminal_id
+        )
+
+        run(:refund, params)
+      end
+
+      def reference
+        params = group_collect(
+          :payment,
+          :ship_to,
+          :amount,
+          :payment_items,
+          :credit_card,
+          :payer,
+          :address
+        )
+
+        run(:reference, params)
+      end
+
+      def details
+        params = collect(:transaction_id)
+        run(:transaction_details, params)
+      end
+    end
+  end
+end

data/lib/paypal/express_checkout/payment_item.rb

@@ -0,0 +1,7 @@
+module PayPal
+  module ExpressCheckout
+    class PaymentItem < PayPal::ExpressCheckout::Base
+      has_fields :payment_item, :amount
+    end
+  end
+end

data/lib/paypal/express_checkout/recurring.rb

@@ -0,0 +1,131 @@
+module PayPal
+  module ExpressCheckout
+    class Recurring < PayPal::ExpressCheckout::Base
+      has_fields :recurring, :ship_to, :credit_card, :payer, :address, :refund
+
+      has_many   :payment_items
+
+      # Suspend a recurring profile.
+      # Suspended profiles can be reactivated.
+      #
+      #   ppr = PayPal::Recurring.new(:profile_id => "I-HYRKXBMNLFSK")
+      #   response = ppr.suspend
+      #
+      def suspend
+        run(:manage_profile, :action => :suspend, :profile_id => profile_id)
+      end
+
+      # Reactivate a suspended recurring profile.
+      #
+      #   ppr = PayPal::Recurring.new(:profile_id => "I-HYRKXBMNLFSK")
+      #   response = ppr.reactivate
+      #
+      def reactivate
+        run(:manage_profile, :action => :reactivate, :profile_id => profile_id)
+      end
+
+      # Cancel a recurring profile.
+      # Cancelled profiles cannot be reactivated.
+      #
+      #   ppr = PayPal::Recurring.new(:profile_id => "I-HYRKXBMNLFSK")
+      #   response = ppr.cancel
+      #
+      def cancel
+        run(:manage_profile, :action => :cancel, :profile_id => profile_id)
+      end
+
+      # Create a recurring billing profile.
+      #
+      #   ppr = PayPal::ExpressCheckout::Recurring.new({
+      #     :amount                => "9.00",
+      #     :initial_amount        => "9.00",
+      #     :initial_amount_action => :cancel,
+      #     :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_period          => :monthly,
+      #     :trial_length          => 1,
+      #     :trial_frequency       => 1,
+      #     :trial_amount          => 0.00
+      #   })
+      #
+      #   response = ppr.create_recurring_profile
+      #
+      def create_profile
+        params = group_collect(
+          :payment_items,
+          :recurring,
+          :payer
+        )
+
+        run(:create_profile, params)
+      end
+
+      # Update a recurring billing profile.
+      #
+      #   ppr = PayPal::ExpressCheckout::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_profile
+        params = group_collect(
+          :recurring,
+          :credit_card,
+          :payer,
+          :address
+        )
+
+        run(:update_profile, params)
+      end
+
+      # Retrieve information about existing recurring profile.
+      #
+      #   ppr = PayPal::ExpressCheckout::Recurring.new(:profile_id => "I-VCEL6TRG35CU")
+      #   response = ppr.profile
+      #
+      def profile
+        run(:profile, :profile_id => profile_id)
+      end
+
+      def bill_outstanding
+        params = collect(
+          :profile_id,
+          :amount,
+          :note
+        )
+
+        run(:bill_outstanding, params)
+      end
+
+      # Retrive fixed options specific request action
+
+      # def fixed_options(request_action)
+      #   {
+      #     :checkout => {
+      #       :payment_action => "Authorization",
+      #       :no_shipping => 1,
+      #       :L_BILLINGTYPE0 => "RecurringPayments"
+      #     }
+      #   }.fetch(request_action, {})
+      # end
+    end
+  end
+end

data/lib/paypal/express_checkout/request.rb

@@ -0,0 +1,212 @@
+module PayPal
+  module ExpressCheckout
+    class Request < PayPal::Request
+      METHODS = {
+        :address_verify       => "AddressVerify",
+        :authorize            => "DoAuthorization",
+        :balance              => "GetBalance",
+        :pal_details          => "GetPalDetails",
+        :bill_outstanding     => "BillOutstandingAmount",
+        :capture              => "DoCapture",
+        :reauthorize          => "DoReauthorization",
+        :checkout             => "SetExpressCheckout",
+        :pay                  => "DoExpressCheckoutPayment",
+        :details              => "GetExpressCheckoutDetails",
+        :create_profile       => "CreateRecurringPaymentsProfile",
+        :profile              => "GetRecurringPaymentsProfileDetails",
+        :manage_profile       => "ManageRecurringPaymentsProfileStatus",
+        :update_profile       => "UpdateRecurringPaymentsProfile",
+        :refund               => "RefundTransaction",
+        :search               => "TransactionSearch",
+        :update_status        => "ManagePendingTransactionStatus",
+        :transaction_details  => "GetTransactionDetails",
+        :reference            => "DoReferenceTransaction",
+        :callback_response    => "CallbackResponse"
+      }
+
+      INITIAL_AMOUNT_ACTIONS = {
+        :cancel   => "CancelOnFailure",
+        :continue => "ContinueOnFailure"
+      }
+
+      ACTIONS = {
+        :accept     => "Accept",
+        :deny       => "Deny",
+        :cancel     => "Cancel",
+        :suspend    => "Suspend",
+        :reactivate => "Reactivate"
+      }
+
+      PERIOD = {
+        :daily        => "Day",
+        :weekly       => "Week",
+        :semi_monthly => "SemiMonth",
+        :monthly      => "Month",
+        :yearly       => "Year"
+      }
+
+      TRIAL_PERIOD = {
+        :daily        => "Day",
+        :weekly       => "Week",
+        :semi_monthly => "SemiMonth",
+        :monthly      => "Month",
+        :yearly       => "Year"
+      }
+
+      OUTSTANDING = {
+        :next_billing => "AddToNextBilling",
+        :no_auto      => "NoAutoBill"
+      }
+
+      REFUND_TYPE  = {
+        :full     => "Full",
+        :partial  => "Partial",
+        :external => "ExternalDispute",
+        :other    => "Other"
+      }
+
+      def default_params
+        {
+          :USER         => PayPal::ExpressCheckout::Api.username,
+          :PWD          => PayPal::ExpressCheckout::Api.password,
+          :SIGNATURE    => PayPal::ExpressCheckout::Api.signature,
+          :VERSION      => PayPal::ExpressCheckout::Api.api_version
+        }
+      end
+
+      def field_map(object)
+        object.class.field_map
+      end
+
+      def normalize_params(object, params)
+        attributes = field_map(object)
+        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|
+            if (attr_name =~ /n/ or attr_name.is_a?(Hash)) and respond_to?("build_#{name}")
+              send("build_#{name}", attr_name, value, buffer)
+            else
+              buffer[attr_name.to_sym] = respond_to?("build_#{name}") ? send("build_#{name}", value) : value
+            end
+          end
+
+          buffer
+        end
+      end
+
+      # Parse current API url.
+      #
+      def uri # :nodoc:
+        @uri ||= PayPal::ExpressCheckout::Api.api_endpoint
+      end
+
+      def api_methods
+        METHODS
+      end
+
+      def run(object, method, params = {}, headers = {})
+        params = prepare_params(object, params.merge(:method => api_methods.fetch(method, method.to_s)))
+        headers = prepare_headers(headers)
+        response = post(params, headers)
+        PayPal::ExpressCheckout::Response.process(method, response)
+      end
+
+      def prepare_params(object, params) # :nodoc:
+        normalize_params(object, default_params.merge(params))
+      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:
+        build_time(value)
+      end
+
+      def build_start_date(value) # :nodoc:
+        build_time(value)
+      end
+
+      def build_end_date(value) # :nodoc:
+        build_time(value)
+      end
+
+      def build_auto_bill_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_failed_initial_action(value) # :nodoc:
+        INITIAL_AMOUNT_ACTIONS.fetch(value.to_sym, value) if value
+      end
+
+      def build_locale(value) # :nodoc:
+        value.to_s.upcase
+      end
+
+      def build_survey_choices(attr_name, values, buffer)
+        Array(values).each_with_index do |value, idx|
+          buffer[attr_name.gsub(/n/, idx.to_s).to_sym] = value
+        end
+      end
+
+      def build_time(value)
+        if value.respond_to?(:strftime)
+          value = value.utc if value.respond_to?(:utc)
+          value.strftime("%Y-%m-%dT%H:%M:%SZ")
+        else
+          value
+        end
+      end
+
+      def build_shipping_options(attr_name, values, buffer)
+        build_object_array(attr_name, values, buffer, "L_", "n")
+      end
+
+      def build_billings(attr_name, values, buffer)
+        build_object_array(attr_name, values, buffer, "L_", "n")
+      end
+
+      def build_payments(attr_name, values, buffer)
+        build_object_array(attr_name, values, buffer, "PAYMENTREQUEST_n_")
+        Array(values).each_with_index do |payment, idx|
+          build_object_array(
+            PayPal::ExpressCheckout::Fields::ASSOCIATIONS[:payment_items],
+            payment.payment_items,
+            buffer,
+            "L_PAYMENTREQUEST_#{idx}_",
+            "n"
+          )
+        end
+      end
+
+      def build_payment_items(attr_name, values, buffer)
+        build_object_array(attr_name, values, buffer, "L_", "n")
+      end
+
+      def build_object_array(attr_name, values, buffer, prefix = "L_", suffix = nil)
+        Array(values).each_with_index do |value, idx|
+          attr_name.each do |attribute, name|
+            name = "#{prefix}#{name}#{suffix}"
+            unless (v = value.send(attribute)).nil?
+              buffer[name.gsub(/n/, idx.to_s).to_sym] = v
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paypal/express_checkout/response.rb

@@ -0,0 +1,52 @@
+module PayPal
+  module ExpressCheckout
+    module Response
+      autoload :Base,                 "paypal/express_checkout/response/base"
+      autoload :Address,              "paypal/express_checkout/response/address"
+      autoload :Account,              "paypal/express_checkout/response/account"
+      autoload :Authorization,        "paypal/express_checkout/response/authorization"
+      autoload :Capture,              "paypal/express_checkout/response/capture"
+      autoload :Checkout,             "paypal/express_checkout/response/checkout"
+      autoload :Details,              "paypal/express_checkout/response/details"
+      autoload :Payment,              "paypal/express_checkout/response/payment"
+      autoload :TransactionDetails,   "paypal/express_checkout/response/transaction_details"
+      autoload :ManageProfile,        "paypal/express_checkout/response/manage_profile"
+      autoload :Profile,              "paypal/express_checkout/response/profile"
+      autoload :Refund,               "paypal/express_checkout/response/refund"
+      autoload :Reference,            "paypal/express_checkout/response/reference"
+      autoload :Search,               "paypal/express_checkout/response/search"
+      autoload :CallbackRequest,      "paypal/express_checkout/response/callback_request"
+      autoload :CallbackResponse,     "paypal/express_checkout/response/callback_response"
+
+      RESPONDERS = {
+        :address_verify       => "Address",
+        :balance              => "Account",
+        :pal_details          => "Account",
+        :authorize            => "Authorization",
+        :reauthorize          => "Authorization",
+        :void                 => "Authorization",
+        :capture              => "Capture",
+        :checkout             => "Checkout",
+        :pay                  => "Checkout",
+        :details              => "Details",
+        :payment              => "Payment",
+        :transaction_details  => "TransactionDetails",
+        :update_status        => "Payment",
+        :search               => "Search",
+        :profile              => "Profile",
+        :create_profile       => "ManageProfile",
+        :manage_profile       => "ManageProfile",
+        :update_profile       => "ManageProfile",
+        :bill_outstanding     => "ManageProfile",
+        :refund               => "Refund",
+        :reference            => "Reference",
+        :callback_response    => "CallbackResponse"
+      }
+
+      def self.process(method, response)
+        response_class = PayPal::ExpressCheckout::Response.const_get(RESPONDERS[method])
+        response_class.new(response)
+      end
+    end
+  end
+end