ianfleeton-paypal-express 0.8.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b3867967578bb74d22b8fc5d931c62a01fa890c
+  data.tar.gz: 97b4500f7158307eb8fb5183367cd3046bb968cf
+SHA512:
+  metadata.gz: 1959ef947bd20eb3fb27d9a439dc657e51871be138e8f1f293307170fbf63781b11483de776cf4709b7dc39d5ba9adbf13237a3b12d0d801bac6a46ad8e415e1
+  data.tar.gz: 3f8fa18f46458fcb4f1390c3d8a2fbe91cafebdb3c16dce2908e0726f89f9f43ea96721f9924f7b921574e7a5d563529d18db6b14f986a1acc007236bbb90c75

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage*
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install:
+  - gem install bundler
+
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+
+env:
+  - RAILS_VERSION="~> 4.2"
+  - RAILS_VERSION="~> 5.0"

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+platform :jruby do
+  gem 'jruby-openssl', '>= 0.7'
+end
+
+if ENV['RAILS_VERSION']
+  gem 'activesupport', ENV['RAILS_VERSION']
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011 Ian Fleeton, nov matake
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= paypal-express
+
+Handle PayPal Express Checkout.
+Both Instance Payment and Recurring Payment are supported.
+Express Checkout for Digital Goods is also supported.
+
+{<img src="https://travis-ci.org/ianfleeton/paypal-express.svg" />}[https://travis-ci.org/ianfleeton/paypal-express]
+
+
+== Why this fork?
+
+The original gem is not maintained and has broken compatibility with current PayPal APIs.
+You can use this fork which is actively maintained to ensure it is working properly.
+
+== Installation
+
+Add to your Gemfile
+  gem 'paypal-express', github: 'ianfleeton/paypal-express'
+Or
+  gem 'ianfleeton-paypal-express'
+
+== Usage
+
+See Wiki on Github
+https://github.com/nov/paypal-express/wiki
+
+Play with Sample Rails App
+https://github.com/nov/paypal-express-sample
+https://paypal-express-sample.heroku.com
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright © 2011 Ian Fleeton, nov matake. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :coverage do
+  desc "Open coverage report"
+  task :report do
+    require 'simplecov'
+    `open "#{File.join SimpleCov.coverage_path, 'index.html'}"`
+  end
+end
+
+task :spec do
+  Rake::Task[:'coverage:report'].invoke unless ENV['TRAVIS_RUBY_VERSION']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.8.2

data/ianfleeton-paypal-express.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = "ianfleeton-paypal-express"
+  s.version = File.read(File.join(File.dirname(__FILE__), "VERSION"))
+  s.licenses = ['MIT']
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ian Fleeton", "nov matake"]
+  s.description = %q{PayPal Express Checkout API Client for Instance, Recurring and Digital Goods Payment.}
+  s.summary = %q{PayPal Express Checkout API Client for Instance, Recurring and Digital Goods Payment.}
+  s.email = 'ianfleeton@gmail.com'
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = "http://github.com/ianfleeton/paypal-express"
+  s.require_paths = ["lib"]
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_dependency 'activesupport', '>= 2.3', '< 6'
+  s.add_dependency 'rest-client', '~> 2.0'
+  s.add_dependency 'attr_required', '~> 0.0', '>= 0.0.5'
+  s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
+  s.add_development_dependency 'simplecov', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  s.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
+end

data/lib/paypal.rb

@@ -0,0 +1,86 @@
+require 'logger'
+require 'active_support'
+require 'active_support/core_ext'
+require 'attr_required'
+require 'attr_optional'
+require 'rest_client'
+
+module Paypal
+  mattr_accessor :api_version
+  self.api_version = '204.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)
+    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/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/payee_info'
+require 'paypal/payment/response/payer'
+require 'paypal/payment/response/reference'
+require 'paypal/payment/response/refund'
+require 'paypal/payment/response/refund_info'
+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/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/exception.rb

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

data/lib/paypal/exception/api_error.rb

@@ -0,0 +1,94 @@
+module Paypal
+  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

data/lib/paypal/exception/http_error.rb

@@ -0,0 +1,12 @@
+module Paypal
+  class Exception
+    class HttpError < Exception
+      attr_accessor :code, :message, :body
+      def initialize(code, message, body = '')
+        @code = code
+        @message = message
+        @body = body
+      end
+    end
+  end
+end

data/lib/paypal/express.rb

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

data/lib/paypal/express/request.rb

@@ -0,0 +1,186 @@
+module Paypal
+  module Express
+    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