killbill-litle 1.10.0 → 2.0.0

data/lib/litle/application.rb

@@ -0,0 +1,96 @@
+# -- encoding : utf-8 --
+
+set :views, File.expand_path(File.dirname(__FILE__) + '/views')
+
+include Killbill::Plugin::ActiveMerchant::Sinatra
+
+configure do
+  # Usage: rackup -Ilib -E test
+  if development? or test?
+    # Make sure the plugin is initialized
+    plugin              = ::Killbill::Litle::PaymentPlugin.new
+    plugin.logger       = Logger.new(STDOUT)
+    plugin.logger.level = Logger::INFO
+    plugin.conf_dir     = File.dirname(File.dirname(__FILE__)) + '/..'
+    plugin.start_plugin
+  end
+end
+
+helpers do
+  def plugin(session = {})
+    ::Killbill::Litle::PrivatePaymentPlugin.new(session)
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-litle/form
+get '/plugins/killbill-litle/form', :provides => 'html' do
+  kb_account_id = request.GET['kb_account_id']
+  required_parameter! :kb_account_id, kb_account_id
+
+  kb_tenant_id = request.GET['kb_tenant_id']
+  kb_tenant = request.env['killbill_tenant']
+  kb_tenant_id ||= kb_tenant.id.to_s unless kb_tenant.nil?
+
+  currency = request.GET['currency'] || plugin.get_currency(kb_account_id)
+
+  tenant_config = config(kb_tenant_id)
+  litle_config = tenant_config[:litle].is_a?(Array) ? (tenant_config[:litle].find { |c| c[:account_id] == currency }) : tenant_config[:litle]
+
+  paypage_id = litle_config[:paypage_id]
+  required_parameter! :paypage_id, paypage_id, "is not configured for currency #{currency.to_sym}"
+
+  secure_page_url = litle_config[:secure_page_url]
+  required_parameter! :secure_page_url, secure_page_url, 'is not configured'
+
+  locals = {
+      :currency => currency,
+      :secure_page_url => secure_page_url,
+      :paypage_id => paypage_id,
+      :kb_account_id => kb_account_id,
+      :kb_tenant_id => kb_tenant_id,
+      :merchant_txn_id => request.GET['merchant_txn_id'] || '1',
+      :order_id => request.GET['order_id'] || '1',
+      :report_group => request.GET['report_group'] || 'Default Report Group',
+      :success_page => params[:successPage] || '/plugins/killbill-litle',
+      :failure_page => params[:failurePage]
+  }
+  erb :paypage, :locals => locals
+end
+
+# This is mainly for testing. Your application should redirect from the PayPage checkout above
+# to a custom endpoint where you call the Kill Bill add payment method JAX-RS API.
+# If you really want to use this endpoint, you'll have to call the Kill Bill refresh payment methods API
+# to get a Kill Bill payment method id assigned.
+post '/plugins/killbill-litle' do
+  pm = plugin.add_payment_method(params)
+
+  status 201
+  redirect '/plugins/killbill-litle/1.0/pms/' + pm.id.to_s
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-litle/1.0/pms/1
+get '/plugins/killbill-litle/1.0/pms/:id', :provides => 'json' do
+  if pm = ::Killbill::Litle::LitlePaymentMethod.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-litle/1.0/transactions/1
+get '/plugins/killbill-litle/1.0/transactions/:id', :provides => 'json' do
+  if transaction = ::Killbill::Litle::LitleTransaction.find_by_id(params[:id].to_i)
+    transaction.to_json
+  else
+    status 404
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-litle/1.0/responses/1
+get '/plugins/killbill-litle/1.0/responses/:id', :provides => 'json' do
+  if transaction = ::Killbill::Litle::LitleResponse.find_by_id(params[:id].to_i)
+    transaction.to_json
+  else
+    status 404
+  end
+end

data/lib/litle/models/payment_method.rb

@@ -0,0 +1,21 @@
+module Killbill #:nodoc:
+  module Litle #:nodoc:
+    class LitlePaymentMethod < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::PaymentMethod
+
+      self.table_name = 'litle_payment_methods'
+
+      def self.from_response(kb_account_id, kb_payment_method_id, kb_tenant_id, cc_or_token, response, options, extra_params = {}, model = ::Killbill::Litle::LitlePaymentMethod)
+        super(kb_account_id,
+              kb_payment_method_id,
+              kb_tenant_id,
+              cc_or_token,
+              response,
+              options,
+              {
+                  :token => extract(response, 'litleToken')
+              }.merge!(extra_params),
+              model)
+      end
+    end
+  end
+end

data/lib/litle/models/response.rb

@@ -0,0 +1,44 @@
+module Killbill #:nodoc:
+  module Litle #:nodoc:
+    class LitleResponse < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Response
+
+      self.table_name = 'litle_responses'
+
+      has_one :litle_transaction
+
+      def self.from_response(api_call, kb_account_id, kb_payment_id, kb_payment_transaction_id, transaction_type, payment_processor_account_id, kb_tenant_id, response, extra_params = {}, model = ::Killbill::Litle::LitleResponse)
+        super(api_call,
+              kb_account_id,
+              kb_payment_id,
+              kb_payment_transaction_id,
+              transaction_type,
+              payment_processor_account_id,
+              kb_tenant_id,
+              response,
+              {
+                  :params_litle_txn_id  => extract(response, 'litleTxnId'),
+                  :params_order_id      => extract(response, 'orderId') || extract(response, 'id'),
+                  :params_litle_token   => extract(response, 'litleToken'),
+                  :params_auth_code     => extract(response, 'authCode'),
+                  :params_response      => extract(response, 'response'),
+                  :params_response_time => extract(response, 'responseTime'),
+                  :params_message       => extract(response, 'message')
+              }.merge!(extra_params),
+              model)
+      end
+
+      def self.search_where_clause(t, search_key)
+        where_clause = t[:params_litle_txn_id].eq(search_key)
+
+        # Only search successful payments and refunds
+        where_clause = where_clause.and(t[:success].eq(true))
+
+        super.or(where_clause)
+      end
+
+      def first_reference_id
+        params_litle_txn_id
+      end
+    end
+  end
+end

data/lib/litle/models/transaction.rb

@@ -0,0 +1,11 @@
+module Killbill #:nodoc:
+  module Litle #:nodoc:
+    class LitleTransaction < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Transaction
+
+      self.table_name = 'litle_transactions'
+
+      belongs_to :litle_response
+
+    end
+  end
+end

data/lib/litle/private_api.rb

@@ -1,19 +1,48 @@
-module Killbill::Litle
-  class PrivatePaymentPlugin
-    include Singleton
+module Killbill #:nodoc:
+  module Litle #:nodoc:
+    class PrivatePaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PrivatePaymentPlugin
+      def initialize(session = {})
+        super(:litle,
+              ::Killbill::Litle::LitlePaymentMethod,
+              ::Killbill::Litle::LitleTransaction,
+              ::Killbill::Litle::LitleResponse,
+              session)
+      end
 
-    def get_currency(kb_account_id)
-      account = kb_apis.get_account_by_id(kb_account_id)
-      account.currency
-    rescue => e
-      'USD'
-    end
+      def add_payment_method(params)
+        payment_processor_account_id = params[:payment_processor_account_id] || :default
+
+        exp_month, exp_year = (params[:exp_date] || '').split('/')
+
+        # TODO Save response row (to keep the response_litle_txn_id)
 
-    private
+        # Create the payment method (not associated with a Kill Bill payment method yet)
+        Killbill::Litle::LitlePaymentMethod.create!(:kb_account_id        => params[:kb_account_id],
+                                                    :kb_payment_method_id => nil,
+                                                    :kb_tenant_id         => params[:kb_tenant_id],
+                                                    :token                => params[:response_paypage_registration_id],
+                                                    :cc_first_name        => params[:first_name],
+                                                    :cc_last_name         => params[:last_name],
+                                                    :cc_type              => nil,
+                                                    :cc_exp_month         => exp_month,
+                                                    :cc_exp_year          => exp_year,
+                                                    :cc_last_4            => params[:cc_num],
+                                                    :address1             => nil,
+                                                    :address2             => nil,
+                                                    :city                 => nil,
+                                                    :state                => nil,
+                                                    :zip                  => nil,
+                                                    :country              => nil,
+                                                    :created_at           => Time.now.utc,
+                                                    :updated_at           => Time.now.utc)
+      end
 
-    def kb_apis
-      # The logger should have been configured when the plugin started
-      Killbill::Litle.kb_apis
+      def get_currency(kb_account_id)
+        account = kb_apis.get_account_by_id(kb_account_id)
+        account.currency
+      rescue => e
+        'USD'
+      end
     end
   end
 end

data/lib/litle/views/paypage.erb

@@ -1,8 +1,9 @@
-<!-- Inspired from the Litle official example: https://cert01.securepaypage.litle.com/checkout/dontSeeCard.html -->
+<!-- Inspired from the Litle official example: https://www.testlitle.com/checkout/dontSeeCard.html -->
 <html>
   <head>
     <title>Pay Page Checkout</title>
-    <script src="<%= secure_page_url %>/LitlePayPage/litle-api.js" type="text/javascript"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js" type="text/javascript"></script>
+    <script src="<%= secure_page_url %>/LitlePayPage/litle-api2.js" type="text/javascript"></script>
     <script>
     $(document).ready(
       function() {
@@ -68,6 +69,7 @@
           else if (response.response == '889') {
             handleError("We are experiencing technical difficulties. Please try your query again later.");
           }
+          console.log(response.message);
           return false;
         }
 
@@ -90,7 +92,7 @@
               "url": "<%= secure_page_url %>"
             };
 
-            sendToLitle(litleRequest, formFields, submitAfterLitle, onErrorAfterLitle, timeoutOnLitle, 5000);
+            new LitlePayPage().sendToLitle(litleRequest, formFields, submitAfterLitle, onErrorAfterLitle, timeoutOnLitle, 5000);
             return false;
           }
         );
@@ -101,6 +103,7 @@
   <body>
     <form method="post" id="form_checkout" name="form_checkout" action="<%= success_page %>">
       <input type="hidden" id="kb_account_id" name="kb_account_id" value="<%= kb_account_id %>"/>
+      <input type="hidden" id="kb_tenant_id" name="kb_tenant_id" value="<%= kb_tenant_id %>"/>
 
       <input type="hidden" id="request_paypage_id" name="request_paypage_id" value="<%= paypage_id %>"/>
       <input type="hidden" id="request_merchant_txn_id" name="request_merchant_txn_id" value="<%= merchant_txn_id %>"/>
@@ -135,8 +138,8 @@
   </body>
   <script>
   function callLitle() {
-    if (typeof sendToLitle != 'function') {
-      handleError("We are experiencing technical difficulties. Please try your query again later (API unavailable).");
+    if (typeof new LitlePayPage().sendToLitle != 'function') {
+      alert("We are experiencing technical difficulties. Please try your query again later (API unavailable).");
     }
   }
   </script>

data/litle.yml

@@ -1,16 +1,38 @@
 :litle:
-  :test: True
-  :log_file: /var/tmp/litle.log
-  :username: YOYO
-  :password: certFoo
-  :merchant_id:
-      :USD: '064400'
-      :EUR: '064401'
+  - :account_id: "USD"
+    :merchant_id: "your-merchant-id-USD"
+    :username: "your-username"
+    :password: "your-password"
+    :secure_page_url: "https://request-prelive.np-securepaypage-litle.com"
+    :paypage_id: "litle-paypage-id-USD"
+  - :account_id: "EUR"
+    :merchant_id: "your-merchant-id-EUR"
+    :username: "your-username"
+    :password: "your-password"
+    :secure_page_url: "https://request-prelive.np-securepaypage-litle.com"
+    :paypage_id: "litle-paypage-id-EUR"
 
 :database:
+# SQLite (development)
   :adapter: sqlite3
   :database: test.db
-
-:currency_conversions:
-  :BRL: 'USD'
-
+# For MySQL
+#  :adapter: mysql
+#  :username: 'killbill'
+#  :password: 'killbill'
+#  :database: 'killbill' # or set the URL :
+#  #:url: jdbc:mysql://127.0.0.1:3306/killbill
+#  :driver: org.mariadb.jdbc.Driver # as in KB
+#  :pool: 30 # AR's default is max 5 connections
+# In Kill Bill
+#  :adapter: mysql
+#  :jndi: 'killbill/osgi/jdbc'
+#  :pool: false # false-pool (JNDI pool's max)
+#  # uncomment if pool does not support JDBC4 :
+#  #:connection_alive_sql: 'select 1'
+#  # MySQL adapter #configure_connection defaults :
+#  #    @@SESSION.sql_auto_is_null = 0,
+#  #    @@SESSION.wait_timeout = 2147483,
+#  #    @@SESSION.sql_mode = 'STRICT_ALL_TABLES'
+#  # ... can be disabled (on AR-JDBC 1.4) using :
+#  :configure_connection: false

data/pom.xml

@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 ~ Copyright 2010-2013 Ning, Inc.
+~ Copyright 2014-2015 The Billing Project, LLC
 ~
-~  Ning licenses this file to you under the Apache License, version 2.0
+~  The Billing Project licenses this file to you under the Apache License, version 2.0
 ~  (the "License"); you may not use this file except in compliance with the
 ~  License.  You may obtain a copy of the License at:
 ~
@@ -25,7 +26,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>litle-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>1.10.0</version>
+    <version>2.0.0</version>
     <name>litle-plugin</name>
     <url>http://github.com/killbill/killbill-litle-plugin</url>
     <description>Plugin for accessing Litle as a payment gateway</description>

data/release.sh

@@ -1,41 +1,61 @@
 set -e
 
-if [ "GNU" != "$(tar --help | grep GNU | head -1 | awk '{print $1}')" ]; then
-  echo "Unable to release: make sure to use GNU tar"
+BUNDLE=${BUNDLE-"bundle exec"}
+MVN=${MVN-"mvn"}
+
+if [ 'GNU' != "$(tar --help | grep GNU | head -1 | awk '{print $1}')" ]; then
+  echo 'Unable to release: make sure to use GNU tar'
   exit 1
 fi
 
 if $(ruby -e'require "java"'); then
   # Good
-  echo "Detected JRuby"
+  echo 'Detected JRuby'
 else
-  echo "Unable to release: make sure to use JRuby"
+  echo 'Unable to release: make sure to use JRuby'
   exit 1
 fi
 
 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"
+if [[ -z "$NO_RELEASE" && "$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 'Cleaning up'
+$BUNDLE rake killbill:clean
+
+echo 'Building gem'
+$BUNDLE rake build
 
-echo "Pushing the gem to Rubygems"
-rake release
+if [[ -z "$NO_RELEASE" ]]; then
+  echo 'Pushing the gem to Rubygems'
+  $BUNDLE rake release
+fi
 
-echo "Building artifact"
-rake killbill:package
+echo 'Building artifact'
+$BUNDLE rake killbill:package
 
 ARTIFACT="$PWD/pkg/killbill-litle-$VERSION.tar.gz"
 echo "Pushing $ARTIFACT to Maven Central"
-mvn gpg:sign-and-deploy-file \
-    -DgroupId=org.kill-bill.billing.plugin.ruby \
-    -DartifactId=litle-plugin \
-    -Dversion=$VERSION \
-    -Dpackaging=tar.gz \
-    -DrepositoryId=ossrh-releases \
-    -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
-    -Dfile=$ARTIFACT \
-    -DpomFile=pom.xml
+
+if [[ -z "$NO_RELEASE" ]]; then
+  GOAL=gpg:sign-and-deploy-file
+  REPOSITORY_ID=ossrh-releases
+  URL=https://oss.sonatype.org/service/local/staging/deploy/maven2/
+else
+  GOAL=deploy:deploy-file
+  REPOSITORY_ID=sonatype-nexus-snapshots
+  URL=https://oss.sonatype.org/content/repositories/snapshots/
+  VERSION="$VERSION-SNAPSHOT"
+fi
+
+$MVN $GOAL \
+     -DgroupId=org.kill-bill.billing.plugin.ruby \
+     -DartifactId=litle-plugin \
+     -Dversion=$VERSION \
+     -Dpackaging=tar.gz \
+     -DrepositoryId=$REPOSITORY_ID \
+     -Durl=$URL \
+     -Dfile=$ARTIFACT \
+     -DpomFile=pom.xml

data/spec/litle/base_plugin_spec.rb

@@ -1,14 +1,15 @@
 require 'spec_helper'
 
 describe Killbill::Litle::PaymentPlugin do
+
+  include ::Killbill::Plugin::ActiveMerchant::RSpec
+
   before(:each) do
     Dir.mktmpdir do |dir|
-      file = File.new(File.join(dir, 'litle.yml'), "w+")
+      file = File.new(File.join(dir, 'litle.yml'), 'w+')
       file.write(<<-eos)
 :litle:
-  :merchant_id:
-    :USD: 'merchant_id'
-  :password: 'password'
+  :test: true
 # As defined by spec_helper.rb
 :database:
   :adapter: 'sqlite3'
@@ -16,10 +17,7 @@ describe Killbill::Litle::PaymentPlugin do
       eos
       file.close
 
-      @plugin = Killbill::Litle::PaymentPlugin.new
-      @plugin.logger = Logger.new(STDOUT)
-      @plugin.logger.level = Logger::INFO
-      @plugin.conf_dir = File.dirname(file)
+      @plugin = build_plugin(::Killbill::Litle::PaymentPlugin, 'litle', File.dirname(file))
 
       # Start the plugin here - since the config file will be deleted
       @plugin.start_plugin
@@ -30,58 +28,33 @@ describe Killbill::Litle::PaymentPlugin do
     @plugin.stop_plugin
   end
 
-  it 'should reset payment methods' do
-    kb_account_id = '129384'
-
-    @plugin.get_payment_methods(kb_account_id).size.should == 0
-    verify_pms kb_account_id, 0
-
-    # Create a pm with a kb_payment_method_id
-    Killbill::Litle::LitlePaymentMethod.create :kb_account_id => kb_account_id,
-                                               :kb_payment_method_id => 'kb-1',
-                                               :litle_token => 'litle-1'
-    verify_pms kb_account_id, 1
-
-    # Add some in KillBill and reset
-    payment_methods = []
-    # Random order... Shouldn't matter...
-    payment_methods << create_pm_info_plugin(kb_account_id, 'kb-3', false, 'litle-3')
-    payment_methods << create_pm_info_plugin(kb_account_id, 'kb-2', false, 'litle-2')
-    payment_methods << create_pm_info_plugin(kb_account_id, 'kb-4', false, 'litle-4')
-    @plugin.reset_payment_methods kb_account_id, payment_methods
-    verify_pms kb_account_id, 4
-
-    # Add a payment method without a kb_payment_method_id
-    Killbill::Litle::LitlePaymentMethod.create :kb_account_id => kb_account_id,
-                                               :litle_token => 'litle-5'
-    @plugin.get_payment_methods(kb_account_id).size.should == 5
-
-    # Verify we can match it
-    payment_methods << create_pm_info_plugin(kb_account_id, 'kb-5', false, 'litle-5')
-    @plugin.reset_payment_methods kb_account_id, payment_methods
-    verify_pms kb_account_id, 5
-
-    @plugin.stop_plugin
-  end
-
-  private
-
-  def verify_pms(kb_account_id, size)
-    pms = @plugin.get_payment_methods(kb_account_id)
-    pms.size.should == size
-    pms.each do |pm|
-      pm.account_id.should == kb_account_id
-      pm.is_default.should == false
-      pm.external_payment_method_id.should == 'litle-' + pm.payment_method_id.split('-')[1]
-    end
-  end
-
-  def create_pm_info_plugin(kb_account_id, kb_payment_method_id, is_default, external_payment_method_id)
-    pm_info_plugin = Killbill::Plugin::Model::PaymentMethodInfoPlugin.new
-    pm_info_plugin.account_id = kb_account_id
-    pm_info_plugin.payment_method_id = kb_payment_method_id
-    pm_info_plugin.is_default = is_default
-    pm_info_plugin.external_payment_method_id = external_payment_method_id
-    pm_info_plugin
-  end
+  # No offsite payments integration
+
+  #xit 'should generate forms correctly' do
+  #  kb_account_id = SecureRandom.uuid
+  #  kb_tenant_id  = SecureRandom.uuid
+  #  context       = @plugin.kb_apis.create_context(kb_tenant_id)
+  #  fields        = @plugin.hash_to_properties({
+  #                                                 :order_id => '1234',
+  #                                                 :amount   => 10
+  #                                             })
+  #  form          = @plugin.build_form_descriptor kb_account_id, fields, [], context
+  #
+  #  form.kb_account_id.should == kb_account_id
+  #  form.form_method.should == 'POST'
+  #  form.form_url.should == 'https://litle.com'
+  #
+  #  form_fields = @plugin.properties_to_hash(form.form_fields)
+  #end
+
+  #xit 'should receive notifications correctly' do
+  #  description    = 'description'
+  #
+  #  kb_tenant_id = SecureRandom.uuid
+  #  context      = @plugin.kb_apis.create_context(kb_tenant_id)
+  #  properties   = @plugin.hash_to_properties({ :description => description })
+  #
+  #  notification    = ""
+  #  gw_notification = @plugin.process_notification notification, properties, context
+  #end
 end