knp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c079e51495b1cd0b1427d622d5473ce85b0c00b
-  data.tar.gz: 3475b42afea5d212cf632f7163cf5f46c1b3ada3
+  metadata.gz: b677aa9e2cf218bc79121fbfda2ae8a9c9421847
+  data.tar.gz: e62b3fd5a487642f35a6628afa53195b87ed92a0
 SHA512:
-  metadata.gz: c1059bed7fc0cdd0a55578336a66dc34949bb627ed82a199c1b4d364437f728a98783b7ec88bbd7cd080d7b80a219fb77ff32d2f9762820f037ca5edae0e54be
-  data.tar.gz: 5e49acb6f45f13a558466475871aa52b3f8eb001d2b83f8ed311db9d63b90027a55f1e939aee590b53c390d01e46a0d8c520f7bd6a82af2dd6aaef2a89ecd062
+  metadata.gz: d428958832a4fae788865db46d537b40d6a4f538c1e9ba853734ea5420350e7cf97313b2a1973435678b453122d88332d8a020c17d604c2801c72c43316add59
+  data.tar.gz: 39044bba32f2ff5b64e8823508fe224e0ae9de27a4c25b25ed05334ecc2c2c91f6cccfecf6d799c2ec1020b27d49ff2da52200fedbfc6c539c131798626c55c1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    knp (0.0.1)
-      killbill-client (~> 0.8.0)
+    knp (0.0.2)
+      killbill-client (~> 0.10.2)
       rails (~> 3.2.0)
 
 GEM
@@ -45,7 +45,7 @@ GEM
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
     json (1.8.1)
-    killbill-client (0.8.1)
+    killbill-client (0.10.2)
       json (>= 1.2.0)
     mail (2.5.4)
       mime-types (~> 1.16)

data/README.md

@@ -3,6 +3,17 @@ Knp
 
 The Kill Bill Notifications Proxy is a Rails mountable engine that can be exposed on a public IP to process notifications from gateways.
 
+Assuming your Knp public address is killbill-public.acme.com, configure the notification URL in the gateway to be killbill-public.acme.com/notifications/_plugin-name_:
+
+* https://killbill-public.acme.com/notifications/killbill-adyen
+* https://killbill-public.acme.com/notifications/killbill-bitpay
+
+ If you have multiple Kill Bill clusters, you can specify an optional cluster parameter in the path (see also the configuration section):
+
+* https://killbill-public.acme.com/notifications/killbill-adyen/europe
+* https://killbill-public.acme.com/notifications/killbill-adyen/us
+* https://killbill-public.acme.com/notifications/killbill-bitpay/europe
+* https://killbill-public.acme.com/notifications/killbill-bitpay/us
 
 Mounting Knp into your own Rails app
 ------------------------------------
@@ -14,6 +25,43 @@ Mounting Knp into your own Rails app
 Configuration
 -------------
 
+### Using a configuration file
+
+Create a file ```config/knp.yml```:
+
+```
+development:
+  killbill:
+    base_uri: http://127.0.0.1:8080/
+    api_key: bob
+    api_secret: lazar
+    username: admin
+    password: password
+```
+
+Check out the [symmetric-encryption](https://github.com/reidmorrison/symmetric-encryption) gem for encrypting the password.
+
+If you have multiple Kill Bill clusters:
+
+```
+development:
+  killbill:
+    us:
+      base_uri: http://killbill-us.acme.com:8080/
+      api_key: bob_us
+      api_secret: lazar_us
+      username: admin
+      password: password
+    europe:
+      base_uri: http://killbill-europe.acme:8080/
+      api_key: bob_europe
+      api_secret: lazar_europe
+      username: admin
+      password: password
+```
+
+### Using code
+
 Specify your Kill Bill server configuration in ```config/initializers/killbill_client.rb```:
 
 ```

data/app/controllers/knp/notifications_controller.rb

@@ -2,12 +2,8 @@ module Knp
   class NotificationsController < ApplicationController
 
     # Catch-all
-    #
-    # Assuming your KNP public address is killbill-public.acme.com, configure the notification
-    # URL in the gateway to be: killbill-public.acme.com/notifications/<plugin-name>.
-    # Examples: killbill-public.acme.com/notifications/killbill-adyen, killbill-public.acme.com/notifications/killbill-bitpay
     def notify
-      notification = build_notification(params[:plugin_name])
+      notification = build_notification(params[:plugin_name], params[:cluster])
       kb_response  = notification.notify!
       build_response(kb_response)
     rescue => e
@@ -17,8 +13,8 @@ module Knp
 
     private
 
-    def build_notification(plugin_name)
-      notification             = Notification.new
+    def build_notification(plugin_name, cluster)
+      notification             = Notification.new(cluster)
       notification.plugin_name = plugin_name
       notification.body        = request.body.read
       notification.params      = request.query_parameters

data/app/models/knp/notification.rb

@@ -8,19 +8,21 @@ module Knp
     attr_accessor :user
     attr_accessor :reason
     attr_accessor :comment
+    attr_accessor :base_uri
     attr_accessor :api_key
     attr_accessor :api_secret
     attr_accessor :username
     attr_accessor :password
 
-    def initialize
-      self.user       = Knp.user || 'Knp'
-      self.reason     = Knp.reason
-      self.comment    = Knp.comment
-      self.api_key    = Knp.api_key
-      self.api_secret = Knp.api_secret
-      self.username   = Knp.username
-      self.password   = Knp.password
+    def initialize(cluster=nil)
+      self.user       = KNP_CONFIG.username(cluster)
+      self.reason     = KNP_CONFIG.reason(cluster)
+      self.comment    = KNP_CONFIG.comment(cluster)
+      self.base_uri   = URI.parse(KNP_CONFIG.base_uri(cluster))
+      self.api_key    = KNP_CONFIG.api_key(cluster)
+      self.api_secret = KNP_CONFIG.api_secret(cluster)
+      self.username   = KNP_CONFIG.username(cluster)
+      self.password   = KNP_CONFIG.password(cluster)
     end
 
     def notify!
@@ -51,6 +53,7 @@ module Knp
               :user       => user,
               :reason     => reason,
               :comment    => comment,
+              :base_uri   => base_uri,
               :api_key    => api_key,
               :api_secret => api_secret,
               :username   => username,

data/config/routes.rb

@@ -1,4 +1,4 @@
 Knp::Engine.routes.draw do
 
-  match '/notifications/:plugin_name', :to => 'notifications#notify', :via => [:get, :post, :put]
+  match '/notifications/:plugin_name(/:cluster)', :to => 'notifications#notify', :via => [:get, :post, :put]
 end

data/knp.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   s.add_dependency "rails", "~> 3.2.0"
-  s.add_dependency "killbill-client", "~> 0.8.0"
+  s.add_dependency "killbill-client", "~> 0.10.2"
 
   s.add_development_dependency "sqlite3"
 end

data/lib/knp.rb

@@ -1,12 +1,95 @@
-require "knp/engine"
+require 'knp/engine'
 
 module Knp
 
-  mattr_accessor :user
-  mattr_accessor :reason
-  mattr_accessor :comment
-  mattr_accessor :api_key
-  mattr_accessor :api_secret
-  mattr_accessor :username
-  mattr_accessor :password
+  class Configuration
+
+    def initialize(user_configuration_file=nil)
+      @user_configuration_file = user_configuration_file
+    end
+
+    %w(base_uri api_key api_secret username password user reason comment).each do |config_key|
+      define_method(config_key) do |cluster=nil|
+        config_value = nil
+        config_value = user_configuration_from_key('killbill', cluster, config_key) unless cluster.nil?
+        config_value ||= user_configuration_from_key('killbill', config_key)
+        config_value ||= send("default_#{config_key}")
+        config_value
+      end
+    end
+
+    protected
+
+    def default_base_uri
+      default = 'http://127.0.0.1:8080/'
+      KillBillClient.url || default
+    rescue KillBillClient::ConfigurationError
+      default
+    end
+
+    def default_api_key
+      KillBillClient.api_key || 'bob'
+    end
+
+    def default_api_secret
+      KillBillClient.api_secret || 'lazar'
+    end
+
+    def default_username
+      KillBillClient.username || 'admin'
+    end
+
+    def default_password
+      KillBillClient.password || 'password'
+    end
+
+    def default_user
+      'Knp'
+    end
+
+    def default_reason
+      nil
+    end
+
+    def default_comment
+      nil
+    end
+
+    private
+
+    #
+    # Return a specific key from the user configuration in config/knp.yml
+    #
+    # ==== Returns
+    #
+    # Mixed:: requested_key or nil
+    #
+    def user_configuration_from_key(*keys)
+      keys.inject(user_configuration) do |hash, key|
+        hash[key] if hash
+      end
+    end
+
+    #
+    # Memoized hash of configuration options for the current Rails environment
+    # as specified in config/knp.yml
+    #
+    # ==== Returns
+    #
+    # Hash:: configuration options for current environment
+    #
+    def user_configuration
+      @user_configuration ||=
+          begin
+            if !@user_configuration_file.nil? && File.exist?(@user_configuration_file)
+              File.open(@user_configuration_file) do |file|
+                processed = ERB.new(file.read).result
+                YAML.load(processed)[Rails.env]
+              end
+            else
+              {}
+            end
+          end
+    end
+  end
 end

data/lib/knp/engine.rb

@@ -9,5 +9,10 @@ require 'killbill_client'
 module Knp
   class Engine < ::Rails::Engine
     isolate_namespace Knp
+
+    initializer 'knp.load_app_root' do |app|
+      config_file = File.join(app.root, 'config', 'knp.yml') unless app.root.nil?
+      ::Knp::KNP_CONFIG = Configuration.new(config_file)
+    end
   end
 end

data/lib/knp/version.rb

@@ -1,3 +1,3 @@
 module Knp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/unit/knp/configuration_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class ConfigurationTest < ActiveSupport::TestCase
+
+  test 'configuration with defaults' do
+    verify_config('http://127.0.0.1:8080/', 'bob', 'lazar', 'admin', 'password', 'Knp', nil, nil)
+  end
+
+  test 'configuration with Kill Bill client overrides' do
+    KillBillClient.url        = 'http://127.0.0.1:9090/'
+    KillBillClient.api_key    = 'bob-override'
+    KillBillClient.api_secret = 'lazar-override'
+    KillBillClient.username   = 'admin-override'
+    KillBillClient.password   = 'password-override'
+
+    verify_config('http://127.0.0.1:9090/', 'bob-override', 'lazar-override', 'admin-override', 'password-override', 'Knp', nil, nil)
+
+    KillBillClient.url        = nil
+    KillBillClient.api_key    = nil
+    KillBillClient.api_secret = nil
+    KillBillClient.username   = nil
+    KillBillClient.password   = nil
+  end
+
+  test 'configuration with file override' do
+    Dir.mktmpdir do |dir|
+      file_path = File.join(dir, 'knp.yml')
+      file      = File.new(file_path, 'w+')
+      file.write(<<-eos)
+test:
+  killbill:
+    base_uri: http://127.0.0.1:7070/
+    api_key: bob-file-override
+    api_secret: lazar-file-override
+    username: admin-file-override
+    password: password-file-override
+      eos
+      file.close
+
+      verify_config('http://127.0.0.1:7070/', 'bob-file-override', 'lazar-file-override', 'admin-file-override', 'password-file-override', 'Knp', nil, nil, Knp::Configuration.new(file_path))
+    end
+  end
+
+  test 'configuration with file and clusters override' do
+    Dir.mktmpdir do |dir|
+      file_path = File.join(dir, 'knp.yml')
+      file      = File.new(file_path, 'w+')
+      file.write(<<-eos)
+test:
+  killbill:
+    us:
+      base_uri: http://killbill-us.acme.com:8080/
+      api_key: bob_us
+      api_secret: lazar_us
+      username: admin_us
+      password: password_us
+    europe:
+      base_uri: http://killbill-europe.acme.com:8080/
+      api_key: bob_europe
+      api_secret: lazar_europe
+      username: admin_europe
+      password: password_europe
+      eos
+      file.close
+
+      config = Knp::Configuration.new(file_path)
+      verify_config('http://killbill-europe.acme.com:8080/', 'bob_europe', 'lazar_europe', 'admin_europe', 'password_europe', 'Knp', nil, nil, config, 'europe')
+      verify_config('http://killbill-us.acme.com:8080/', 'bob_us', 'lazar_us', 'admin_us', 'password_us', 'Knp', nil, nil, Knp::Configuration.new(file_path), 'us')
+    end
+  end
+
+  private
+
+  def verify_config(base_uri, api_key, api_secret, username, password, user, reason, comment, config=Knp::Configuration.new, cluster=nil)
+    assert_equal base_uri, config.base_uri(cluster)
+    assert_equal api_key, config.api_key(cluster)
+    assert_equal api_secret, config.api_secret(cluster)
+    assert_equal username, config.username(cluster)
+    assert_equal password, config.password(cluster)
+    assert_equal user, config.user(cluster)
+    assert_equal reason, config.reason(cluster)
+    assert_equal comment, config.comment(cluster)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Killbill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ files:
 - test/functional/knp/mock_notifications_controller_test.rb
 - test/knp_test.rb
 - test/test_helper.rb
+- test/unit/knp/configuration_test.rb
 homepage: http://killbill.io
 licenses: []
 metadata: {}
@@ -178,3 +179,4 @@ test_files:
 - test/functional/knp/mock_notifications_controller_test.rb
 - test/knp_test.rb
 - test/test_helper.rb
+- test/unit/knp/configuration_test.rb