killbill 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3336dc6cd112f6b516306599a87b91a0e40ad173
-  data.tar.gz: 03519858360b4d15c0e31150839e9bf552404428
+  metadata.gz: 78a98058965b5bbd7559afd32426452aa08fcd0c
+  data.tar.gz: 33b92e5f2629345f60769ed4b4c076982a474daf
 SHA512:
-  metadata.gz: 478800fd4c8c6cdd40e4df01c8f3ed93c5de4280a2a7103d03872f9d7d362152b5847ee2189f7ddb7447102f6fe0d00f535793b7bcb9df33bf1e4a368bfa0981
-  data.tar.gz: 8d36533b6e1bcdf452fd9571e8fd6250b3025df5d872939a65b17213ec9df94d8ca1e9d657c1d8cade011de1b1aa14b16614d9f56234ae3cddf9b4579d332241
+  metadata.gz: 7e49b1e770ff125e918d2d58aa1a4a204e87c3a13b71c2b738a8e8ea902a160d069e6b4b777a9ddfc55d92ecb7d04c141145dabd1c48776f3ee4daac229a1f63
+  data.tar.gz: 9274aa2930d128170b6939c9e73e72bb075ddf26d79e49056aa18adbb8bfc01e2a0924a1323c885545248844e3721860b4463f1908c6814cb0b3607ea4ea8132

data/Jarfile

@@ -5,4 +5,5 @@ jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.8.2'
 jar 'org.kill-bill.billing.plugin:killbill-plugin-api-retry', '0.8.1'
 jar 'org.kill-bill.billing.plugin:killbill-plugin-api-invoice', '0.8.2'
 jar 'org.kill-bill.billing:killbill-util:tests', '0.12.0'
+jar 'org.mockito:mockito-all', '1.9.0'
 jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/NEWS

@@ -1,3 +1,7 @@
+3.2.2
+    Logger performance improvement
+    Initial support for invoice plugins
+
 3.2.1
     Regenerate models
 

data/VERSION

@@ -1 +1 @@
-3.2.1
+3.2.2

data/gen_config/plugin_api.conf

@@ -1,6 +1,7 @@
 -i
 file:///PATH_TO_REPO/killbill-plugin-api/payment/src/main/java,
 file:///PATH_TO_REPO/killbill-plugin-api/notification/src/main/java,
+file:///PATH_TO_REPO/killbill-plugin-api/invoice/src/main/java,
 file:///PATH_TO_REPO/killbill-plugin-api/currency/src/main/java,
 file:///PATH_TO_REPO/killbill-api/src/main/java/
 -o
@@ -10,6 +11,7 @@ JRUBY_PLUGIN
 -q
 org.killbill.billing.payment.plugin.api,
 org.killbill.billing.notification.plugin.api,
+org.killbill.billing.invoice.plugin.api
 org.killbill.billing.currency.plugin.api
 -m
 JRUBY_PLUGIN_API

data/lib/killbill.rb

@@ -63,4 +63,5 @@ require 'killbill/gen/api/require_gen'
 require 'killbill/gen/plugin-api/require_gen'
 require 'killbill/notification'
 require 'killbill/payment'
+require 'killbill/invoice'
 require 'killbill/currency'

data/lib/killbill/gen/plugin-api/invoice_plugin_api.rb

@@ -0,0 +1,84 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module Killbill
+  module Plugin
+    module Api
+
+      java_package 'org.killbill.billing.invoice.plugin.api'
+      class InvoicePluginApi < JPlugin
+
+        include org.killbill.billing.invoice.plugin.api.InvoicePluginApi
+
+        def initialize(real_class_name, services = {})
+          super(real_class_name, services)
+        end
+
+
+        java_signature 'Java::java.util.List getAdditionalInvoiceItems(Java::org.killbill.billing.invoice.api.Invoice, Java::java.lang.Iterable, Java::org.killbill.billing.util.callcontext.CallContext)'
+        def get_additional_invoice_items(invoice, properties, context)
+
+          # conversion for invoice [type = org.killbill.billing.invoice.api.Invoice]
+          invoice = Killbill::Plugin::Model::Invoice.new.to_ruby(invoice) unless invoice.nil?
+
+          # conversion for properties [type = java.lang.Iterable]
+          tmp = []
+          (properties.nil? ? [] : properties.iterator).each do |m|
+            # conversion for m [type = org.killbill.billing.payment.api.PluginProperty]
+            m = Killbill::Plugin::Model::PluginProperty.new.to_ruby(m) unless m.nil?
+            tmp << m
+          end
+          properties = tmp
+
+          # conversion for context [type = org.killbill.billing.util.callcontext.CallContext]
+          context = Killbill::Plugin::Model::CallContext.new.to_ruby(context) unless context.nil?
+          begin
+            res = @delegate_plugin.get_additional_invoice_items(invoice, properties, context)
+            # conversion for res [type = java.util.List]
+            tmp = java.util.ArrayList.new
+            (res || []).each do |m|
+              # conversion for m [type = org.killbill.billing.invoice.api.InvoiceItem]
+              m = m.to_java unless m.nil?
+              tmp.add(m)
+            end
+            res = tmp
+            return res
+          rescue Exception => e
+            message = "Failure in get_additional_invoice_items: #{e}"
+            unless e.backtrace.nil?
+              message = "#{message}\n#{e.backtrace.join("\n")}"
+            end
+            logger.warn message
+            raise Java::org.killbill.billing.payment.plugin.api.PaymentPluginApiException.new("get_additional_invoice_items failure", e.message)
+          ensure
+            @delegate_plugin.after_request
+          end
+        end
+      end
+    end
+  end
+end

data/lib/killbill/gen/plugin-api/require_gen.rb

@@ -30,6 +30,7 @@ require 'killbill/gen/plugin-api/payment_plugin_api'
 require 'killbill/gen/plugin-api/payment_plugin_api_exception'
 require 'killbill/gen/plugin-api/ext_bus_event'
 require 'killbill/gen/plugin-api/notification_plugin_api'
+require 'killbill/gen/plugin-api/invoice_plugin_api'
 require 'killbill/gen/plugin-api/currency_plugin_api'
 require 'killbill/gen/plugin-api/gateway_notification'
 require 'killbill/gen/plugin-api/hosted_payment_page_form_descriptor'

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

@@ -42,7 +42,7 @@ module Killbill
           pool.remove(connection)
           connection.disconnect!
 
-          @logger.debug "after_request: pool.active_connection? = #{pool.active_connection?}, connection.active? = #{connection.active?}, pool.connections.size = #{pool.connections.size}, connections = #{pool.connections.inspect}"
+          @logger.debug { "after_request: pool.active_connection? = #{pool.active_connection?}, connection.active? = #{connection.active?}, pool.connections.size = #{pool.connections.size}, connections = #{pool.connections.inspect}" }
         end
 
         def authorize_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -518,7 +518,7 @@ module Killbill
 
           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)
 
-          @logger.debug "Recorded transaction: #{transaction.inspect}" unless transaction.nil?
+          @logger.debug { "Recorded transaction: #{transaction.inspect}" } unless transaction.nil?
 
           return response, transaction
         end

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

@@ -76,7 +76,7 @@ module Killbill
 
           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)
 
-          logger.debug "Recorded transaction: #{transaction.inspect}" unless transaction.nil?
+          logger.debug { "Recorded transaction: #{transaction.inspect}" } unless transaction.nil?
 
           return response, transaction
         end

data/lib/killbill/invoice.rb

@@ -0,0 +1,41 @@
+require 'killbill/plugin'
+require 'securerandom'
+
+module Killbill
+  module Plugin
+    class Invoice < PluginBase
+
+      def get_additional_invoice_items(invoice, properties, context)
+        []
+      end
+
+      # Helper method to build a new item from an existing one
+      def build_item(item_model, amount, description = nil, type = :EXTERNAL_CHARGE)
+        item = Model::InvoiceItem.new
+
+        item.created_date    = item_model.created_date
+        item.updated_date    = item_model.updated_date
+        item.invoice_id      = item_model.invoice_id
+        item.account_id      = item_model.account_id
+        item.currency        = item_model.currency
+        item.bundle_id       = item_model.bundle_id
+        item.subscription_id = item_model.subscription_id
+        item.start_date      = item_model.start_date
+        item.end_date        = item_model.end_date
+        item.plan_name       = item_model.plan_name
+        item.phase_name      = item_model.phase_name
+        item.usage_name      = item_model.usage_name
+
+        item.linked_item_id = item_model.id
+
+        item.id                = SecureRandom.uuid
+        item.invoice_item_type = type
+        item.amount            = amount
+        item.description       = description
+        item.rate              = nil
+
+        item
+      end
+    end
+  end
+end

data/lib/killbill/killbill_logger.rb

@@ -15,19 +15,19 @@ module Killbill
       end
 
       def debug(message=nil, &block)
-        @logger.log(4, build_message(message, &block))
+        @logger.log(4, build_message(message, &block)) if debug?
       end
 
       def info(message=nil, &block)
-        @logger.log(3, build_message(message, &block))
+        @logger.log(3, build_message(message, &block)) if info?
       end
 
       def warn(message=nil, &block)
-        @logger.log(2, build_message(message, &block))
+        @logger.log(2, build_message(message, &block)) if warn?
       end
 
       def error(message=nil, &block)
-        @logger.log(1, build_message(message, &block))
+        @logger.log(1, build_message(message, &block)) if error?
       end
 
       # Rack Error stream
@@ -59,7 +59,7 @@ module Killbill
         end
       end
 
-      def build_message(message=nil, &block)
+      def build_message(message = nil)
         if message.nil?
           if block_given?
             message = yield

data/spec/killbill/invoice_plugin_api_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Killbill::Plugin::Api::InvoicePluginApi do
+
+  before(:all) do
+    logger            = ::Logger.new(STDOUT)
+    @invoicePluginApi = Killbill::Plugin::Api::InvoicePluginApi.new('Killbill::Plugin::InvoiceTest', {'logger' => logger})
+  end
+
+  it 'should add items' do
+    invoice = create_invoice
+
+    items = @invoicePluginApi.get_additional_invoice_items(invoice, java.util.ArrayList.new, nil)
+    items.size.should == 2
+
+    items.get(0).invoice_id.should == invoice.id
+    items.get(0).amount.compareTo(java.math.BigDecimal.new('7')).should == 0
+    items.get(0).invoice_item_type.should == org.killbill.billing.invoice.api.InvoiceItemType::TAX
+
+    items.get(1).invoice_id.should == invoice.id
+    items.get(1).amount.compareTo(java.math.BigDecimal.new('200')).should == 0
+    items.get(1).invoice_item_type.should == org.killbill.billing.invoice.api.InvoiceItemType::EXTERNAL_CHARGE
+  end
+
+  private
+
+  def create_invoice
+    invoice_id = java.util.UUID.random_uuid
+
+    invoice = org.mockito.Mockito.mock(org.killbill.billing.invoice.api.Invoice.java_class)
+    org.mockito.Mockito.when(invoice.getId).thenReturn(invoice_id)
+
+    item = org.mockito.Mockito.mock(org.killbill.billing.invoice.api.InvoiceItem.java_class)
+    org.mockito.Mockito.when(item.getInvoiceId).thenReturn(invoice_id)
+    org.mockito.Mockito.when(item.getAmount).thenReturn(java.math.BigDecimal.new('100'))
+
+    items = java.util.ArrayList.new
+    items.add(item)
+    org.mockito.Mockito.when(invoice.getInvoiceItems).thenReturn(items)
+
+    invoice
+  end
+end

data/spec/killbill/invoice_plugin_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class DummyInvoicePlugin < Killbill::Plugin::Invoice
+end
+
+describe Killbill::Plugin::Invoice do
+
+  it 'should not raise exceptions by default' do
+    plugin = DummyInvoicePlugin.new
+    plugin.get_additional_invoice_items(nil, nil, nil).size.should == 0
+  end
+
+  it 'should be able to build items' do
+    model                   = Killbill::Plugin::Model::InvoiceItem.new
+    model.created_date      = SecureRandom.uuid
+    model.updated_date      = SecureRandom.uuid
+    model.invoice_id        = SecureRandom.uuid
+    model.account_id        = SecureRandom.uuid
+    model.currency          = SecureRandom.uuid
+    model.bundle_id         = SecureRandom.uuid
+    model.subscription_id   = SecureRandom.uuid
+    model.start_date        = SecureRandom.uuid
+    model.end_date          = SecureRandom.uuid
+    model.plan_name         = SecureRandom.uuid
+    model.phase_name        = SecureRandom.uuid
+    model.usage_name        = SecureRandom.uuid
+    model.linked_item_id    = SecureRandom.uuid
+    model.id                = SecureRandom.uuid
+    model.invoice_item_type = SecureRandom.uuid
+    model.amount            = SecureRandom.uuid
+    model.description       = SecureRandom.uuid
+    model.rate              = SecureRandom.uuid
+
+    amount      = 123
+    description = 'Toto'
+    type        = :TAX
+
+    plugin = DummyInvoicePlugin.new
+    item   = plugin.build_item(model, amount, description, type)
+
+    item.created_date.should == model.created_date
+    item.updated_date.should == model.updated_date
+    item.invoice_id.should == model.invoice_id
+    item.account_id.should == model.account_id
+    item.currency.should == model.currency
+    item.bundle_id.should == model.bundle_id
+    item.subscription_id.should == model.subscription_id
+    item.start_date.should == model.start_date
+    item.end_date.should == model.end_date
+    item.plan_name.should == model.plan_name
+    item.phase_name.should == model.phase_name
+    item.usage_name.should == model.usage_name
+    item.linked_item_id.should == model.id
+
+    item.id.should_not == model.id
+    item.amount.should == amount
+    item.description.should == description
+    item.invoice_item_type.should == type
+    item.rate.should be_nil
+  end
+end

data/spec/killbill/invoice_test.rb

@@ -0,0 +1,20 @@
+require 'killbill/invoice'
+
+# See invoice_plugin_api_spec.rb
+module Killbill
+  module Plugin
+    class InvoiceTest < Invoice
+
+      def get_additional_invoice_items(invoice, properties, context)
+        additional_items = []
+        invoice.invoice_items.each do |original_item|
+          additional_items << build_item(original_item, original_item.amount * 7 / 100, 'Tax item', :TAX)
+          additional_items << build_item(original_item, original_item.amount * 2, 'Charge item', :EXTERNAL_CHARGE)
+        end
+
+        additional_items
+      end
+
+    end
+  end
+end

data/spec/killbill/killbill_logger_spec.rb

@@ -10,4 +10,15 @@ describe Killbill::Plugin::KillbillLogger do
     logger.add(Logger::FATAL) { 'Fatal error!' }
     logger.close
   end
+
+  it 'only executes block when at given level' do
+    logger = Killbill::Plugin::KillbillLogger.new(::Logger.new(STDOUT))
+    logger.log_level = ::Logger::INFO
+    logger.info { 'logging at INFO level' }
+    logger.debug { raise 'logging at DEBUG level' } # should not raise
+    logger.add(Logger::WARN) { 'logging at WARN level' }
+    logger.add(Logger::DEBUG) { raise 'logging at DEBUG level' } # should not raise
+    logger.close
+  end
+
 end

data/spec/killbill/notification_test.rb

@@ -1,5 +1,6 @@
 require 'killbill/notification'
 
+# See notification_plugin_api_spec.rb
 module Killbill
   module Plugin
     class NotificationTest < Notification

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ require 'killbill/http_servlet'
 
 require 'killbill/payment_test'
 require 'killbill/notification_test'
+require 'killbill/invoice_test'
 require 'killbill/helpers/active_merchant'
 require 'killbill/helpers/active_merchant/active_record/models/helpers'
 require 'killbill/helpers/active_merchant/killbill_spec_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -414,6 +414,7 @@ files:
 - lib/killbill/gen/plugin-api/ext_bus_event.rb
 - lib/killbill/gen/plugin-api/gateway_notification.rb
 - lib/killbill/gen/plugin-api/hosted_payment_page_form_descriptor.rb
+- lib/killbill/gen/plugin-api/invoice_plugin_api.rb
 - lib/killbill/gen/plugin-api/notification_plugin_api.rb
 - lib/killbill/gen/plugin-api/payment_method_info_plugin.rb
 - lib/killbill/gen/plugin-api/payment_plugin_api.rb
@@ -437,6 +438,7 @@ files:
 - lib/killbill/helpers/active_merchant/sinatra.rb
 - lib/killbill/helpers/active_merchant/utils.rb
 - lib/killbill/http_servlet.rb
+- lib/killbill/invoice.rb
 - lib/killbill/jnotification.rb
 - lib/killbill/jplugin.rb
 - lib/killbill/killbill_api.rb
@@ -461,6 +463,9 @@ files:
 - spec/killbill/helpers/test_schema.rb
 - spec/killbill/helpers/transaction_spec.rb
 - spec/killbill/helpers/utils_spec.rb
+- spec/killbill/invoice_plugin_api_spec.rb
+- spec/killbill/invoice_plugin_spec.rb
+- spec/killbill/invoice_test.rb
 - spec/killbill/killbill_integration_spec.rb
 - spec/killbill/killbill_logger_spec.rb
 - spec/killbill/killbillapi_spec.rb
@@ -517,6 +522,9 @@ test_files:
 - spec/killbill/helpers/test_schema.rb
 - spec/killbill/helpers/transaction_spec.rb
 - spec/killbill/helpers/utils_spec.rb
+- spec/killbill/invoice_plugin_api_spec.rb
+- spec/killbill/invoice_plugin_spec.rb
+- spec/killbill/invoice_test.rb
 - spec/killbill/killbill_integration_spec.rb
 - spec/killbill/killbill_logger_spec.rb
 - spec/killbill/killbillapi_spec.rb