kaui 1.4.1 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e742130946b631b91580c426cdcb8ee8dfd07d5a
-  data.tar.gz: fdbf1ab93ef8dc3e1a7680f51779cdf1a958fe9d
+  metadata.gz: 062f8cf3943a8a8cae8f80490cac4c2545ed68bd
+  data.tar.gz: 398c6df309bdd8bf44eaddcac3273e9cfc394d17
 SHA512:
-  metadata.gz: 2f27c656b5b034092471fb10989c134fc0bd6cbbe7694a75fe8461c81459bbf3f8d83145cfe6c130e025218ecfa39284fcc3bb80d378417db33c1c3809c15dba
-  data.tar.gz: 4cf31c31fec9d8071830403b990187e282221b6c6c2d2f6fb861400c9cebf33c240f0045988b52ebe83bc970c409b5364026a4bcae4815c2fbe4228c14493238
+  metadata.gz: df121d5c0caa28f819c2678c7abf61a4ed161ee16dc6f047f7e6ca0279348f682de5dd8ce57e6bd31ad70f164892a44d911f22da2eaaa3689c4bf06dd560b302
+  data.tar.gz: 405d0913456d27232ee1518fb1637efc35423f62f5a948e3312e817c2547fe8f04f38029b5e8d4785522480ef261853640bddf728143e3f84a45408ff26b1219

data/README.md

@@ -11,7 +11,8 @@ Kill Bill compatibility
 | 0.14.y       | 0.16.z            |
 | 0.15.y       | 0.18.z (Rails 4)  |
 | 0.16.y       | 0.18.z (Rails 5)  |
-| 1.x.y        | 0.20.z            |
+| 1.x.y        | 0.20.z (Rails 5)  |
+| 2.x.y        | 0.22.z (Rails 5)  |
 
 Dependencies
 ------------
@@ -21,13 +22,15 @@ Ruby 2.4.2+ or JRuby 9.1.14.0+ required.
 Running Kaui locally
 ---------------------
 
+Note: use Ruby, not JRuby, for running the app locally.
+
 You can run Kaui locally by using the test/dummy app provided:
 
 ```
-export RAILS_ENV=development
+export RAILS_ENV=development DB_HOST=127.0.0.1 DB_USER=root DB_PASSWORD=root DB_PORT=3306
 bundle install
-rails db:migrate
-rails s
+bundle exec rails db:migrate
+bundle exec rails s
 ```
 
 The Kill Bill URL can be configured through the `KILLBILL_URL` environment variable, e.g.
@@ -91,7 +94,19 @@ Alternatively, you can run the `kaui` script under `bin` by setting your loadpat
 Releases
 ========
 
-The releases are done using Jruby and require the following property `export JRUBY_OPTS='--2.0 -J-Xmx1024m'`
+To trigger a release, run (update `patch` as needed):
+
+```
+bundle exec gem bump -c -p -t -v patch
+```
+
+This will:
+
+* Update the `version.rb` file
+* Commit the changes
+* Create the new tag and push the changes
+
+GitHub Actions will automatically push the new gem to Rubygems.
 
 Multi-Tenancy
 =============

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

@@ -144,6 +144,7 @@ jQuery(document).ready(function ($) {
     const VALIDATE_EXTERNAL_KEY = {
         account: { url: Routes.kaui_engine_accounts_validate_external_key_path(), invalid_msg_class_name: '.account_external_key_invalid_msg' },
         payment_method: {url: Routes.kaui_engine_payment_methods_validate_external_key_path(), invalid_msg_class_name: '.payment_method_external_key_invalid_msg'},
+        bundle: {url: Routes.kaui_engine_subscriptions_validate_bundle_external_key_path(), invalid_msg_class_name: '.subscription_bundle_external_key_invalid_msg'},
         subscription: {url: Routes.kaui_engine_subscriptions_validate_external_key_path(), invalid_msg_class_name: '.subscription_external_key_invalid_msg'}
     }
 
@@ -157,8 +158,13 @@ jQuery(document).ready(function ($) {
         validate_external_key($(this).val(),'payment_method');
     });
 
-    validate_external_key($('#external_key').val(),'subscription');
-    $('#external_key').on('change', function(e){
+    validate_external_key($('#bundle_external_key').val(),'bundle');
+    $('#bundle_external_key').on('change', function(e){
+        validate_external_key($(this).val(),'bundle');
+    });
+
+    validate_external_key($('#subscription_external_key').val(),'subscription');
+    $('#subscription_external_key').on('change', function(e){
         validate_external_key($(this).val(),'subscription');
     });
 
@@ -199,7 +205,7 @@ jQuery(document).ready(function ($) {
             return;
         }
 
-        var message = 'Request Status: ' + jqxhr.status + ', Status Text: ' + jqxhr.statusText + ': ' + getMessageFromResponse(jqxhr);
+        var message = 'Request error: ' + getMessageFromResponse(jqxhr);
 
         if (jqxhr.status == 200) {
             message = thrownError.message == undefined ? thrownError : thrownError.message;

data/app/assets/stylesheets/kaui/common.less

@@ -717,4 +717,47 @@ form[id^="new_tag_definition"] {
 
 .switch-tenant-active {
     color: #00919d;
-}
+}
+
+/* Required for https://github.com/killbill/killbill-admin-ui/issues/262 */
+.ui-autocomplete {
+  position: absolute;
+  z-index: 1000;
+  float: left;
+  display: none;
+  min-width: 160px;
+  padding: 4px 0;
+  margin: 2px 0 0 0;
+  list-style: none;
+  background-color: #ffffff;
+  border-color: rgba(0, 0, 0, 0.2);
+  border-style: solid;
+  border-width: 1px;
+  border-radius: 5px;
+  box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);
+  background-clip: padding-box;
+
+  .ui-menu-item {
+    display: block;
+    padding: 3px 15px;
+    clear: both;
+    font-weight: normal;
+    line-height: 18px;
+    color: #555555;
+    white-space: nowrap;
+
+    .ui-state-active, .ui-state-hover {
+      color: #ffffff;
+      text-decoration: none;
+      background-color: #0088cc;
+      border-radius: 0px;
+      -webkit-border-radius: 0px;
+      -moz-border-radius: 0px;
+      background-image: none;
+    }
+  }
+}
+
+.ui-helper-hidden-accessible {
+  display: none;
+}

data/app/controllers/kaui/admin_tenants_controller.rb

@@ -81,12 +81,7 @@ class Kaui::AdminTenantsController < Kaui::EngineController
     fetch_overdue = promise { Kaui::Overdue::get_overdue_json(options) rescue @overdue = nil }
     fetch_overdue_xml = promise { Kaui::Overdue::get_tenant_overdue_config('xml', options) rescue @overdue_xml = nil }
 
-    plugin_repository = Kaui::AdminTenant::get_plugin_repository
-    # hack:: replace paypal key with paypal_express, to set configuration and allow the ui to find the right configuration inputs
-    plugin_repository = plugin_repository.inject({}) { |p, (k,v)| p[k.to_s.sub(/\Apaypal/, 'paypal_express').to_sym] = v; p }
-
-    fetch_plugin_config = promise { Kaui::AdminTenant::get_oss_plugin_info(plugin_repository) }
-    fetch_tenant_plugin_config = promise { Kaui::AdminTenant::get_tenant_plugin_config(plugin_repository, options) }
+    fetch_tenant_plugin_config = promise { Kaui::AdminTenant::get_tenant_plugin_config(options) }
 
     @catalog_versions = []
     wait(fetch_catalog_versions).each_with_index do |effective_date, idx|
@@ -98,7 +93,6 @@ class Kaui::AdminTenantsController < Kaui::EngineController
 
     @overdue = wait(fetch_overdue)
     @overdue_xml = wait(fetch_overdue_xml)
-    @plugin_config = wait(fetch_plugin_config) rescue ''
     @tenant_plugin_config = wait(fetch_tenant_plugin_config) rescue ''
 
     # When reloading page from the view, it sends the last tab that was active
@@ -121,27 +115,15 @@ class Kaui::AdminTenantsController < Kaui::EngineController
   end
 
   def new_catalog
-    @tenant = safely_find_tenant_by_id(params[:id])
-
     options = tenant_options_for_client
-    options[:api_key] = @tenant.api_key
-    options[:api_secret] = @tenant.api_secret
-
-    latest_catalog = Kaui::Catalog::get_catalog_json(true, nil, options)
-
-    @ao_mapping = Kaui::Catalog::build_ao_mapping(latest_catalog)
-
-    @available_base_products = latest_catalog && latest_catalog.products ?
-        latest_catalog.products.select { |p| p.type == 'BASE' }.map { |p| p.name } : []
-    @available_ao_products = latest_catalog && latest_catalog.products ?
-        latest_catalog.products.select { |p| p.type == 'ADD_ON' }.map { |p| p.name } : []
-    @available_standalone_products = latest_catalog && latest_catalog.products ?
-        latest_catalog.products.select { |p| p.type == 'STANDALONE' }.map { |p| p.name } : []
-    @product_categories = [:BASE, :ADD_ON, :STANDALONE]
-    @billing_period = [:DAILY, :WEEKLY, :BIWEEKLY, :THIRTY_DAYS, :MONTHLY, :QUARTERLY, :BIANNUAL, :ANNUAL, :BIENNIAL]
-    @time_units = [:UNLIMITED, :DAYS, :WEEKS, :MONTHS, :YEARS]
-
-    @simple_plan = Kaui::SimplePlan.new
+    fetch_state_for_new_catalog_screen(options)
+    @simple_plan = Kaui::SimplePlan.new({
+                                         :product_category => 'BASE',
+                                         :amount => 0,
+                                         :trial_length => 0,
+                                         :currency => 'USD',
+                                         :billing_period => 'MONTHLY'
+                                        })
   end
 
   def delete_catalog
@@ -189,21 +171,55 @@ class Kaui::AdminTenantsController < Kaui::EngineController
   end
 
   def create_simple_plan
-    current_tenant = safely_find_tenant_by_id(params[:id])
-
     options = tenant_options_for_client
-    options[:api_key] = current_tenant.api_key
-    options[:api_secret] = current_tenant.api_secret
+    fetch_state_for_new_catalog_screen(options)
 
     simple_plan = params.require(:simple_plan).delete_if { |e, value| value.blank? }
     # Fix issue in Rails where first entry in the multi-select array is an empty string
     simple_plan["available_base_products"].reject!(&:blank?) if simple_plan["available_base_products"]
 
-    simple_plan = KillBillClient::Model::SimplePlanAttributes.new(simple_plan)
-
-    Kaui::Catalog.add_tenant_catalog_simple_plan(simple_plan, options[:username], nil, comment, options)
+    @simple_plan = Kaui::SimplePlan.new(simple_plan)
+
+    valid = true
+    # Validate new simple plan
+    # https://github.com/killbill/killbill-admin-ui/issues/247
+    if @available_base_products.include?(@simple_plan.plan_id)
+      flash.now[:error] = "Error while creating plan: invalid plan name (#{@simple_plan.plan_id} is a BASE product already)"
+      valid = false
+    elsif @available_ao_products.include?(@simple_plan.plan_id)
+      flash.now[:error] = "Error while creating plan: invalid plan name (#{@simple_plan.plan_id} is an ADD_ON product already)"
+      valid = false
+    elsif @available_standalone_products.include?(@simple_plan.plan_id)
+      flash.now[:error] = "Error while creating plan: invalid plan name (#{@simple_plan.plan_id} is a STANDALONE product already)"
+      valid = false
+    elsif @all_plans.include?(@simple_plan.product_name)
+      flash.now[:error] = "Error while creating plan: invalid product name (#{@simple_plan.product_name} is a plan name already)"
+      valid = false
+    elsif @all_plans.include?(@simple_plan.plan_id)
+      flash.now[:error] = "Error while creating plan: plan #{@simple_plan.plan_id} already exists"
+      valid = false
+    elsif @available_base_products.include?(@simple_plan.product_name) && @simple_plan.product_category != 'BASE'
+      flash.now[:error] = "Error while creating plan: product #{@simple_plan.product_name} is a BASE product"
+      valid = false
+    elsif @available_ao_products.include?(@simple_plan.product_name) && @simple_plan.product_category != 'ADD_ON'
+      flash.now[:error] = "Error while creating plan: product #{@simple_plan.product_name} is an ADD_ON product"
+      valid = false
+    elsif @available_standalone_products.include?(@simple_plan.product_name) && @simple_plan.product_category != 'STANDALONE'
+      flash.now[:error] = "Error while creating plan: product #{@simple_plan.product_name} is a STANDALONE product"
+      valid = false
+    end
 
-    redirect_to admin_tenant_path(current_tenant.id), :notice => 'Catalog plan was successfully added'
+    if valid
+      begin
+        Kaui::Catalog.add_tenant_catalog_simple_plan(@simple_plan, options[:username], nil, comment, options)
+        redirect_to admin_tenant_path(@tenant.id), :notice => 'Catalog plan was successfully added'
+      rescue => e
+        flash.now[:error] = "Error while creating plan: #{as_string(e)}"
+        render :action => :new_catalog
+      end
+    else
+      render :action => :new_catalog
+    end
   end
 
   def new_overdue_config
@@ -307,6 +323,8 @@ class Kaui::AdminTenantsController < Kaui::EngineController
 
     if plugin_properties.blank?
       flash[:error] = 'Plugin properties cannot be blank'
+    elsif plugin_name.blank?
+      flash[:error] = 'Plugin name cannot be blank'
     else
       plugin_config = Kaui::AdminTenant.format_plugin_config(plugin_key, plugin_type, plugin_properties)
 
@@ -314,7 +332,7 @@ class Kaui::AdminTenantsController < Kaui::EngineController
       flash[:notice] = 'Config for plugin was successfully uploaded'
     end
 
-    redirect_to admin_tenant_path(current_tenant.id)
+    redirect_to admin_tenant_path(current_tenant.id, :active_tab => 'PluginConfig')
   end
 
   def remove_allowed_user
@@ -406,28 +424,6 @@ class Kaui::AdminTenantsController < Kaui::EngineController
     end
   end
 
-  def suggest_plugin_name
-    json_response do
-      message = nil
-      entered_plugin_name = params.require(:plugin_name)
-      plugin_repository = view_context.plugin_repository
-
-      found_plugin, weights = fuzzy_match(entered_plugin_name, plugin_repository)
-
-      if weights.size > 0
-        plugin_anchor = view_context.link_to(weights[0][:plugin_name], '#', id: 'suggested',
-                                            data: {
-                                                plugin_name: weights[0][:plugin_name],
-                                                plugin_key: weights[0][:plugin_key],
-                                                plugin_type: weights[0][:plugin_type],
-                                            })
-        message = "Similar plugin already installed: '#{plugin_anchor}'" if weights[0][:worth_weight].to_f >= 1.0 && weights[0][:installed]
-        message = "Did you mean '#{plugin_anchor}'?" if weights[0][:worth_weight].to_f < 1.0 || !weights[0][:installed]
-      end
-      { suggestion: message, plugin: found_plugin }
-    end
-  end
-
   def switch_tenant
     tenant = Kaui::Tenant.find_by_kb_tenant_id(params.require(:kb_tenant_id))
 
@@ -441,6 +437,29 @@ class Kaui::AdminTenantsController < Kaui::EngineController
 
   private
 
+  # Share code to handle render on error
+  def fetch_state_for_new_catalog_screen(options)
+    @tenant = safely_find_tenant_by_id(params[:id])
+
+    options[:api_key] = @tenant.api_key
+    options[:api_secret] = @tenant.api_secret
+
+    latest_catalog = Kaui::Catalog::get_catalog_json(true, nil, options)
+    @all_plans = latest_catalog ? (latest_catalog.products || []).map(&:plans).flatten.map(&:name) : []
+
+    @ao_mapping = Kaui::Catalog::build_ao_mapping(latest_catalog)
+
+    @available_base_products = latest_catalog && latest_catalog.products ?
+        latest_catalog.products.select { |p| p.type == 'BASE' }.map { |p| p.name } : []
+    @available_ao_products = latest_catalog && latest_catalog.products ?
+        latest_catalog.products.select { |p| p.type == 'ADD_ON' }.map { |p| p.name } : []
+    @available_standalone_products = latest_catalog && latest_catalog.products ?
+        latest_catalog.products.select { |p| p.type == 'STANDALONE' }.map { |p| p.name } : []
+    @product_categories = [:BASE, :ADD_ON, :STANDALONE]
+    @billing_period = [:DAILY, :WEEKLY, :BIWEEKLY, :THIRTY_DAYS, :MONTHLY, :QUARTERLY, :BIANNUAL, :ANNUAL, :BIENNIAL]
+    @time_units = [:UNLIMITED, :DAYS, :WEEKS, :MONTHS, :YEARS]
+  end
+
   def safely_find_tenant_by_id(tenant_id)
     tenant = Kaui::Tenant.find_by_id(tenant_id)
     raise ActiveRecord::RecordNotFound.new('Could not find tenant ' + tenant_id) unless retrieve_tenants_for_current_user.include?(tenant.kb_tenant_id)
@@ -473,54 +492,6 @@ class Kaui::AdminTenantsController < Kaui::EngineController
     data.to_s.split(/(?=[A-Z])|(?=[_])|(?=[-])|(?=[ ])/).select {|member| !member.gsub(/[_-]/,'').strip.empty?}.map { |member| member.gsub(/[_-]/,'').strip.downcase }
   end
 
-  def fuzzy_match(entered_plugin_name, plugin_repository)
-    splitted_entered_plugin_name = split_camel_dash_underscore_space(entered_plugin_name)
-    worth_of_non_words = 0.5 / splitted_entered_plugin_name.size.to_i
-
-    weights = []
-
-    plugin_repository.each do |plugin|
-      return plugin, [] if plugin[:plugin_name] == entered_plugin_name || plugin[:plugin_key] == entered_plugin_name
-      weight = { :plugin_name => plugin[:plugin_name], :plugin_key => plugin[:plugin_key],
-                 :plugin_type => plugin[:plugin_type], :installed => plugin[:installed], :worth_weight => 0.0 }
-
-      splitted_plugin_name = split_camel_dash_underscore_space(plugin[:plugin_name])
-      splitted_entered_plugin_name.each do |entered|
-        if splitted_plugin_name.include?(entered)
-          weight[:worth_weight] = weight[:worth_weight] + 1.0
-        end
-
-        splitted_plugin_name.each do |splitted|
-          if entered.chars.all? { |ch| splitted.include?(ch) }
-            weight[:worth_weight] = weight[:worth_weight] + worth_of_non_words
-            break
-          end
-        end
-
-        # perform a plugin key search, if weight is zero
-        next unless weight[:worth_weight] == 0
-        splitted_plugin_key = split_camel_dash_underscore_space(plugin[:plugin_key])
-
-        if splitted_plugin_key.include?(entered)
-          weight[:worth_weight] = weight[:worth_weight] + 1.0
-        end
-
-        splitted_plugin_key.each do |splitted|
-          if entered.chars.all? { |ch| splitted.include?(ch) }
-            weight[:worth_weight] = weight[:worth_weight] + worth_of_non_words
-            break
-          end
-        end
-      end
-
-      weights << weight if weight[:worth_weight] > 0
-
-    end
-
-    weights.sort! { |a,b| b[:worth_weight] <=> a[:worth_weight] } if weights.size > 1
-    return nil, weights
-  end
-
   def fetch_catalog_xml(tenant_id, effective_date)
     current_tenant = safely_find_tenant_by_id(tenant_id)
 

data/app/controllers/kaui/audit_logs_controller.rb

@@ -1,5 +1,5 @@
 class Kaui::AuditLogsController < Kaui::EngineController
-  OBJECT_WITH_HISTORY = %w[ACCOUNT ACCOUNT_EMAIL CUSTOM_FIELD PAYMENT_ATTEMPT PAYMENT PAYMENT_METHOD TRANSACTION TAG TAG_DEFINITION]
+  OBJECT_WITH_HISTORY = %w[ACCOUNT ACCOUNT_EMAIL BLOCKING_STATES BUNDLE CUSTOM_FIELD INVOICE INVOICE_ITEM PAYMENT_ATTEMPT PAYMENT PAYMENT_METHOD SUBSCRIPTION SUBSCRIPTION_EVENT TRANSACTION TAG TAG_DEFINITION]
 
   def index
     cached_options_for_klient = options_for_klient
@@ -57,8 +57,25 @@ class Kaui::AuditLogsController < Kaui::EngineController
         elsif object_type == 'ACCOUNT_EMAIL'
           account = Kaui::Account::find_by_id_or_key(account_id, false, false, cached_options_for_klient)
           audit_logs_with_history = account.email_audit_logs_with_history(object_id, cached_options_for_klient)
+        elsif object_type == 'BLOCKING_STATES'
+          audit_logs_with_history = Kaui::Account::blocking_state_audit_logs_with_history(object_id, cached_options_for_klient)
+        elsif object_type == 'BUNDLE'
+          bundle = Kaui::Bundle::find_by_id(object_id, cached_options_for_klient)
+          audit_logs_with_history = bundle.audit_logs_with_history(cached_options_for_klient)
         elsif object_type == 'CUSTOM_FIELD'
           audit_logs_with_history = Kaui::CustomField.new({:custom_field_id => object_id}).audit_logs_with_history(cached_options_for_klient)
+        elsif object_type == 'INVOICE'
+          invoice = Kaui::Invoice::find_by_id(object_id, false, "NONE", cached_options_for_klient)
+          audit_logs_with_history = invoice.audit_logs_with_history(cached_options_for_klient)
+        elsif object_type == 'INVOICE_ITEM'
+          invoice_item = Kaui::InvoiceItem.new
+          invoice_item.invoice_item_id = object_id
+          audit_logs_with_history = invoice_item.audit_logs_with_history(cached_options_for_klient)
+=begin See https://github.com/killbill/killbill/issues/1104
+        elsif object_type == 'INVOICE_PAYMENT'
+          invoice_payment = Kaui::InvoicePayment::find_by_id(object_id, false, false, cached_options_for_klient)
+          audit_logs_with_history = invoice_payment.audit_logs_with_history(cached_options_for_klient)
+=end
         elsif object_type == 'PAYMENT_ATTEMPT'
           audit_logs_with_history = Kaui::Payment::attempt_audit_logs_with_history(object_id, cached_options_for_klient)
         elsif object_type == 'PAYMENT'
@@ -67,6 +84,11 @@ class Kaui::AuditLogsController < Kaui::EngineController
         elsif object_type == 'PAYMENT_METHOD'
           payment_method = Kaui::PaymentMethod::find_by_id(object_id, false, cached_options_for_klient)
           audit_logs_with_history = payment_method.audit_logs_with_history(cached_options_for_klient)
+        elsif object_type == 'SUBSCRIPTION'
+          subscription = Kaui::Subscription::find_by_id(object_id, cached_options_for_klient)
+          audit_logs_with_history = subscription.audit_logs_with_history(cached_options_for_klient)
+        elsif object_type == 'SUBSCRIPTION_EVENT'
+          audit_logs_with_history = Kaui::Subscription::event_audit_logs_with_history(object_id, cached_options_for_klient)
         elsif object_type == 'TRANSACTION'
           audit_logs_with_history = Kaui::Transaction::new({:transaction_id => object_id}).audit_logs_with_history(cached_options_for_klient)
         elsif object_type == 'TAG'

data/app/controllers/kaui/bundles_controller.rb

@@ -31,6 +31,10 @@ class Kaui::BundlesController < Kaui::EngineController
     @available_tags = wait(fetch_available_tags)
     @available_subscription_tags = wait(fetch_available_subscription_tags)
 
+    # TODO This doesn't take into account catalog versions
+    catalogs = Kaui::Catalog.get_account_catalog_json(@account.account_id, nil, cached_options_for_klient) || []
+    @catalog = catalogs[-1]
+
     @subscription = {}
     @bundles.each do |bundle|
       bundle.subscriptions.each do |sub|