paypal-recurring 0.1.0

data/lib/paypal/recurring/request.rb

@@ -0,0 +1,143 @@
+module PayPal
+  module Recurring
+    class Request
+      METHODS = {
+        :checkout       => "SetExpressCheckout",
+        :payment        => "DoExpressCheckoutPayment",
+        :details        => "GetExpressCheckoutDetails",
+        :create_profile => "CreateRecurringPaymentsProfile",
+        :profile        => "GetRecurringPaymentsProfileDetails",
+        :manage_profile => "ManageRecurringPaymentsProfileStatus"
+      }
+
+      ACTIONS = {
+        :cancel     => "Cancel",
+        :suspend    => "Suspend",
+        :reactivate => "Reactivate"
+      }
+
+      PERIOD = {
+        :daily   => "Day",
+        :monthly => "Month",
+        :yearly  => "Year"
+      }
+
+      OUTSTANDING = {
+        :next_billing => "AddToNextBilling",
+        :no_auto      => "NoAutoBill"
+      }
+
+      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"],
+        :email          => "EMAIL",
+        :failed         => "MAXFAILEDPAYMENTS",
+        :frequency      => "BILLINGFREQUENCY",
+        :ipn_url        => ["PAYMENTREQUEST_0_NOTIFYURL", "NOTIFYURL"],
+        :method         => "METHOD",
+        :no_shipping    => "NOSHIPPING",
+        :outstanding    => "AUTOBILLOUTAMT",
+        :password       => "PWD",
+        :payer_id       => "PAYERID",
+        :payment_action => "PAYMENTREQUEST_0_PAYMENTACTION",
+        :period         => "BILLINGPERIOD",
+        :profile_id     => "PROFILEID",
+        :reference      => "PROFILEREFERENCE",
+        :return_url     => "RETURNURL",
+        :signature      => "SIGNATURE",
+        :start_at       => "PROFILESTARTDATE",
+        :token          => "TOKEN",
+        :username       => "USER",
+        :version        => "VERSION",
+      }
+
+      CA_FILE = File.dirname(__FILE__) + "/cacert.pem"
+
+      # 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.post(: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 post(method, params = {})
+        params = prepare_params(params.merge(:method => METHODS.fetch(method, method.to_s)))
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request["User-Agent"] = "PayPal::Recurring/#{PayPal::Recurring::Version::STRING}"
+        request.form_data = params
+        response = client.request(request)
+        Response.process(method, response)
+      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_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_action(value) # :nodoc:
+        ACTIONS.fetch(value.to_sym, value) if value
+      end
+    end
+  end
+end

data/lib/paypal/recurring/response.rb

@@ -0,0 +1,26 @@
+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"
+
+      RESPONDERS = {
+        :checkout       => "Checkout",
+        :details        => "Details",
+        :payment        => "Payment",
+        :profile        => "Profile",
+        :create_profile => "ManageProfile",
+        :manage_profile => "ManageProfile"
+      }
+
+      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,74 @@
+module PayPal
+  module Recurring
+    module Response
+      class Base
+        attr_accessor :response
+
+        def self.mapping(options = {})
+          options.each do |to, from|
+            class_eval <<-RUBY
+              def #{to}
+                @#{to} ||= begin
+                  value = params[:#{from}]
+                  value = send("build_#{to}", params[:#{from}]) if respond_to?("build_#{to}", true)
+                  value
+                end
+              end
+            RUBY
+          end
+        end
+
+        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}"
+        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,22 @@
+module PayPal
+  module Recurring
+    module Response
+      class Payment < Base
+        mapping(
+          :status    => :PAYMENTINFO_0_PAYMENTSTATUS,
+          :amount    => :PAYMENTINFO_0_AMT,
+          :fees      => :PAYMENTINFO_0_FEEAMT,
+          :seller_id => :PAYMENTINFO_0_SECUREMERCHANTACCOUNTID
+        )
+
+        def completed?
+          params[:PAYMENTINFO_0_PAYMENTSTATUS] == "Completed"
+        end
+
+        def approved?
+          params[:PAYMENTINFO_0_ACK] == "Success"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module PayPal
+  module Recurring
+    module Response
+      class Profile < Base
+        mapping(
+          :profile_id          => :PROFILEID,
+          :status              => :STATUS,
+          :description         => :DESC,
+          :outstanding         => :AUTOBILLOUTAMT,
+          :failed              => :MAXFAILEDPAYMENTS,
+          :payer_name          => :SUBSCRIBERNAME,
+          :start_at            => :PROFILESTARTDATE,
+          :reference           => :PROFILEREFERENCE,
+          :completed           => :NUMCYCLESCOMPLETED,
+          :remaining           => :NUMCYCLESREMAINING,
+          :outstanding_balance => :OUTSTANDINGBALANCE,
+          :failed_count        => :FAILEDPAYMENTCOUNT,
+          :last_payment_date   => :LASTPAYMENTDATE,
+          :last_payment_amount => :LASTPAYMENTAMT,
+          :period              => :BILLINGPERIOD,
+          :frequency           => :BILLINGFREQUENCY,
+          :currency            => :CURRENCYCODE,
+          :amount              => :AMT
+        )
+
+        OUTSTANDING = {
+          "AddToNextBilling" => :next_billing,
+          "NoAutoBill" => :no_auto
+        }
+
+        STATUS = {
+          "Cancelled" => :canceled,
+          "Active"    => :active,
+          "Suspended" => :suspended
+        }
+
+        PERIOD = {
+          "Month" => :monthly,
+          "Year"  => :yearly,
+          "Day"   => :daily
+        }
+
+        def active?
+          status == :active
+        end
+
+        private
+        def build_outstanding(value)
+          OUTSTANDING.fetch(value, value)
+        end
+
+        def build_status(value)
+          STATUS.fetch(value, value)
+        end
+
+        def build_date(string)
+          Time.parse(string)
+        end
+
+        def build_period(value)
+          PERIOD.fetch(value, value)
+        end
+
+        alias_method :build_start_at, :build_date
+        alias_method :build_last_payment_date, :build_date
+      end
+    end
+  end
+end

data/lib/paypal/recurring/version.rb

@@ -0,0 +1,10 @@
+module PayPal
+  module Recurring
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/paypal-recurring.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "paypal-recurring"
+
+Gem::Specification.new do |s|
+  s.name        = "paypal-recurring"
+  s.version     = PayPal::Recurring::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/paypal-recurring"
+  s.summary     = "PayPal Express Checkout API Client for recurring billing."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "rake", "~> 0.8.7"
+  s.add_development_dependency "vcr", "~> 1.10"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "ruby-debug19"
+end

data/spec/fixtures/checkout/failure.yml

@@ -0,0 +1,26 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://api-3t.sandbox.paypal.com:443/nvp
+    body: USER=seller_1308793919_biz_api1.simplesideias.com.br&PWD=1308793931&SIGNATURE=AFcWxV21C7fd0v3bYYYRCpSSRl31AzaB6TzXx5amObyEghjU13.0av2Y&VERSION=72.0&PAYMENTREQUEST_0_PAYMENTACTION=Authorization&NOSHIPPING=1&L_BILLINGTYPE0=RecurringPayments&METHOD=SetExpressCheckout
+    headers: 
+      user-agent: 
+      - PayPal::Recurring/0.1.0
+      content-type: 
+      - application/x-www-form-urlencoded
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      date: 
+      - Sun, 26 Jun 2011 23:40:00 GMT
+      server: 
+      - Apache
+      content-length: 
+      - "779"
+      content-type: 
+      - text/plain; charset=utf-8
+    body: TIMESTAMP=2011%2d06%2d26T23%3a40%3a02Z&CORRELATIONID=4cd5b6afca9b2&ACK=Failure&VERSION=72%2e0&BUILD=1936884&L_ERRORCODE0=10478&L_ERRORCODE1=10404&L_ERRORCODE2=10405&L_SHORTMESSAGE0=Invalid%20Data&L_SHORTMESSAGE1=Transaction%20refused%20because%20of%20an%20invalid%20argument%2e%20See%20additional%20error%20messages%20for%20details%2e&L_SHORTMESSAGE2=Transaction%20refused%20because%20of%20an%20invalid%20argument%2e%20See%20additional%20error%20messages%20for%20details%2e&L_LONGMESSAGE0=Recurring%20payments%20profile%20description%20must%20be%20provided%20if%20the%20billing%20agreement%20type%20is%20recurring%20payments%2e&L_LONGMESSAGE1=ReturnURL%20is%20missing%2e&L_LONGMESSAGE2=CancelURL%20is%20missing%2e&L_SEVERITYCODE0=Error&L_SEVERITYCODE1=Error&L_SEVERITYCODE2=Error
+    http_version: "1.1"