killbill-paypal-express 1.0.1

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.jbundler
+Jarfile.lock
+Gemfile.lock
+
+.DS_Store
+
+# Build directory
+killbill-paypal-express/
+
+# Config file
+paypal_express.yml
+
+# Testing database
+test.db
+
+target

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+notifications:
+  email:
+    - killbilling-dev@googlegroups.com
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Jarfile

@@ -0,0 +1,3 @@
+jar 'com.ning.billing:killbill-api', '0.1.63'
+jar 'com.ning.billing:killbill-util:tests', '0.1.63'
+jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/README.md

@@ -0,0 +1,7 @@
+[![Build Status](https://travis-ci.org/killbill/killbill-paypal-express-plugin.png)](https://travis-ci.org/killbill/killbill-paypal-express-plugin)
+[![Code Climate](https://codeclimate.com/github/killbill/killbill-paypal-express-plugin.png)](https://codeclimate.com/github/killbill/killbill-paypal-express-plugin)
+
+killbill-paypal-express-plugin
+==============================
+
+Plugin to use Express Checkout as a gateway

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+
+# Install tasks to build and release the plugin
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+# Install test tasks
+require 'rspec/core/rake_task'
+namespace :test do
+  desc "Run RSpec tests"
+  RSpec::Core::RakeTask.new do |task|
+    task.name = 'spec'
+    task.pattern = './spec/*/*_spec.rb'
+  end
+
+  namespace :remote do
+    desc "Run RSpec remote tests"
+    RSpec::Core::RakeTask.new do |task|
+      task.name = 'spec'
+      task.pattern = './spec/*/remote/*_spec.rb'
+    end
+  end
+end
+
+# Install tasks to package the plugin for Killbill
+require 'killbill/rake_task'
+Killbill::PluginHelper.install_tasks
+
+# Run tests by default
+task :default => 'test:spec'

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/config.ru

@@ -0,0 +1,4 @@
+require 'paypal_express'
+require 'paypal_express/config/application'
+
+run Sinatra::Application

data/db/schema.rb

@@ -0,0 +1,81 @@
+require 'active_record'
+
+ActiveRecord::Schema.define(:version => 20130311153635) do
+  create_table "paypal_express_payment_methods", :force => true do |t|
+    t.string   "kb_account_id",           :null => false
+    t.string   "kb_payment_method_id"     # NULL before Killbill knows about it
+    t.string   "paypal_express_payer_id"  # NULL before the express checkout is completed
+    t.string   "paypal_express_baid"      # NULL before the express checkout is completed
+    t.string   "paypal_express_token",    :null => false, :unique => true
+    t.boolean  "is_deleted",              :null => false, :default => false
+    t.datetime "created_at",              :null => false
+    t.datetime "updated_at",              :null => false
+  end
+
+  create_table "paypal_express_transactions", :force => true do |t|
+    t.integer  "paypal_express_response_id", :null => false
+    t.string   "api_call",                   :null => false
+    t.string   "kb_payment_id",              :null => false
+    t.string   "paypal_express_txn_id",      :null => false
+    t.integer  "amount_in_cents",            :null => false
+    t.datetime "created_at",                 :null => false
+    t.datetime "updated_at",                 :null => false
+  end
+
+  create_table "paypal_express_responses", :force => true do |t|
+    t.string   "api_call",        :null => false
+    t.string   "kb_payment_id"
+    t.string   "message"
+    t.string   "authorization"
+    t.boolean  "fraud_review"
+    t.boolean  "test"
+    t.string   "token"
+    t.string   "payer_id"
+    t.string   "billing_agreement_id"
+    t.string   "payer_name"
+    t.string   "payer_email"
+    t.string   "payer_country"
+    t.string   "contact_phone"
+    t.string   "ship_to_address_name"
+    t.string   "ship_to_address_company"
+    t.string   "ship_to_address_address1"
+    t.string   "ship_to_address_address2"
+    t.string   "ship_to_address_city"
+    t.string   "ship_to_address_state"
+    t.string   "ship_to_address_country"
+    t.string   "ship_to_address_zip"
+    t.string   "ship_to_address_phone"
+    t.string   "receiver_info_business"
+    t.string   "receiver_info_receiver"
+    t.string   "receiver_info_receiverid"
+    t.string   "payment_info_transactionid"
+    t.string   "payment_info_parenttransactionid"
+    t.string   "payment_info_receiptid"
+    t.string   "payment_info_transactiontype"
+    t.string   "payment_info_paymenttype"
+    t.string   "payment_info_paymentdate"
+    t.string   "payment_info_grossamount"
+    t.string   "payment_info_feeamount"
+    t.string   "payment_info_taxamount"
+    t.string   "payment_info_exchangerate"
+    t.string   "payment_info_paymentstatus"
+    t.string   "payment_info_pendingreason"
+    t.string   "payment_info_reasoncode"
+    t.string   "payment_info_protectioneligibility"
+    t.string   "payment_info_protectioneligibilitytype"
+    t.string   "payment_info_shipamount"
+    t.string   "payment_info_shiphandleamount"
+    t.string   "payment_info_shipdiscount"
+    t.string   "payment_info_insuranceamount"
+    t.string   "payment_info_subject"
+    t.string   "avs_result_code"
+    t.string   "avs_result_message"
+    t.string   "avs_result_street_match"
+    t.string   "avs_result_postal_match"
+    t.string   "cvv_result_code"
+    t.string   "cvv_result_message"
+    t.boolean  "success"
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
+end

data/killbill-paypal-express.gemspec

@@ -0,0 +1,41 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-paypal-express'
+  s.version     = version
+  s.summary     = 'Plugin to use Express Checkout as a gateway.'
+  s.description = 'Killbill payment plugin for Paypal Express Checkout.'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.license = 'Apache License (2.0)'
+
+  s.author   = 'Killbill core team'
+  s.email    = 'killbilling-users@googlegroups.com'
+  s.homepage = 'http://www.killbilling.org'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rdoc_options << '--exclude' << '.'
+
+  s.add_dependency 'killbill', '~> 1.0.12'
+  s.add_dependency 'activemerchant', '~> 1.31.1'
+  s.add_dependency 'activerecord', '~> 3.2.1'
+  s.add_dependency 'sinatra', '~> 1.3.4'
+  if defined?(JRUBY_VERSION)
+    s.add_dependency 'activerecord-jdbcmysql-adapter', '~> 1.2.9'
+  end
+
+  s.add_development_dependency 'jbundler', '~> 0.4.1'
+  s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.12.0'
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.2.6'
+  else
+    s.add_development_dependency 'sqlite3', '~> 1.3.7'
+  end
+end

data/killbill.properties

@@ -0,0 +1,3 @@
+mainClass=Killbill::PaypalExpress::PaymentPlugin
+require=paypal_express
+pluginType=PAYMENT

data/lib/paypal_express/api.rb

@@ -0,0 +1,124 @@
+module Killbill::PaypalExpress
+  class PaymentPlugin < Killbill::Plugin::Payment
+    def start_plugin
+      Killbill::PaypalExpress.initialize! "#{@root}/paypal_express.yml", @logger
+      @gateway = Killbill::PaypalExpress.gateway
+
+      @ip = Utils.ip
+
+      super
+
+      @logger.info "Killbill::PaypalExpress::PaymentPlugin started"
+    end
+
+    def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount_in_cents, currency, options = {})
+      options[:currency] ||= currency
+      options[:payment_type] ||= 'Any'
+      options[:invoice_id] ||= kb_payment_id
+      options[:description] ||= "Kill Bill payment for #{kb_payment_id}"
+      options[:ip] ||= @ip
+
+      if options[:reference_id].blank?
+        payment_method = PaypalExpressPaymentMethod.from_kb_payment_method_id(kb_payment_method_id)
+        options[:reference_id] = payment_method.paypal_express_baid
+      end
+
+      # Go to Paypal (DoReferenceTransaction call)
+      paypal_response = @gateway.reference_transaction amount_in_cents, options
+      response = save_response_and_transaction paypal_response, :charge, kb_payment_id, amount_in_cents
+
+      response.to_payment_response
+    end
+
+    def process_refund(kb_account_id, kb_payment_id, amount_in_cents, currency, options = {})
+      # Find one successful charge which amount is at least the amount we are trying to refund
+      paypal_express_transaction = PaypalExpressTransaction.where("paypal_express_transactions.amount_in_cents >= ?", amount_in_cents).find_last_by_api_call_and_kb_payment_id(:charge, kb_payment_id)
+      raise "Unable to find Paypal Express transaction id for payment #{kb_payment_id}" if paypal_express_transaction.nil?
+
+      options[:currency] ||= currency
+      options[:refund_type] ||= paypal_express_transaction.amount_in_cents != amount_in_cents ? 'Partial' : 'Full'
+
+      identification = paypal_express_transaction.paypal_express_txn_id
+
+      # Go to Paypal
+      paypal_response = @gateway.refund amount_in_cents, identification, options
+      response = save_response_and_transaction paypal_response, :refund, kb_payment_id, amount_in_cents
+
+      response.to_refund_response
+    end
+
+    def get_payment_info(kb_account_id, kb_payment_id, options = {})
+      paypal_express_transaction = PaypalExpressTransaction.from_kb_payment_id(kb_payment_id)
+
+      begin
+        transaction_id = paypal_express_transaction.paypal_express_txn_id
+        response = @gateway.transaction_details transaction_id
+        PaypalExpressResponse.from_response(:transaction_details, kb_payment_id, response).to_payment_response
+      rescue => e
+        @logger.warn("Exception while retrieving Paypal Express transaction detail for payment #{kb_payment_id}, defaulting to cached response: #{e}")
+        paypal_express_transaction.paypal_express_response.to_payment_response
+      end
+    end
+
+    def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default=false, options = {})
+      token = payment_method_props.value('token')
+      return false if token.nil?
+
+      # The payment method should have been created during the setup step (see private api)
+      payment_method = PaypalExpressPaymentMethod.from_kb_account_id_and_token(kb_account_id, token)
+
+      # Go to Paypal to get the Payer id (GetExpressCheckoutDetails call)
+      paypal_express_details_response = @gateway.details_for token
+      response = save_response_and_transaction paypal_express_details_response, :details_for
+      return false unless response.success?
+
+      payer_id = response.payer_id
+      unless payer_id.nil?
+        # Go to Paypal to create the BAID for recurring payments (CreateBillingAgreement call)
+        paypal_express_baid_response = @gateway.create_billing_agreement :token => token
+        response = save_response_and_transaction paypal_express_baid_response, :create_billing_agreement
+        return false unless response.success?
+
+        payment_method.kb_payment_method_id = kb_payment_method_id
+        payment_method.paypal_express_payer_id = payer_id
+        payment_method.paypal_express_baid = response.billing_agreement_id
+        payment_method.save!
+
+        logger.info "Created BAID #{payment_method.paypal_express_baid} for payment method #{kb_payment_method_id} (account #{kb_account_id})"
+        true
+      else
+        logger.warn "Unable to retrieve Payer id details for token #{token} (account #{kb_account_id})"
+        false
+      end
+    end
+
+    def delete_payment_method(kb_account_id, kb_payment_method_id, options = {})
+      PaypalExpressPaymentMethod.mark_as_deleted! kb_payment_method_id
+    end
+
+    def get_payment_method_detail(kb_account_id, kb_payment_method_id, options = {})
+      PaypalExpressPaymentMethod.from_kb_payment_method_id(kb_payment_method_id).to_payment_method_response
+    end
+
+    def get_payment_methods(kb_account_id, refresh_from_gateway = false, options = {})
+      PaypalExpressPaymentMethod.from_kb_account_id(kb_account_id).collect { |pm| pm.to_payment_method_response }
+    end
+
+    private
+
+    def save_response_and_transaction(paypal_express_response, api_call, kb_payment_id=nil, amount_in_cents=0)
+      @logger.warn "Unsuccessful #{api_call}: #{paypal_express_response.message}" unless paypal_express_response.success?
+
+      # Save the response to our logs
+      response = PaypalExpressResponse.from_response(api_call, kb_payment_id, paypal_express_response)
+      response.save!
+
+      if response.success and !response.authorization.blank?
+        # Record the transaction
+        transaction = response.create_paypal_express_transaction!(:amount_in_cents => amount_in_cents, :api_call => api_call, :kb_payment_id => kb_payment_id, :paypal_express_txn_id => response.authorization)
+        @logger.debug "Recorded transaction: #{transaction.inspect}"
+      end
+      response
+    end
+  end
+end

data/lib/paypal_express/config/application.rb

@@ -0,0 +1,50 @@
+configure do
+  # Usage: rackup -Ilib -E test
+  if development? or test?
+    Killbill::PaypalExpress.initialize! unless Killbill::PaypalExpress.initialized
+  end
+end
+
+helpers do
+  def plugin
+    Killbill::PaypalExpress::PrivatePaymentPlugin.instance
+  end
+end
+
+# curl -v -XPOST http://127.0.0.1:9292/plugins/killbill-paypal-express/1.0/setup-checkout --data-binary '{"kb_account_id":"a6b33ba1"}'
+post '/plugins/killbill-paypal-express/1.0/setup-checkout', :provides => 'json' do
+  begin
+    data = JSON.parse request.body.read
+  rescue JSON::ParserError => e
+    halt 400, {'Content-Type' => 'text/plain'}, "Invalid payload: #{e}"
+  end
+
+  response = plugin.initiate_express_checkout data['kb_account_id'],
+                                              data['amount_in_cents'] || 0,
+                                              data['currency'] || 'USD',
+                                              data['options'] || {}
+  unless response.success?
+    status 500
+    response.message
+  else
+    redirect response.to_express_checkout_url
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-paypal-express/1.0/pms/1
+get '/plugins/killbill-paypal-express/1.0/pms/:id', :provides => 'json' do
+  if pm = Killbill::PaypalExpress::PaypalExpressPaymentMethod.find_by_id(params[:id].to_i)
+    pm.to_json
+  else
+    status 404
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-paypal-express/1.0/transactions/1
+get '/plugins/killbill-paypal-express/1.0/transactions/:id', :provides => 'json' do
+  if transaction = Killbill::PaypalExpress::PaypalExpressTransaction.find_by_id(params[:id].to_i)
+    transaction.to_json
+  else
+    status 404
+  end
+end

data/lib/paypal_express/config/configuration.rb

@@ -0,0 +1,35 @@
+require 'logger'
+
+module Killbill::PaypalExpress
+  mattr_reader :logger
+  mattr_reader :config
+  mattr_reader :gateway
+  mattr_reader :paypal_sandbox_url
+  mattr_reader :paypal_production_url
+  mattr_reader :initialized
+  mattr_reader :test
+
+  def self.initialize!(config_file='paypal_express.yml', logger=Logger.new(STDOUT))
+    @@logger = logger
+
+    @@config = Properties.new(config_file)
+    @@config.parse!
+
+    @@paypal_sandbox_url = @@config[:paypal][:sandbox_url] || 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+    @@paypal_production_url = @@config[:paypal][:production_url] || 'https://www.paypal.com/cgi-bin/webscr'
+    @@test = @@config[:paypal][:test]
+
+    @@gateway = Killbill::PaypalExpress::Gateway.instance
+    @@gateway.configure(@@config[:paypal])
+
+    if defined?(JRUBY_VERSION)
+      # See https://github.com/jruby/activerecord-jdbc-adapter/issues/302
+      require 'jdbc/mysql'
+      Jdbc::MySQL.load_driver(:require) if Jdbc::MySQL.respond_to?(:load_driver)
+    end
+
+    ActiveRecord::Base.establish_connection(@@config[:database])
+
+    @@initialized = true
+  end
+end

data/lib/paypal_express/config/properties.rb

@@ -0,0 +1,27 @@
+module Killbill::PaypalExpress
+  class Properties
+    def initialize(file = 'paypal_express.yml')
+      @config_file = Pathname.new(file).expand_path
+    end
+
+    def parse!
+      raise "#{@config_file} is not a valid file" unless @config_file.file?
+      @config = YAML.load_file(@config_file.to_s)
+      validate!
+    end
+
+    def [](key)
+      @config[key]
+    end
+
+    private
+
+    def validate!
+      raise "Bad configuration for PaypalExpress plugin. Config is #{@config.inspect}" if @config.blank? ||
+                                                                                          @config[:paypal].blank? ||
+                                                                                          @config[:paypal][:signature].blank? ||
+                                                                                          @config[:paypal][:login].blank? ||
+                                                                                          @config[:paypal][:password].blank?
+    end
+  end
+end

data/lib/paypal_express/models/paypal_express_payment_method.rb

@@ -0,0 +1,44 @@
+module Killbill::PaypalExpress
+  class PaypalExpressPaymentMethod < ActiveRecord::Base
+    attr_accessible :kb_account_id,
+                    :kb_payment_method_id,
+                    :paypal_express_payer_id,
+                    :paypal_express_baid,
+                    :paypal_express_token
+
+    def self.from_kb_account_id(kb_account_id)
+      find_all_by_kb_account_id_and_is_deleted(kb_account_id, false)
+    end
+
+    def self.from_kb_payment_method_id(kb_payment_method_id)
+      payment_methods = find_all_by_kb_payment_method_id_and_is_deleted(kb_payment_method_id, false)
+      raise "No payment method found for payment method #{kb_payment_method_id}" if payment_methods.empty?
+      raise "Killbill payment method mapping to multiple active PaypalExpress tokens for payment method #{kb_payment_method_id}" if payment_methods.size > 1
+      payment_methods[0]
+    end
+
+    # Used to complete the checkout process
+    def self.from_kb_account_id_and_token(kb_account_id, token)
+      payment_methods = find_all_by_kb_account_id_and_paypal_express_token_and_is_deleted(kb_account_id, token, false)
+      raise "No payment method found for account #{kb_account_id}" if payment_methods.empty?
+      raise "Paypal token mapping to multiple active PaypalExpress payment methods #{kb_account_id}" if payment_methods.size > 1
+      payment_methods[0]
+    end
+
+    def self.mark_as_deleted!(kb_payment_method_id)
+      payment_method = from_kb_payment_method_id(kb_payment_method_id)
+      payment_method.is_deleted = true
+      payment_method.save!
+    end
+
+    def to_payment_method_response
+      external_payment_method_id = paypal_express_baid
+      # No concept of default payment method in Paypal Express
+      is_default = false
+      # We don't store extra information in Paypal Express
+      properties = []
+
+      Killbill::Plugin::PaymentMethodResponse.new external_payment_method_id, is_default, properties
+    end
+  end
+end