kaui 0.1.18 → 0.2.0

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.idea
+sandbox
+foo

data/.travis.yml

@@ -0,0 +1,30 @@
+language: ruby
+
+notifications:
+  email:
+    - ri-dev@ning.com
+
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+before_script:
+  - mysql -e 'create database kaui_test;'
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+env:
+  - MYSQL_PASSWORD=''

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.3"
+gem 'rest-client', '~> 1.6.7'
+gem 'money-rails', '~> 0.5.0'
+gem 'd3_rails', '~> 2.10.0'
+
+group :development, :test do
+  # jquery-rails is used by the dummy application
+  gem "jquery-rails"
+
+  if defined?(JRUBY_VERSION)
+    gem "jruby-openssl", "~> 0.7.7"
+
+    gem 'activerecord-jdbc-adapter', '~> 1.2.2'
+    gem 'activerecord-jdbcmysql-adapter', '~> 1.2.2'
+    gem 'jdbc-mysql', :require => false
+  else
+    gem 'mysql2'
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,107 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    d3_rails (2.10.0)
+      railties (>= 3.1.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.0)
+    json (1.7.0-java)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    money (5.0.0)
+      i18n (~> 0.4)
+      json
+    money-rails (0.5.0)
+      activesupport (~> 3.0)
+      money (~> 5.0.0)
+      railties (~> 3.0)
+    multi_json (1.3.4)
+    mysql2 (0.3.11)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  d3_rails (~> 2.10.0)
+  jquery-rails
+  money-rails (~> 0.5.0)
+  mysql2
+  rails (~> 3.2.3)
+  rest-client (~> 1.6.7)

data/README.md

@@ -0,0 +1,60 @@
+Getting started
+===============
+
+Running Kaui
+------------
+
+You can run Kaui locally using the dummy app in the test directory:
+
+    # Point to your killbill installation
+    export KILLBILL_URL="http://killbill.company.com:8080"
+    cd test/dummy && rails s
+
+
+Mounting Kaui into your own Rails app
+-------------------------------------
+
+The Kaui gem comes with a `kaui` script to mount it in your existing Rails app. See the [Getting Started](http://killbilling.org/start.html#kaui_deployment) guide.
+
+Kaui expects the container app to define the <tt>current_user</tt> method, which returns the
+name of the logged-in user. This is used by Killbill for auditing purposes.
+
+Finally, Killbill server needs to be running for Kaui to fetch its information. Set the `KILLBILL_URL`
+variable to point to your existing Killbill installation (e.g. http://killbill.company.com:8080).
+
+
+Running tests
+-------------
+
+Prepare a kaui_test database locally to be able to run the test suite:
+
+    create database kaui_test;
+    grant all privileges on kaui_test.* to 'root'@'localhost' identified by '';
+
+You can run tests using rake:
+
+    rake test
+
+
+Development
+===========
+
+Working with the kaui script
+----------------------------
+
+In order to generate the Rubygems-friendly `kaui` script, you need to build the gem
+and install it locally.
+
+First, build the gem in the `pkg` directory:
+
+    rake build
+
+Then, install and run it from a local directory:
+
+    mkdir foo
+    gem install pkg/kaui-*.gem -i foo
+    GEM_PATH=$PWD/foo:$GEM_PATH ./foo/bin/kaui /path/to/rails/app --path=$PWD --skip-bundle
+
+Alternatively, you can run the `kaui` script under `bin` by setting your loadpath correctly:
+
+    ruby -Ilib bin/kaui /path/to/rails/app --path=$PWD --skip-bundle

data/app/assets/javascripts/kaui/validation.js

@@ -0,0 +1,21 @@
+// Restrict numeric input for a text field
+// TODO - consider switching to HTML5's <input type="number" />
+function preventNonNumericValues(event) {
+  // Allow: backspace, delete, tab, escape, and enter
+  if (event.keyCode == 46 || event.keyCode == 8 || event.keyCode == 9 || event.keyCode == 27 || event.keyCode == 13 ||
+      // Allow: Ctrl+A
+      (event.keyCode == 65 && event.ctrlKey === true) ||
+      // Allow dot
+      (event.keyCode == 190) ||
+      // Allow: home, end, left, right
+      (event.keyCode >= 35 && event.keyCode <= 39)) {
+      // let it happen, don't do anything
+      return;
+  }
+  else {
+    // Ensure that it is a number and stop the keypress
+    if (event.shiftKey || (event.keyCode < 48 || event.keyCode > 57) && (event.keyCode < 96 || event.keyCode > 105 )) {
+      event.preventDefault();
+    }
+  }
+}

data/app/assets/stylesheets/kaui/analytics.css

@@ -0,0 +1,26 @@
+path {
+  stroke: steelblue;
+  stroke-width: 1;
+  fill: none;
+}
+
+.axis {
+  shape-rendering: crispEdges;
+}
+
+.x.axis line {
+  stroke: lightgrey;
+}
+
+.x.axis .minor {
+  stroke-opacity: .5;
+}
+
+.x.axis path {
+  display: none;
+}
+
+.y.axis line, .y.axis path {
+  fill: none;
+  stroke: #000;
+}

data/app/controllers/kaui/accounts_controller.rb

@@ -1,6 +1,3 @@
-require 'rest_client'
-require 'json'
-
 class Kaui::AccountsController < Kaui::EngineController
   def index
     if params[:account_id].present?

data/app/controllers/kaui/analytics_controller.rb

@@ -1,22 +1,31 @@
 module Kaui
-  class AnalyticsController < ApplicationController
+  class AnalyticsController < Kaui::EngineController
     def index
       @slugs = []
-      catalog = Kaui::KillbillHelper::get_full_catalog()
-      catalog['products'].each do |product|
-        product['plans'].each do |plan|
-          name = plan['name']
-          plan['phases'].each do |phase|
-            type = phase['type']
-            @slugs << "#{name.downcase}-#{type.downcase}"
+      begin
+        catalog = Kaui::KillbillHelper::get_full_catalog()
+        catalog['products'].each do |product|
+          product['plans'].each do |plan|
+            name = plan['name']
+            plan['phases'].each do |phase|
+              type = phase['type']
+              @slugs << "#{name.downcase}-#{type.downcase}"
+            end
           end
         end
+        @product_type = catalog['name']
+      rescue => e
+        flash[:error] = "Error while retrieving catalog: #{as_string(e)}"
       end
-      @product_type = catalog['name']
     end
 
     def accounts_over_time
-      @accounts = Analytics.accounts_over_time
+      begin
+        @accounts = Analytics.accounts_over_time
+      rescue => e
+        flash[:error] = "Error while retrieving data: #{as_string(e)}"
+        @accounts = Kaui::TimeSeriesData.empty
+      end
     end
 
     def subscriptions_over_time
@@ -25,4 +34,4 @@ module Kaui
       @subscriptions = Analytics.subscriptions_over_time(@product_type, @slug)
     end
   end
-end
+end

data/app/controllers/kaui/engine_controller.rb

@@ -2,8 +2,17 @@ require 'kaui/error_helper'
 
 class Kaui::EngineController < ApplicationController
   include Kaui::ErrorHelper
-  # This is a semi-isolated engine (https://bibwild.wordpress.com/2012/05/10/the-semi-isolated-rails-engine/)
-  # We expect that the hosting app's ApplicationController has these methods defined:
-  #
-  #   current_user - returns the id of the current user
+
+  layout :get_layout
+
+  # Used for auditing purposes
+  def current_user
+    super rescue Kaui.config[:default_current_user]
+  end
+
+  protected
+
+    def get_layout
+      layout ||= Kaui.config[:layout]
+    end
 end

data/app/controllers/kaui/invoices_controller.rb

@@ -36,7 +36,7 @@ class Kaui::InvoicesController < Kaui::EngineController
           render :action => :index
         end
       rescue => e
-        flash[:error] = "Error while getting information for invoice #{invoice_id}: #{as_string(e)}"
+        flash[:error] = "Error while getting information for invoice #{@invoice_id}: #{as_string(e)}"
       end
     else
       flash[:error] = "No id given"

data/app/controllers/kaui/refunds_controller.rb

@@ -19,10 +19,25 @@ class Kaui::RefundsController < Kaui::EngineController
           @refunds = Kaui::KillbillHelper::get_refunds_for_payment(params[:id])
           unless @refunds.present?
             flash[:error] = "Refund for id or payment id #{params[:id]} couldn't be found"
-            render :action => :index
+            render :action => :index and return
           end
         rescue => e
           flash[:error] = "Error while retrieving the refunds for the payment: #{as_string(e)}"
+          render :action => :index and return
+        end
+      end
+
+      if @refunds.size > 0
+        begin
+          # Retrieve the account via the payment
+          payment = Kaui::KillbillHelper::get_payment(@refunds[0].payment_id)
+          unless payment.present?
+            flash[:error] = "Account for payment id #{@refunds[0].payment_id} couldn't be found"
+            render :action => :index
+          end
+          @account = Kaui::KillbillHelper::get_account(payment.account_id)
+        rescue => e
+          flash[:error] = "Error while retrieving the account for the refund: #{as_string(e)}"
           render :action => :index
         end
       end

data/app/controllers/kaui/subscriptions_controller.rb

@@ -14,6 +14,12 @@ class Kaui::SubscriptionsController < Kaui::EngineController
         flash[:error] = "No subscription id given or subscription not found"
         redirect_to :back
       end
+
+      @account = Kaui::KillbillHelper::get_account_by_bundle_id(@subscription.bundle_id)
+      unless @account.present?
+        flash[:error] = "Unable to retrieve account for bundle #{@subscription.bundle_id}"
+        redirect_to :back
+      end
     rescue => e
       flash[:error] = "Error while getting subscription information: #{as_string(e)}"
     end

data/app/controllers/kaui/tag_definitions_controller.rb

@@ -1,9 +1,14 @@
 module Kaui
-  class TagDefinitionsController < ApplicationController
+  class TagDefinitionsController < Kaui::EngineController
     # GET /tag_definitions
     # GET /tag_definitions.json
     def index
-      @tag_definitions = TagDefinition.all
+      begin
+        @tag_definitions = TagDefinition.all
+      rescue => e
+        flash[:error] = "Error while retrieving tag definitions: #{as_string(e)}"
+        @tag_definitions = []
+      end
 
       respond_to do |format|
         format.html # index.html.erb

data/app/helpers/kaui/date_helper.rb

@@ -1,8 +1,7 @@
 module Kaui
   module DateHelper
-    def format_date(date)
-      # TODO: make timezone configurable
-      parsed_date = DateTime.parse(date.to_s).in_time_zone("Pacific Time (US & Canada)")
+    def format_date(date, timezone="Pacific Time (US & Canada)")
+      parsed_date = DateTime.parse(date.to_s).in_time_zone(timezone)
       parsed_date.to_s(:date_only)
     end
   end

data/app/helpers/kaui/killbill_helper.rb

@@ -1,6 +1,3 @@
-require 'rest_client'
-require 'time'
-
 module Kaui
   module KillbillHelper
 

data/app/models/kaui/account.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::Account < Kaui::Base
   define_attr :account_id
   define_attr :external_key

data/app/models/kaui/account_timeline.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::AccountTimeline < Kaui::Base
   has_one :account, Kaui::Account
   has_many :payments, Kaui::Payment

data/app/models/kaui/audit_log.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::AuditLog < Kaui::Base
   define_attr :change_date
   define_attr :change_type

data/app/models/kaui/bundle.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::Bundle < Kaui::Base
   define_attr :account_id
   define_attr :external_key

data/app/models/kaui/invoice.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::Invoice < Kaui::Base
   define_attr :amount
   define_attr :balance
@@ -59,4 +57,4 @@ class Kaui::Invoice < Kaui::Base
   def credit_adjustment_to_money(currency)
     Kaui::Base.to_money(credit_adjustment, currency)
   end
-end
+end

data/app/models/kaui/invoice_item.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::InvoiceItem < Kaui::Base
   SAMPLE_REASON_CODES = [ "100 - Courtesy",
                           "101 - Billing Error",
@@ -23,4 +21,4 @@ class Kaui::InvoiceItem < Kaui::Base
   def amount_to_money
     Kaui::Base.to_money(amount, currency)
   end
-end
+end

data/app/models/kaui/payment.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::Payment < Kaui::Base
 
   SAMPLE_REASON_CODES = [ "600 - Alt payment method",
@@ -13,6 +11,7 @@ class Kaui::Payment < Kaui::Base
   define_attr :paid_amount
   define_attr :payment_id
   define_attr :payment_method_id
+  # TODO - is this used?
   define_attr :refund_amount
   define_attr :requested_date
   define_attr :retry_count
@@ -35,4 +34,9 @@ class Kaui::Payment < Kaui::Base
   def paid_amount_to_money
     Kaui::Base.to_money(paid_amount, currency)
   end
-end
+
+  def is_fully_refunded?
+    # paid_amount is the original payment amount minus the refunds
+    paid_amount == 0
+  end
+end

data/app/models/kaui/payment_attempt.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::PaymentAttempt < Kaui::Base
   define_attr :account_id
   define_attr :invoice_id
@@ -26,4 +24,4 @@ class Kaui::PaymentAttempt < Kaui::Base
           :udpated_dt => data['updatedDate'],
           :retry_count => data['retryCount'])
   end
-end
+end

data/app/models/kaui/payment_method.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::PaymentMethod < Kaui::Base
   define_attr :account_id
   define_attr :is_default
@@ -35,4 +33,4 @@ class Kaui::PaymentMethod < Kaui::Base
   def email
     plugin_info.property("email") if plugin_info.present?
   end
-end
+end

data/app/models/kaui/plugin_info.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::PluginInfo < Kaui::Base
   define_attr :external_payment_id
 
@@ -9,4 +7,4 @@ class Kaui::PluginInfo < Kaui::Base
     prop = properties.find { |prop| prop.key == key } unless properties.nil?
     prop.value unless prop.nil?
   end
-end
+end

data/app/models/kaui/plugin_info_property.rb

@@ -1,7 +1,5 @@
-require 'active_model'
-
 class Kaui::PluginInfoProperty < Kaui::Base
   define_attr :key
   define_attr :value
   define_attr :is_updatable
-end
+end

data/app/models/kaui/refund.rb

@@ -1,5 +1,3 @@
-require 'active_model'
-
 class Kaui::Refund < Kaui::Base
   SAMPLE_REASON_CODES = [ "500 - Courtesy",
                           "501 - Billing Error",
@@ -21,4 +19,4 @@ class Kaui::Refund < Kaui::Base
   def amount_to_money
     Kaui::Base.to_money(amount, currency)
   end
-end
+end

data/app/models/kaui/time_series_data.rb

@@ -1,4 +1,8 @@
 class Kaui::TimeSeriesData < Kaui::Base
   define_attr :dates
   define_attr :values
-end
+
+  def self.empty
+    Kaui::TimeSeriesData.new(:dates => [], :values => [])
+  end
+end