killbill-orbital 0.0.1

data/killbill-orbital.gemspec

@@ -0,0 +1,52 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-orbital'
+  s.version     = version
+  s.summary     = 'Plugin to use Orbital as a gateway.'
+  s.description = 'Kill Bill payment plugin for Orbital.'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.license = 'Apache License (2.0)'
+
+  s.author   = 'Kill Bill core team'
+  s.email    = 'killbilling-users@googlegroups.com'
+  s.homepage = 'http://killbill.io'
+
+  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', '~> 7.0'
+
+  s.add_dependency 'sinatra', '~> 1.3.4'
+  s.add_dependency 'thread_safe', '~> 0.3.4'
+  s.add_dependency 'activerecord', '~> 4.1.0'
+  if defined?(JRUBY_VERSION)
+    s.add_dependency 'activerecord-bogacs', '~> 0.3'
+    s.add_dependency 'activerecord-jdbc-adapter', '~> 1.3', '< 1.5'
+    s.add_dependency 'jruby-openssl', '~> 0.9.7'
+  end
+  s.add_dependency 'actionpack', '~> 4.1.0'
+  s.add_dependency 'actionview', '~> 4.1.0'
+  s.add_dependency 'activemerchant', '~> 1.55.0'
+  s.add_dependency 'offsite_payments', '~> 2.1.0'
+  s.add_dependency 'monetize', '~> 1.1.0'
+  s.add_dependency 'money', '~> 6.5.1'
+
+  s.add_development_dependency 'jbundler', '~> 0.9.2'
+  s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.12.0'
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'jdbc-sqlite3', '~> 3.7'
+    s.add_development_dependency 'jdbc-mariadb', '~> 1.1'
+    s.add_development_dependency 'jdbc-postgres', '~> 9.4'
+  else
+    s.add_development_dependency 'sqlite3', '~> 1.3.7'
+  end
+end

data/killbill.properties

@@ -0,0 +1,3 @@
+mainClass=Killbill::Orbital::PaymentPlugin
+require=orbital
+pluginType=PAYMENT

data/lib/orbital/api.rb

@@ -0,0 +1,141 @@
+module Killbill #:nodoc:
+  module Orbital #:nodoc:
+    class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin
+
+      def initialize
+        gateway_builder = Proc.new do |config|
+          ::ActiveMerchant::Billing::OrbitalGateway.new :login => config[:login],
+                                                        :password => config[:password],
+                                                        # ActiveMerchant expects it to be a String
+                                                        :merchant_id => config[:merchant_id].to_s
+        end
+
+        super(gateway_builder,
+              :orbital,
+              ::Killbill::Orbital::OrbitalPaymentMethod,
+              ::Killbill::Orbital::OrbitalTransaction,
+              ::Killbill::Orbital::OrbitalResponse)
+      end
+
+      def on_event(event)
+        # Require to deal with per tenant configuration invalidation
+        super(event)
+        #
+        # Custom event logic could be added below...
+        #
+      end
+
+      def authorize_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      end
+
+      def capture_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      end
+
+      def purchase_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      end
+
+      def void_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, properties, context)
+      end
+
+      def credit_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      end
+
+      def refund_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      end
+
+      def get_payment_info(kb_account_id, kb_payment_id, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, properties, context)
+      end
+
+      def search_payments(search_key, offset, limit, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(search_key, offset, limit, properties, context)
+      end
+
+      def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context)
+      end
+
+      def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_method_id, properties, context)
+      end
+
+      def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_method_id, properties, context)
+      end
+
+      def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+        # TODO
+      end
+
+      def get_payment_methods(kb_account_id, refresh_from_gateway, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, refresh_from_gateway, properties, context)
+      end
+
+      def search_payment_methods(search_key, offset, limit, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(search_key, offset, limit, properties, context)
+      end
+
+      def reset_payment_methods(kb_account_id, payment_methods, properties, context)
+        super
+      end
+    end
+  end
+end

data/lib/orbital/application.rb

@@ -0,0 +1,50 @@
+# -- 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::Orbital::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::Orbital::PrivatePaymentPlugin.new(session)
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-orbital/1.0/pms/1
+get '/plugins/killbill-orbital/1.0/pms/:id', :provides => 'json' do
+  if pm = ::Killbill::Orbital::OrbitalPaymentMethod.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-orbital/1.0/transactions/1
+get '/plugins/killbill-orbital/1.0/transactions/:id', :provides => 'json' do
+  if transaction = ::Killbill::Orbital::OrbitalTransaction.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-orbital/1.0/responses/1
+get '/plugins/killbill-orbital/1.0/responses/:id', :provides => 'json' do
+  if transaction = ::Killbill::Orbital::OrbitalResponse.find_by_id(params[:id].to_i)
+    transaction.to_json
+  else
+    status 404
+  end
+end

data/lib/orbital/ext/active_merchant/active_merchant.rb

@@ -0,0 +1,10 @@
+module ActiveMerchant
+  module Billing
+    class OrbitalGateway
+
+      def store(creditcard, options = {})
+        add_customer_profile(creditcard, options)
+      end
+    end
+  end
+end

data/lib/orbital/models/payment_method.rb

@@ -0,0 +1,21 @@
+module Killbill #:nodoc:
+  module Orbital #:nodoc:
+    class OrbitalPaymentMethod < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::PaymentMethod
+
+      self.table_name = 'orbital_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::Orbital::OrbitalPaymentMethod)
+        super(kb_account_id,
+              kb_payment_method_id,
+              kb_tenant_id,
+              cc_or_token,
+              response,
+              options,
+              {
+                :cc_number => extract(response, 'cc_account_num'),
+              }.merge!(extra_params),
+              model)
+      end
+    end
+  end
+end

data/lib/orbital/models/response.rb

@@ -0,0 +1,84 @@
+module Killbill #:nodoc:
+  module Orbital #:nodoc:
+    class OrbitalResponse < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Response
+
+      self.table_name = 'orbital_responses'
+
+      has_one :orbital_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::Orbital::OrbitalResponse)
+        super(api_call,
+              kb_account_id,
+              kb_payment_id,
+              kb_payment_transaction_id,
+              transaction_type,
+              payment_processor_account_id,
+              kb_tenant_id,
+              response,
+              orbital_response_params(response).merge!(extra_params),
+              model)
+      end
+
+      def self.orbital_response_params(response)
+        {
+          :params_account_num => extract(response, 'account_num'),
+          :params_address_1 => extract(response, 'address_1'),
+          :params_address_2 => extract(response, 'address_2'),
+          :params_approval_status => extract(response, 'approval_status'),
+          :params_auth_code => extract(response, 'auth_code'),
+          :params_avs_resp_code => extract(response, 'avs_resp_code'),
+          :params_card_brand => extract(response, 'card_brand'),
+          :params_cavv_resp_code => extract(response, 'cavv_resp_code'),
+          :params_cc_account_num => extract(response, 'cc_account_num'),
+          :params_cc_expire_date => extract(response, 'cc_expire_date'),
+          :params_country_fraud_filter_status => extract(response, 'country_fraud_filter_status'),
+          :params_customer_bin => extract(response, 'customer_bin'),
+          :params_customer_city => extract(response, 'customer_city'),
+          :params_customer_country_code => extract(response, 'customer_country_code'),
+          :params_customer_email => extract(response, 'customer_email'),
+          :params_customer_merchant_id => extract(response, 'customer_merchant_id'),
+          :params_customer_name => extract(response, 'customer_name'),
+          :params_customer_phone => extract(response, 'customer_phone'),
+          :params_customer_profile_action => extract(response, 'customer_profile_action'),
+          :params_customer_profile_message => extract(response, 'customer_profile_message'),
+          :params_customer_profile_order_override_ind => extract(response, 'customer_profile_order_override_ind'),
+          :params_customer_ref_num => extract(response, 'customer_ref_num'),
+          :params_customer_state => extract(response, 'customer_state'),
+          :params_customer_zip => extract(response, 'customer_zip'),
+          :params_cvv2_resp_code => extract(response, 'cvv2_resp_code'),
+          :params_ecp_account_dda => extract(response, 'ecp_account_dda'),
+          :params_ecp_account_rt => extract(response, 'ecp_account_rt'),
+          :params_ecp_account_type => extract(response, 'ecp_account_type'),
+          :params_ecp_bank_pmt_dlv => extract(response, 'ecp_bank_pmt_dlv'),
+          :params_host_avs_resp_code => extract(response, 'host_avs_resp_code'),
+          :params_host_cvv2_resp_code => extract(response, 'host_cvv2_resp_code'),
+          :params_host_resp_code => extract(response, 'host_resp_code'),
+          :params_industry_type => extract(response, 'industry_type'),
+          :params_iso_country_code => extract(response, 'iso_country_code'),
+          :params_merchant_id => extract(response, 'merchant_id'),
+          :params_message_type => extract(response, 'message_type'),
+          :params_order_default_amount => extract(response, 'order_default_amount'),
+          :params_order_default_description => extract(response, 'order_default_description'),
+          :params_order_id => extract(response, 'order_id'),
+          :params_partial_auth_occurred => extract(response, 'partial_auth_occurred'),
+          :params_proc_status => extract(response, 'proc_status'),
+          :params_profile_proc_status => extract(response, 'profile_proc_status'),
+          :params_recurring_advice_cd => extract(response, 'recurring_advice_cd'),
+          :params_redeemed_amount => extract(response, 'redeemed_amount'),
+          :params_remaining_balance => extract(response, 'remaining_balance'),
+          :params_requested_amount => extract(response, 'requested_amount'),
+          :params_resp_code => extract(response, 'resp_code'),
+          :params_resp_msg => extract(response, 'resp_msg'),
+          :params_resp_time => extract(response, 'resp_time'),
+          :params_status => extract(response, 'status'),
+          :params_status_msg => extract(response, 'status_msg'),
+          :params_switch_solo_issue_num => extract(response, 'switch_solo_issue_num'),
+          :params_switch_solo_start_date => extract(response, 'switch_solo_start_date'),
+          :params_terminal_id => extract(response, 'terminal_id'),
+          :params_tx_ref_idx => extract(response, 'tx_ref_idx'),
+          :params_tx_ref_num => extract(response, 'tx_ref_num'),
+        }
+      end
+    end
+  end
+end

data/lib/orbital/models/transaction.rb

@@ -0,0 +1,11 @@
+module Killbill #:nodoc:
+  module Orbital #:nodoc:
+    class OrbitalTransaction < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Transaction
+
+      self.table_name = 'orbital_transactions'
+
+      belongs_to :orbital_response
+
+    end
+  end
+end

data/lib/orbital/private_api.rb

@@ -0,0 +1,13 @@
+module Killbill #:nodoc:
+  module Orbital #:nodoc:
+    class PrivatePaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PrivatePaymentPlugin
+      def initialize(session = {})
+        super(:orbital,
+              ::Killbill::Orbital::OrbitalPaymentMethod,
+              ::Killbill::Orbital::OrbitalTransaction,
+              ::Killbill::Orbital::OrbitalResponse,
+              session)
+      end
+    end
+  end
+end

data/lib/orbital.rb

@@ -0,0 +1,26 @@
+require 'openssl'
+require 'action_controller'
+require 'active_record'
+require 'action_view'
+require 'active_merchant'
+require 'active_support'
+require 'bigdecimal'
+require 'money'
+require 'monetize'
+require 'offsite_payments'
+require 'pathname'
+require 'sinatra'
+require 'singleton'
+require 'yaml'
+
+require 'killbill'
+require 'killbill/helpers/active_merchant'
+
+require 'orbital/ext/active_merchant/active_merchant.rb'
+
+require 'orbital/api'
+require 'orbital/private_api'
+
+require 'orbital/models/payment_method'
+require 'orbital/models/response'
+require 'orbital/models/transaction'

data/orbital.yml

@@ -0,0 +1,34 @@
+:orbital:
+  - :account_id: default
+    :test: true
+    :login: <%= ENV['LOGIN'] %>
+    :password: <%= ENV['PASSWORD'] %>
+    :merchant_id: <%= ENV['MERCHANT_ID'] %>
+
+:database:
+# SQLite (development)
+  :adapter: sqlite3
+  :database: test.db
+# For PostgreSQL
+#  :adapter: postgresql
+#  :database: 'killbill'
+# For MySQL
+#  :adapter: mariadb
+#  :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