killbill 7.0.3 → 7.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0af413a5183714f9c7cda0b9c2ec1c4240397593
-  data.tar.gz: 128972b51281d32b3bb1cc9bc4b88887ba7efe36
+  metadata.gz: 4d15f7f9e9da5390cf9abe1cb4734e51622842b0
+  data.tar.gz: d40ccd578500e93b61b25e3851b3fc46e4872b2a
 SHA512:
-  metadata.gz: fc0116cb6ac588e04ae7c4c365ab51d8e24cb04660a505c178c32fab49b82636ae5d22ce9a3e075818df6c312540bc82409c3c410765e68d907ac13071248f3b
-  data.tar.gz: 507a28b987997ae0c05296400997678606d3a73193b7a510a5fe9f2cf0ef7df2fb820b0d9d17b24a07e6ce1b0fc639bdd2cf002f15ecbb29dc40d8f3171ef95b
+  metadata.gz: bd1d6ad6cf260b363d634bdb440098d73d4d55ec143a0f613dccd85e15d5e8546f985647fb79df2f8786c28a3d20df2cdec64fa6bad3e2dd8425e5fc2bbae1da
+  data.tar.gz: ae70cbd211f1036e53345e4f4fbd7024eef6eed016311caf4561c832d03674d1075b8093bf6d717265f35e6f320a49434a9e02a6fa05c38383cc9e9e3849660f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill (7.0.3)
+    killbill (7.0.4)
       rack (>= 1.5.2)
       sinatra (~> 1.3.4)
       typhoeus (~> 0.6.9)
@@ -56,7 +56,7 @@ GEM
     diff-lcs (1.1.3)
     equalizer (0.0.11)
     erubis (2.7.0)
-    ethon (0.8.1)
+    ethon (0.9.0)
       ffi (>= 1.3.0)
     ffi (1.9.10-java)
     i18n (0.7.0)

data/NEWS

@@ -1,3 +1,8 @@
+7.0.4
+    Add support for migrations
+    ActiveMerchant: change message column to TEXT
+    ActiveMerchant: pass in extra_params to dispatch_to_gateways
+
 7.0.3
     Java API: set default dates in context to now()
     Expose the underlying object from LazyEvaluator

data/README.md

@@ -138,10 +138,16 @@ Use the plugin generator:
 
 ```bash
 ./script/generate active_merchant gateway_name /path/to/dir
+cd /path/to/dir
+git init .
+git add .
+git commit -m 'Initial'
 ```
 
 Replace `gateway_name` with the snake case of your ActiveMerchant gateway (e.g. `yandex`, `stripe`, `paypal`, etc.).
 
+The newly generated plugin is in a git repository due to the way that the gemspec file resolves the files to include in the `killbill:package` rake task.  The above will add the generated files to a git repository, the handling of which is left to the reader.
+
 This will generate a tree of files ready to be plugged into Kill Bill. To package the plugin, run:
 
 ```bash

data/bin/killbill-migration

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+require 'killbill/migration_cli'
+
+begin
+  Killbill::Cli.start
+rescue => e
+  Thor::Shell::Color.new.say e.message, :red
+  exit 1
+end

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

@@ -57,7 +57,7 @@ CREATE TABLE <%= identifier %>_responses (
   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,
+  message text DEFAULT NULL,
   authorisation varchar(255) DEFAULT NULL,
   fraud_review boolean DEFAULT NULL,
   test boolean DEFAULT NULL,

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

@@ -58,7 +58,7 @@ ActiveRecord::Schema.define(:version => 20140410153635) do
     t.string   "kb_payment_transaction_id"
     t.string   "transaction_type"
     t.string   "payment_processor_account_id"
-    t.string   "message"
+    t.text     "message"
     t.string   "authorization"
     t.boolean  "fraud_review"
     t.boolean  "test"

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

@@ -361,7 +361,7 @@ module Killbill
         # TODO Split settlements is partially implemented. Left to be done:
         # * payment_source should probably be retrieved per gateway
         # * amount per gateway should be retrieved from the options
-        def dispatch_to_gateways(operation, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context, gateway_call_proc, linked_transaction_proc=nil)
+        def dispatch_to_gateways(operation, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context, gateway_call_proc, linked_transaction_proc=nil, extra_params={})
           kb_transaction        = Utils::LazyEvaluator.new { get_kb_transaction(kb_payment_id, kb_payment_transaction_id, context.tenant_id) }
           amount_in_cents       = amount.nil? ? nil : to_cents(amount, currency)
 
@@ -412,7 +412,7 @@ module Killbill
 
             # Perform the operation in the gateway
             gw_response           = gateway_call_proc.call(gateway, linked_transaction, payment_source, amount_in_cents, options)
-            response, transaction = save_response_and_transaction(gw_response, operation, kb_account_id, context.tenant_id, payment_processor_account_id, kb_payment_id, kb_payment_transaction_id, operation.upcase, amount_in_cents, currency)
+            response, transaction = save_response_and_transaction(gw_response, operation, kb_account_id, context.tenant_id, payment_processor_account_id, kb_payment_id, kb_payment_transaction_id, operation.upcase, amount_in_cents, currency, extra_params)
 
             # Filter after each gateway call
             after_gateway(response, transaction, gw_response, context)
@@ -564,10 +564,10 @@ module Killbill
           account.currency
         end
 
-        def save_response_and_transaction(gw_response, api_call, kb_account_id, kb_tenant_id, payment_processor_account_id, kb_payment_id=nil, kb_payment_transaction_id=nil, transaction_type=nil, amount_in_cents=0, currency=nil)
+        def save_response_and_transaction(gw_response, api_call, kb_account_id, kb_tenant_id, payment_processor_account_id, kb_payment_id=nil, kb_payment_transaction_id=nil, transaction_type=nil, amount_in_cents=0, currency=nil, extra_params={})
           @logger.warn "Unsuccessful #{api_call}: #{gw_response.message}" unless gw_response.success?
 
-          response, transaction = @response_model.create_response_and_transaction(@identifier, @transaction_model, api_call, kb_account_id, kb_payment_id, kb_payment_transaction_id, transaction_type, payment_processor_account_id, kb_tenant_id, gw_response, amount_in_cents, currency, {}, @response_model)
+          response, transaction = @response_model.create_response_and_transaction(@identifier, @transaction_model, api_call, kb_account_id, kb_payment_id, kb_payment_transaction_id, transaction_type, payment_processor_account_id, kb_tenant_id, gw_response, amount_in_cents, currency, extra_params, @response_model)
 
           @logger.debug { "Recorded transaction: #{transaction.inspect}" } unless transaction.nil?
 

data/lib/killbill/migration.rb

@@ -0,0 +1,109 @@
+require 'logger'
+
+require 'active_record'
+require 'arjdbc'
+
+require 'jdbc/mariadb'
+Jdbc::MariaDB.load_driver
+
+module Killbill
+  class Migration
+
+    class << self
+      attr_accessor :ar_patched
+    end
+
+    def initialize(plugin_name, config = nil, logger = Logger.new(STDOUT))
+      configure_logging(logger)
+      configure_migration(plugin_name)
+      configure_connection(config)
+
+      monkey_patch_ar
+    end
+
+    def sql_for_migration(migrations_paths = ActiveRecord::Migrator.migrations_paths)
+      ActiveRecord::Base.connection.readonly = true
+
+      ActiveRecord::Migrator.migrate(migrations_paths)
+
+      ActiveRecord::Base.connection.migration_statements
+    end
+
+    def migrate(migrations_paths = ActiveRecord::Migrator.migrations_paths)
+      ActiveRecord::Base.connection.readonly = false
+
+      ActiveRecord::Migrator.migrate(migrations_paths)
+    end
+
+    def current_version
+      ActiveRecord::Migrator.current_version
+    end
+
+    def sql_dump(stream = StringIO.new)
+      Dir.mktmpdir do |dir|
+        filename = File.join(dir, 'structure.sql')
+        ActiveRecord::Tasks::DatabaseTasks.structure_dump(@config, filename)
+        stream.write(File.read(filename))
+      end
+      stream
+    end
+
+    def ruby_dump(stream = StringIO.new)
+      ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    end
+
+    private
+
+    def configure_logging(logger)
+      verbose = ENV['VERBOSE'] ? ENV['VERBOSE'] == 'true' : false
+
+      ActiveRecord::Base.logger = logger
+      ActiveRecord::Base.logger.level = verbose ? Logger::DEBUG : Logger::INFO
+
+      ActiveRecord::Migration.verbose = verbose
+    end
+
+    def configure_migration(plugin_name)
+      ActiveRecord::SchemaMigration.table_name_prefix = "#{plugin_name}_"
+    end
+
+    def configure_connection(config)
+      config ||= {}
+      db_config = {
+          :adapter => ENV['ADAPTER'] || :mysql,
+          :driver => ENV['DRIVER'] || 'org.mariadb.jdbc.Driver',
+          :username => ENV['USERNAME'] || 'killbill',
+          :password => ENV['PASSWORD'] || 'killbill',
+          :database => ENV['DB'] || 'killbill',
+          :host => ENV['HOST'] || '127.0.0.1'
+      }
+      config_with_defaults = db_config.merge(config)
+      ActiveRecord::Base.establish_connection(config_with_defaults)
+
+      @config = config_with_defaults.stringify_keys
+    end
+
+    def monkey_patch_ar
+      return if self.class.ar_patched
+
+      ActiveRecord::Base.connection.class.class_eval do
+        attr_accessor :migration_statements
+        attr_accessor :readonly
+
+        [:exec_query, :exec_insert, :exec_delete, :exec_update, :exec_query_raw, :execute].each do |method|
+          send(:alias_method, "old_#{method}".to_sym, method)
+
+          define_method(method) do |sql, *args|
+            migration_sql = /^(create|alter|drop|insert|delete|update)/i.match(sql)
+
+            @migration_statements ||= []
+            @migration_statements << "#{sql};" if migration_sql
+
+            send("old_#{method}", sql, *args) if !migration_sql || (migration_sql && !@readonly)
+          end
+        end
+      end
+      self.class.ar_patched = true
+    end
+  end
+end

data/lib/killbill/migration_cli.rb

@@ -0,0 +1,80 @@
+require 'highline'
+require 'thor'
+
+require 'killbill/migration'
+
+module Killbill
+  class Cli < Thor
+
+    include ::Thor::Actions
+
+    class_option :adapter,
+                 :type => :string,
+                 :default => 'mysql',
+                 :desc => 'Database adapter'
+
+    class_option :driver,
+                 :type => :string,
+                 :default => 'org.mariadb.jdbc.Driver',
+                 :desc => 'Database driver'
+
+    class_option :username,
+                 :type => :string,
+                 :default => 'killbill',
+                 :desc => 'Database username'
+
+    class_option :password,
+                 :type => :string,
+                 :default => 'killbill',
+                 :desc => 'Database password'
+
+    class_option :database,
+                 :type => :string,
+                 :default => 'killbill',
+                 :desc => 'Database name'
+
+    class_option :host,
+                 :type => :string,
+                 :default => '127.0.0.1',
+                 :desc => 'Database hostname'
+
+    desc 'current_version plugin_name', 'Display the current migration version'
+    def current_version(plugin_name)
+      say migration(plugin_name, options).current_version, :green
+    end
+
+    method_option :path,
+                  :type => :string,
+                  :default => ActiveRecord::Migrator.migrations_paths,
+                  :desc => 'Folder where to find migration files.'
+    desc 'sql_for_migration plugin_name', 'Display the migration SQL'
+    def sql_for_migration(plugin_name)
+      say migration(plugin_name, options).sql_for_migration(options[:path]).join("\n"), :green
+    end
+
+    method_option :path,
+                  :type => :string,
+                  :default => ActiveRecord::Migrator.migrations_paths,
+                  :desc => 'Folder where to find migration files.'
+    desc 'migrate plugin_name', 'Run all migrations'
+    def migrate(plugin_name)
+      migration(plugin_name, options).migrate(options[:path])
+    end
+
+    desc 'ruby_dump plugin_name', 'Dump the current schema structure (Ruby)'
+    def ruby_dump(plugin_name)
+      say migration(plugin_name, options).ruby_dump.string, :green
+    end
+
+    desc 'sql_dump plugin_name', 'Dump the current schema structure (SQL)'
+    def sql_dump(plugin_name)
+      say migration(plugin_name, options).sql_dump.string, :green
+    end
+
+    private
+
+    def migration(plugin_name, options)
+      Killbill::Migration.new(plugin_name, options)
+    end
+  end
+end

data/lib/killbill/rake_task.rb

@@ -5,6 +5,8 @@ require 'tmpdir'
 require 'rake'
 require 'rubygems/installer'
 
+require 'killbill/migration'
+
 module Killbill
   class PluginHelper
     include Rake::DSL
@@ -64,6 +66,8 @@ module Killbill
       # Staging area to install gem dependencies
       # Note the Killbill friendly structure (which we will keep in the tarball)
       @plugin_gem_target_dir = @plugin_target_dir.join(@gems_dir_path)
+
+      @migration = Killbill::Migration.new(plugin_name || ENV['PLUGIN_NAME'])
     end
 
     attr_reader :base
@@ -246,6 +250,33 @@ module Killbill
         task :clean => :clobber do
           rm_r @package_dir if File.exist?(@package_dir)
         end
+
+        namespace :db do
+          desc 'Display the current migration version'
+          task :current_version do
+            puts @migration.current_version
+          end
+
+          desc 'Display the migration SQL'
+          task :sql_for_migration do
+            puts @migration.sql_for_migration.join("\n")
+          end
+
+          desc 'Run all migrations'
+          task :migrate do
+            @migration.migrate
+          end
+
+          desc 'Dump the current schema structure (Ruby)'
+          task :ruby_dump do
+            puts @migration.ruby_dump.string
+          end
+
+          desc 'Dump the current schema structure (SQL)'
+          task :sql_dump do
+            puts @migration.sql_dump.string
+          end
+        end
       end
     end
 

data/lib/killbill/version.rb

@@ -1,3 +1,3 @@
 module Killbill
-  VERSION = '7.0.3'
+  VERSION = '7.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.0.4
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -298,7 +298,8 @@ dependencies:
   type: :development
 description: Base classes to write plugins.
 email: killbilling-users@googlegroups.com
-executables: []
+executables:
+- killbill-migration
 extensions: []
 extra_rdoc_files: []
 files:
@@ -312,6 +313,7 @@ files:
 - NEWS
 - README.md
 - Rakefile
+- bin/killbill-migration
 - gen_config/api.conf
 - gen_config/plugin_api.conf
 - generators/active_merchant/active_merchant_generator.rb
@@ -538,6 +540,8 @@ files:
 - lib/killbill/jplugin.rb
 - lib/killbill/killbill_api.rb
 - lib/killbill/killbill_logger.rb
+- lib/killbill/migration.rb
+- lib/killbill/migration_cli.rb
 - lib/killbill/notification.rb
 - lib/killbill/payment.rb
 - lib/killbill/payment_control.rb
@@ -599,7 +603,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.6
 signing_key:
 specification_version: 4
 summary: Framework to write Kill Bill plugins in Ruby.