killbill-bitpay 0.0.1

data/db/ddl.sql

@@ -0,0 +1,75 @@
+CREATE TABLE `bitpay_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_bitpay_payment_methods_on_kb_account_id` (`kb_account_id`),
+  KEY `index_bitpay_payment_methods_on_kb_payment_method_id` (`kb_payment_method_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `bitpay_transactions` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `bitpay_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_bitpay_transactions_on_kb_payment_id` (`kb_payment_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `bitpay_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 "bitpay_payment_methods", :force => true do |t|
+    t.string   "kb_payment_method_id"      # NULL before Kill Bill knows about it
+    t.string   "token"                     # bitpay 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(:bitpay_payment_methods, :kb_account_id)
+  add_index(:bitpay_payment_methods, :kb_payment_method_id)
+
+  create_table "bitpay_transactions", :force => true do |t|
+    t.integer  "bitpay_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"                          # bitpay 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(:bitpay_transactions, :kb_payment_id)
+
+  create_table "bitpay_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-bitpay.gemspec

@@ -0,0 +1,49 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-bitpay'
+  s.version     = version
+  s.summary     = 'Plugin to use Bitpay as a gateway.'
+  s.description = 'Kill Bill payment plugin for Bitpay.'
+
+  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://kill-bill.org'
+
+  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', '~> 3.2.0'
+  s.add_dependency 'activemerchant', '~> 1.44.1'
+  s.add_dependency 'offsite_payments', '~> 2.0.1'
+  s.add_dependency 'activerecord', '~> 4.1.0'
+  s.add_dependency 'actionpack', '~> 4.1.0'
+  s.add_dependency 'actionview', '~> 4.1.0'
+  s.add_dependency 'activesupport', '~> 4.1.0'
+  s.add_dependency 'money', '~> 6.1.1'
+  s.add_dependency 'monetize', '~> 0.3.0'
+  s.add_dependency 'sinatra', '~> 1.3.4'
+  if defined?(JRUBY_VERSION)
+    s.add_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3.7'
+    # Required to avoid errors like java.lang.NoClassDefFoundError: org/bouncycastle/asn1/DERBoolean
+    s.add_dependency 'jruby-openssl', '~> 0.9.4'
+  end
+
+  s.add_development_dependency 'jbundler', '~> 0.4.1'
+  s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.12.0'
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3.7'
+  else
+    s.add_development_dependency 'sqlite3', '~> 1.3.7'
+  end
+end

data/killbill.properties

@@ -0,0 +1,3 @@
+mainClass=Killbill::Bitpay::PaymentPlugin
+require=bitpay
+pluginType=PAYMENT

data/lib/bitpay.rb

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

data/lib/bitpay/api.rb

@@ -0,0 +1,228 @@
+module Killbill #:nodoc:
+  module Bitpay #:nodoc:
+    class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin
+
+      def initialize
+        gateway_builder = Proc.new do |config|
+          nil
+        end
+
+        super(gateway_builder,
+              :bitpay,
+              ::Killbill::Bitpay::BitpayPaymentMethod,
+              ::Killbill::Bitpay::BitpayTransaction,
+              ::Killbill::Bitpay::BitpayResponse)
+      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)
+        kb_tenant_id                     = context.tenant_id
+        kb_payment_transaction           = get_kb_transaction(kb_payment_id, kb_payment_transaction_id, kb_tenant_id)
+        payment_transaction_external_key = kb_payment_transaction.external_key
+
+        response = @response_model.where("transaction_type = 'PURCHASE' AND kb_tenant_id = '#{kb_tenant_id}' AND authorization = '#{payment_transaction_external_key}'")
+                                  .order(:created_at)[0]
+
+        transaction = response.create_bitpay_transaction(:kb_account_id                => kb_account_id,
+                                                         :kb_tenant_id                 => kb_tenant_id,
+                                                         :amount_in_cents              => amount.nil? ? nil : to_cents(amount, currency),
+                                                         :currency                     => currency,
+                                                         :api_call                     => :purchase,
+                                                         :kb_payment_id                => kb_payment_id,
+                                                         :kb_payment_transaction_id    => kb_payment_transaction_id,
+                                                         :transaction_type             => response.transaction_type,
+                                                         :payment_processor_account_id => response.payment_processor_account_id,
+                                                         :txn_id                       => response.txn_id,
+                                                         :bitpay_response_id           => response.id)
+
+        response.to_transaction_info_plugin(transaction)
+      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
+
+      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 the BitPay API key to generate the invoice id
+        options = {
+            :account_id => config[:bitpay][:api_key],
+            # Overload the order_id (passed as posData) (TODO fix OffsitePayments implementation)
+            :order_id => "#{kb_account_id};#{context.tenant_id}"
+        }
+        descriptor_fields = merge_properties(descriptor_fields, options)
+
+        super(kb_account_id, descriptor_fields, properties, context)
+      end
+
+      def process_notification(notification, properties, context)
+        # Add the BitPay API key to retrieve the invoice
+        options = {
+            :credential1 => config[:bitpay][:api_key]
+        }
+        properties = merge_properties(properties, options)
+
+        super(notification, properties, context) do |gw_notification, service|
+          is_success = nil
+          if service.status == 'Completed'
+            is_success = true
+          elsif service.status == 'Failed'
+            is_success = false
+          end
+
+          if is_success.nil?
+            # Either the invoice was never paid (expired) or hasn't been confirmed yet
+            logger.info "Ignoring BitPay IPN #{service.raw}"
+          else
+            # See above (parsed from posData)
+            kb_account_id, kb_tenant_id = service.item_id.nil? ? nil : service.item_id.split(';')
+            amount = service.params['price']
+            currency = service.currency
+            payment_external_key = service.transaction_id
+            payment_transaction_external_key = service.transaction_id
+
+            payment = record_payment(kb_account_id, kb_tenant_id, amount, currency, is_success, payment_external_key, payment_transaction_external_key)
+            gw_notification.kb_payment_id = payment.id unless payment.nil?
+          end
+        end
+      end
+
+      def record_payment(kb_account_id, kb_tenant_id, amount, currency, is_success, payment_external_key, payment_transaction_external_key, kb_payment_method_id=nil)
+        if kb_account_id.nil? || kb_tenant_id.nil? || amount.nil? || currency.nil? || payment_transaction_external_key.nil?
+          @logger.warn "Invalid notification: kb_account_id=#{kb_account_id}, kb_tenant_id=#{kb_tenant_id}, amount=#{amount}, currency=#{currency}, payment_external_key=#{payment_external_key}, payment_transaction_external_key=#{payment_transaction_external_key}, kb_payment_method_id=#{kb_payment_method_id}"
+          return nil
+        else
+          @logger.info "Recording payment: kb_account_id=#{kb_account_id}, amount=#{amount}, currency=#{currency}, payment_external_key=#{payment_external_key}, payment_transaction_external_key=#{payment_transaction_external_key}, kb_payment_method_id=#{kb_payment_method_id}"
+        end
+
+        @response_model.create(:api_call         => :purchase,
+                               :kb_account_id    => kb_account_id,
+                               :transaction_type => :PURCHASE,
+                               :authorization    => payment_transaction_external_key,
+                               :kb_tenant_id     => kb_tenant_id,
+                               :success          => is_success)
+
+        context = @kb_apis.create_context(kb_tenant_id)
+        kb_account = @kb_apis.account_user_api.get_account_by_id(kb_account_id, context)
+        kb_payment_method_id = kb_payment_method_id.nil? ? kb_account.payment_method_id : kb_payment_method_id
+        kb_payment_id = nil
+        properties = {}
+        @kb_apis.payment_api.create_purchase(kb_account,
+                                             kb_payment_method_id,
+                                             kb_payment_id,
+                                             amount,
+                                             currency,
+                                             payment_external_key,
+                                             payment_transaction_external_key,
+                                             properties,
+                                             context)
+      end
+
+      def get_active_merchant_module
+        ::OffsitePayments.integration(:bit_pay)
+      end
+    end
+  end
+end