killbill 1.0.0 → 1.0.1

data/Jarfile

@@ -1,2 +1,3 @@
-jar 'com.ning.billing:killbill-api', '0.1.48'
-jar 'com.ning.billing:killbill-util:tests', '0.1.48'
+jar 'com.ning.billing:killbill-api', '0.1.56-SNAPSHOT'
+jar 'com.ning.billing:killbill-util:tests', '0.1.56-SNAPSHOT'
+jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.org/killbill/killbill-plugin-framework-ruby.png)](https://travis-ci.org/killbill/killbill-plugin-framework-ruby)
+[![Code Climate](https://codeclimate.com/github/killbill/killbill-plugin-framework-ruby.png)](https://codeclimate.com/github/killbill/killbill-plugin-framework-ruby)
+
 killbill-plugin-framework-ruby
 ==============================
 
@@ -8,6 +11,8 @@ There are various types of plugins one can write for Killbill:
 1. notifications plugins, which listen to external bus events and can react to it
 2. payment plugins, which are used to issue payments against a payment gateway
 
+Both types of plugin can interact with Killbill directly via killbill-library APIs and expose HTTP endpoints.
+
 How to write a Notification plugin
 ----------------------------------
 
@@ -88,6 +93,22 @@ Make sure to create the corresponding killbill.properties file:
     mainClass=MyPaymentPlugin
     pluginType=PAYMENT
 
+How to expose HTTP endpoints
+----------------------------
+
+Killbill exports a Rack handler that interfaces directly with the container in which killbill-server runs (e.g. Jetty).
+
+This basically means that Killbill will understand native Rack config.ru files placed in the root of your plugin, e.g. (using Sinatra): 
+
+    require 'sinatra'
+
+    get "/plugins/myPlugin/ping" do
+      status 200
+      "pong"
+    end
+    run Sinatra::Application
+
+
 Rake tasks
 ----------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/killbill.gemspec

@@ -23,10 +23,12 @@ Gem::Specification.new do |s|
   s.rdoc_options << '--exclude' << '.'
 
   s.add_development_dependency 'jbundler', '~> 0.4.1'
+  s.add_development_dependency 'rack', '>= 1.5.2'
   s.add_development_dependency 'rake', '>= 0.8.7'
   s.add_development_dependency 'rspec', '~> 2.12.0'
+  s.add_development_dependency 'sinatra', '~> 1.3.4'
 
-  s.requirements << "jar 'com.ning.billing:killbill-api', '0.1.48'"
+  s.requirements << "jar 'com.ning.billing:killbill-api', '0.1.56-SNAPSHOT'"
   # For testing only
-  s.requirements << "jar 'com.ning.billing:killbill-util:tests', '0.1.48'"
+  s.requirements << "jar 'com.ning.billing:killbill-util:tests', '0.1.56-SNAPSHOT'"
 end

data/lib/killbill.rb

@@ -17,7 +17,6 @@ KILLBILL_APIS = %w(
   com.ning.billing.invoice.api.InvoiceMigrationApi
   com.ning.billing.invoice.api.InvoicePaymentApi
   com.ning.billing.invoice.api.InvoiceUserApi
-  com.ning.billing.meter.api.MeterUserApi
   com.ning.billing.overdue.OverdueUserApi
   com.ning.billing.payment.api.PaymentApi
   com.ning.billing.tenant.api.TenantUserApi
@@ -35,12 +34,12 @@ rescue NameError
   begin
     require 'jbundler'
     KILLBILL_APIS.each { |api| java_import api }
-    warn 'Using JBundler to load killbill-api. This should only happen in development mode!'
-    warn "Classpath (see .jbundler/classpath.rb):\n\t#{JBUNDLER_CLASSPATH.join("\n\t")}"
+    warn 'Using JBundler to load killbill-api (see .jbundler/classpath.rb). This should only happen in development mode!'
   rescue LoadError => e
-    warn 'Unable to load killbill-api and couldn\'t find JBundler. For development purposes, make sure to run: `bundle install && jbundle install\' from the killbill gem source tree'
+    warn 'Unable to load killbill-api. For development purposes, use JBundler (create the following Jarfile: http://git.io/eobYXA and run: `bundle install && jbundle install\')'
   end
 end
 
+require 'killbill/http_servlet'
 require 'killbill/notification'
 require 'killbill/payment'

data/lib/killbill/http_servlet.rb

@@ -0,0 +1,99 @@
+gem 'rack'
+require 'rack'
+require 'rack/rewindable_input'
+
+require 'singleton'
+
+module Killbill
+  module Plugin
+    java_package 'com.ning.billing.osgi.api.http'
+    class RackHandler < Java::javax.servlet.http.HttpServlet
+      include Singleton
+
+      def configure(logger, config_ru)
+        @logger = logger
+        @app = Rack::Builder.parse_file(config_ru).first
+      end
+
+      def configured?
+        !@app.nil?
+      end
+
+      java_signature 'void service(HttpServletRequest, HttpServletResponse)'
+      def service(servlet_request, servlet_response)
+        input = Rack::RewindableInput.new(servlet_request.input_stream.to_io)
+        scheme = servlet_request.scheme
+        method = servlet_request.method
+        request_uri = servlet_request.request_uri
+        query_string = servlet_request.query_string
+        server_name = servlet_request.server_name
+        server_port = servlet_request.server_port
+        content_type = servlet_request.content_type
+        content_length = servlet_request.content_length
+
+        headers = {}
+        servlet_request.header_names.reject { |name| name =~ /^Content-(Type|Length)$/i }.each do |name|
+          headers[name] = servlet_request.get_headers(name).to_a
+        end
+
+        response_status, response_headers, response_body = rack_service(request_uri, method, query_string, input, scheme, server_name, server_port, content_type, content_length, headers)
+
+        # Set status
+        servlet_response.status = response_status
+
+        # Set headers
+        response_headers.each do |header_name, header_value|
+          case header_name
+            when /^Content-Type$/i
+              servlet_response.content_type = header_value.to_s
+            when /^Content-Length$/i
+              servlet_response.content_length = header_value.to_i
+            else
+              servlet_response.add_header(header_name.to_s, header_value.to_s)
+          end
+        end
+
+        # Write output
+        response_stream = servlet_response.output_stream
+        response_body.each { |part| response_stream.write(part.to_java_bytes) }
+        response_stream.flush rescue nil
+      ensure
+        response_body.close if response_body.respond_to? :close
+      end
+
+      def rack_service(request_uri = '/', method = 'GET', query_string = '', input = '', scheme = 'http', server_name = 'localhost', server_port = 4567, content_type = 'text/plain', content_length = 0, headers = {})
+        rack_env = {
+                'rack.version' => Rack::VERSION,
+                'rack.multithread' => true,
+                'rack.multiprocess' => false,
+                'rack.input' => input,
+                # TODO
+                'rack.errors' => java::lang::System::err.to_io,
+                'rack.logger' => java::lang::System::out.to_io,
+                'rack.url_scheme' => scheme,
+                'REQUEST_METHOD' => method,
+                'SCRIPT_NAME' => '',
+                'PATH_INFO' => request_uri,
+                'QUERY_STRING' => (query_string || ""),
+                'SERVER_NAME' => server_name,
+                'SERVER_PORT' => server_port.to_s
+        }
+
+        rack_env['CONTENT_TYPE'] = content_type unless content_type.nil?
+        rack_env['CONTENT_LENGTH']  = content_length unless content_length.nil?
+        headers.each do |name, values|
+          rack_env["HTTP_#{name.to_s.upcase.gsub(/-/,'_')}"] = values.join(',')
+        end
+
+        @app.call(rack_env)
+      end
+    end
+  end
+end
+
+# Fix bug in JRuby's handling of gems in jars (JRUBY-3986)
+class File
+  def self.mtime(path)
+    stat(path).mtime
+  end
+end

data/lib/killbill/jpayment.rb

@@ -0,0 +1,152 @@
+require 'singleton'
+
+require 'killbill/plugin'
+require 'killbill/jresponse/jpayment_response'
+require 'killbill/jresponse/jrefund_response'
+require 'killbill/jresponse/jpayment_method_response'
+require 'killbill/jresponse/jpayment_method_response_internal'
+
+
+module Killbill
+  module Plugin
+
+    java_package 'com.ning.billing.payment.plugin.api'
+    class JPayment
+
+      include Java::com.ning.billing.payment.plugin.api.PaymentPluginApi
+
+      attr_reader :real_payment
+
+      def initialize(real_class_name, services = {})
+        real_payment_class = class_from_string(real_class_name)
+        @real_payment = real_payment_class.new(services)
+      end
+
+      # TODO STEPH decide what to do the getName()
+      java_signature 'java.lang.String getName()'
+      def get_name
+      end
+
+      java_signature 'Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin processPayment(java.util.UUID, java.util.UUID, java.lang.BigDecimal, Java::com.ning.billing.util.callcontext.CallContext)'
+      def charge(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return JPaymentResponse.new(res)
+        end
+      end
+
+      java_signature 'Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin getPaymentInfo(java.util.UUID, Java::com.ning.billing.util.callcontext.TenantContext)'
+      def get_payment_info(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return JPaymentResponse.new(res)
+        end
+      end
+
+      java_signature 'Java::com.ning.billing.payment.plugin.api.RefundInfoPlugin processRefund(java.util.UUID, java.lang.BigDecimal, Java::com.ning.billing.util.callcontext.CallContext)'
+      def refund(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return JRefundResponse.new(res)
+        end
+      end
+
+      java_signature 'void addPaymentMethod(java.util.UUID, java.util.UUID, Java::com.ning.billing.payment.api.PaymentMethodPlugin, Java::boolean, Java::com.ning.billing.util.callcontext.CallContext)'
+      def add_payment_method(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return nil
+        end
+      end
+
+      java_signature 'void deletePaymentMethod(java.util.UUID, Java::com.ning.billing.util.callcontext.CallContext)'
+      def delete_payment_method(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return nil
+        end
+      end
+
+      java_signature 'Java::com.ning.billing.payment.api.PaymentMethodPlugin getPaymentMethodDetail(java.util.UUID, java.util.UUID, Java::com.ning.billing.util.callcontext.TenantContext)'
+      def get_payment_method_detail(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return JPaymentMethodResponse.new(res)
+        end
+      end
+
+      java_signature 'void setDefaultPaymentMethod(java.util.UUID kbPaymentMethodId, Java::com.ning.billing.util.callcontext.CallContext)'
+      def set_default_payment_method(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return nil
+        end
+      end
+
+      java_signature 'java.util.List getPaymentMethods(java.util.UUID, Java::boolean refreshFromGateway, Java::com.ning.billing.util.callcontext.CallContext)'
+      def get_payment_methods(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          array_res = java.util.ArrayList.new
+          res.each do |el|
+            array_res.add(JPaymentMethodResponseInternal.new(el))
+          end
+          return array_res
+        end
+      end
+
+      java_signature 'void resetPaymentMethods(java.util.List)'
+      def reset_payment_methods(*args)
+        do_call_handle_exception(__method__, *args) do |res|
+          return nil
+        end
+      end
+
+      private
+
+      def do_call_handle_exception(method_name, *args)
+        begin
+          rargs = convert_args(method_name, args)
+          res = @real_payment.send(method_name, *rargs)
+          yield(res)
+        rescue Exception => e
+          wrap_and_throw_exception(method_name, e)
+        end
+      end
+
+      def wrap_and_throw_exception(api, e)
+        raise Java::com.ning.billing.payment.plugin.api.PaymentPluginApiException.new("#{api} failure", e.message)
+      end
+
+      def class_from_string(str)
+        str.split('::').inject(Kernel) do |mod, class_name|
+          mod.const_get(class_name)
+        end
+      end
+
+      def convert_args(api, args)
+        args.collect! do |a|
+         if a.nil?
+           nil
+         elsif a.java_kind_of? java.util.UUID
+           JConverter.from_uuid(a)
+         elsif a.java_kind_of? java.math.BigDecimal
+           JConverter.from_big_decimal(a)
+         elsif a.java_kind_of? Java::com.ning.billing.payment.api.PaymentMethodPlugin
+           JConverter.from_payment_method_plugin(a)
+         elsif ((a.java_kind_of? Java::boolean) || (a.java_kind_of? java.lang.Boolean))
+           JConverter.from_boolean(a)
+         elsif a.java_kind_of? java.util.List
+           result = Array.new
+           if a.size > 0
+             first_element = a.get(0)
+             if first_element.java_kind_of? Java::com.ning.billing.payment.plugin.api.PaymentMethodInfoPlugin
+               a.each do |el|
+                 result << JConverter.from_payment_method_info_plugin(el)
+               end
+             else
+               raise Java::com.ning.billing.payment.plugin.api.PaymentPluginApiException.new("#{api} failure", "Unexpected parameter type #{first_element.class} for list")
+             end
+           end
+           result
+         else
+           raise Java::com.ning.billing.payment.plugin.api.PaymentPluginApiException.new("#{api} failure", "Unexpected parameter type #{a.class}")
+         end
+        end
+      end
+
+    end
+  end
+end

data/lib/killbill/jresponse/jconverter.rb

@@ -0,0 +1,100 @@
+
+require 'date'
+require 'killbill/response/payment_status'
+
+module Killbill
+  module Plugin
+
+    class JConverter
+
+      class << self
+
+        #
+        # Convert from ruby -> java
+        #
+        def to_uuid(uuid)
+          uuid.nil? ? nil : java.util.UUID.fromString(uuid.to_s)
+        end
+
+        def to_joda_date_time(time)
+          time.nil? ? nil : org.joda.time.DateTime.new(time.to_s)
+        end
+
+        def to_string(str)
+          str.nil? ? nil : java.lang.String.new(str)
+        end
+
+        def to_payment_plugin_status(status)
+          if status == PaymentStatus::SUCCESS
+            Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus::PROCESSED
+          elsif status == PaymentStatus::ERROR
+            Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus::ERROR
+          else
+            Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus::UNDEFINED
+          end
+        end
+
+        def to_big_decimal(amount_in_cents)
+          amount_in_cents.nil? ? java.math.BigDecimal::ZERO : java.math.BigDecimal.new('%.2f' % (amount_in_cents.to_i/100.0))
+        end
+
+        def to_boolean(b)
+          java.lang.Boolean.new(b)
+        end
+
+
+        #
+        # Convert from java -> ruby
+        #
+        def from_uuid(uuid)
+           uuid.nil? ? nil : uuid.to_s
+        end
+
+        def from_joda_date_time(joda_time)
+          if joda_time.nil?
+            return nil
+          end
+
+          fmt = org.joda.time.format.ISODateTimeFormat.date_time
+          str = fmt.print(joda_time);
+          DateTime.iso8601(str)
+        end
+
+        def from_string(str)
+          str.nil? ? nil : str.to_s
+        end
+
+        def from_payment_plugin_status(status)
+          if status == Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus::PROCESSED
+            PaymentStatus::SUCCESS
+          elsif status == Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus::ERROR
+            PaymentStatus::ERROR
+          else
+            PaymentStatus::UNDEFINED
+          end
+        end
+
+        def from_big_decimal(big_decimal)
+          big_decimal.nil? ? 0 : big_decimal.multiply(java.math.BigDecimal.valueOf(100)).to_s.to_i
+        end
+
+        def from_boolean(b)
+          if b.nil?
+            return false
+          end
+
+          b_value = (b.java_kind_of? java.lang.Boolean) ? b.boolean_value : b
+          return b_value ? true : false
+        end
+
+        def from_payment_method_plugin(payment_method_plugin)
+          JPaymentMethodResponse.to_payment_method_response(payment_method_plugin)
+        end
+
+        def from_payment_method_info_plugin(payment_method_info_plugin)
+         JPaymentMethodResponseInternal.to_payment_method_response_internal(payment_method_info_plugin)
+        end
+      end
+    end
+  end
+end

data/lib/killbill/jresponse/jpayment_method_response.rb

@@ -0,0 +1,89 @@
+require 'killbill/response/payment_method_response'
+require 'killbill/jresponse/jconverter'
+
+module Killbill
+  module Plugin
+
+    class JPaymentMethodProperty < Java::com.ning.billing.payment.api.PaymentMethodPlugin::PaymentMethodKVInfo
+
+      class << self
+        def create_from(payment_method_prop)
+
+          key = JConverter.to_string(payment_method_prop.key)
+          value = JConverter.to_string(payment_method_prop.value)
+          is_updatable = JConverter.to_boolean(payment_method_prop.is_updatable)
+          Java::com.ning.billing.payment.api.PaymentMethodPlugin::PaymentMethodKVInfo.new(key, value, is_updatable)
+        end
+
+        def to_payment_method_property(jpayment_method_prop)
+          key = JConverter.from_string(jpayment_method_prop.get_key)
+          value = JConverter.from_string(jpayment_method_prop.get_value)
+          is_updatable = JConverter.from_boolean(jpayment_method_prop.get_is_updatable)
+          PaymentMethodProperty.new(key, value, is_updatable)
+        end
+
+      end
+
+    end
+
+    java_package 'com.ning.billing.payment.api'
+    class JPaymentMethodResponse
+
+      include Java::com.ning.billing.payment.api.PaymentMethodPlugin
+
+      attr_reader :external_payment_method_id,
+                   :is_default,
+                   :properties
+
+      class << self
+        def to_payment_method_response(jpayment_method_response)
+          props = Array.new
+          jpayment_method_response.get_properties.each do |p|
+            props << JPaymentMethodProperty.to_payment_method_property(p)
+          end
+          pmid = JConverter.from_string(jpayment_method_response.get_external_payment_method_id)
+          default = JConverter.from_boolean(jpayment_method_response.is_default_payment_method)
+          PaymentMethodResponse.new(pmid, default, props)
+        end
+
+      end
+
+      def initialize(payment_method_response)
+        @external_payment_method_id = JConverter.to_string(payment_method_response.external_payment_method_id)
+        @is_default = JConverter.to_boolean(payment_method_response.is_default)
+        @properties = java.util.ArrayList.new
+        payment_method_response.properties.each do |p|
+          jp = JPaymentMethodProperty.create_from(p)
+          @properties.add(jp)
+        end
+      end
+
+      java_signature 'java.lang.String getExternalPaymentMethodId()'
+      def get_external_payment_method_id
+        @external_payment_method_id
+      end
+
+      java_signature 'java.lang.Boolean isDefaultPaymentMethod()'
+      def is_default_payment_method
+        @is_default
+      end
+
+      java_signature 'java.util.List getProperties()'
+      def get_properties
+        @properties
+      end
+
+      java_signature 'java.lang.String getValueString(java.lang.String)'
+      def get_value_string(key)
+        @properties.each do |p|
+          if p.key == key
+            return p
+          end
+        end
+        nil
+      end
+
+    end
+
+  end
+end