paypal-express 0.0.1

data/lib/paypal.rb

@@ -0,0 +1,56 @@
+require 'logger'
+require 'active_support/core_ext'
+require 'attr_required'
+require 'attr_optional'
+require 'restclient_with_ssl_support'
+
+module Paypal
+
+  API_VERSION = '66.0'
+  ENDPOINT = {
+    :production => 'https://www.paypal.com/cgi-bin/webscr',
+    :sandbox => 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+  }
+
+  def self.log(message, mode = :info)
+    self.logger.send mode, message
+  end
+  def self.logger
+    @@logger
+  end
+  def self.logger=(logger)
+    @@logger = logger
+  end
+  @@logger = Logger.new(STDERR)
+  @@logger.progname = 'Paypal::Express'
+
+  def self.sandbox?
+    @@sandbox
+  end
+  def self.sandbox!
+    self.sandbox = true
+  end
+  def self.sandbox=(boolean)
+    @@sandbox = boolean
+  end
+  self.sandbox = false
+
+end
+
+require 'paypal/util'
+require 'paypal/exceptions'
+require 'paypal/base'
+require 'paypal/nvp/request'
+require 'paypal/nvp/response'
+require 'paypal/express/request'
+require 'paypal/express/response'
+require 'paypal/payment/request'
+require 'paypal/payment/response'
+require 'paypal/payment/response/amount'
+require 'paypal/payment/response/info'
+require 'paypal/payment/response/payer'
+require 'paypal/payment/response/ship_to'
+require 'paypal/payment/recurring'
+require 'paypal/payment/recurring/activation'
+require 'paypal/payment/recurring/billing'
+require 'paypal/payment/recurring/summary'

data/lib/paypal/base.rb

@@ -0,0 +1,19 @@
+module Paypal
+  class Base
+    include AttrRequired, AttrOptional, Util
+
+    def initialize(attributes = {})
+      if attributes.is_a?(Hash)
+        (required_attributes + optional_attributes).each do |key|
+          value = if numeric_attribute?(key)
+            Util.to_numeric(attributes[key])
+          else
+            attributes[key]
+          end
+          self.send "#{key}=", value
+        end
+      end
+      attr_missing!
+    end
+  end
+end

data/lib/paypal/exceptions.rb

@@ -0,0 +1,21 @@
+module Paypal
+
+  class Exception < StandardError; end
+
+  class HttpError < Exception
+    attr_accessor :code, :message, :body
+    def initialize(code, message, body = '')
+      @code = code
+      @message = message
+      @body = body
+    end
+  end
+
+  class APIError < Exception
+    attr_accessor :response
+    def initialize(response = {})
+      @response = response
+    end
+  end
+
+end

data/lib/paypal/express.rb

@@ -0,0 +1 @@
+require 'paypal'

data/lib/paypal/express/request.rb

@@ -0,0 +1,64 @@
+module Paypal
+  module Express
+    class Request < NVP::Request
+      attr_required :return_url, :cancel_url
+
+      def setup(payment_requests)
+        params = {
+          :RETURNURL => self.return_url,
+          :CANCELURL => self.cancel_url
+        }
+        Array(payment_requests).each_with_index do |payment_request, index|
+          params.merge! payment_request.to_params(index)
+        end
+        response = self.request :SetExpressCheckout, params
+        Response.new response
+      end
+
+      def details(token)
+        response = self.request :GetExpressCheckoutDetails, {:TOKEN => token}
+        Response.new response
+      end
+
+      def checkout!(token, payer_id, payment_requests)
+        params = {
+          :TOKEN => token,
+          :PAYERID => payer_id
+        }
+        Array(payment_requests).each_with_index do |payment_request, index|
+          params.merge! payment_request.to_params(index)
+        end
+        response = self.request :DoExpressCheckoutPayment, params
+        Response.new response
+      end
+
+      def subscribe!(token, recurring_profile)
+        params = {
+          :TOKEN => token
+        }
+        params.merge! recurring_profile.to_params
+        response = self.request :CreateRecurringPaymentsProfile, params
+        Response.new response
+      end
+
+      def subscription(profile_id)
+        params = {
+          :PROFILEID => profile_id
+        }
+        response = self.request :GetRecurringPaymentsProfileDetails, params
+        Response.new response
+      end
+
+      def renew!(profile_id, action, note = '')
+        params = {
+          :PROFILEID => profile_id,
+          :ACTION => action,
+          :NOTE => note
+        }
+        response = self.request :ManageRecurringPaymentsProfileStatus, params
+        Response.new response
+      end
+
+    end
+  end
+end

data/lib/paypal/express/response.rb

@@ -0,0 +1,19 @@
+module Paypal
+  module Express
+    class Response < NVP::Response
+      def redirect_uri
+        endpoint = if Paypal.sandbox?
+          Paypal::ENDPOINT[:sandbox]
+        else
+          Paypal::ENDPOINT[:production]
+        end
+        endpoint = URI.parse endpoint
+        endpoint.query = {
+          :cmd => '_express-checkout',
+          :token => self.token
+        }.to_query
+        endpoint.to_s
+      end
+    end
+  end
+end

data/lib/paypal/nvp/request.rb

@@ -0,0 +1,59 @@
+module Paypal
+  module NVP
+    class Request < Base
+      attr_required :username, :password, :signature
+      attr_accessor :version, :endpoint
+
+      ENDPOINT = {
+        :production => 'https://api-3t.paypal.com/nvp',
+        :sandbox => 'https://api-3t.sandbox.paypal.com/nvp'
+      }
+
+      def initialize(attributes = {})
+        @version = API_VERSION
+        @endpoint = if Paypal.sandbox?
+          ENDPOINT[:sandbox]
+        else
+          ENDPOINT[:production]
+        end
+        super
+      end
+
+      def common_params
+        {
+          :USER => self.username,
+          :PWD => self.password,
+          :SIGNATURE => self.signature,
+          :VERSION => self.version
+        }
+      end
+
+      def request(method, params = {})
+        handle_response do
+          post(method, params)
+        end
+      end
+
+      private
+
+      def post(method, params)
+        RestClient.post(self.endpoint, common_params.merge(params).merge(:METHOD => method))
+      end
+
+      def handle_response
+        response = yield
+        response = CGI.parse(response).inject({}) do |res, (k, v)|
+          res.merge!(k.to_sym => v.first)
+        end
+        case response[:ACK]
+        when 'Success', 'SuccessWithWarning'
+          response
+        else
+          raise APIError.new(response)
+        end
+      rescue RestClient::Exception => e
+        raise HttpError.new(e.http_code, e.message, e.http_body)
+      end
+    end
+  end
+end

data/lib/paypal/nvp/response.rb

@@ -0,0 +1,145 @@
+module Paypal
+  module NVP
+    class Response < Base
+      cattr_reader :attribute_mapping
+      @@attribute_mapping = {
+        :ACK => :ack,
+        :ADDRESSSTATUS => :address_status,
+        :BILLINGAGREEMENTACCEPTEDSTATUS => :billing_agreement_accepted_status,
+        :BUILD => :build,
+        :CHECKOUTSTATUS => :checkout_status,
+        :CORRELATIONID => :colleration_id,
+        :COUNTRYCODE => :country_code,
+        :CURRENCYCODE => :currency_code,
+        :TIMESTAMP => :timestamp,
+        :TOKEN => :token,
+        :VERSION => :version
+      }
+      attr_accessor *@@attribute_mapping.values
+      attr_accessor :shipping_options_is_default, :success_page_redirect_requested, :insurance_option_selected
+      attr_accessor :amount, :ship_to, :payer, :recurring, :payment_responses, :payment_info
+
+      def initialize(attributes = {})
+        attrs = attributes.dup
+        @@attribute_mapping.each do |key, value|
+          self.send "#{value}=", attrs.delete(key)
+        end
+        @shipping_options_is_default = attrs.delete(:SHIPPINGOPTIONISDEFAULT) == 'true'
+        @success_page_redirect_requested = attrs.delete(:SUCCESSPAGEREDIRECTREQUESTED) == 'true'
+        @insurance_option_selected = attrs.delete(:INSURANCEOPTIONSELECTED) == 'true'
+        @amount = Payment::Response::Amount.new(
+          :total => attrs.delete(:AMT),
+          :handing => attrs.delete(:HANDLINGAMT),
+          :insurance => attrs.delete(:INSURANCEAMT),
+          :ship_disc => attrs.delete(:SHIPDISCAMT),
+          :shipping => attrs.delete(:SHIPPINGAMT),
+          :tax => attrs.delete(:TAXAMT)
+        )
+        @ship_to = Payment::Response::ShipTo.new(
+          :owner => attrs.delete(:SHIPADDRESSOWNER),
+          :status => attrs.delete(:SHIPADDRESSSTATUS),
+          :name => attrs.delete(:SHIPTONAME),
+          :zip => attrs.delete(:SHIPTOZIP),
+          :street => attrs.delete(:SHIPTOSTREET),
+          :city => attrs.delete(:SHIPTOCITY),
+          :state => attrs.delete(:SHIPTOSTATE),
+          :country_code => attrs.delete(:SHIPTOCOUNTRYCODE),
+          :country_name => attrs.delete(:SHIPTOCOUNTRYNAME)
+        )
+        if attrs[:PAYERID]
+          @payer = Payment::Response::Payer.new(
+            :identifier => attrs.delete(:PAYERID),
+            :status => attrs.delete(:PAYERSTATUS),
+            :first_name => attrs.delete(:FIRSTNAME),
+            :last_name => attrs.delete(:LASTNAME),
+            :email => attrs.delete(:EMAIL)
+          )
+        end
+        if attrs[:PROFILEID]
+          @recurring = Payment::Recurring.new(
+            :identifier => attrs.delete(:PROFILEID),
+            # NOTE:
+            #  CreateRecurringPaymentsProfile returns PROFILESTATUS
+            #  GetRecurringPaymentsProfileDetails returns STATUS
+            :description => attrs.delete(:DESC),
+            :status => attrs.delete(:STATUS) || attrs.delete(:PROFILESTATUS),
+            :start_date => attrs.delete(:PROFILESTARTDATE),
+            :name => attrs.delete(:SUBSCRIBERNAME),
+            :reference => attrs.delete(:PROFILEREFERENCE),
+            :auto_bill => attrs.delete(:AUTOBILLOUTAMT),
+            :max_fails => attrs.delete(:MAXFAILEDPAYMENTS),
+            :aggregate_amount => attrs.delete(:AGGREGATEAMT),
+            :aggregate_optional_amount => attrs.delete(:AGGREGATEOPTIONALAMT),
+            :final_payment_date => attrs.delete(:FINALPAYMENTDUEDATE)
+          )
+          if attrs[:BILLINGPERIOD]
+            @recurring.billing = Payment::Recurring::Billing.new(
+              :amount => @amount,
+              :currency_code => @currency_code,
+              :period => attrs.delete(:BILLINGPERIOD),
+              :frequency => attrs.delete(:BILLINGFREQUENCY),
+              :total_cycles => attrs.delete(:TOTALBILLINGCYCLES),
+              :trial_amount_paid => attrs.delete(:TRIALAMTPAID)
+            )
+          end
+          if attrs[:REGULARAMT]
+            @recurring.regular_billing = Payment::Recurring::Billing.new(
+              :amount => attrs.delete(:REGULARAMT),
+              :shipping_amount => attrs.delete(:REGULARSHIPPINGAMT),
+              :tax_amount => attrs.delete(:REGULARTAXAMT),
+              :currency_code => attrs.delete(:REGULARCURRENCYCODE),
+              :period => attrs.delete(:REGULARBILLINGPERIOD),
+              :frequency => attrs.delete(:REGULARBILLINGFREQUENCY),
+              :total_cycles => attrs.delete(:REGULARTOTALBILLINGCYCLES),
+              :paid => attrs.delete(:REGULARAMTPAID)
+            )
+            @recurring.summary = Payment::Recurring::Summary.new(
+              :next_billing_date => attrs.delete(:NEXTBILLINGDATE),
+              :cycles_completed => attrs.delete(:NUMCYCLESCOMPLETED),
+              :cycles_remaining => attrs.delete(:NUMCYCLESREMAINING),
+              :outstanding_balance => attrs.delete(:OUTSTANDINGBALANCE),
+              :failed_count => attrs.delete(:FAILEDPAYMENTCOUNT),
+              :last_payment_date => attrs.delete(:LASTPAYMENTDATE),
+              :last_payment_amount => attrs.delete(:LASTPAYMENTAMT)
+            )
+          end
+        end
+
+        # payment_responses
+        payment_responses = []
+        attrs.keys.each do |attribute|
+          prefix, index, key = attribute.to_s.split('_')
+          case prefix
+          when 'PAYMENTREQUEST', 'PAYMENTREQUESTINFO'
+            payment_responses[index.to_i] ||= {}
+            payment_responses[index.to_i][key.to_sym] = attrs.delete(attribute)
+          end
+        end
+        @payment_responses = payment_responses.collect do |_attrs_|
+          Payment::Response.new _attrs_
+        end
+
+        # payment_info
+        payment_info = []
+        attrs.keys.each do |_attr_|
+          prefix, index, key = _attr_.to_s.split('_')
+          if prefix == 'PAYMENTINFO'
+            payment_info[index.to_i] ||= {}
+            payment_info[index.to_i][key.to_sym] = attrs.delete(_attr_)
+          end
+        end
+        @payment_info = payment_info.collect do |_attrs_|
+          Payment::Response::Info.new _attrs_
+        end
+
+        # remove duplicated parameters
+        attrs.delete(:SHIPTOCOUNTRY) # NOTE: Same with SHIPTOCOUNTRYCODE
+
+        # warn ignored attrs
+        attrs.each do |key, value|
+          Paypal.log "Ignored Parameter (#{self.class}): #{key}=#{value}", :warn
+        end
+      end
+    end
+  end
+end

data/lib/paypal/payment/recurring.rb

@@ -0,0 +1,43 @@
+module Paypal
+  module Payment
+    class Recurring < Base
+      attr_optional :start_date, :description, :identifier, :status, :name, :reference, :max_fails, :auto_bill, :aggregate_amount, :aggregate_optional_amount, :final_payment_date
+      attr_accessor :activation, :billing, :regular_billing, :summary
+
+      def initialize(attributes = {})
+        super
+        @activation = Activation.new attributes[:activation] if attributes[:activation]
+        @billing = Billing.new attributes[:billing] if attributes[:billing]
+        @regular_billing = Billing.new attributes[:regular_billing] if attributes[:regular_billing]
+        @summary = Summary.new attributes[:summary] if attributes[:summary]
+      end
+
+      def to_params
+        params = [
+          self.billing,
+          self.activation
+        ].compact.inject({}) do |params, attribute|
+          params.merge! attribute.to_params
+        end
+        if self.start_date.is_a?(Time)
+          self.start_date = self.start_date.to_s(:db)
+        end
+        params.merge!(
+          :DESC  => self.description,
+          :MAXFAILEDPAYMENTS => self.max_fails,
+          :AUTOBILLAMT => self.auto_bill,
+          :PROFILESTARTDATE => self.start_date,
+          :SUBSCRIBERNAME => self.name,
+          :PROFILEREFERENCE => self.reference
+        )
+        params.delete_if do |k, v|
+          v.blank?
+        end
+      end
+
+      def numeric_attribute?(key)
+        super || [:max_fails, :failed_count].include?(key)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Paypal
+  module Payment
+    class Recurring::Activation < Base
+      attr_optional :initial_amount, :failed_action
+
+      def to_params
+        {
+          :INITAMT => Util.formatted_amount(self.initial_amount),
+          :FAILEDINITAMTACTION => self.failed_action
+        }
+      end
+    end
+  end
+end