killbill-payment-test 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c58a089b0e1054f39f3c674ca442797217d1872
-  data.tar.gz: 7277e0b8ea2176d94ab9c7385b043efdf41f9ef6
+  metadata.gz: d15b07f1b2de9e55be2aa7410ef913d44efc7560
+  data.tar.gz: dd473f58c669eef5749980bd8a4b7ceb877ed6e5
 SHA512:
-  metadata.gz: 9057caeec3e173541c224de8f7b1eea3e30bea09e1b4880675f3cd22998bfd4b872c7533fecad1f942d9b65a902f5ccf8b4df56b019a3f0629d86332ed7f3b5a
-  data.tar.gz: 10a5732bbefd7367621c45bf2e420d73af8f1eb9ce2b6ac6367f8abbac8d0e169a0dc2ce5d57a63ed076eaff637e51379a936be37445064ebcae11c484d5f3bc
+  metadata.gz: e5d2781cd1fb3da583cae4d285d52989e9f540f0d40fbc3109e8ce457c5cff9df63053f51a6fcf584ab8d077faf0ada3a67f47816364f45415b15f703cdcc341
+  data.tar.gz: 2d59e5316912603f004a9d83a9153e520654918c6717a1eeea3f346b8c4fe29c16aaf975cff8c24bbc2cbf671380f8814fd81931e7e78bfccca1fda12fae67e0

data/VERSION

@@ -1 +1 @@
-1.8.3
+1.8.4

data/lib/payment_test/api.rb

@@ -1,79 +1,40 @@
-module PaymentTest
-  class PaymentPlugin < Killbill::Plugin::Payment
-
-    def purchase_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
-      build_transaction_info :PURCHASE, kb_payment_id, kb_payment_transaction_id, amount, currency
-    end
-
-    def get_payment_info(kb_account_id, kb_payment_id, properties, context)
-      [build_transaction_info(:PURCHASE, kb_payment_id)]
-    end
-
-    def refund_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
-      build_transaction_info :REFUND, kb_payment_id, kb_payment_transaction_id, amount, currency
-    end
-
-    def get_refund_info(kb_account_id, kb_payment_id, properties, context)
-      build_transaction_info :REFUND, kb_payment_id
-    end
-
-    def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context)
-    end
+require 'payment_test/api_beatrix'
+require 'payment_test/api_control'
 
-    def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context)
-    end
-
-    def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context)
-      res                            = Killbill::Plugin::Model::PaymentMethodPlugin.new
-      res.kb_payment_method_id       = "9e3ff858-809d-4d12-a1fa-da789e0841d"
-      res.external_payment_method_id = "external_payment_method_id"
-      res.is_default_payment_method  = true
-      properties                     = []
-      prop1                          = Killbill::Plugin::Model::PluginProperty.new
-      prop1.key                      = "key1"
-      prop1.value                    = "value1"
-      properties << prop1
-      prop2       = Killbill::Plugin::Model::PluginProperty.new
-      prop2.key   = "key2"
-      prop2.value = "value2"
-      properties << prop2
-      res.properties=properties
-      res
-    end
-
-    def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context)
-    end
-
-    def get_payment_methods(kb_account_id, refresh_from_gateway, properties, context)
-      res                            = Killbill::Plugin::Model::PaymentMethodInfoPlugin.new
-      res.account_id                 = kb_account_id
-      res.payment_method_id          = kb_account_id
-      res.is_default                 = true
-      res.external_payment_method_id = "external_payment_method_id"
-      [res]
-    end
-
-    def search_payment_methods(search_key, offset = 0, limit = 100, properties, context)
-      [get_payment_method_detail(nil, nil, properties, context)]
-    end
-
-    private
+module PaymentTest
 
-    def build_transaction_info(transaction_type, kb_payment_id, kb_payment_transaction_id=nil, amount=0, currency=:USD)
-      res                             = Killbill::Plugin::Model::PaymentTransactionInfoPlugin.new
-      res.kb_payment_id               = kb_payment_id
-      res.kb_transaction_payment_id   = kb_payment_transaction_id
-      res.transaction_type            = transaction_type
-      res.amount                      = amount
-      res.currency                    = currency
-      res.created_date                = DateTime.now
-      res.effective_date              = DateTime.now
-      res.status                      = :PROCESSED
-      res.gateway_error               = "gateway_error"
-      res.gateway_error_code          = "gateway_error_code"
-      res.first_payment_reference_id  = "first_payment_reference_id"
-      res.second_payment_reference_id = "second_payment_reference_id"
-      res
+  #
+  # Note we don't inherit Killbill::Plugin::Payment < Killbill::Plugin::PluginBase, but we inherit straight Killbill::Plugin::PluginBase
+  # to bypass the definition of all the APIs, which by default raise OperationUnsupportedByGatewayError. That way, any API call
+  # goes straight into method_missing, and the correct delegate dispatching can happen.
+  #
+  class PaymentPlugin < Killbill::Plugin::PluginBase
+    attr_reader :api_beatrix, :api_control
+
+    def initialize
+      super
+      @api_beatrix = PaymentPluginBeatrix.new(self)
+      @api_control = PaymentPluginControl.new(self)
+    end
+
+
+    def method_missing(method, *args, &block)
+      # properties is always the second last argument right before context
+      properties = args[args.length - 2]
+
+      if  properties && (!properties.is_a? Hash)
+        raise ArgumentError.new "properties should be a Hash"
+      end
+
+      # Default to Beatrix (nil properties, no key specified, or explicit key)
+      if properties.nil? ||
+          (!properties.has_key? 'TEST_MODE') ||
+          properties['TEST_MODE'] == 'BEATRIX'
+        @api_beatrix.send method, *args
+      else
+        @api_control.sleep_if_required properties
+        @api_control.send method, *args
+      end
     end
   end
 end

data/lib/payment_test/api_beatrix.rb

@@ -0,0 +1,108 @@
+module PaymentTest
+  class PaymentPluginBeatrix
+
+    attr_reader :parent
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+
+    def authorize_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+    end
+
+    def capture_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+    end
+
+    def purchase_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      build_transaction_info :PURCHASE, kb_payment_id, kb_payment_transaction_id, amount, currency
+    end
+
+    def void_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, properties, context)
+    end
+
+    def credit_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+    end
+
+    def refund_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      build_transaction_info :REFUND, kb_payment_id, kb_payment_transaction_id, amount, currency
+    end
+
+    def get_payment_info(kb_account_id, kb_payment_id, properties, context)
+      [build_transaction_info(:PURCHASE, kb_payment_id)]
+    end
+
+    def search_payments(searchKey, offset, limit, properties, context)
+      [get_payment_method_detail(nil, nil, properties, context)]
+    end
+
+    def add_payment_method(kb_account_id, kb_payment_method_id, paymentMethodProps, setDefault, properties, context)
+    end
+
+    def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+    end
+
+    def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context)
+      res = Killbill::Plugin::Model::PaymentMethodPlugin.new
+      res.kb_payment_method_id = "9e3ff858-809d-4d12-a1fa-da789e0841d"
+      res.external_payment_method_id = "external_payment_method_id"
+      res.is_default_payment_method = true
+      properties = []
+      prop1 = Killbill::Plugin::Model::PluginProperty.new
+      prop1.key = "key1"
+      prop1.value = "value1"
+      properties << prop1
+      prop2 = Killbill::Plugin::Model::PluginProperty.new
+      prop2.key = "key2"
+      prop2.value = "value2"
+      properties << prop2
+      res.properties=properties
+      res
+    end
+
+    def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+    end
+
+    def get_payment_methods(kb_account_id, refreshFromGateway, properties, context)
+      res = Killbill::Plugin::Model::PaymentMethodInfoPlugin.new
+      res.account_id = kb_account_id
+      res.payment_method_id = kb_account_id
+      res.is_default = true
+      res.external_payment_method_id = "external_payment_method_id"
+      [res]
+    end
+
+    def search_payment_methods(searchKey, offset, limit, properties, context)
+      [Killbill::Plugin::Model::PaymentMethodInfoPlugin.new]
+    end
+
+    def reset_payment_methods(kb_account_id, paymentMethods, properties, context)
+    end
+
+    def build_form_descriptor(kb_account_id, customFields, properties, context)
+    end
+
+    def process_notification(notification, properties, context)
+    end
+
+
+    private
+
+    def build_transaction_info(transaction_type, kb_payment_id, kb_payment_transaction_id=nil, amount=0, currency=:USD)
+      res = Killbill::Plugin::Model::PaymentTransactionInfoPlugin.new
+      res.kb_payment_id = kb_payment_id
+      res.kb_transaction_payment_id = kb_payment_transaction_id
+      res.transaction_type = transaction_type
+      res.amount = amount
+      res.currency = currency
+      res.created_date = DateTime.now
+      res.effective_date = DateTime.now
+      res.status = :PROCESSED
+      res.gateway_error = "gateway_error"
+      res.gateway_error_code = "gateway_error_code"
+      res.first_payment_reference_id = "first_payment_reference_id"
+      res.second_payment_reference_id = "second_payment_reference_id"
+      res
+    end
+  end
+end

data/lib/payment_test/api_control.rb

@@ -0,0 +1,146 @@
+module PaymentTest
+  class PaymentPluginControl
+
+
+    class Payment
+      attr_reader :kb_account_id, :kb_payment_id, :transactions
+
+      def initialize(kb_account_id, kb_payment_id)
+        @kb_account_id = kb_account_id
+        @kb_payment_id = kb_payment_id
+        @transactions = Array.new
+      end
+
+      def add_transaction(transaction)
+        @transactions << transaction
+      end
+    end
+
+    attr_reader :parent, :payments
+
+    def initialize(parent)
+      @parent = parent
+      @payments = Hash.new
+    end
+
+    def authorize_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :AUTHORIZE, amount, currency, properties)
+    end
+
+    def capture_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :CAPTURE, amount, currency, properties)
+    end
+
+    def purchase_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :PURCHASE, amount, currency, properties)
+    end
+
+    def void_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :VOID, amount, currency, properties)
+    end
+
+    def credit_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :CREDIT, amount, currency, properties)
+    end
+
+    def refund_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+      add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, :REFUND, amount, currency, properties)
+    end
+
+    def get_payment_info(kb_account_id, kb_payment_id, properties, context)
+      @payments[kb_payment_id].transactions
+    end
+
+    def search_payments(search_key, offset, limit, properties, context)
+      raise NotImplementedError.new("search_payments not implemented")
+    end
+
+    def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context)
+      # Noop
+    end
+
+    def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+      # Noop
+    end
+
+    def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context)
+      payment_method = ::Killbill::Plugin::Model::PaymentMethodInfoPlugin.new
+      payment_method.account_id = kb_account_id
+      payment_method.payment_method_id = kb_payment_method_id
+      payment_method
+    end
+
+    def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context)
+      # Noop
+    end
+
+    def get_payment_methods(kb_account_id, refresh_from_gateway, properties, context)
+      raise NotImplementedError.new("get_payment_methods not implemented")
+    end
+
+    def search_payment_methods(search_key, offset, limit, properties, context)
+      raise NotImplementedError.new("search_payment_methods not implemented")
+    end
+
+    def reset_payment_methods(kb_account_id, payment_methods, properties, context)
+      # Noop
+    end
+
+    def build_form_descriptor(kb_account_id, customFields, properties, context)
+      raise NotImplementedError.new("build_form_descriptor not implemented")
+    end
+
+    def process_notification(notification, properties, context)
+      # Noop
+    end
+
+
+    def sleep_if_required(properties)
+      if properties.nil? ||
+          (!properties.has_key? 'SLEEP_TIME_SEC')
+        return
+      end
+
+      sleep_time = properties['SLEEP_TIME_SEC']
+      @parent.logger "PaymentPluginControl sleeping #{sleep_time}"
+      sleep sleep_time
+    end
+
+    private
+
+    def get_or_create_payment(kb_account_id, kb_payment_id)
+      if !@payments.has_key? kb_payment_id
+        new_payment = Payment.new(kb_account_id, kb_payment_id)
+        @payments[kb_payment_id] = new_payment
+      end
+      @payments[kb_payment_id]
+    end
+
+    def add_transaction(kb_account_id, kb_payment_id, kb_transaction_id, transaction_type, amount, currency, properties)
+
+      payment = get_or_create_payment(kb_account_id, kb_payment_id)
+
+      transaction = ::Killbill::Plugin::Model::PaymentTransactionInfoPlugin.new
+      transaction.kb_payment_id = kb_payment_id
+      transaction.kb_transaction_payment_id = kb_transaction_id
+
+      transaction.transaction_type = transaction_type
+      transaction.amount = amount
+      transaction.currency = currency
+      transaction.status = status_from_properties(properties)
+
+      payment.add_transaction(transaction)
+      transaction
+    end
+
+
+    def status_from_properties(properties)
+      if properties.nil? ||
+          (!properties.has_key? 'TRANSACTION_STATUS')
+        return :PROCESSED
+      else
+        properties['TRANSACTION_STATUS'].to_sym
+      end
+    end
+  end
+end

data/pom.xml

@@ -27,7 +27,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>payment-test-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>1.8.3</version>
+    <version>1.8.4</version>
     <name>payment-test-plugin</name>
     <description></description>
     <scm>

data/spec/payment_test/base_plugin_spec.rb

@@ -5,6 +5,7 @@ require 'payment_test'
 
 describe PaymentTest::PaymentPlugin do
   before(:each) do
+
     kb_apis = Killbill::Plugin::KillbillApi.new("killbill-payment-test", {})
     @plugin = PaymentTest::PaymentPlugin.new
     @plugin.logger = Logger.new(STDOUT)
@@ -25,7 +26,7 @@ describe PaymentTest::PaymentPlugin do
   end
 
   it "should test charge" do
-    output = @plugin.purchase_payment(@kb_account_id, @kb_payment_id, @kb_payment_transaction_id, @kb_payment_method_id, @amount_in_cents, @currency, [], @call_context)
+    output = @plugin.purchase_payment(@kb_account_id, @kb_payment_id, @kb_payment_transaction_id, @kb_payment_method_id, @amount_in_cents, @currency, nil, @call_context)
 
     output.should be_an_instance_of Killbill::Plugin::Model::PaymentTransactionInfoPlugin
     output.amount.should == @amount_in_cents
@@ -35,4 +36,32 @@ describe PaymentTest::PaymentPlugin do
   it "should test search" do
     @plugin.search_payment_methods("blah", 0, 100, nil, @call_context).size.should == 1
   end
+
+  it "should test control api" do
+    properties = Hash.new
+    properties['TEST_MODE'] = 'CONTROL'
+    transaction1 = @plugin.authorize_payment(@kb_account_id, @kb_payment_id, @kb_payment_transaction_id, @kb_payment_method_id, @amount_in_cents, @currency, properties, @call_context)
+
+    transaction1.should be_an_instance_of Killbill::Plugin::Model::PaymentTransactionInfoPlugin
+    transaction1.kb_payment_id.should == @kb_payment_id
+    transaction1.kb_transaction_payment_id.should == @kb_payment_transaction_id
+    transaction1.amount.should == @amount_in_cents
+    transaction1.currency.should == @currency
+    transaction1.transaction_type.should == :AUTHORIZE
+    transaction1.status.should == :PROCESSED
+
+    properties['TRANSACTION_STATUS'] = 'ERROR'
+
+    transaction2 = @plugin.capture_payment(@kb_account_id, @kb_payment_id, @kb_payment_transaction_id, @kb_payment_method_id, @amount_in_cents, @currency, properties, @call_context)
+    transaction2.kb_payment_id.should == @kb_payment_id
+    transaction2.kb_transaction_payment_id.should == @kb_payment_transaction_id
+    transaction2.amount.should == @amount_in_cents
+    transaction2.currency.should == @currency
+    transaction2.transaction_type.should == :CAPTURE
+    transaction2.status.should == :ERROR
+
+    transactions = @plugin.get_payment_info(@kb_account_id, @kb_payment_id,  properties, @call_context)
+    transactions.size.should == 2
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-payment-test
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -83,6 +83,8 @@ files:
 - killbill.properties
 - lib/payment_test.rb
 - lib/payment_test/api.rb
+- lib/payment_test/api_beatrix.rb
+- lib/payment_test/api_control.rb
 - pom.xml
 - release.sh
 - spec/payment_test/base_plugin_spec.rb