knp 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.idea
+config/initializers/killbill_client.rb

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in knp.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    knp (0.0.1)
+      killbill-client (~> 0.8.0)
+      rails (~> 3.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.21)
+      actionpack (= 3.2.21)
+      mail (~> 2.5.4)
+    actionpack (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.21)
+      activesupport (= 3.2.21)
+      builder (~> 3.0.0)
+    activerecord (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
+    activesupport (3.2.21)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    journey (1.0.4)
+    jquery-rails (3.1.2)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    killbill-client (0.8.1)
+      json (>= 1.2.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    multi_json (1.10.1)
+    polyglot (0.3.5)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.21)
+      actionmailer (= 3.2.21)
+      actionpack (= 3.2.21)
+      activerecord (= 3.2.21)
+      activeresource (= 3.2.21)
+      activesupport (= 3.2.21)
+      bundler (~> 1.0)
+      railties (= 3.2.21)
+    railties (3.2.21)
+      actionpack (= 3.2.21)
+      activesupport (= 3.2.21)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.42)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jquery-rails
+  knp!
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+Knp
+===
+
+The Kill Bill Notifications Proxy is a Rails mountable engine that can be exposed on a public IP to process notifications from gateways.
+
+
+Mounting Knp into your own Rails app
+------------------------------------
+
+* Add `knp` to your Gemfile
+* Add `mount Knp::Engine, at: "/killbill"` in your `config/routes.rb`
+
+
+Configuration
+-------------
+
+Specify your Kill Bill server configuration in ```config/initializers/killbill_client.rb```:
+
+```
+KillBillClient.url        = 'http://127.0.0.1:8080/'
+KillBillClient.api_key    = 'bob'
+KillBillClient.api_secret = 'lazar'
+KillBillClient.username   = 'admin'
+KillBillClient.password   = 'password'
+# To log requests
+KillBillClient.logger     = Rails.logger
+```
+
+
+Running tests
+-------------
+
+```
+rake test
+```
+
+Note: functional tests require an instance of Kill Bill to test against.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Knp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/knp/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/knp/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/knp/application_controller.rb

@@ -0,0 +1,4 @@
+module Knp
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/knp/notifications_controller.rb

@@ -0,0 +1,39 @@
+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])
+      kb_response  = notification.notify!
+      build_response(kb_response)
+    rescue => e
+      logger.warn "Error processing notification for plugin #{params[:plugin_name]}: #{e}\n\t#{e.backtrace.join("\n\t")}"
+      head :bad_request
+    end
+
+    private
+
+    def build_notification(plugin_name)
+      notification             = Notification.new
+      notification.plugin_name = plugin_name
+      notification.body        = request.body.read
+      notification.params      = request.query_parameters
+      notification.headers     = request.headers
+      notification
+    end
+
+    def build_response(kb_response)
+      # This could have security issues (e.g. leak of JSESSIONID). Is there a gateway that actually requires it?
+      #response.headers = kb_response[:headers]
+
+      render :text         => kb_response[:body],
+             :content_type => kb_response[:content_type],
+             :location     => kb_response[:location],
+             :status       => kb_response[:status]
+    end
+  end
+end

data/app/helpers/knp/application_helper.rb

@@ -0,0 +1,4 @@
+module Knp
+  module ApplicationHelper
+  end
+end

data/app/models/knp/notification.rb

@@ -0,0 +1,61 @@
+module Knp
+  class Notification
+
+    attr_accessor :plugin_name
+    attr_accessor :body
+    attr_accessor :params
+    attr_accessor :headers
+    attr_accessor :user
+    attr_accessor :reason
+    attr_accessor :comment
+    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
+    end
+
+    def notify!
+      # Response is a Net::HTTPResponse
+      response = KillBillClient::API.post(kb_url, body, params, build_options)
+
+      {
+          :body         => response.body,
+          :status       => response.code,
+          # The header key is case insensitive in Net::HTTPHeader
+          :location     => response['location'],
+          :content_type => response.content_type,
+          :headers      => response.to_hash,
+      }
+    end
+
+    private
+
+    def kb_url
+      "#{KillBillClient::Model::Resource::KILLBILL_API_PREFIX}/paymentGateways/notification/#{plugin_name}"
+    end
+
+    def build_options
+      # Merge after to avoid conflicts with headers passed by the gateway
+      headers
+          .deep_dup
+          .merge(
+              :user       => user,
+              :reason     => reason,
+              :comment    => comment,
+              :api_key    => api_key,
+              :api_secret => api_secret,
+              :username   => username,
+              :password   => password
+          )
+    end
+  end
+end

data/app/views/layouts/knp/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Knp</title>
+  <%= stylesheet_link_tag    "knp/application", :media => "all" %>
+  <%= javascript_include_tag "knp/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/knp.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "knp/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "knp"
+  s.version     = Knp::VERSION
+  s.authors     = ['Killbill core team']
+  s.email       = ['killbilling-users@googlegroups.com']
+  s.homepage    = 'http://killbill.io'
+  s.summary     = 'Kill Bill Notifications Proxy'
+  s.description = 'Externally-facing proxy to forward notifications to Kill Bill'
+
+  s.files = `git ls-files`.split("\n")
+  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_development_dependency "sqlite3"
+end

data/lib/knp.rb

@@ -0,0 +1,12 @@
+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
+end