killbill-kpm-ui 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c7ab1958f7682e1709819cb222d376118b0df25
+  data.tar.gz: 5bcb62502ce425428aafcd7c7f8b836e7b8fd0be
+SHA512:
+  metadata.gz: d2c0cc082907faa196de41f2ee58e179a28706ad22013b667f3ee0e060d2da7ddcf2deadb18a5595b9bbae45426937159910e013beb07f82b97e76bc01d7dae6
+  data.tar.gz: 8f4d5ef2d2f24785759cb223d419758e7c8f246f39e9ecf62de1226870945bc7bf3c38e203e8d46fc6f9045e6c5f14732927ae433fdb43ac30d54f2cc7ba606e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 The Billing Project, LLC
+
+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,32 @@
+Overview
+========
+
+Rails mountable engine to manage the KPM plugin.
+
+See [killbill-admin-ui-standalone](https://github.com/killbill/killbill-admin-ui-standalone) to get started with the Kill Bill Admin UI.
+
+Kill Bill compatibility
+-----------------------
+
+| KPM UI version | Kill Bill version |
+| -------------: | ----------------: |
+| 0.1.y          | 0.16.z            |
+| 0.2.y          | 0.18.z (Rails 4)  |
+| 0.3.y          | 0.18.z (Rails 5)  |
+| 1.x.y          | 0.19.z            |
+
+Testing
+-------
+
+To run the dummy app:
+
+```
+rails s
+```
+
+
+To run tests:
+
+```
+rails t
+```

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KPM'
+  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'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_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/application.js

@@ -0,0 +1,18 @@
+// 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 any plugin's vendor/assets/javascripts directory 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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require dataTables/jquery.dataTables
+//= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+//= require kpm/kpm

data/app/assets/javascripts/kpm/kpm.js

@@ -0,0 +1,7 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require_tree .

data/app/assets/stylesheets/application.css

@@ -0,0 +1,19 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_self
+ *= require dataTables/jquery.dataTables
+ *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+ *= require font-awesome
+ *= require bootstrap_and_overrides
+ *= require kpm/kpm
+ */

data/app/assets/stylesheets/bootstrap_and_overrides.css

@@ -0,0 +1,13 @@
+/*
+ *= require twitter-bootstrap-static/bootstrap
+*/
+
+/* Override Bootstrap 3 font locations */
+@font-face {
+    font-family: 'Glyphicons Halflings';
+    src: url('../assets/glyphicons-halflings-regular.eot');
+    src: url('../assets/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),
+    url('../assets/glyphicons-halflings-regular.woff') format('woff'),
+    url('../assets/glyphicons-halflings-regular.ttf') format('truetype'),
+    url('../assets/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg');
+}

data/app/assets/stylesheets/kpm/kpm.css

@@ -0,0 +1,6 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. 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_tree .
+*/

data/app/controllers/kpm/engine_controller.rb

@@ -0,0 +1,29 @@
+module KPM
+  class EngineController < ApplicationController
+
+    layout :get_layout
+
+    def get_layout
+      layout ||= KPM.config[:layout]
+    end
+
+    def current_tenant_user
+      # If the rails application on which that engine is mounted defines such method (Devise), we extract the current user,
+      # if not we default to nil, and serve our static mock configuration
+      user = current_user if respond_to?(:current_user)
+      KPM.current_tenant_user.call(session, user)
+    end
+
+    def options_for_klient
+      user = current_tenant_user
+      {
+          :username => user[:username],
+          :password => user[:password],
+          :session_id => user[:session_id],
+          :api_key => user[:api_key],
+          :api_secret => user[:api_secret]
+      }
+    end
+
+  end
+end

data/app/controllers/kpm/nodes_info_controller.rb

@@ -0,0 +1,109 @@
+require 'kpm/client'
+
+module KPM
+  class NodesInfoController < EngineController
+
+    def index
+      @nodes_info = ::KillBillClient::Model::NodesInfo.nodes_info(options_for_klient)
+
+      # For convenience, put pure OSGI bundles at the bottom
+      @nodes_info.each do |node_info|
+        next if node_info.plugins_info.nil?
+        node_info.plugins_info.sort! do |a, b|
+          if osgi_bundle?(a) && !osgi_bundle?(b)
+            1
+          elsif !osgi_bundle?(a) && osgi_bundle?(b)
+            -1
+          else
+            a.plugin_name <=> b.plugin_name
+          end
+        end
+      end
+
+      @logs = ::Killbill::KPM::KPMClient.get_osgi_logs(options_for_klient).reverse
+
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+    def install_plugin
+      command_properties = [
+          build_node_command_property('forceDownload', params[:force_download] == '1')
+      ]
+      trigger_node_plugin_command('INSTALL_PLUGIN', command_properties)
+
+      redirect_to :action => :index
+    end
+
+    def install_plugin_from_fs
+      ::Killbill::KPM::KPMClient.install_plugin(params.require(:key),
+                                                params.require(:version),
+                                                params.require(:type),
+                                                params.require(:plugin).original_filename,
+                                                params.require(:plugin).read,
+                                                options_for_klient)
+
+      redirect_to :action => :index
+    end
+
+    def uninstall_plugin
+      trigger_node_plugin_command('UNINSTALL_PLUGIN')
+      head :ok
+    end
+
+    def start_plugin
+      trigger_node_plugin_command('START_PLUGIN')
+      head :ok
+    end
+
+    def stop_plugin
+      trigger_node_plugin_command('STOP_PLUGIN')
+      head :ok
+    end
+
+    def restart_plugin
+      trigger_node_plugin_command('RESTART_PLUGIN')
+      head :ok
+    end
+
+    private
+
+    def trigger_node_plugin_command(command_type, command_properties=[])
+      command_properties << build_node_command_property('pluginKey', params[:plugin_key])
+      command_properties << build_node_command_property('pluginName', params[:plugin_name])
+      command_properties << build_node_command_property('pluginVersion', params[:plugin_version])
+
+      trigger_node_command(command_type, command_properties)
+    end
+
+    def trigger_node_command(command_type, command_properties=[])
+      node_command = ::KillBillClient::Model::NodeCommandAttributes.new
+      node_command.system_command_type = true
+      node_command.node_command_type = command_type
+      node_command.node_command_properties = command_properties
+
+      # TODO Can we actually use node_name?
+      local_node_only = false
+
+      ::KillBillClient::Model::NodesInfo.trigger_node_command(node_command,
+                                                              local_node_only,
+                                                              options_for_klient[:username],
+                                                              params[:reason],
+                                                              params[:comment],
+                                                              options_for_klient)
+    end
+
+    def build_node_command_property(key, value)
+      property = ::KillBillClient::Model::NodeCommandPropertyAttributes.new
+      property.key = key
+      property.value = value
+      property
+    end
+
+    def osgi_bundle?(plugin_info)
+      plugin_info.version.blank? || plugin_info.plugin_name.starts_with?('org.apache.felix.') || plugin_info.plugin_name.starts_with?('org.kill-bill.billing.killbill-platform-')
+    end
+  end
+end

data/app/controllers/kpm/plugins_controller.rb

@@ -0,0 +1,19 @@
+require 'kpm/client'
+
+module KPM
+  class PluginsController < EngineController
+
+    def index
+      begin
+        plugins = ::Killbill::KPM::KPMClient.get_available_plugins(true, options_for_klient)
+      rescue => e
+        # No connectivity, GitHub down, ...
+        Rails.logger.warn("Unable to get latest plugins, trying built-in directory: #{e.inspect}")
+        plugins = ::Killbill::KPM::KPMClient.get_available_plugins(false, options_for_klient)
+      end
+
+      @plugins = Hash[plugins.sort]
+    end
+
+  end
+end

data/app/helpers/kpm/application_helper.rb

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

data/app/views/kpm/layouts/kpm_application.html.erb

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>KPM</title>
+  <%= yield :scripts %>
+  <%= stylesheet_link_tag 'application', :media => 'all' %>
+  <%= javascript_include_tag 'application' %>
+  <%= csrf_meta_tags %>
+</head>
+<div class="container-fluid">
+  <%- # :alert used by devise  -%>
+  <% [:error, :alert].each do |key| %>
+      <% if flash[key] %>
+          <div class="row">
+            <div class="col-md-10 col-md-offset-2">
+              <div class="alert alert-error"><%= flash[key] %></div>
+            </div>
+          </div>
+      <% end %>
+  <% end %>
+  <% if flash[:notice] %>
+      <div class="row">
+        <div class="col-md-10 col-md-offset-2">
+          <div class="alert alert-info"><%= flash[:notice] %></div>
+        </div>
+      </div>
+  <% end %>
+  <%= yield %>
+</div>
+</body>
+</html>

data/app/views/kpm/nodes_info/_logs_table.html.erb

@@ -0,0 +1,43 @@
+<table id="logs-table" class="table table-condensed table-striped mobile-data">
+  <thead>
+  <tr>
+    <th>Time</th>
+    <th>Name</th>
+    <th>Level</th>
+    <th>Message</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% logs.each do |log| %>
+      <tr>
+        <td>
+          <% unless log['time'].blank? %>
+              <%= DateTime.strptime(log['time'].to_s, '%Q').strftime('%Y-%m-%d %H:%M:%S') %>
+          <% end %>
+        </td>
+        <td><%= log['name'] %></td>
+        <td>
+          <% if log['level'] == 'ERROR' %>
+              <span class="label label-danger"><%= log['level'] %></span>
+          <% elsif log['level'] == 'WARNING' %>
+              <span class="label label-warning"><%= log['level'] %></span>
+          <% else %>
+              <span class="label label-success"><%= log['level'] %></span>
+          <% end %>
+        </td>
+        <td><pre><%= log['message'] %></pre></td>
+      </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= javascript_tag do %>
+  $(document).ready(function() {
+    $('#logs-table').dataTable({
+      "dom": "<'row'r>t<'row'<'col-md-6'i><'col-md-6'p>>",
+      "pagingType": "full_numbers",
+      "pageLength": 50,
+      "ordering": false
+    });
+  });
+<% end %>

data/app/views/kpm/nodes_info/_nodes_table.html.erb

@@ -0,0 +1,68 @@
+<table id="nodes-table" class="table table-condensed table-striped mobile-data">
+  <thead>
+  <tr>
+    <th>Node name</th>
+    <th>Boot time</th>
+    <th>Updated date</th>
+    <th>Kill Bill version</th>
+    <th>Dependencies</th>
+    <th>Plugins</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% nodes_info.each do |node_info| %>
+      <tr>
+        <td><%= node_info.node_name %></td>
+        <td>
+          <% unless node_info.boot_time.blank? %>
+              <%= time_ago_in_words(DateTime.parse(node_info.boot_time)) %> ago
+          <% end %>
+        </td>
+        <td>
+          <% unless node_info.last_updated_date.blank? %>
+              <%= time_ago_in_words(DateTime.parse(node_info.last_updated_date)) %> ago
+          <% end %>
+        </td>
+        <td><%= node_info.kb_version %></td>
+        <td>
+          <ul>
+            <li>API: <%= node_info.api_version %></li>
+            <li>Plugin API: <%= node_info.plugin_api_version %></li>
+            <li>Platform: <%= node_info.platform_version %></li>
+            <li>Commons: <%= node_info.common_version %></li>
+          </ul>
+        </td>
+        <td>
+          <% unless (node_info.plugins_info || []).empty? %>
+              <ul>
+                <% node_info.plugins_info.each do |plugin_info| %>
+                    <li>
+                      <%= plugin_info.plugin_name %> <%= plugin_info.version %> <span class="label label-<%= plugin_info.state == 'RUNNING' ? 'success' : (plugin_info.state == 'INSTALLED' ? 'warning' : 'danger') %>"><%= plugin_info.state %></span>
+                      <% if plugin_info.state == 'RUNNING' %>
+                          <%= link_to '<i class="fa fa-pause"></i>'.html_safe, plugin_stop_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Stop', :remote => true, :class => 'plugin-link' %>
+                          <%= link_to '<i class="fa fa-refresh"></i>'.html_safe, plugin_restart_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Restart', :remote => true, :class => 'plugin-link' %>
+                      <% elsif plugin_info.state == 'INSTALLED' || plugin_info.state == 'STOPPED' %>
+                          <%= link_to '<i class="fa fa-play"></i>'.html_safe, plugin_start_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Start', :remote => true, :class => 'plugin-link' %>
+                      <% end %>
+                      <% unless plugin_info.version.nil? %>
+                          <%= link_to '<i class="fa fa-eject"></i>'.html_safe, plugin_uninstall_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Uninstall', :remote => true, :class => 'plugin-link' %>
+                      <% end %>
+                    </li>
+                <% end %>
+              </ul>
+          <% end %>
+        </td>
+      </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= javascript_tag do %>
+  $(document).ready(function() {
+    $('#nodes-table').dataTable({
+      "dom": "t",
+      "paging": false,
+      "ordering": false
+    });
+  });
+<% end %>