killbill-kpm 0.0.1 → 0.0.2

data/README.md

@@ -1,2 +1,2 @@
-# killbill-kpm-ui
-Rails mountable engine to manage the KPM plugin
+# killbill-kpm-plugin
+Kill Bill KPM plugin

data/Rakefile

@@ -1,37 +1,22 @@
-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'
-
-
+#!/usr/bin/env rake
 
+# Install tasks to build and release the plugin
+require 'bundler/setup'
 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
+# Install test tasks
+require 'rspec/core/rake_task'
+namespace :test do
+  desc 'Run RSpec tests'
+  RSpec::Core::RakeTask.new do |task|
+    task.name = 'spec'
+    task.pattern = './spec/*/*_spec.rb'
+  end
 end
 
+# Install tasks to package the plugin for Killbill
+require 'killbill/rake_task'
+Killbill::PluginHelper.install_tasks
 
-task default: :test
+# Run tests by default
+task :default => 'test:spec'

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/config.ru

@@ -0,0 +1,4 @@
+require 'kpm_plugin'
+require 'kpm/application'
+
+run Sinatra::Application

data/killbill-kpm.gemspec

@@ -0,0 +1,31 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-kpm'
+  s.version     = version
+  s.summary     = 'Kill Bill KPM plugin'
+  s.description = 'Plugin to manage installed plugins'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.license = 'Apache License (2.0)'
+
+  s.author   = 'Killbill core team'
+  s.email    = 'killbilling-users@googlegroups.com'
+  s.homepage = 'http://killbill.io'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.rdoc_options << '--exclude' << '.'
+
+  s.add_dependency 'killbill', '~> 6.2'
+  s.add_dependency 'kpm', '~> 0.1'
+
+  s.add_development_dependency 'jbundler', '~> 0.4.3'
+  s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/killbill.properties

@@ -0,0 +1,3 @@
+mainClass=KPM::Listener
+require=kpm_plugin
+pluginType=NOTIFICATION

data/lib/kpm/application.rb

@@ -0,0 +1,91 @@
+configure do
+  # Usage: bundle exec rackup -Ilib -E test
+  if development? or test?
+    require 'logger'
+    ::KPM::PluginsInstaller.instance.initialize!('/var/tmp/bundles/plugins/ruby/kpm/0.0.1',
+                                                 File.expand_path(File.dirname(__FILE__) + '../../../'),
+                                                 nil,
+                                                 Logger.new(STDOUT))
+  end
+end
+
+# Lookup plugins
+get '/plugins/killbill-kpm/plugins', :provides => 'json' do
+  artifact_id = params[:artifact_id] || params[:name]
+  latest = params[:latest] == 'false' ? false : true
+
+  if artifact_id.nil?
+    ::KPM::PluginsInstaller.instance.all(latest).to_json
+  else
+    group_id, artifact_id, packaging, classifier, version, type = ::KPM::PluginsInstaller.instance.lookup artifact_id, latest
+
+    if artifact_id.nil?
+      status 404
+    else
+      {
+          :group_id => group_id,
+          :artifact_id => artifact_id,
+          :packaging => packaging,
+          :classifier => classifier,
+          :version => version,
+          :type => type
+      }.to_json
+    end
+  end
+end
+
+# Install a plugin
+post '/plugins/killbill-kpm/plugins', :provides => 'json' do
+  if !request.body.nil?
+    type = (params[:type] || 'java').downcase
+
+    info = Dir.mktmpdir do |dir|
+      plugin_path = File.join(dir, params[:filename] || "#{params[:name]}.#{type == 'java' ? 'jar' : 'tar.gz'}")
+      File.open(plugin_path, 'w') do |file|
+        file.write(request.body.read)
+      end
+      ::KPM::PluginsInstaller.instance.install_from_fs plugin_path,
+                                                       params[:name],
+                                                       params[:version],
+                                                       type
+    end
+  else
+    info = ::KPM::PluginsInstaller.instance.install params[:artifact_id] || params[:name],
+                                                    params[:version],
+                                                    params[:group_id],
+                                                    params[:packaging],
+                                                    params[:classifier],
+                                                    params[:type],
+                                                    params[:force_download]
+  end
+
+  if info.nil?
+    status 400
+  else
+    info.to_json
+  end
+end
+
+# Uninstall a plugin
+delete '/plugins/killbill-kpm/plugins', :provides => 'json' do
+  modified = ::KPM::PluginsInstaller.instance.uninstall params[:name],
+                                                        params[:version]
+
+  if modified.empty?
+    status 404
+  else
+    modified.to_json
+  end
+end
+
+# Restart a plugin
+put '/plugins/killbill-kpm/plugins', :provides => 'json' do
+  modified = ::KPM::PluginsInstaller.instance.restart params[:name],
+                                                      params[:version]
+
+  if modified.empty?
+    status 404
+  else
+    modified.to_json
+  end
+end

data/lib/kpm/listener.rb

@@ -0,0 +1,94 @@
+require 'nexus_cli'
+
+module KPM
+  class Listener < Killbill::Plugin::Notification
+
+    def start_plugin
+      super
+
+      ::KPM::PluginsInstaller.instance.initialize!(@root, @conf_dir, @kb_apis, @logger)
+    end
+
+    def on_event(event)
+      return unless [:BROADCAST_SERVICE].include?(event.event_type)
+
+      unless ::KPM::PluginsInstaller.instance.initialized?
+        @logger.warn "KPM plugin wasn't started properly - check logs"
+        return
+      end
+
+      broadcast_metadata = event.meta_data.nil? ? {} : JSON.parse(event.meta_data)
+      command = broadcast_metadata['commandType']
+      return if command != 'INSTALL_PLUGIN' && command != 'UNINSTALL_PLUGIN'
+
+      service = broadcast_metadata['service']
+      event_json = broadcast_metadata['eventJson'].nil? ? {} : JSON.parse(broadcast_metadata['eventJson'])
+
+      properties = properties_to_hash(event_json['properties'])
+
+      @logger.info "Received #{event.event_type} event: service=#{service} command=#{command} event=#{event_json}"
+
+      return if !validate_inputs(command, properties, Proc.new { |command, properties, property_name|
+                                          if properties[property_name].nil?
+                                            @logger.info("Cannot run #{command}: missing property #{property_name}")
+                                            return false
+                                          end
+                                        })
+
+      handle_event(command,
+                   properties['pluginKey'],
+                   properties['pluginName'],
+                   properties['pluginArtifactId'],
+                   properties['pluginVersion'],
+                   properties['pluginGroupId'],
+                   properties['pluginPackaging'],
+                   properties['pluginClassifier'],
+                   properties['pluginType'],
+                   properties['forceDownload'] == 'true')
+    end
+
+    private
+
+    # Check for mandatory properties
+    def validate_inputs(command, properties, proc_validation)
+      # For installation we allow either to pass the pluginKey (entry in plugins_directory.yml), or the full pluginGroupId/pluginArtifactId/pluginVersion/pluginType
+      if command == 'INSTALL_PLUGIN'
+        if properties['pluginKey'].nil?
+          proc_validation.call(command, properties, 'pluginGroupId')
+          proc_validation.call(command, properties, 'pluginArtifactId')
+          proc_validation.call(command, properties, 'pluginVersion')
+          proc_validation.call(command, properties, 'pluginType')
+        end
+        return true
+      elsif command == 'UNINSTALL_PLUGIN'
+        proc_validation.call(command, properties, 'pluginName')
+        return true
+      end
+    end
+
+    def handle_event(command, plugin_key, plugin_name, artifact_id, version=nil, group_id=nil, packaging=nil, classifier=nil, type=nil, force_download=false)
+      @logger.info "handle_event command=#{command}, plugin_key=#{plugin_key}, plugin_name=#{plugin_name}, artifact_id=#{artifact_id}, version=#{version}, group_id=#{group_id}, packaging=#{packaging}, classifier=#{classifier}, type=#{type}, force_download=#{force_download}"
+
+      if command == 'INSTALL_PLUGIN'
+        plugin_key_or_artifact_id = plugin_key ? plugin_key : artifact_id
+        ::KPM::PluginsInstaller.instance.install(plugin_key_or_artifact_id, version, group_id, packaging, classifier, type, force_download)
+      elsif command == 'UNINSTALL_PLUGIN'
+        ::KPM::PluginsInstaller.instance.uninstall(plugin_name, version)
+      else
+        @logger.warn("Ignoring unsupported command #{command}")
+      end
+    rescue NexusCli::ArtifactNotFoundException
+      @logger.warn("Unable to #{command} #{plugin_name}: artifact was not found in Nexus")
+    end
+
+    def properties_to_hash(properties)
+      return {} if properties.nil?
+
+      h = {}
+      properties.each do |prop|
+        h[prop['key']] = prop['value']
+      end
+      h
+    end
+  end
+end

data/lib/kpm/plugins_installer.rb

@@ -0,0 +1,113 @@
+module KPM
+  class PluginsInstaller
+    include Singleton
+
+    attr_reader :initialized
+    alias_method :initialized?, :initialized
+
+    def initialize!(root_dir, conf_dir, kb_apis, logger)
+      @kb_apis = kb_apis
+      @logger = logger
+
+      configure!(Pathname.new(conf_dir).expand_path.join('kpm.yml'))
+
+      @bundles_dir = Pathname.new(root_dir).join('..').join('..').join('..').join('..').expand_path
+      plugins_dir = @bundles_dir.join('plugins')
+
+      @installer = ::KPM::BaseInstaller.new(@logger, @glob_config[:kpm][:nexus], @glob_config[:kpm][:ssl_verify])
+      @manager = ::KPM::PluginsManager.new(plugins_dir, @logger)
+
+      @initialized = true
+    end
+
+    # If an earlier version of the plugin is installed, Kill Bill will only start the latest one (see org.killbill.billing.osgi.FileInstall)
+    def install(specified_artifact_id, specified_version=nil, specified_group_id=nil, specified_packaging=nil, specified_classifier=nil, specified_type=nil, force_download=false)
+      @logger.info("Instructed to install artifact_id=#{specified_artifact_id} version=#{specified_version} group_id=#{specified_group_id} packaging=#{specified_packaging} classifier=#{specified_classifier} type=#{specified_type} force_download=#{force_download}")
+      info = @installer.install_plugin(specified_group_id, specified_artifact_id, specified_packaging, specified_classifier, specified_version, @bundles_dir, specified_type, force_download, @glob_config[:kpm][:verify_sha1])
+      if info.nil?
+        @logger.warn("Error during installation of plugin #{artifact_id}")
+      else
+        path = info[:bundle_dir] ? info[:bundle_dir] : info[:dir_name]
+        notify_fs_change(path, :NEW_VERSION)
+      end
+      info
+    end
+
+    def install_from_fs(file_path, name, version, type)
+      @logger.info("Instructed to install file_path=#{file_path} name=#{name} version=#{version} type=#{type}")
+      info = @installer.install_plugin_from_fs(file_path, name, version, @bundles_dir, type)
+      if info.nil?
+        @logger.warn("Error during installation of plugin #{name}")
+      else
+        notify_fs_change(info[:bundle_dir], :NEW_VERSION)
+      end
+      info
+    end
+
+    def uninstall(plugin_name, version=nil)
+      modified = @manager.uninstall(plugin_name, version || :all)
+      modified.each do |path|
+        notify_fs_change(path, :DISABLED)
+      end
+    end
+
+    def restart(plugin_name, version=nil)
+      @manager.restart(plugin_name, version || :all)
+    end
+
+    def lookup(artifact_id, latest=true)
+      KPM::PluginsDirectory.lookup(artifact_id, latest)
+    end
+
+    def all(latest=true)
+      KPM::PluginsDirectory.all(latest)
+    end
+
+    private
+
+    def notify_fs_change(path, state)
+      return if path.nil?
+
+      # Plugin name should be the directory name (path is something like /var/tmp/bundles/plugins/ruby/killbill-stripe/2.0.0)
+      fs_info = path.to_s.split('/')
+      plugin_type = fs_info[-3].upcase
+
+      unless %w(JAVA RUBY).include?(plugin_type)
+        @logger.warn("Invalid plugin type #{plugin_type} (path #{path}): Kill Bill won't be notified of new state #{state}")
+        return
+      end
+
+      if @kb_apis.nil?
+        @logger.warn("APIs not configured: Kill Bill won't be notified of new state #{state}")
+        return
+      end
+
+      plugin_name = fs_info[-2]
+      plugin_version = fs_info[-1]
+      @logger.info("Notifying Kill Bill: state=#{state} plugin_name=#{plugin_name} plugin_version=#{plugin_version} plugin_type=#{plugin_type}")
+      @kb_apis.plugins_info_api.notify_of_state_changed(state, plugin_name, plugin_version, plugin_type)
+    end
+
+    def configure!(config_file)
+      @glob_config = {}
+
+      # Look for global config
+      if !config_file.blank? && Pathname.new(config_file).file?
+        @glob_config = ::Killbill::Plugin::ActiveMerchant::Properties.new(config_file)
+        @glob_config.parse!
+        @glob_config = @glob_config.to_hash
+      end
+
+      @glob_config[:kpm] ||= {}
+
+      @glob_config[:kpm][:nexus] ||= {}
+      @glob_config[:kpm][:nexus][:url] ||= 'https://oss.sonatype.org'
+      @glob_config[:kpm][:nexus][:repository] ||= 'releases'
+
+      @glob_config[:kpm][:ssl_verify] = true if @glob_config[:kpm][:ssl_verify].nil?
+      @glob_config[:kpm][:verify_sha1] = true if @glob_config[:kpm][:verify_sha1].nil?
+
+      @logger.level = Logger::DEBUG if (@glob_config[:logger] || {})[:debug]
+    end
+  end
+end

data/lib/kpm_plugin.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/object/blank'
+require 'json'
+require 'pathname'
+require 'sinatra'
+require 'yaml'
+
+require 'kpm'
+
+require 'killbill'
+require 'killbill/helpers/active_merchant/properties'
+
+require 'kpm/plugins_installer'
+require 'kpm/listener'

data/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+~ Copyright 2014-2015 The Billing Project, LLC
+~
+~  The Billing Project licenses this file to you under the Apache License, version 2.0
+~  (the "License"); you may not use this file except in compliance with the
+~  License.  You may obtain a copy of the License at:
+~
+~     http://www.apache.org/licenses/LICENSE-2.0
+~
+~  Unless required by applicable law or agreed to in writing, software
+~  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+~  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+~  License for the specific language governing permissions and limitations
+~  under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>org.sonatype.oss</groupId>
+        <artifactId>oss-parent</artifactId>
+        <version>5</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.kill-bill.billing.plugin.ruby</groupId>
+    <artifactId>kpm-plugin</artifactId>
+    <packaging>pom</packaging>
+    <version>0.0.2</version>
+    <name>kpm-plugin</name>
+    <url>http://github.com/killbill/killbill-kpm-plugin</url>
+    <description>Kill Bill KPM plugin</description>
+    <licenses>
+        <license>
+            <name>Apache License 2.0</name>
+            <url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+    <scm>
+        <connection>scm:git:git://github.com/killbill/killbill-kpm-plugin.git</connection>
+        <url>https://github.com/killbill/killbill-kpm-plugin/</url>
+        <developerConnection>scm:git:git@github.com:killbill/killbill-kpm-plugin.git</developerConnection>
+    </scm>
+</project>