killbill-securenet 0.1.0

data/NEWS

@@ -0,0 +1,2 @@
+0.1.0
+    Initial release for Kill Bill 0.16.x

data/README.md

@@ -0,0 +1,87 @@
+killbill-securenet-plugin
+=========================
+
+Plugin to use [SecureNet](http://www.securenet.com/) as a gateway.
+
+Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.plugin.ruby%22%20AND%20a%3A%22securenet-plugin%22) with coordinates `org.kill-bill.billing.plugin.ruby:securenet-plugin`.
+
+Kill Bill compatibility
+-----------------------
+
+| Plugin version | Kill Bill version |
+| -------------: | ----------------: |
+| 0.1.y          | 0.16.z            |
+
+Requirements
+------------
+
+The plugin needs a database. The latest version of the schema can be found [here](https://github.com/killbill/killbill-securenet-plugin/blob/master/db/ddl.sql).
+
+Configuration
+-------------
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: text/plain' \
+     -d ':securenet:
+  :login: "your-login"
+  :password: "your-password"' \
+     http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-securenet
+```
+
+To go to production, create a `securenet.yml` configuration file under `/var/tmp/bundles/plugins/ruby/killbill-securenet/x.y.z/` containing the following:
+
+```
+:securenet:
+  :test: false
+```
+
+Usage
+-----
+
+Note: integration with PayOS.js hasn't been done yet.
+
+To store a credit card:
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: application/json' \
+     -d '{
+       "pluginName": "killbill-securenet",
+       "pluginInfo": {
+         "properties": [
+           {
+             "key": "ccFirstName",
+             "value": "John"
+           },
+           {
+             "key": "ccLastName",
+             "value": "Doe"
+           },
+           {
+             "key": "ccExpirationMonth",
+             "value": 12
+           },
+           {
+             "key": "ccExpirationYear",
+             "value": 2017
+           },
+           {
+             "key": "ccNumber",
+             "value": "4111111111111111"
+           }
+         ]
+       }
+     }' \
+     "http://127.0.0.1:8080/1.0/kb/accounts/2a55045a-ce1d-4344-942d-b825536328f9/paymentMethods?isDefault=true&pluginProperty=skip_gw=true"
+```

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 @@
+0.1.0

data/config.ru

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

data/db/ddl.sql

@@ -0,0 +1,75 @@
+CREATE TABLE `securenet_payment_methods` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `kb_payment_method_id` varchar(255) DEFAULT NULL,
+  `token` varchar(255) DEFAULT NULL,
+  `cc_first_name` varchar(255) DEFAULT NULL,
+  `cc_last_name` varchar(255) DEFAULT NULL,
+  `cc_type` varchar(255) DEFAULT NULL,
+  `cc_exp_month` varchar(255) DEFAULT NULL,
+  `cc_exp_year` varchar(255) DEFAULT NULL,
+  `cc_number` varchar(255) DEFAULT NULL,
+  `cc_last_4` varchar(255) DEFAULT NULL,
+  `cc_start_month` varchar(255) DEFAULT NULL,
+  `cc_start_year` varchar(255) DEFAULT NULL,
+  `cc_issue_number` varchar(255) DEFAULT NULL,
+  `cc_verification_value` varchar(255) DEFAULT NULL,
+  `cc_track_data` varchar(255) DEFAULT NULL,
+  `address1` varchar(255) DEFAULT NULL,
+  `address2` varchar(255) DEFAULT NULL,
+  `city` varchar(255) DEFAULT NULL,
+  `state` varchar(255) DEFAULT NULL,
+  `zip` varchar(255) DEFAULT NULL,
+  `country` varchar(255) DEFAULT NULL,
+  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  `kb_account_id` varchar(255) DEFAULT NULL,
+  `kb_tenant_id` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_securenet_payment_methods_on_kb_account_id` (`kb_account_id`),
+  KEY `index_securenet_payment_methods_on_kb_payment_method_id` (`kb_payment_method_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `securenet_transactions` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `securenet_response_id` int(11) NOT NULL,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_id` varchar(255) NOT NULL,
+  `kb_payment_transaction_id` varchar(255) NOT NULL,
+  `transaction_type` varchar(255) NOT NULL,
+  `payment_processor_account_id` varchar(255) DEFAULT NULL,
+  `txn_id` varchar(255) DEFAULT NULL,
+  `amount_in_cents` int(11) DEFAULT NULL,
+  `currency` varchar(255) DEFAULT NULL,
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  `kb_account_id` varchar(255) NOT NULL,
+  `kb_tenant_id` varchar(255) NOT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_securenet_transactions_on_kb_payment_id` (`kb_payment_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `securenet_responses` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_id` varchar(255) DEFAULT NULL,
+  `kb_payment_transaction_id` varchar(255) DEFAULT NULL,
+  `transaction_type` varchar(255) DEFAULT NULL,
+  `payment_processor_account_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,
+  `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,
+  `kb_account_id` varchar(255) DEFAULT NULL,
+  `kb_tenant_id` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;

data/db/schema.rb

@@ -0,0 +1,76 @@
+require 'active_record'
+
+ActiveRecord::Schema.define(:version => 20140410153635) do
+  create_table "securenet_payment_methods", :force => true do |t|
+    t.string   "kb_payment_method_id"      # NULL before Kill Bill knows about it
+    t.string   "token"                     # securenet id
+    t.string   "cc_first_name"
+    t.string   "cc_last_name"
+    t.string   "cc_type"
+    t.string   "cc_exp_month"
+    t.string   "cc_exp_year"
+    t.string   "cc_number"
+    t.string   "cc_last_4"
+    t.string   "cc_start_month"
+    t.string   "cc_start_year"
+    t.string   "cc_issue_number"
+    t.string   "cc_verification_value"
+    t.string   "cc_track_data"
+    t.string   "address1"
+    t.string   "address2"
+    t.string   "city"
+    t.string   "state"
+    t.string   "zip"
+    t.string   "country"
+    t.boolean  "is_deleted",               :null => false, :default => false
+    t.datetime "created_at",               :null => false
+    t.datetime "updated_at",               :null => false
+    t.string   "kb_account_id"
+    t.string   "kb_tenant_id"
+  end
+
+  add_index(:securenet_payment_methods, :kb_account_id)
+  add_index(:securenet_payment_methods, :kb_payment_method_id)
+
+  create_table "securenet_transactions", :force => true do |t|
+    t.integer  "securenet_response_id",  :null => false
+    t.string   "api_call",                       :null => false
+    t.string   "kb_payment_id",                  :null => false
+    t.string   "kb_payment_transaction_id",      :null => false
+    t.string   "transaction_type",               :null => false
+    t.string   "payment_processor_account_id"
+    t.string   "txn_id"                          # securenet transaction id
+    # Both null for void
+    t.integer  "amount_in_cents"
+    t.string   "currency"
+    t.datetime "created_at",                     :null => false
+    t.datetime "updated_at",                     :null => false
+    t.string   "kb_account_id",                  :null => false
+    t.string   "kb_tenant_id",                   :null => false
+  end
+
+  add_index(:securenet_transactions, :kb_payment_id)
+
+  create_table "securenet_responses", :force => true do |t|
+    t.string   "api_call",          :null => false
+    t.string   "kb_payment_id"
+    t.string   "kb_payment_transaction_id"
+    t.string   "transaction_type"
+    t.string   "payment_processor_account_id"
+    t.string   "message"
+    t.string   "authorization"
+    t.boolean  "fraud_review"
+    t.boolean  "test"
+    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
+    t.string   "kb_account_id"
+    t.string   "kb_tenant_id"
+  end
+end

data/killbill-securenet.gemspec

@@ -0,0 +1,52 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-securenet'
+  s.version     = version
+  s.summary     = 'Plugin to use SecureNet as a gateway.'
+  s.description = 'Kill Bill payment plugin for SecureNet.'
+
+  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'
+    # Required to avoid errors like java.lang.NoClassDefFoundError: org/bouncycastle/asn1/DERBoolean
+    s.add_dependency 'jruby-openssl', '~> 0.9.6'
+  end
+  s.add_dependency 'actionpack', '~> 4.1.0'
+  s.add_dependency 'actionview', '~> 4.1.0'
+  s.add_dependency 'activemerchant', '~> 1.48.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'
+  else
+    s.add_development_dependency 'sqlite3', '~> 1.3.7'
+  end
+end

data/killbill.properties

@@ -0,0 +1,3 @@
+mainClass=Killbill::Securenet::PaymentPlugin
+require=securenet
+pluginType=PAYMENT

data/lib/securenet.rb

@@ -0,0 +1,24 @@
+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 'securenet/api'
+require 'securenet/private_api'
+
+require 'securenet/models/payment_method'
+require 'securenet/models/response'
+require 'securenet/models/transaction'

data/lib/securenet/api.rb

@@ -0,0 +1,185 @@
+module Killbill #:nodoc:
+  module Securenet #:nodoc:
+    class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin
+
+      def initialize
+        gateway_builder = Proc.new do |config|
+          ::ActiveMerchant::Billing::SecureNetGateway.new :login => config[:login], :password => config[:password]
+        end
+
+        super(gateway_builder,
+              :securenet,
+              ::Killbill::Securenet::SecurenetPaymentMethod,
+              ::Killbill::Securenet::SecurenetTransaction,
+              ::Killbill::Securenet::SecurenetResponse)
+      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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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 = {}
+
+        default_options(options, kb_payment_transaction_id)
+
+        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
+
+      def build_form_descriptor(kb_account_id, descriptor_fields, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+        properties = merge_properties(properties, options)
+
+        # Add your custom static hidden tags here
+        options = {
+            #:token => config[:securenet][:token]
+        }
+        descriptor_fields = merge_properties(descriptor_fields, options)
+
+        super(kb_account_id, descriptor_fields, properties, context)
+      end
+
+      def process_notification(notification, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+        properties = merge_properties(properties, options)
+
+        super(notification, properties, context) do |gw_notification, service|
+          # Retrieve the payment
+          # gw_notification.kb_payment_id =
+          #
+          # Set the response body
+          # gw_notification.entity =
+        end
+      end
+
+      private
+
+      def default_options(options, kb_payment_transaction_id)
+        # SecureNet limits it to 25 characters
+        options[:order_id] ||= Killbill::Plugin::ActiveMerchant::Utils.compact_uuid(kb_payment_transaction_id)
+      end
+    end
+  end
+end