killbill 3.0.0 → 3.1.0

data/lib/killbill/helpers/active_merchant/private_payment_plugin.rb

@@ -0,0 +1,119 @@
+module Killbill
+  module Plugin
+    module ActiveMerchant
+      require 'action_controller'
+      require 'action_view'
+      require 'active_support'
+      require 'cgi'
+
+      class PrivatePaymentPlugin < ::Killbill::Plugin::Payment
+
+        # Implicit dependencies for form_tag helpers
+        include ::ActiveSupport::Configurable
+        include ::ActionController::RequestForgeryProtection
+        include ::ActionView::Context
+        include ::ActionView::Helpers::FormTagHelper
+        include ::ActiveMerchant::Billing::Integrations::ActionViewHelper
+
+        # For RequestForgeryProtection
+        attr_reader :session
+
+        def initialize(identifier, payment_method_model, transaction_model, response_model, session = {})
+          @identifier           = identifier
+          @payment_method_model = payment_method_model
+          @transaction_model    = transaction_model
+          @response_model       = response_model
+
+          @session = session
+          reset_output_buffer
+        end
+
+        # Valid options: :amount, :currency, :test, :credential2, :credential3, :credential4, :country, :account_name,
+        #                :transaction_type, :authcode, :notify_url, :return_url, :redirect_param, :forward_url
+        #
+        # Additionally, you can have a :html key which will be passed through to the link_to helper
+        def payment_link_for(name, order_id, account_id, service, options = {})
+          integration_module = ::ActiveMerchant::Billing::Integrations.const_get(service.to_s.camelize)
+          service_class      = integration_module.const_get('Helper')
+
+          link_options = options.delete(:html) || {}
+          service      = service_class.new(order_id, account_id, options)
+
+          service_url = service.respond_to?(:credential_based_url) ? service.credential_based_url : integration_module.service_url
+
+          # Hack for QIWI which requires 'id' to be the first query parameter...
+          params      = service.form_fields
+          order_key   = service.mappings[:order]
+          url         = service_url + '?' + "#{CGI.escape(order_key.to_param)}=#{CGI.escape(params[order_key].to_s)}"
+          params.delete order_key
+          url += '&' + params.to_query
+
+          # service.form_fields are query parameters
+          link_to name, url, link_options.merge(service.form_fields)
+        end
+
+        # Valid options: :amount, :currency, :test, :credential2, :credential3, :credential4, :country, :account_name,
+        #                :transaction_type, :authcode, :notify_url, :return_url, :redirect_param, :forward_url
+        #
+        # Additionally, you can have a :html key which will be passed through to the form_tag helper
+        def payment_form_for(order_id, account_id, service, options = {}, &proc)
+          # For ActiveMerchant routing
+          options[:service] = service
+
+          options[:html]                              ||= {}
+          options[:html][:disable_authenticity_token] ||= true
+          options[:html][:enforce_utf8]               ||= false
+
+          payment_service_for(order_id, account_id, options, &proc)
+
+          output_buffer
+        end
+
+        protected
+
+        def reset_output_buffer
+          @output_buffer = ''
+        end
+
+        def save_response(response, api_call)
+          save_response_and_transaction(response, api_call)[0]
+        end
+
+        def save_response_and_transaction(response, api_call, kb_payment_id=nil, amount_in_cents=0, currency=nil)
+          logger.warn "Unsuccessful #{api_call}: #{response.message}" unless response.success?
+
+          # Save the response to our logs
+          response = @response_model.from_response(api_call, kb_payment_id, response)
+          response.save!
+
+          transaction = nil
+          txn_id      = response.txn_id
+          if response.success and !kb_payment_id.blank? and !txn_id.blank?
+            # Record the transaction
+            transaction = response.send("create_#{@identifier}_transaction!",
+                                        :amount_in_cents => amount_in_cents,
+                                        :currency        => currency,
+                                        :api_call        => api_call,
+                                        :kb_payment_id   => kb_payment_id,
+                                        :txn_id          => txn_id)
+
+            logger.debug "Recorded transaction: #{transaction.inspect}"
+          end
+          return response, transaction
+        end
+
+        def kb_apis
+          ::Killbill::Plugin::ActiveMerchant.kb_apis
+        end
+
+        def gateway
+          ::Killbill::Plugin::ActiveMerchant.gateway
+        end
+
+        def logger
+          ::Killbill::Plugin::ActiveMerchant.logger
+        end
+      end
+    end
+  end
+end

data/lib/killbill/helpers/active_merchant/properties.rb

@@ -0,0 +1,20 @@
+module Killbill
+  module Plugin
+    module ActiveMerchant
+      class Properties
+        def initialize(file)
+          @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)
+        end
+
+        def [](key)
+          @config[key]
+        end
+      end
+    end
+  end
+end

data/lib/killbill/helpers/active_merchant/sinatra.rb

@@ -0,0 +1,30 @@
+module Killbill
+  module Plugin
+    module ActiveMerchant
+      module Sinatra
+        enable :sessions
+
+        include ::ActionView::Helpers::FormTagHelper
+
+        helpers do
+          def config
+            ::Killbill::Plugin::ActiveMerchant.config
+          end
+
+          def logger
+            ::Killbill::Plugin::ActiveMerchant.logger
+          end
+
+          def required_parameter!(parameter_name, parameter_value, message='must be specified!')
+            halt 400, "#{parameter_name} #{message}" if parameter_value.blank?
+          end
+        end
+
+        after do
+          # return DB connections to the Pool if required
+          ::ActiveRecord::Base.connection.close
+        end
+      end
+    end
+  end
+end

data/lib/killbill/helpers/active_merchant/utils.rb

@@ -0,0 +1,23 @@
+module Killbill
+  module Plugin
+    module ActiveMerchant
+      class Utils
+        # Use base 62 to be safe
+        BASE62 = ('0'..'9').to_a + ('A'..'Z').to_a + ('a'..'z').to_a
+
+        def self.compact_uuid(uuid)
+          uuid = uuid.gsub(/-/, '')
+          uuid.hex.base(62).map{ |i| BASE62[i].chr } * ''
+        end
+
+        def self.unpack_uuid(base62_uuid)
+          as_hex = base62_uuid.split(//).inject(0) { |i,e| i*62 + BASE62.index(e[0]) }
+          no_hyphens = "%x" % as_hex
+          no_hyphens = '0' * (32 - no_hyphens.size) + no_hyphens
+          no_hyphens.insert(8, "-").insert(13, "-").insert(18, "-").insert(23, "-")
+        end
+      end
+    end
+  end
+end
+

data/lib/killbill/payment.rb

@@ -7,43 +7,55 @@ module Killbill
       class OperationUnsupportedByGatewayError < NotImplementedError
       end
 
-      def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount_in_cents, currency, call_context, options = {})
+      def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount, currency, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def get_payment_info(kb_account_id, kb_payment_id, tenant_context, options = {})
+      def get_payment_info(kb_account_id, kb_payment_id, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def process_refund(kb_account_id, kb_payment_id, amount_in_cents, currency, call_context, options = {})
+      def search_payments(search_key, offset, limit, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def get_refund_info(kb_account_id, kb_payment_id, tenant_context, options = {})
+      def process_refund(kb_account_id, kb_payment_id, refund_amount, currency, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, call_context, options = {})
+      def get_refund_info(kb_account_id, kb_payment_id, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def delete_payment_method(kb_account_id, kb_payment_method_id, call_context, options = {})
+      def search_refunds(search_key, offset, limit, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def get_payment_method_detail(kb_account_id, kb_payment_method_id, tenant_context, options = {})
+      def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def set_default_payment_method(kb_account_id, kb_payment_method_id, call_context, options = {})
+      def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def get_payment_methods(kb_account_id, refresh_from_gateway, call_context, options = {})
+      def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context)
         raise OperationUnsupportedByGatewayError
       end
 
-      def reset_payment_methods(kb_account_id, payment_methods)
+      def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+        raise OperationUnsupportedByGatewayError
+      end
+
+      def get_payment_methods(kb_account_id, refresh_from_gateway, properties, context)
+        raise OperationUnsupportedByGatewayError
+      end
+
+      def search_payment_methods(search_key, offset, limit, properties, context)
+        raise OperationUnsupportedByGatewayError
+      end
+
+      def reset_payment_methods(kb_account_id, payment_methods, properties)
         raise OperationUnsupportedByGatewayError
       end
     end

data/script/generate

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+
+require File.expand_path('../../generators/killbill_generator', __FILE__)
+
+Dir[File.expand_path('../..', __FILE__) + '/generators/*/*.rb'].each do |generator|
+  require generator
+end
+
+class Generate < Thor
+  register(ActiveMerchantGenerator, 'active_merchant', 'active_merchant NAME DIR', 'Generates a new active_merchant plugin for Kill Bill.')
+end
+
+Generate.start

data/spec/killbill/helpers/payment_method_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+module Killbill #:nodoc:
+  module Test #:nodoc:
+    class TestPaymentMethod < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::PaymentMethod
+
+      self.table_name = 'test_payment_methods'
+
+    end
+  end
+end
+
+describe Killbill::Plugin::ActiveMerchant::ActiveRecord::PaymentMethod do
+
+  before :all do
+    ::Killbill::Test::TestPaymentMethod.delete_all
+  end
+
+  it 'should generate the right SQL query' do
+    # Check count query (search query numeric)
+    expected_query = "SELECT COUNT(DISTINCT \"test_payment_methods\".\"id\") FROM \"test_payment_methods\"  WHERE ((((((((((((((\"test_payment_methods\".\"kb_account_id\" = '1234' OR \"test_payment_methods\".\"kb_payment_method_id\" = '1234') OR \"test_payment_methods\".\"token\" = '1234') OR \"test_payment_methods\".\"cc_type\" = '1234') OR \"test_payment_methods\".\"state\" = '1234') OR \"test_payment_methods\".\"zip\" = '1234') OR \"test_payment_methods\".\"cc_first_name\" LIKE '%1234%') OR \"test_payment_methods\".\"cc_last_name\" LIKE '%1234%') OR \"test_payment_methods\".\"address1\" LIKE '%1234%') OR \"test_payment_methods\".\"address2\" LIKE '%1234%') OR \"test_payment_methods\".\"city\" LIKE '%1234%') OR \"test_payment_methods\".\"country\" LIKE '%1234%') OR \"test_payment_methods\".\"cc_exp_month\" = 1234) OR \"test_payment_methods\".\"cc_exp_year\" = 1234) OR \"test_payment_methods\".\"cc_last_4\" = 1234)  ORDER BY \"test_payment_methods\".\"id\""
+    # Note that Kill Bill will pass a String, even for numeric types
+    ::Killbill::Test::TestPaymentMethod.search_query('1234').to_sql.should == expected_query
+
+    # Check query with results (search query numeric)
+    expected_query = "SELECT  DISTINCT \"test_payment_methods\".* FROM \"test_payment_methods\"  WHERE ((((((((((((((\"test_payment_methods\".\"kb_account_id\" = '1234' OR \"test_payment_methods\".\"kb_payment_method_id\" = '1234') OR \"test_payment_methods\".\"token\" = '1234') OR \"test_payment_methods\".\"cc_type\" = '1234') OR \"test_payment_methods\".\"state\" = '1234') OR \"test_payment_methods\".\"zip\" = '1234') OR \"test_payment_methods\".\"cc_first_name\" LIKE '%1234%') OR \"test_payment_methods\".\"cc_last_name\" LIKE '%1234%') OR \"test_payment_methods\".\"address1\" LIKE '%1234%') OR \"test_payment_methods\".\"address2\" LIKE '%1234%') OR \"test_payment_methods\".\"city\" LIKE '%1234%') OR \"test_payment_methods\".\"country\" LIKE '%1234%') OR \"test_payment_methods\".\"cc_exp_month\" = 1234) OR \"test_payment_methods\".\"cc_exp_year\" = 1234) OR \"test_payment_methods\".\"cc_last_4\" = 1234)  ORDER BY \"test_payment_methods\".\"id\" LIMIT 10 OFFSET 0"
+    # Note that Kill Bill will pass a String, even for numeric types
+    ::Killbill::Test::TestPaymentMethod.search_query('1234', 0, 10).to_sql.should == expected_query
+
+    # Check count query (search query string)
+    expected_query = "SELECT COUNT(DISTINCT \"test_payment_methods\".\"id\") FROM \"test_payment_methods\"  WHERE (((((((((((\"test_payment_methods\".\"kb_account_id\" = 'XXX' OR \"test_payment_methods\".\"kb_payment_method_id\" = 'XXX') OR \"test_payment_methods\".\"token\" = 'XXX') OR \"test_payment_methods\".\"cc_type\" = 'XXX') OR \"test_payment_methods\".\"state\" = 'XXX') OR \"test_payment_methods\".\"zip\" = 'XXX') OR \"test_payment_methods\".\"cc_first_name\" LIKE '%XXX%') OR \"test_payment_methods\".\"cc_last_name\" LIKE '%XXX%') OR \"test_payment_methods\".\"address1\" LIKE '%XXX%') OR \"test_payment_methods\".\"address2\" LIKE '%XXX%') OR \"test_payment_methods\".\"city\" LIKE '%XXX%') OR \"test_payment_methods\".\"country\" LIKE '%XXX%')  ORDER BY \"test_payment_methods\".\"id\""
+    ::Killbill::Test::TestPaymentMethod.search_query('XXX').to_sql.should == expected_query
+
+    # Check query with results (search query string)
+    expected_query = "SELECT  DISTINCT \"test_payment_methods\".* FROM \"test_payment_methods\"  WHERE (((((((((((\"test_payment_methods\".\"kb_account_id\" = 'XXX' OR \"test_payment_methods\".\"kb_payment_method_id\" = 'XXX') OR \"test_payment_methods\".\"token\" = 'XXX') OR \"test_payment_methods\".\"cc_type\" = 'XXX') OR \"test_payment_methods\".\"state\" = 'XXX') OR \"test_payment_methods\".\"zip\" = 'XXX') OR \"test_payment_methods\".\"cc_first_name\" LIKE '%XXX%') OR \"test_payment_methods\".\"cc_last_name\" LIKE '%XXX%') OR \"test_payment_methods\".\"address1\" LIKE '%XXX%') OR \"test_payment_methods\".\"address2\" LIKE '%XXX%') OR \"test_payment_methods\".\"city\" LIKE '%XXX%') OR \"test_payment_methods\".\"country\" LIKE '%XXX%')  ORDER BY \"test_payment_methods\".\"id\" LIMIT 10 OFFSET 0"
+    ::Killbill::Test::TestPaymentMethod.search_query('XXX', 0, 10).to_sql.should == expected_query
+  end
+
+  it 'should search all fields' do
+    do_search('foo').size.should == 0
+
+    pm = ::Killbill::Test::TestPaymentMethod.create :kb_account_id        => '11-22-33-44',
+                                                    :kb_payment_method_id => '55-66-77-88',
+                                                    :cc_first_name        => 'ccFirstName',
+                                                    :cc_last_name         => 'ccLastName',
+                                                    :cc_type              => 'ccType',
+                                                    :cc_exp_month         => 10,
+                                                    :cc_exp_year          => 11,
+                                                    :cc_last_4            => 1234,
+                                                    :address1             => 'address1',
+                                                    :address2             => 'address2',
+                                                    :city                 => 'city',
+                                                    :state                => 'state',
+                                                    :zip                  => 'zip',
+                                                    :country              => 'country'
+
+    do_search('foo').size.should == 0
+    do_search('ccType').size.should == 1
+    # Exact match only for cc_last_4
+    do_search('123').size.should == 0
+    do_search('1234').size.should == 1
+    # Test partial match
+    do_search('address').size.should == 1
+    do_search('Name').size.should == 1
+
+    pm2 = ::Killbill::Test::TestPaymentMethod.create :kb_account_id        => '22-33-44-55',
+                                                     :kb_payment_method_id => '66-77-88-99',
+                                                     :cc_first_name        => 'ccFirstName',
+                                                     :cc_last_name         => 'ccLastName',
+                                                     :cc_type              => 'ccType',
+                                                     :cc_exp_month         => 10,
+                                                     :cc_exp_year          => 11,
+                                                     :cc_last_4            => 1234,
+                                                     :address1             => 'address1',
+                                                     :address2             => 'address2',
+                                                     :city                 => 'city',
+                                                     :state                => 'state',
+                                                     :zip                  => 'zip',
+                                                     :country              => 'country'
+
+    do_search('foo').size.should == 0
+    do_search('ccType').size.should == 2
+    # Exact match only for cc_last_4
+    do_search('123').size.should == 0
+    do_search('1234').size.should == 2
+    # Test partial match
+    do_search('cc').size.should == 2
+    do_search('address').size.should == 2
+    do_search('Name').size.should == 2
+  end
+
+  private
+
+  def do_search(search_key)
+    pagination = ::Killbill::Test::TestPaymentMethod.search(search_key)
+    pagination.current_offset.should == 0
+    results = pagination.iterator.to_a
+    pagination.total_nb_records.should == results.size
+    results
+  end
+end

data/spec/killbill/helpers/response_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+module Killbill #:nodoc:
+  module Test #:nodoc:
+    class TestResponse < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Response
+
+      self.table_name = 'test_responses'
+
+    end
+  end
+end
+
+describe Killbill::Plugin::ActiveMerchant::ActiveRecord::Response do
+
+  before :all do
+    ::Killbill::Test::TestResponse.delete_all
+  end
+
+  it 'should generate the right SQL query' do
+    # Check count query (search query numeric)
+    expected_query = "SELECT COUNT(DISTINCT \"test_responses\".\"id\") FROM \"test_responses\"  WHERE (((\"test_responses\".\"kb_payment_id\" = '1234' OR \"test_responses\".\"message\" = '1234') OR \"test_responses\".\"authorization\" = '1234') OR \"test_responses\".\"fraud_review\" = '1234') AND \"test_responses\".\"api_call\" = 'charge' AND \"test_responses\".\"success\" = 't'  ORDER BY \"test_responses\".\"id\""
+    # Note that Kill Bill will pass a String, even for numeric types
+    ::Killbill::Test::TestResponse.search_query('charge', '1234').to_sql.should == expected_query
+
+    # Check query with results (search query numeric)
+    expected_query = "SELECT  DISTINCT \"test_responses\".* FROM \"test_responses\"  WHERE (((\"test_responses\".\"kb_payment_id\" = '1234' OR \"test_responses\".\"message\" = '1234') OR \"test_responses\".\"authorization\" = '1234') OR \"test_responses\".\"fraud_review\" = '1234') AND \"test_responses\".\"api_call\" = 'charge' AND \"test_responses\".\"success\" = 't'  ORDER BY \"test_responses\".\"id\" LIMIT 10 OFFSET 0"
+    # Note that Kill Bill will pass a String, even for numeric types
+    ::Killbill::Test::TestResponse.search_query('charge', '1234', 0, 10).to_sql.should == expected_query
+
+    # Check count query (search query string)
+    expected_query = "SELECT COUNT(DISTINCT \"test_responses\".\"id\") FROM \"test_responses\"  WHERE (((\"test_responses\".\"kb_payment_id\" = 'XXX' OR \"test_responses\".\"message\" = 'XXX') OR \"test_responses\".\"authorization\" = 'XXX') OR \"test_responses\".\"fraud_review\" = 'XXX') AND \"test_responses\".\"api_call\" = 'charge' AND \"test_responses\".\"success\" = 't'  ORDER BY \"test_responses\".\"id\""
+    ::Killbill::Test::TestResponse.search_query('charge', 'XXX').to_sql.should == expected_query
+
+    # Check query with results (search query string)
+    expected_query = "SELECT  DISTINCT \"test_responses\".* FROM \"test_responses\"  WHERE (((\"test_responses\".\"kb_payment_id\" = 'XXX' OR \"test_responses\".\"message\" = 'XXX') OR \"test_responses\".\"authorization\" = 'XXX') OR \"test_responses\".\"fraud_review\" = 'XXX') AND \"test_responses\".\"api_call\" = 'charge' AND \"test_responses\".\"success\" = 't'  ORDER BY \"test_responses\".\"id\" LIMIT 10 OFFSET 0"
+    ::Killbill::Test::TestResponse.search_query('charge', 'XXX', 0, 10).to_sql.should == expected_query
+  end
+
+  it 'should search all fields' do
+    do_search('foo').size.should == 0
+
+    pm       = ::Killbill::Test::TestResponse.create :api_call      => 'charge',
+                                                     :kb_payment_id => '11-22-33-44',
+                                                     :success       => true
+
+    # Wrong api_call
+    ignored1 = ::Killbill::Test::TestResponse.create :api_call      => 'add_payment_method',
+                                                     :kb_payment_id => pm.kb_payment_id,
+                                                     :success       => true
+
+    # Not successful
+    ignored2 = ::Killbill::Test::TestResponse.create :api_call      => 'charge',
+                                                     :kb_payment_id => pm.kb_payment_id,
+                                                     :success       => false
+
+    do_search(pm.kb_payment_id).size.should == 1
+
+    pm2 = ::Killbill::Test::TestResponse.create :api_call      => 'charge',
+                                                :kb_payment_id => pm.kb_payment_id,
+                                                :success       => true
+
+    do_search(pm.kb_payment_id).size.should == 2
+  end
+
+  private
+
+  def do_search(search_key)
+    pagination = ::Killbill::Test::TestResponse.search(search_key)
+    pagination.current_offset.should == 0
+    results = pagination.iterator.to_a
+    pagination.total_nb_records.should == results.size
+    results
+  end
+end