express-checkout 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e016efaa655a370f36a5480ef0b65c28590c576d
-  data.tar.gz: 6c4e0e630d86d54107877f0c9274068f34108091
+  metadata.gz: c7019fc3b0f27e0ba38c68edff4bc4c07d87f3c1
+  data.tar.gz: 77fc1279c58d5373b98d5c36944f51821899073f
 SHA512:
-  metadata.gz: 69da75217e4720eecc22b99d0f2999f42912f27a332e66233a3f1ad0d07d1070579cad3f9ba3d9b04f8b3c35ed56c466bfe5355bc47af0bfe45e59bb04dfe53e
-  data.tar.gz: 4408c17eac1331e66895b369ac241eaef7b14829fdad914f070cc09dd0f2a1f6ea9be460b1da29a8e6b108a3cd8df3551f399d14ef9e237241b59b07f8666dc8
+  metadata.gz: be6b78d98106f7a75282cc47c4534dd6ec03682b7a267e8dc9ff8b44d10a0201b85089e52cc324410ce061b4ad47269b0f56b37bc09909687334acd1f9c0105c
+  data.tar.gz: 4f799585716cfedf9eb60b7443b820880927896db20579e225cb8d51f8b0e29fc60e47112ab6b64c54e21e7b9c99d042026d029e7811800da3792db4f6ebd0d0

data/express-checkout.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'express/checkout/version'
+require 'express/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "express-checkout"
-  spec.version       = Express::Checkout::VERSION
+  spec.version       = Express::VERSION
   spec.authors       = ["Wei-Yi Chiu"]
   spec.email         = ["bird1204@gmail.com"]
 
@@ -27,6 +27,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 2.3"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "attr_required", ">= 0.0.5"
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 0.8"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rspec", "< 2.99"
+  spec.add_development_dependency "fakeweb", ">= 1.3.0"
 end

data/lib/express.rb

@@ -0,0 +1,85 @@
+require 'express/checkout/version'
+require 'logger'
+require 'active_support'
+require 'active_support/core_ext'
+require 'attr_required'
+require 'attr_optional'
+require 'rest_client'
+
+module Express
+  mattr_accessor :api_version
+  self.api_version = '88.0'
+
+  ENDPOINT = {
+    production: 'https://www.paypal.com/cgi-bin/webscr',
+    sandbox: 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+  }
+  POPUP_ENDPOINT = {
+    production: 'https://www.paypal.com/incontext',
+    sandbox: 'https://www.sandbox.paypal.com/incontext'
+  }
+
+  def self.endpoint
+    if sandbox?
+      Paypal::ENDPOINT[:sandbox]
+    else
+      Paypal::ENDPOINT[:production]
+    end
+  end
+  def self.popup_endpoint
+    if sandbox?
+      Paypal::POPUP_ENDPOINT[:sandbox]
+    else
+      Paypal::POPUP_ENDPOINT[:production]
+    end
+  end
+
+  def self.log(message, mode = :info)
+    logger.send mode, message
+  end
+  def self.logger
+    @@logger
+  end
+  def self.logger=(logger)
+    @@logger = logger
+  end
+
+  @@logger = Logger.new(STDERR)
+  @@logger.progname = 'Express::Checkout'
+
+  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/exception'
+require 'paypal/exception/http_error'
+require 'paypal/exception/api_error'
+require 'paypal/base'
+require 'paypal/ipn'
+require 'paypal/nvp/request'
+require 'paypal/nvp/response'
+require 'paypal/payment/common/amount'
+require 'paypal/express/request'
+require 'paypal/express/response'
+require 'paypal/payment/request'
+require 'paypal/payment/request/item'
+require 'paypal/payment/response'
+require 'paypal/payment/response/info'
+require 'paypal/payment/response/item'
+require 'paypal/payment/response/payer'
+require 'paypal/payment/response/reference'
+require 'paypal/payment/response/refund'
+require 'paypal/payment/response/address'
+require 'paypal/payment/recurring'
+require 'paypal/payment/recurring/activation'
+require 'paypal/payment/recurring/billing'
+require 'paypal/payment/recurring/summary'

data/lib/express/base.rb

@@ -0,0 +1,19 @@
+module Express
+  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
+          send "#{key}=", value
+        end
+      end
+      attr_missing!
+    end
+  end
+end

data/lib/express/checkout.rb

@@ -1,7 +1 @@
-require "express/checkout/version"
-
-module Express
-  module Checkout
-    # Your code goes here...
-  end
-end
+require 'paypal'

data/lib/express/checkout/request.rb

@@ -0,0 +1,194 @@
+module Express
+  module Checkout
+    class Request < NVP::Request
+
+      # Common
+
+      def setup(payment_requests, return_url, cancel_url, options = {})
+        params = {
+          :RETURNURL => return_url,
+          :CANCELURL => cancel_url
+        }
+        if options[:no_shipping]
+          params[:REQCONFIRMSHIPPING] = 0
+          params[:NOSHIPPING] = 1
+        end
+
+        params[:ALLOWNOTE] = 0 if options[:allow_note] == false
+
+        {
+          :solution_type => :SOLUTIONTYPE,
+          :landing_page  => :LANDINGPAGE,
+          :email         => :EMAIL,
+          :brand         => :BRANDNAME,
+          :locale        => :LOCALECODE,
+          :logo          => :LOGOIMG,
+          :cart_border_color => :CARTBORDERCOLOR,
+          :payflow_color => :PAYFLOWCOLOR
+        }.each do |option_key, param_key|
+          params[param_key] = options[option_key] if options[option_key]
+        end
+        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, options
+      end
+
+      def details(token)
+        response = self.request :GetExpressCheckoutDetails, {:TOKEN => token}
+        Response.new response
+      end
+
+      def transaction_details(transaction_id)
+        response = self.request :GetTransactionDetails, {:TRANSACTIONID=> transaction_id}
+        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 capture!(authorization_id, amount, currency_code, complete_type = 'Complete')
+        params = {
+          :AUTHORIZATIONID => authorization_id,
+          :COMPLETETYPE => complete_type,
+          :AMT => amount,
+          :CURRENCYCODE => currency_code
+        }
+
+        response = self.request :DoCapture, params
+        Response.new response
+      end
+
+      def void!(authorization_id, params={})
+        params = {
+          :AUTHORIZATIONID => authorization_id,
+          :NOTE => params[:note]
+        }
+
+        response = self.request :DoVoid, params
+        Response.new response
+      end
+
+      # Recurring Payment Specific
+
+      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, options = {})
+        params = {
+          :PROFILEID => profile_id,
+          :ACTION => action
+        }
+        if options[:note]
+          params[:NOTE] = options[:note]
+        end
+        response = self.request :ManageRecurringPaymentsProfileStatus, params
+        Response.new response
+      end
+
+      def suspend!(profile_id, options = {})
+        renew!(profile_id, :Suspend, options)
+      end
+
+      def cancel!(profile_id, options = {})
+        renew!(profile_id, :Cancel, options)
+      end
+
+      def reactivate!(profile_id, options = {})
+        renew!(profile_id, :Reactivate, options)
+      end
+
+
+      # Reference Transaction Specific
+
+      def agree!(token, options = {})
+        params = {
+          :TOKEN => token
+        }
+        if options[:max_amount]
+          params[:MAXAMT] = Util.formatted_amount options[:max_amount]
+        end
+        response = self.request :CreateBillingAgreement, params
+        Response.new response
+      end
+
+      def agreement(reference_id)
+        params = {
+          :REFERENCEID => reference_id
+        }
+        response = self.request :BillAgreementUpdate, params
+        Response.new response
+      end
+
+      def charge!(reference_id, amount, options = {})
+        params = {
+          :REFERENCEID => reference_id,
+          :AMT => Util.formatted_amount(amount),
+          :PAYMENTACTION => options[:payment_action] || :Sale
+        }
+        if options[:currency_code]
+          params[:CURRENCYCODE] = options[:currency_code]
+        end
+        response = self.request :DoReferenceTransaction, params
+        Response.new response
+      end
+
+      def revoke!(reference_id)
+        params = {
+          :REFERENCEID => reference_id,
+          :BillingAgreementStatus => :Canceled
+        }
+        response = self.request :BillAgreementUpdate, params
+        Response.new response
+      end
+
+
+      # Refund Specific
+
+      def refund!(transaction_id, options = {})
+        params = {
+          :TRANSACTIONID => transaction_id,
+          :REFUNDTYPE => :Full
+        }
+        if options[:invoice_id]
+          params[:INVOICEID] = options[:invoice_id]
+        end
+        if options[:type]
+          params[:REFUNDTYPE] = options[:type]
+          params[:AMT] = options[:amount]
+          params[:CURRENCYCODE] = options[:currency_code]
+        end
+        if options[:note]
+          params[:NOTE] = options[:note]
+        end
+        response = self.request :RefundTransaction, params
+        Response.new response
+      end
+
+    end
+  end
+end

data/lib/express/checkout/response.rb

@@ -0,0 +1,35 @@
+module Express
+  module Check
+    class Response < NVP::Response
+      attr_accessor :pay_on_paypal, :mobile
+
+      def initialize(response, options = {})
+        super response
+        @pay_on_paypal = options[:pay_on_paypal]
+        @mobile        = options[:mobile]
+      end
+
+      def redirect_uri
+        endpoint = URI.parse Paypal.endpoint
+        endpoint.query = query(:with_cmd).to_query
+        endpoint.to_s
+      end
+
+      def popup_uri
+        endpoint = URI.parse Paypal.popup_endpoint
+        endpoint.query = query.to_query
+        endpoint.to_s
+      end
+
+      private
+
+      def query(with_cmd = false)
+        _query_ = {:token => self.token}
+        _query_.merge!(:cmd => '_express-checkout')        if with_cmd
+        _query_.merge!(:cmd => '_express-checkout-mobile') if mobile
+        _query_.merge!(:useraction => 'commit')            if pay_on_paypal
+        _query_
+      end
+    end
+  end
+end

data/lib/express/exception.rb

@@ -0,0 +1,4 @@
+module Express
+  class Exception < StandardError
+  end
+end

data/lib/express/exception/api_error.rb

@@ -0,0 +1,94 @@
+module Express
+  class Exception
+    class APIError < Exception
+      attr_accessor :response
+      def initialize(response = {})
+        @response = if response.is_a?(Hash)
+          Response.new response
+        else
+          response
+        end
+      end
+
+      def message
+        if response.respond_to?(:short_messages) && response.short_messages.any?
+          "PayPal API Error: " <<
+            response.short_messages.map{ |m| "'#{m}'" }.join(", ")
+        else
+          "PayPal API Error"
+        end
+      end
+
+      class Response
+        cattr_reader :attribute_mapping
+        @@attribute_mapping = {
+          :ACK => :ack,
+          :BUILD => :build,
+          :CORRELATIONID => :correlation_id,
+          :TIMESTAMP => :timestamp,
+          :VERSION => :version,
+          :ORDERTIME => :order_time,
+          :PENDINGREASON => :pending_reason,
+          :PAYMENTSTATUS => :payment_status,
+          :PAYMENTTYPE => :payment_type,
+          :REASONCODE => :reason_code,
+          :TRANSACTIONTYPE => :transaction_type
+        }
+        attr_accessor *@@attribute_mapping.values
+        attr_accessor :raw, :details
+        alias_method :colleration_id, :correlation_id # NOTE: I made a typo :p
+
+        class Detail
+          cattr_reader :attribute_mapping
+          @@attribute_mapping = {
+            :ERRORCODE => :error_code,
+            :SEVERITYCODE => :severity_code,
+            :LONGMESSAGE => :long_message,
+            :SHORTMESSAGE => :short_message
+          }
+          attr_accessor *@@attribute_mapping.values
+
+          def initialize(attributes = {})
+            @raw = attributes
+            attrs = attributes.dup
+            @@attribute_mapping.each do |key, value|
+              self.send "#{value}=", attrs.delete(key)
+            end
+
+            # warn ignored params
+            attrs.each do |key, value|
+              Paypal.log "Ignored Parameter (#{self.class}): #{key}=#{value}", :warn
+            end
+          end
+        end
+
+        def initialize(attributes = {})
+          attrs = attributes.dup
+          @raw = attributes
+          @@attribute_mapping.each do |key, value|
+            self.send "#{value}=", attrs.delete(key)
+          end
+          details = []
+          attrs.keys.each do |attribute|
+            key, index = attribute.to_s.scan(/^L_(\S+)(\d+)$/).first
+            next if [key, index].any?(&:blank?)
+            details[index.to_i] ||= {}
+            details[index.to_i][key.to_sym] = attrs.delete(attribute)
+          end
+          @details = details.collect do |_attrs_|
+            Detail.new _attrs_
+          end
+
+          # warn ignored params
+          attrs.each do |key, value|
+            Paypal.log "Ignored Parameter (#{self.class}): #{key}=#{value}", :warn
+          end
+        end
+
+        def short_messages
+          details.map(&:short_message).compact
+        end
+      end
+    end
+  end
+end