killbill-paypal-express 1.0.2 → 1.0.3

data/Jarfile

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

data/README.md

@@ -4,4 +4,89 @@
 killbill-paypal-express-plugin
 ==============================
 
-Plugin to use Express Checkout as a gateway
+Plugin to use Express Checkout as a gateway.
+
+Usage
+-----
+
+Issue the following call to generate a Paypal token:
+
+```
+curl -v \
+     -X POST \
+     -H "Content-Type: application/json" \
+     --data-binary '{
+       "kb_account_id": "13d26090-b8d7-11e2-9e96-0800200c9a66",
+       "currency": "USD",
+       "options": {
+         "return_url": "http://www.google.com/?q=SUCCESS",
+         "cancel_return_url": "http://www.google.com/?q=FAILURE",
+         "billing_agreement": {
+           "description": "Your subscription"
+         }
+       }
+     }' \
+     "http://$HOST:8080/plugins/killbill-paypal-express/1.0/setup-checkout"
+```
+
+Kill Bill will return a 303 See Other on success. The customer should be redirected to the url specified in the Location header, e.g. https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-20G53990M6953444J.
+
+Once the customer comes back from the PayPal flow, save the BAID in Kill Bill:
+
+```
+curl -v \
+     -X POST \
+     -H "Content-Type: application/json" \
+     -H "X-Killbill-CreatedBy: Web server" \
+     -H "X-Killbill-Reason: New account" \
+     --data-binary '{
+       "pluginName": "killbill-paypal-express",
+       "pluginInfo": {
+         "properties": [{
+           "key": "token",
+           "value": "20G53990M6953444J"
+         }]
+       }
+     }' \
+     "http://$HOST:8080/1.0/kb/accounts/13d26090-b8d7-11e2-9e96-0800200c9a66/paymentMethods?isDefault=true"
+```
+
+To display the payment method details for that account, one can call:
+
+```
+curl -v \
+     "http://$HOST:8080/1.0/kb/accounts/13d26090-b8d7-11e2-9e96-0800200c9a66/paymentMethods?withPluginInfo=true"
+```
+
+Requirements
+------------
+
+The plugin needs a database. The latest version of the schema can be found here: https://raw.github.com/killbill/killbill-paypal-express-plugin/master/db/ddl.sql.
+
+Configuration
+-------------
+
+The plugin expects a `paypal_express.yml` configuration file containing the following:
+
+```
+:paypal:
+  :signature: 'your-paypal-signature'
+  :login: 'your-username-facilitator.something.com'
+  :password: 'your-password'
+  :log_file: '/var/tmp/paypal.log'
+  # Switch to false for production
+  :test: true
+
+:database:
+  :adapter: 'sqlite3'
+  :database: 'test.db'
+# For MySQL
+#  :adapter: 'jdbc'
+#  :username: 'your-username'
+#  :password: 'your-password'
+#  :driver: 'com.mysql.jdbc.Driver'
+#  :url: 'jdbc:mysql://127.0.0.1:3306/your-database'
+```
+
+By default, the plugin will look at the plugin directory root (where `killbill.properties` is located) to find this file.
+Alternatively, set the Kill Bill system property `-Dcom.ning.billing.osgi.bundles.jruby.conf.dir=/my/directory` to specify another location.

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/db/ddl.sql

@@ -0,0 +1,83 @@
+CREATE TABLE `paypal_express_payment_methods` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `kb_account_id` varchar(255) NOT NULL,
+  `kb_payment_method_id` varchar(255) DEFAULT NULL,
+  `paypal_express_payer_id` varchar(255) DEFAULT NULL,
+  `paypal_express_baid` varchar(255) DEFAULT NULL,
+  `paypal_express_token` varchar(255) NOT NULL,
+  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `paypal_express_transactions` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `paypal_express_response_id` int(11) NOT NULL,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_id` varchar(255) NOT NULL,
+  `paypal_express_txn_id` varchar(255) NOT NULL,
+  `amount_in_cents` int(11) NOT NULL,
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `paypal_express_responses` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_id` varchar(255) DEFAULT NULL,
+  `message` varchar(255) DEFAULT NULL,
+  `authorization` varchar(255) DEFAULT NULL,
+  `fraud_review` tinyint(1) DEFAULT NULL,
+  `test` tinyint(1) DEFAULT NULL,
+  `token` varchar(255) DEFAULT NULL,
+  `payer_id` varchar(255) DEFAULT NULL,
+  `billing_agreement_id` varchar(255) DEFAULT NULL,
+  `payer_name` varchar(255) DEFAULT NULL,
+  `payer_email` varchar(255) DEFAULT NULL,
+  `payer_country` varchar(255) DEFAULT NULL,
+  `contact_phone` varchar(255) DEFAULT NULL,
+  `ship_to_address_name` varchar(255) DEFAULT NULL,
+  `ship_to_address_company` varchar(255) DEFAULT NULL,
+  `ship_to_address_address1` varchar(255) DEFAULT NULL,
+  `ship_to_address_address2` varchar(255) DEFAULT NULL,
+  `ship_to_address_city` varchar(255) DEFAULT NULL,
+  `ship_to_address_state` varchar(255) DEFAULT NULL,
+  `ship_to_address_country` varchar(255) DEFAULT NULL,
+  `ship_to_address_zip` varchar(255) DEFAULT NULL,
+  `ship_to_address_phone` varchar(255) DEFAULT NULL,
+  `receiver_info_business` varchar(255) DEFAULT NULL,
+  `receiver_info_receiver` varchar(255) DEFAULT NULL,
+  `receiver_info_receiverid` varchar(255) DEFAULT NULL,
+  `payment_info_transactionid` varchar(255) DEFAULT NULL,
+  `payment_info_parenttransactionid` varchar(255) DEFAULT NULL,
+  `payment_info_receiptid` varchar(255) DEFAULT NULL,
+  `payment_info_transactiontype` varchar(255) DEFAULT NULL,
+  `payment_info_paymenttype` varchar(255) DEFAULT NULL,
+  `payment_info_paymentdate` varchar(255) DEFAULT NULL,
+  `payment_info_grossamount` varchar(255) DEFAULT NULL,
+  `payment_info_feeamount` varchar(255) DEFAULT NULL,
+  `payment_info_taxamount` varchar(255) DEFAULT NULL,
+  `payment_info_exchangerate` varchar(255) DEFAULT NULL,
+  `payment_info_paymentstatus` varchar(255) DEFAULT NULL,
+  `payment_info_pendingreason` varchar(255) DEFAULT NULL,
+  `payment_info_reasoncode` varchar(255) DEFAULT NULL,
+  `payment_info_protectioneligibility` varchar(255) DEFAULT NULL,
+  `payment_info_protectioneligibilitytype` varchar(255) DEFAULT NULL,
+  `payment_info_shipamount` varchar(255) DEFAULT NULL,
+  `payment_info_shiphandleamount` varchar(255) DEFAULT NULL,
+  `payment_info_shipdiscount` varchar(255) DEFAULT NULL,
+  `payment_info_insuranceamount` varchar(255) DEFAULT NULL,
+  `payment_info_subject` varchar(255) DEFAULT NULL,
+  `avs_result_code` varchar(255) DEFAULT NULL,
+  `avs_result_message` varchar(255) DEFAULT NULL,
+  `avs_result_street_match` varchar(255) DEFAULT NULL,
+  `avs_result_postal_match` varchar(255) DEFAULT NULL,
+  `cvv_result_code` varchar(255) DEFAULT NULL,
+  `cvv_result_message` varchar(255) DEFAULT NULL,
+  `success` tinyint(1) DEFAULT NULL,
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;

data/killbill-paypal-express.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
 
   s.rdoc_options << '--exclude' << '.'
 
-  s.add_dependency 'killbill', '~> 1.0.13'
-  s.add_dependency 'activemerchant', '~> 1.31.1'
+  s.add_dependency 'killbill', '~> 1.0.16'
+  s.add_dependency 'activemerchant', '~> 2.0.0'
   s.add_dependency 'activerecord', '~> 3.2.1'
   s.add_dependency 'sinatra', '~> 1.3.4'
   if defined?(JRUBY_VERSION)

data/lib/paypal_express.rb

@@ -6,9 +6,6 @@ require 'singleton'
 require 'yaml'
 
 require 'killbill'
-require 'killbill/response/payment_method_response'
-require 'killbill/response/payment_response'
-require 'killbill/response/refund_response'
 
 require 'paypal_express/config/configuration'
 require 'paypal_express/config/properties'

data/lib/paypal_express/api.rb

@@ -1,7 +1,7 @@
 module Killbill::PaypalExpress
   class PaymentPlugin < Killbill::Plugin::Payment
     def start_plugin
-      Killbill::PaypalExpress.initialize! "#{@root}/paypal_express.yml", @logger
+      Killbill::PaypalExpress.initialize! @logger, @conf_dir
       @gateway = Killbill::PaypalExpress.gateway
 
       @ip = Utils.ip
@@ -11,7 +11,16 @@ module Killbill::PaypalExpress
       @logger.info "Killbill::PaypalExpress::PaymentPlugin started"
     end
 
+    # return DB connections to the Pool if required
+    def after_request
+      ActiveRecord::Base.connection.close
+    end
+
     def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount_in_cents, currency, options = {})
+      # If the payment was already made, just return the status
+      paypal_express_transaction = PaypalExpressTransaction.from_kb_payment_id(kb_payment_id) rescue nil
+      return paypal_express_transaction.paypal_express_response.to_payment_response unless paypal_express_transaction.nil?
+
       options[:currency] ||= currency
       options[:payment_type] ||= 'Any'
       options[:invoice_id] ||= kb_payment_id
@@ -31,9 +40,7 @@ module Killbill::PaypalExpress
     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?
+      paypal_express_transaction = PaypalExpressTransaction.find_candidate_transaction_for_refund(kb_payment_id, amount_in_cents)
 
       options[:currency] ||= currency
       options[:refund_type] ||= paypal_express_transaction.amount_in_cents != amount_in_cents ? 'Partial' : 'Full'
@@ -75,7 +82,7 @@ module Killbill::PaypalExpress
       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
+        paypal_express_baid_response = @gateway.store token
         response = save_response_and_transaction paypal_express_baid_response, :create_billing_agreement
         return false unless response.success?
 
@@ -113,7 +120,7 @@ module Killbill::PaypalExpress
       response = PaypalExpressResponse.from_response(api_call, kb_payment_id, paypal_express_response)
       response.save!
 
-      if response.success and !response.authorization.blank?
+      if response.success and !kb_payment_id.blank? 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}"

data/lib/paypal_express/config/configuration.rb

@@ -9,9 +9,10 @@ module Killbill::PaypalExpress
   mattr_reader :initialized
   mattr_reader :test
 
-  def self.initialize!(config_file='paypal_express.yml', logger=Logger.new(STDOUT))
+  def self.initialize!(logger=Logger.new(STDOUT), conf_dir=File.expand_path('../../../', File.dirname(__FILE__)))
     @@logger = logger
 
+    config_file = "#{conf_dir}/paypal_express.yml"
     @@config = Properties.new(config_file)
     @@config.parse!
 

data/lib/paypal_express/models/paypal_express_payment_method.rb

@@ -38,7 +38,7 @@ module Killbill::PaypalExpress
       # We don't store extra information in Paypal Express
       properties = []
 
-      Killbill::Plugin::PaymentMethodResponse.new external_payment_method_id, is_default, properties
+      Killbill::Plugin::Model::PaymentMethodPlugin.new(external_payment_method_id, is_default, properties, "PayPal", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil)
     end
   end
 end

data/lib/paypal_express/models/paypal_express_response.rb

@@ -118,31 +118,40 @@ module Killbill::PaypalExpress
     end
 
     def to_payment_response
-      to_killbill_response Killbill::Plugin::PaymentResponse
+      to_killbill_response :payment
     end
 
     def to_refund_response
-      to_killbill_response Killbill::Plugin::RefundResponse
+      to_killbill_response :refund
     end
 
     private
 
-    def to_killbill_response(klass)
+    def to_killbill_response(type)
       if paypal_express_transaction.nil?
         # payment_info_grossamount is e.g. "100.00" - we need to convert it in cents
         amount_in_cents = payment_info_grossamount ? (payment_info_grossamount.to_f * 100).to_i : nil
         created_date = created_at
+        first_payment_reference_id = nil
+        second_payment_reference_id = nil
       else
         amount_in_cents = paypal_express_transaction.amount_in_cents
         created_date = paypal_express_transaction.created_at
+        first_payment_reference_id = paypal_express_transaction.paypal_express_txn_id
+        second_payment_reference_id = paypal_express_transaction.id.to_s
       end
 
       effective_date = created_date
-      status = message
-      gateway_error = nil
+      gateway_error = message
       gateway_error_code = nil
 
-      klass.new(amount_in_cents, created_date, effective_date, status, gateway_error, gateway_error_code)
+      if type == :payment
+        status = success ? Killbill::Plugin::Model::PaymentPluginStatus.new(:PROCESSED) : Killbill::Plugin::Model::PaymentPluginStatus.new(:ERROR)
+        Killbill::Plugin::Model::PaymentInfoPlugin.new(amount_in_cents, created_date, effective_date, status, gateway_error, gateway_error_code, first_payment_reference_id, second_payment_reference_id)
+      else
+        status = success ? Killbill::Plugin::Model::RefundPluginStatus.new(:PROCESSED) : Killbill::Plugin::Model::RefundPluginStatus.new(:ERROR)
+        Killbill::Plugin::Model::RefundInfoPlugin.new(amount_in_cents, created_date, effective_date, status, gateway_error, gateway_error_code, first_payment_reference_id)
+      end
     end
 
     # Paypal has various response formats depending on the API call and the ActiveMerchant Paypal plugin doesn't try to

data/lib/paypal_express/models/paypal_express_transaction.rb

@@ -12,5 +12,22 @@ module Killbill::PaypalExpress
       raise "Killbill payment mapping to multiple Paypal Express transactions for payment #{kb_payment_id}" if paypal_express_transactions.size > 1
       paypal_express_transactions[0]
     end
+
+    def self.find_candidate_transaction_for_refund(kb_payment_id, amount_in_cents)
+      # Find one successful charge which amount is at least the amount we are trying to refund
+      paypal_express_transactions = PaypalExpressTransaction.where("paypal_express_transactions.amount_in_cents >= ?", amount_in_cents)
+                                                            .find_all_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_transactions.size == 0
+
+      # We have candidates, but we now need to make sure we didn't refund more than for the specified amount
+      amount_refunded_in_cents = Killbill::PaypalExpress::PaypalExpressTransaction.where("api_call = ? and kb_payment_id = ?", :refund, kb_payment_id)
+                                                                                  .sum("amount_in_cents")
+
+      amount_left_to_refund_in_cents = -amount_refunded_in_cents
+      paypal_express_transactions.map { |transaction| amount_left_to_refund_in_cents += transaction.amount_in_cents }
+      raise "Amount #{amount_in_cents} too large to refund for payment #{kb_payment_id}" if amount_left_to_refund_in_cents < amount_in_cents
+
+      paypal_express_transactions.first
+    end
   end
 end

data/pom.xml

@@ -25,7 +25,7 @@
     <groupId>com.ning.killbill.ruby</groupId>
     <artifactId>paypal-express-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.0</version>
+    <version>1.0.2</version>
     <name>paypal-express-plugin</name>
     <scm>
         <connection>scm:git:git://github.com/killbill/killbill-paypal-express-plugin.git</connection>

data/release.sh

@@ -1,4 +1,20 @@
+set -e
+
 VERSION=`grep -E '<version>([0-9]+\.[0-9]+\.[0-9]+)</version>' pom.xml | sed 's/[\t \n]*<version>\(.*\)<\/version>[\t \n]*/\1/'`
+if [ "$VERSION" != "$(cat $PWD/VERSION)" ]; then
+  echo "Unable to release: make sure the versions in pom.xml and VERSION match"
+  exit 1
+fi
+
+echo "Cleaning up"
+rake killbill:clean ; rake build
+
+echo "Pushing the gem to Rubygems"
+rake release
+
+echo "Building artifact"
+rake killbill:package
+
 ARTIFACT="$PWD/pkg/killbill-paypal-express-$VERSION.tar.gz"
 echo "Pushing $ARTIFACT to Maven Central"
 mvn gpg:sign-and-deploy-file \

data/spec/paypal_express/base_plugin_spec.rb

@@ -17,8 +17,8 @@ eos
       file.close
 
       @plugin = Killbill::PaypalExpress::PaymentPlugin.new
-      @plugin.root = File.dirname(file)
       @plugin.logger = Logger.new(STDOUT)
+      @plugin.conf_dir = File.dirname(file)
 
       # Start the plugin here - since the config file will be deleted
       @plugin.start_plugin

data/spec/paypal_express/remote/integration_spec.rb

@@ -6,7 +6,7 @@ ActiveMerchant::Billing::Base.mode = :test
 describe Killbill::PaypalExpress::PaymentPlugin do
   before(:each) do
     @plugin = Killbill::PaypalExpress::PaymentPlugin.new
-    @plugin.root = File.expand_path(File.dirname(__FILE__) + '../../../../')
+    @plugin.conf_dir = File.expand_path(File.dirname(__FILE__) + '../../../../')
 
     logger = Logger.new(STDOUT)
     logger.level = Logger::DEBUG

metadata

@@ -2,14 +2,14 @@
 name: killbill-paypal-express
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Killbill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -17,13 +17,13 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.13
+        version: 1.0.16
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.13
+        version: 1.0.16
     none: false
   prerelease: false
   type: :runtime
@@ -33,13 +33,13 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 2.0.0
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 2.0.0
     none: false
   prerelease: false
   type: :runtime
@@ -169,6 +169,7 @@ files:
 - Rakefile
 - VERSION
 - config.ru
+- db/ddl.sql
 - db/schema.rb
 - killbill-paypal-express.gemspec
 - killbill.properties