killbill 3.0.0 → 3.1.0

data/generators/active_merchant/templates/Rakefile.rb

@@ -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/generators/active_merchant/templates/VERSION.rb

@@ -0,0 +1 @@
+0.0.1

data/generators/active_merchant/templates/config.ru.rb

@@ -0,0 +1,4 @@
+require '<%= identifier %>'
+require '<%= identifier %>/application'
+
+run Sinatra::Application

data/generators/active_merchant/templates/config.yml.rb

@@ -0,0 +1,13 @@
+:<%= identifier %>:
+  :test: true
+  :log_file: /var/tmp/<%= identifier %>.log
+
+:database:
+  :adapter: sqlite3
+  :database: test.db
+# For MySQL
+#  :adapter: 'jdbc'
+#  :username: 'your-username'
+#  :password: 'your-password'
+#  :driver: 'com.mysql.jdbc.Driver'
+#  :url: 'jdbc:mysql://127.0.0.1:3306/your-database'

data/generators/active_merchant/templates/db/ddl.sql.rb

@@ -0,0 +1,64 @@
+CREATE TABLE `<%= identifier %>_payment_methods` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `kb_account_id` varchar(255) NOT NULL,
+  `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` int(11) DEFAULT NULL,
+  `cc_exp_year` int(11) DEFAULT NULL,
+  `cc_number` int(11) DEFAULT NULL,
+  `cc_last_4` int(11) 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,
+  PRIMARY KEY (`id`),
+  KEY `index_<%= identifier %>_payment_methods_on_kb_account_id` (`kb_account_id`),
+  KEY `index_<%= identifier %>_payment_methods_on_kb_payment_method_id` (`kb_payment_method_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `<%= identifier %>_transactions` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `<%= identifier %>_response_id` int(11) NOT NULL,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_id` varchar(255) NOT NULL,
+  `txn_id` varchar(255) NOT NULL,
+  `amount_in_cents` int(11) NOT NULL,
+  `currency` varchar(255) NOT NULL,
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_<%= identifier %>_transactions_on_kb_payment_id` (`kb_payment_id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;
+
+CREATE TABLE `<%= identifier %>_responses` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `api_call` varchar(255) NOT NULL,
+  `kb_payment_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,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin;

data/generators/active_merchant/templates/db/schema.rb

@@ -0,0 +1,64 @@
+require 'active_record'
+
+ActiveRecord::Schema.define(:version => 20140410153635) do
+  create_table "<%= identifier %>_payment_methods", :force => true do |t|
+    t.string   "kb_account_id",            :null => false
+    t.string   "kb_payment_method_id"      # NULL before Kill Bill knows about it
+    t.string   "token"                     # <%= identifier %> id
+    t.string   "cc_first_name"
+    t.string   "cc_last_name"
+    t.string   "cc_type"
+    t.integer  "cc_exp_month"
+    t.integer  "cc_exp_year"
+    t.integer  "cc_number"
+    t.integer  "cc_last_4"
+    t.integer  "cc_start_month"
+    t.integer  "cc_start_year"
+    t.integer  "cc_issue_number"
+    t.integer  "cc_verification_value"
+    t.integer  "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
+  end
+
+  add_index(:<%= identifier %>_payment_methods, :kb_account_id)
+  add_index(:<%= identifier %>_payment_methods, :kb_payment_method_id)
+
+  create_table "<%= identifier %>_transactions", :force => true do |t|
+    t.integer  "<%= identifier %>_response_id",  :null => false
+    t.string   "api_call",                       :null => false
+    t.string   "kb_payment_id",                  :null => false
+    t.string   "txn_id"                          # <%= identifier %> transaction id
+    t.integer  "amount_in_cents",                :null => false
+    t.string   "currency",                       :null => false
+    t.datetime "created_at",                     :null => false
+    t.datetime "updated_at",                     :null => false
+  end
+
+  add_index(:<%= identifier %>_transactions, :kb_payment_id)
+
+  create_table "<%= identifier %>_responses", :force => true do |t|
+    t.string   "api_call",          :null => false
+    t.string   "kb_payment_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
+  end
+end

data/generators/active_merchant/templates/killbill.properties.rb

@@ -0,0 +1,3 @@
+mainClass=Killbill::<%= class_name %>::PaymentPlugin
+require=<%= identifier %>
+pluginType=PAYMENT

data/generators/active_merchant/templates/lib/api.rb

@@ -0,0 +1,119 @@
+module Killbill #:nodoc:
+  module <%= class_name %> #:nodoc:
+    class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin
+
+      def initialize
+        gateway_builder = Proc.new do |config|
+          # Change this if needed
+          ::ActiveMerchant::Billing::<%= class_name %>Gateway.new :login => config[:login]
+        end
+
+        super(gateway_builder,
+              :<%= identifier %>,
+              ::Killbill::<%= class_name %>::<%= class_name %>PaymentMethod,
+              ::Killbill::<%= class_name %>::<%= class_name %>Transaction,
+              ::Killbill::<%= class_name %>::<%= class_name %>Response)
+      end
+
+      def authorize_payment(kb_account_id, kb_payment_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_method_id, amount, currency, context, properties)
+      end
+
+      def capture_payment(kb_account_id, kb_payment_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_method_id, amount, currency, properties, context)
+      end
+
+      def void_payment(kb_account_id, kb_payment_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_method_id, properties, context)
+      end
+
+      def process_payment(kb_account_id, kb_payment_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_method_id, amount, currency, properties, context)
+      end
+
+      def get_payment_info(kb_account_id, kb_payment_id, properties, context)
+        super
+      end
+
+      def search_payments(search_key, offset, limit, properties, context)
+        super
+      end
+
+      def process_refund(kb_account_id, kb_payment_id, refund_amount, currency, properties, context)
+        # Pass extra parameters for the gateway here
+        options = {}
+
+        properties = merge_properties(properties, options)
+        super(kb_account_id, kb_payment_id, refund_amount, currency, properties, context)
+      end
+
+      def get_refund_info(kb_account_id, kb_payment_id, properties, context)
+        super
+      end
+
+      def search_refunds(search_key, offset, limit, properties, context)
+        super
+      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)
+        super
+      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)
+        super
+      end
+
+      def search_payment_methods(search_key, offset, limit, properties, context)
+        super
+      end
+
+      def reset_payment_methods(kb_account_id, payment_methods, properties)
+        super
+      end
+
+      def build_form_descriptor(kb_account_id, descriptor_fields, properties, context)
+        super
+      end
+
+      def process_notification(notification, properties, context)
+        super
+      end
+    end
+  end
+end

data/generators/active_merchant/templates/lib/application.rb

@@ -0,0 +1,84 @@
+# -- 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::<%= class_name %>::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::<%= class_name %>::PrivatePaymentPlugin.new(:<%= identifier %>,
+                                                            ::Killbill::<%= class_name %>::<%= class_name %>PaymentMethod,
+                                                            ::Killbill::<%= class_name %>::<%= class_name %>Transaction,
+                                                            ::Killbill::<%= class_name %>::<%= class_name %>Response,
+                                                            session)
+  end
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-<%= identifier %>/form
+get '/plugins/killbill-<%= identifier %>/form', :provides => 'html' do
+  order_id = request.GET['order_id']
+  account_id = request.GET['account_id']
+  options = {
+      :amount => request.GET['amount'],
+      :currency => request.GET['currency'],
+      :test => request.GET['test'],
+      :credential2 => request.GET['credential2'],
+      :credential3 => request.GET['credential3'],
+      :credential4 => request.GET['credential4'],
+      :country => request.GET['country'],
+      :account_name => request.GET['account_name'],
+      :transaction_type => request.GET['transaction_type'],
+      :authcode => request.GET['authcode'],
+      :notify_url => request.GET['notify_url'],
+      :return_url => request.GET['return_url'],
+      :redirect_param => request.GET['redirect_param'],
+      :forward_url => request.GET['forward_url']
+  }
+
+  @form = plugin(session).payment_form_for(order_id, account_id, :<%= identifier %>, options) do |service|
+    # Add your custom hidden tags here, e.g.
+    #service.token = config[:<%= identifier %>][:token]
+    submit_tag 'Submit'
+  end
+
+  erb :form
+end
+
+# curl -v http://127.0.0.1:9292/plugins/killbill-<%= identifier %>/1.0/pms/1
+get '/plugins/killbill-<%= identifier %>/1.0/pms/:id', :provides => 'json' do
+  if pm = ::Killbill::<%= class_name %>::<%= class_name %>PaymentMethod.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-<%= identifier %>/1.0/transactions/1
+get '/plugins/killbill-<%= identifier %>/1.0/transactions/:id', :provides => 'json' do
+  if transaction = ::Killbill::<%= class_name %>::<%= class_name %>Transaction.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-<%= identifier %>/1.0/responses/1
+get '/plugins/killbill-<%= identifier %>/1.0/responses/:id', :provides => 'json' do
+  if transaction = ::Killbill::<%= class_name %>::<%= class_name %>Response.find_by_id(params[:id].to_i)
+    transaction.to_json
+  else
+    status 404
+  end
+end

data/generators/active_merchant/templates/lib/models/payment_method.rb

@@ -0,0 +1,22 @@
+module Killbill #:nodoc:
+  module <%= class_name %> #:nodoc:
+    class <%= class_name %>PaymentMethod < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::PaymentMethod
+
+      self.table_name = '<%= identifier %>_payment_methods'
+
+      def self.from_response(kb_account_id, kb_payment_method_id, cc_or_token, response, options, extra_params = {})
+        super(kb_account_id,
+              kb_payment_method_id,
+              cc_or_token,
+              response,
+              options,
+              {
+                  # Pass custom key/values here
+                  #:params_id => extract(response, 'id'),
+                  #:params_card_id => extract(response, 'card', 'id')
+              }.merge!(extra_params),
+              ::Killbill::<%= class_name %>::<%= class_name %>PaymentMethod)
+      end
+    end
+  end
+end

data/generators/active_merchant/templates/lib/models/response.rb

@@ -0,0 +1,22 @@
+module Killbill #:nodoc:
+  module <%= class_name %> #:nodoc:
+    class <%= class_name %>Response < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Response
+
+      self.table_name = '<%= identifier %>_responses'
+
+      has_one :<%= identifier %>_transaction
+
+      def self.from_response(api_call, kb_payment_id, response, extra_params = {})
+        super(api_call,
+              kb_payment_id,
+              response,
+              {
+                  # Pass custom key/values here
+                  #:params_id => extract(response, 'id'),
+                  #:params_card_id => extract(response, 'card', 'id')
+              }.merge!(extra_params),
+              ::Killbill::<%= class_name %>::<%= class_name %>Response)
+      end
+    end
+  end
+end

data/generators/active_merchant/templates/lib/models/transaction.rb

@@ -0,0 +1,11 @@
+module Killbill #:nodoc:
+  module <%= class_name %> #:nodoc:
+    class <%= class_name %>Transaction < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Transaction
+
+      self.table_name = '<%= identifier %>_transactions'
+
+      belongs_to :<%= identifier %>_response
+
+    end
+  end
+end