killbill 1.0.0 → 1.0.1

data/lib/killbill/jresponse/jpayment_method_response_internal.rb

@@ -0,0 +1,54 @@
+require 'killbill/response/payment_method_response_internal'
+require 'killbill/jresponse/jconverter'
+
+module Killbill
+  module Plugin
+
+    java_package 'com.ning.billing.payment.plugin.api'
+    class JPaymentMethodResponseInternal
+
+      include Java::com.ning.billing.payment.plugin.api.PaymentMethodInfoPlugin
+      attr_reader :kb_account_id,
+                   :kb_payment_method_id,
+                   :is_default
+                   :external_payment_method_id
+
+      class << self
+        def to_payment_method_response_internal(jinfo)
+          account_id = JConverter.from_uuid(jinfo.get_account_id)
+          payment_method_id = JConverter.from_uuid(jinfo.get_payment_method_id)
+          is_default = JConverter.from_boolean(jinfo.is_default)
+          external_payment_method_id = JConverter.from_string(jinfo.get_external_payment_method_id)
+          PaymentMethodResponseInternal.new(account_id, payment_method_id, is_default, external_payment_method_id)
+        end
+      end
+
+      def initialize(payment_method_response_internal)
+        @kb_account_id = JConverter.to_uuid(payment_method_response_internal.kb_account_id)
+        @kb_payment_method_id = JConverter.to_uuid(payment_method_response_internal.kb_payment_method_id)
+        @is_default = JConverter.to_boolean(payment_method_response_internal.is_default)
+        @external_payment_method_id = JConverter.to_string(payment_method_response_internal.external_payment_method_id)
+      end
+
+      java_signature 'java.lang.UUID getAccountId()'
+      def get_account_id
+        @kb_account_id
+      end
+
+      java_signature 'java.lang.UUID getPaymentMethodId()'
+      def get_payment_method_id
+        @kb_payment_method_id
+      end
+
+      java_signature 'java.lang.Boolean isDefault()'
+      def is_default
+        @is_default
+      end
+
+      java_signature 'java.lang.String getExternalPaymentMethodId()'
+      def get_external_payment_method_id
+        @external_payment_method_id
+      end
+    end
+  end
+end

data/lib/killbill/jresponse/jpayment_response.rb

@@ -0,0 +1,59 @@
+require 'killbill/response/payment_response'
+require 'killbill/jresponse/jconverter'
+
+module Killbill
+  module Plugin
+
+    java_package 'com.ning.billing.payment.plugin.api'
+    class JPaymentResponse
+
+      include Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin
+
+      attr_reader :amount,
+                  :created_date,
+                  :effective_date,
+                  :status,
+                  :gateway_error,
+                  :gateway_error_code
+
+      def initialize(payment_response)
+        @amount = JConverter.to_big_decimal(payment_response.amount_in_cents)
+        @created_date = JConverter.to_joda_date_time(payment_response.created_date)
+        @effective_date = JConverter.to_joda_date_time(payment_response.effective_date)
+        @status = JConverter.to_payment_plugin_status(payment_response.status)
+        @gateway_error = JConverter.to_string(payment_response.gateway_error)
+        @gateway_error_code = JConverter.to_string(payment_response.gateway_error_code)
+      end
+
+      java_signature 'java.math.BigDecimal getAmount()'
+      def get_amount
+        @amount
+      end
+
+      java_signature 'org.joda.time.DateTime getCreatedDate()'
+      def get_created_date
+        @created_date
+      end
+
+      java_signature 'org.joda.time.DateTime getEffectiveDate()'
+      def get_effective_date
+        @effective_date
+      end
+
+      java_signature 'Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus getStatus()'
+      def get_status
+        @status
+      end
+
+      java_signature 'java.lang.String getGatewayError()'
+      def get_gateway_error
+        @gateway_error
+      end
+
+      java_signature 'java.lang.String getGatewayErrorCode()'
+      def get_gateway_error_code
+        @gateway_error_code
+      end
+    end
+  end
+end

data/lib/killbill/jresponse/jrefund_response.rb

@@ -0,0 +1,60 @@
+require 'killbill/response/refund_response'
+require 'killbill/jresponse/jconverter'
+
+module Killbill
+  module Plugin
+
+    java_package 'com.ning.billing.payment.plugin.api'
+    class JRefundResponse
+
+      include Java::com.ning.billing.payment.plugin.api.RefundInfoPlugin
+
+      attr_reader :amount,
+                  :created_date,
+                  :effective_date,
+                  :status,
+                  :gateway_error,
+                  :gateway_error_code
+
+      def initialize(refund_response)
+        @amount = JConverter.to_big_decimal(refund_response.amount_in_cents)
+        @created_date = JConverter.to_joda_date_time(refund_response.created_date)
+        @effective_date = JConverter.to_joda_date_time(refund_response.effective_date)
+        @status = JConverter.to_payment_plugin_status(refund_response.status)
+        @gateway_error = JConverter.to_string(refund_response.gateway_error)
+        @gateway_error_code = JConverter.to_string(refund_response.gateway_error_code)
+      end
+
+
+      java_signature 'java.math.BigDecimal getAmount()'
+      def get_amount
+        @amount
+      end
+
+      java_signature 'org.joda.time.DateTime getCreatedDate()'
+      def get_created_date
+        @created_date
+      end
+
+      java_signature 'org.joda.time.DateTime getEffectiveDate()'
+      def get_effective_date
+        @effective_date
+      end
+
+      java_signature 'Java::com.ning.billing.payment.plugin.api.PaymentInfoPlugin::PaymentPluginStatus getStatus()'
+      def get_status
+        @status
+      end
+
+      java_signature 'java.lang.String getGatewayError()'
+      def get_gateway_error
+        @gateway_error
+      end
+
+      java_signature 'java.lang.String getGatewayErrorCode()'
+      def get_gateway_error_code
+        @gateway_error_code
+      end
+   end
+  end
+end

data/lib/killbill/logger.rb

@@ -0,0 +1,44 @@
+# Plugin logger that will delegate to the OSGI LogService
+module Killbill
+  module Plugin
+    class Logger
+      def initialize(delegate)
+        @logger = delegate
+      end
+
+      def debug(msg)
+        @logger.log(4, msg)
+      end
+
+      def info(msg)
+        @logger.log(3, msg)
+      end
+
+      def warn(msg)
+        @logger.log(2, msg)
+      end
+
+      def error(msg)
+        @logger.log(1, msg)
+      end
+
+      alias_method :fatal, :error
+
+      # XXX TODO
+      def debug?
+        false
+      end
+
+      def info?
+        true
+      end
+
+      def warn?
+        true
+      end
+
+      alias_method :error?, :warn?
+      alias_method :fatal?, :error?
+    end
+  end
+end

data/lib/killbill/payment.rb

@@ -1,4 +1,5 @@
 require 'killbill/plugin'
+require 'killbill/response/payment_response'
 
 module Killbill
   module Plugin
@@ -7,38 +8,45 @@ module Killbill
       class OperationUnsupportedByGatewayError < NotImplementedError
       end
 
-      def charge(external_account_key, killbill_payment_id, amount_in_cents, options = {})
+      def get_name
         raise OperationUnsupportedByGatewayError
       end
 
-      def refund(external_account_key, killbill_payment_id, amount_in_cents, options = {})
+      def charge(kb_payment_id, kb_payment_method_id, amount_in_cents, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def get_payment_info(killbill_payment_id, options = {})
+      def get_payment_info(kb_payment_id, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def add_payment_method(external_account_key, payment_method, options = {})
+      def refund(kb_payment_id, amount_in_cents, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def delete_payment_method(external_account_key, external_payment_method_id, options = {})
+      def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def update_payment_method(external_account_key, payment_method, options = {})
+      def delete_payment_method(kb_payment_method_id, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def set_default_payment_method(external_account_key, payment_method, options = {})
+      def get_payment_method_detail(kb_account_id, kb_payment_method_id, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
-      def create_account(killbill_account, options = {})
+      def set_default_payment_method(kb_payment_method_id, options = {})
         raise OperationUnsupportedByGatewayError
       end
 
+      def get_payment_methods(kb_account_id, options = {})
+        raise OperationUnsupportedByGatewayError
+      end
+
+      def reset_payment_methods(payment_methods)
+        raise OperationUnsupportedByGatewayError
+      end
     end
   end
 end

data/lib/killbill/plugin.rb

@@ -1,3 +1,6 @@
+require 'killbill/http_servlet'
+require 'killbill/logger'
+
 module Killbill
   # There are various types of plugins one can write for Killbill:
   #
@@ -18,47 +21,77 @@ module Killbill
         @active = false
       end
 
-      attr_accessor :account_user_api,
-                    :analytics_sanity_api,
-                    :analytics_user_api,
-                    :catalog_user_api,
-                    :entitlement_migration_api,
-                    :entitlement_timeline_api,
-                    :entitlement_transfer_api,
-                    :entitlement_user_api,
-                    :invoice_migration_api,
-                    :invoice_payment_api,
-                    :invoice_user_api,
-                    :meter_user_api,
-                    :overdue_user_api,
-                    :payment_api,
-                    :tenant_user_api,
-                    :usage_user_api,
-                    :audit_user_api,
-                    :custom_field_user_api,
-                    :export_user_api,
-                    :tag_user_api
+      attr_writer :account_user_api,
+                  :analytics_sanity_api,
+                  :analytics_user_api,
+                  :catalog_user_api,
+                  :entitlement_migration_api,
+                  :entitlement_timeline_api,
+                  :entitlement_transfer_api,
+                  :entitlement_user_api,
+                  :invoice_migration_api,
+                  :invoice_payment_api,
+                  :invoice_user_api,
+                  :meter_user_api,
+                  :overdue_user_api,
+                  :payment_api,
+                  :tenant_user_api,
+                  :usage_user_api,
+                  :audit_user_api,
+                  :custom_field_user_api,
+                  :export_user_api,
+                  :tag_user_api
+      # Extra services
+      attr_accessor :root,
+                    :logger
 
       # Called by the Killbill lifecycle when instantiating the plugin
-      def initialize(apis_map = {})
+      def initialize(services = {})
         @active = false
 
-        apis_map.each do |api_name, api_instance|
+        services.each do |service_name, service_instance|
           begin
-            self.send("#{api_name}=", api_instance)
+            self.send("#{service_name}=", service_instance)
           rescue NoMethodError
-            warn "Ignoring unsupported API: #{api_name}"
+            warn "Ignoring unsupported service: #{service_name}"
           end
         end
       end
 
+      def logger=(logger)
+        @logger = Killbill::Plugin::Logger.new(logger)
+      end
+
+      # Called by the Killbill lifecycle to register the servlet
+      def rack_handler
+        config_ru = Pathname.new("#{@root}/config.ru").expand_path
+        if config_ru.file?
+          @logger.info "Found Rack configuration file at #{config_ru.to_s}"
+          instance = Killbill::Plugin::RackHandler.instance
+          instance.configure(@logger, config_ru.to_s) unless instance.configured?
+          instance
+        else
+          @logger.info "No Rack configuration file found at #{config_ru.to_s}"
+          nil
+        end
+      end
+
       class APINotAvailableError < NotImplementedError
       end
 
       def method_missing(m, *args, &block)
-        raise APINotAvailableError.new("API #{m} is not available") if m =~ /_api$/
+        # m being a symbol, to_s is required for Ruby 1.8
+        if m.to_s =~ /_api$/
+          api = self.instance_variable_get("@#{m.to_s}")
+          if api.nil?
+            raise APINotAvailableError.new("API #{m} is not available")
+          else
+            api
+          end
+        else
+          raise NoMethodError.new("undefined method `#{m}' for #{self}")
+        end
       end
-
     end
   end
 end

data/lib/killbill/rake_task.rb

@@ -44,8 +44,8 @@ module Killbill
       # Note the Killbill friendly structure (which we will keep in the tarball)
       @target_dir = @package_dir.join("#{version}/gems").expand_path
 
-      # Staging area to install the killbill.properties file
-      @killbill_properties_target_dir = @package_dir.join("#{version}").expand_path
+      # Staging area to install the killbill.properties and config.ru files
+      @plugin_root_target_dir = @package_dir.join("#{version}").expand_path
     end
 
     def specs
@@ -58,6 +58,7 @@ module Killbill
     def install
       namespace :killbill do
         desc "Validate plugin tree"
+        # The killbill.properties file is required, but not the config.ru one
         task :validate => killbill_properties_file do
           validate
         end
@@ -72,7 +73,7 @@ module Killbill
         desc "Stage all dependencies"
         task :stage => :validate do
           stage_dependencies
-          stage_killbill_properties_file
+          stage_extra_files
 
           # Small hack! Update the list of files to package (Rake::FileList is evaluated too early above)
           package_task.package_files = Rake::FileList.new("#{@package_dir.basename}/**/*")
@@ -166,20 +167,38 @@ module Killbill
         # For the plugin itself, install it manually (the cache path is likely to be wrong)
         next if spec.name == name and spec.version == version
         @logger.debug "Staging #{spec.name} (#{spec.version}) from #{spec.cache_file}"
-        Gem::Installer.new(spec.cache_file, {:force => true, :install_dir => @target_dir}).install
+        begin
+          Gem::Installer.new(spec.cache_file, {:force => true, :install_dir => @target_dir}).install
+        rescue => e
+          @logger.warn "Unable to stage #{spec.name} (#{spec.version}) from #{spec.cache_file}: #{e}"
+        end
       end
 
       @logger.debug "Staging #{name} (#{version}) from #{@plugin_gem_file}"
       Gem::Installer.new(@plugin_gem_file, {:force => true, :install_dir => @target_dir}).install
     end
 
-    def stage_killbill_properties_file
-      @logger.debug "Staging #{killbill_properties_file} to #{@killbill_properties_target_dir}"
-      cp killbill_properties_file, @killbill_properties_target_dir
+    def stage_extra_files
+      unless killbill_properties_file.nil?
+        @logger.debug "Staging #{killbill_properties_file} to #{@plugin_root_target_dir}"
+        cp killbill_properties_file, @plugin_root_target_dir
+      end
+      unless config_ru_file.nil?
+        @logger.debug "Staging #{config_ru_file} to #{@plugin_root_target_dir}"
+        cp config_ru_file, @plugin_root_target_dir
+      end
     end
 
     def killbill_properties_file
-      @base.join("killbill.properties").expand_path.to_s
+      path_to_string @base.join("killbill.properties").expand_path
+    end
+
+    def config_ru_file
+      path_to_string @base.join("config.ru").expand_path
+    end
+
+    def path_to_string(path)
+      path.file? ? path.to_s : nil
     end
   end
 end