kaui 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c998eb4ff14442f28a18da7cab14072cc7d19dfc
-  data.tar.gz: 660dbac2ba54d6d0c853b63c697587e486a5c2ed
+  metadata.gz: 062f8cf3943a8a8cae8f80490cac4c2545ed68bd
+  data.tar.gz: 398c6df309bdd8bf44eaddcac3273e9cfc394d17
 SHA512:
-  metadata.gz: 714a6e0da369b82570551cd082b7fd9b8d62ab18e906756a4194e31dfa5f90d47dd5b8624f5ca070915e45308d31839f451cca5a343895642d50ba47c89d1716
-  data.tar.gz: bc72e0c1b8febf3d413d1191e48431a2d330aff546e84493953e0697b043258365973d3fd5d0ea6dddab244b4c9a5d4cc6a92d9ce9e60155cf9663f7acc92b60
+  metadata.gz: df121d5c0caa28f819c2678c7abf61a4ed161ee16dc6f047f7e6ca0279348f682de5dd8ce57e6bd31ad70f164892a44d911f22da2eaaa3689c4bf06dd560b302
+  data.tar.gz: 405d0913456d27232ee1518fb1637efc35423f62f5a948e3312e817c2547fe8f04f38029b5e8d4785522480ef261853640bddf728143e3f84a45408ff26b1219

data/README.md

@@ -22,35 +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 DATABASE_URL=mysql://root:killbill@<MySQL Host IP>/killbill
+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
-```
-If you experience an error of;
-
-```
-You must use Bundler 2 or greater with this lockfile.
-```
-
-Then run the following commands to update your environment.
-
-Update Rubygems;
-
-```
-gem update --system
-```
-Update bundler;
-```
-gem install bundler
-```
-Update the Gemfile.lock file;
-```
-bundler update --bundler
+bundle exec rails db:migrate
+bundle exec rails s
 ```
 
 The Kill Bill URL can be configured through the `KILLBILL_URL` environment variable, e.g.
@@ -114,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

@@ -205,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/controllers/kaui/audit_logs_controller.rb

@@ -74,8 +74,8 @@ class Kaui::AuditLogsController < Kaui::EngineController
 =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)
-=end
           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'

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|

data/app/controllers/kaui/engine_controller_util.rb

@@ -65,6 +65,7 @@ module Kaui::EngineControllerUtil
     value = promise.value!(60)
     raise promise.reason unless promise.reason.nil?
     if value.nil? && promise.state != :fulfilled
+      # Could be https://github.com/ruby-concurrency/concurrent-ruby/issues/585
       Rails.logger.warn("Unable to run promise #{promise_as_string(promise)}")
       raise Timeout::Error
     end
@@ -125,7 +126,7 @@ module Kaui::EngineControllerUtil
       response = yield
       response_status = 200
     rescue KillBillClient::API::ResponseError => e
-      response = e.response.message
+      response = as_string_from_response(e.response.body)
       response_status = e.code
     rescue Exception => e
       response = e.message

data/app/controllers/kaui/invoices_controller.rb

@@ -49,7 +49,25 @@ class Kaui::InvoicesController < Kaui::EngineController
 
     @invoice = Kaui::Invoice.find_by_id(params.require(:id), 'FULL', cached_options_for_klient)
     # This will put the TAX items at the bottom
-    @invoice.items.sort_by! { |ii| [ii.item_type, ii.description] }
+    precedence = {
+        'EXTERNAL_CHARGE' => 0,
+        'FIXED' => 1,
+        'RECURRING' => 2,
+        'REPAIR_ADJ' => 3,
+        'USAGE' => 4,
+        'PARENT_SUMMARY' => 5,
+        'ITEM_ADJ' => 6,
+        'CBA_ADJ' => 7,
+        'CREDIT_ADJ' => 8,
+        'TAX' => 9
+    }
+    # TODO The pretty description has to be shared with the view
+    @invoice.items.sort_by! do |ii|
+      # Make sure not to compare nil (ArgumentError comparison of Array with Array failed)
+      a = precedence[ii.item_type] || 100
+      b = (ii.pretty_plan_name.blank? || !ii.item_type.in?(%w{USAGE RECURRING}) ? ii.description : ii.pretty_plan_name) || ''
+      [a, b]
+    end
 
     fetch_payments = promise { @invoice.payments(true, true, 'FULL', cached_options_for_klient).map { |payment| Kaui::InvoicePayment.build_from_raw_payment(payment) } }
     fetch_pms = fetch_payments.then { |payments| Kaui::PaymentMethod.payment_methods_for_payments(payments, cached_options_for_klient) }

data/app/helpers/kaui/subscription_helper.rb

@@ -19,11 +19,24 @@ module Kaui
       end
     end
 
-    def humanized_subscription_product_name(sub)
-      if !sub.present? or !sub.product_name.present?
+    def humanized_subscription_product_name(sub, catalog = nil)
+      if !sub.present? || !sub.product_name.present?
         nil
       else
-        humanized_product_name(sub.product_name)
+        product = catalog.nil? ? nil : catalog.products.find { |p| p.name == sub.product_name }
+        humanized_product_name(!product.nil? && !product.pretty_name.blank? ? product.pretty_name : sub.product_name)
+      end
+    end
+
+    def humanized_subscription_pretty_plan_name(sub, catalog = nil)
+      if !sub.present? || !sub.product_name.present?
+        nil
+      else
+        product = catalog.nil? ? nil : catalog.products.find { |p| p.name == sub.product_name }
+        return nil if product.nil?
+
+        plan = product.plans.find { |p| p.name == sub.plan_name }
+        plan.nil? || plan.pretty_name.blank? ? nil : plan.pretty_name
       end
     end
 
@@ -56,8 +69,11 @@ module Kaui
       end
     end
 
-    def humanized_subscription_full_product_name(sub)
-      humanized_product_name   = humanized_subscription_product_name(sub)
+    def humanized_subscription_plan_or_product_name(sub, catalog = nil)
+      pretty_plan_name = humanized_subscription_pretty_plan_name(sub, catalog)
+      return pretty_plan_name unless pretty_plan_name.nil?
+
+      humanized_product_name   = humanized_subscription_product_name(sub, catalog)
       humanized_billing_period = humanized_subscription_billing_period(sub)
       humanized_price_list     = humanized_subscription_price_list(sub, false)
 

data/app/models/kaui/catalog.rb

@@ -4,6 +4,20 @@ class Kaui::Catalog < KillBillClient::Model::Catalog
 
   class << self
 
+    def get_account_catalog_json(account_id, requested_date = nil, options = {})
+      params = {}
+      params[:accountId] = account_id
+      params[:requestedDate] = requested_date if requested_date
+
+      get KillBillClient::Model::Catalog::KILLBILL_API_CATALOG_PREFIX,
+          params,
+          {
+              :head => {'Accept' => "application/json"},
+              :content_type => "application/json",
+
+          }.merge(options)
+    end
+
     def get_tenant_catalog_json(requested_date = nil, options = {})
       super
     rescue ::KillBillClient::API::InternalServerError => e

data/app/views/kaui/bundles/index.html.erb

@@ -76,7 +76,7 @@
 
         <% if bundle.subscriptions.present? %>
             <div class="search">
-              <%= render :partial => 'kaui/subscriptions/subscriptions_table', :locals => {:bundle => bundle, :account => @account} %>
+              <%= render :partial => 'kaui/subscriptions/subscriptions_table', :locals => {:bundle => bundle, :account => @account, :catalog => @catalog} %>
             </div>
         <% end %>
 

data/app/views/kaui/invoices/_invoice_table.html.erb

@@ -82,7 +82,7 @@
 
               </td>
           <% end %>
-          <td onClick="hightlightLinkedItems('<%= item.invoice_item_id %>', '<%= item.linked_invoice_item_id %>'); return false;"><%= item.description %></td>
+          <td onClick="hightlightLinkedItems('<%= item.invoice_item_id %>', '<%= item.linked_invoice_item_id %>'); return false;"><%= item.pretty_plan_name.blank? || !item.item_type.in?(%w{USAGE RECURRING}) ? item.description : item.pretty_plan_name %></td>
           <td onClick="hightlightLinkedItems('<%= item.invoice_item_id %>', '<%= item.linked_invoice_item_id %>'); return false;"><%= item.start_date.html_safe if item.start_date %></td>
           <td onClick="hightlightLinkedItems('<%= item.invoice_item_id %>', '<%= item.linked_invoice_item_id %>'); return false;"><%= item.end_date.html_safe if item.end_date %></td>
           <td onClick="hightlightLinkedItems('<%= item.invoice_item_id %>', '<%= item.linked_invoice_item_id %>'); return false;"><%= item.subscription_id %></td>
@@ -130,7 +130,7 @@
 
 <script language="javascript">
     function hightlightLinkedItems(invoice_item_id, linked_invoice_item_id) {
-        $("#invoice_table tr:gt(0)").each(function (index) {
+        $("#invoice-table tr:gt(0)").each(function (index) {
             var ids = $(this).attr("id").split("_");
             var item_id = ids[2];
             var linked_item_id = ids[3];

data/app/views/kaui/invoices/show.html.erb

@@ -105,6 +105,7 @@
     $('#invoice-table').dataTable({
       "dom": "t",
       "paging": false,
+      "order": [],
       "columns": [
         null,
         null,

data/app/views/kaui/subscriptions/_subscriptions_table.html.erb

@@ -4,8 +4,8 @@
     <% unless @available_subscription_tags.blank? && @custom_fields_per_subscription.blank? %>
       <th></th>
     <% end %>
-    <th>Product category</th>
-    <th>Product name</th>
+    <th>Category</th>
+    <th>Name</th>
     <th>Phase type</th>
     <th>Start date</th>
     <th>Charged through date</th>
@@ -47,7 +47,7 @@
             <%= humanized_subscription_product_category(sub) %>
           </span>
         </td>
-        <td><%= humanized_subscription_full_product_name(sub) %></td>
+        <td><%= humanized_subscription_plan_or_product_name(sub, catalog) %></td>
         <td><%= humanized_subscription_phase_type(sub) %></td>
         <td><%= humanized_subscription_start_date(sub, account) %></td>
         <td><%= humanized_subscription_charged_through_date(sub, account) %></td>

data/lib/kaui/version.rb

@@ -1,3 +1,3 @@
 module Kaui
-  VERSION = '2.0.3'
+  VERSION = '2.0.4'
 end

data/test/dummy/config/database.yml

@@ -3,7 +3,7 @@ default: &default
   encoding: utf8
   username: <%= ENV.fetch('DB_USER', 'root') %>
   password: <%= ENV.fetch('DB_PASSWORD', 'root') %>
-  host: 127.0.0.1
+  host: <%= ENV.fetch('DB_HOST', '127.0.0.1') %>
   port: <%= ENV.fetch('DB_PORT', '3306') %>
   pool: 25
   timeout: 5000
@@ -17,7 +17,7 @@ default: &default
 
 development:
   <<: *default
-  database: kaui
+  database: <%= ENV.fetch('DB_NAME', 'kaui') %>
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaui
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Killbill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -402,6 +402,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -885,106 +899,106 @@ signing_key:
 specification_version: 4
 summary: Killbill Admin UI mountable engine
 test_files:
-- test/fixtures/catalog-v1.xml
-- test/fixtures/invoice_translation_fr-v1.properties
-- test/fixtures/catalog_translation_fr-v1.properties
-- test/fixtures/invoice_template-v1.html
-- test/fixtures/overdue-v1.xml
-- test/fixtures/stripe.yml
-- test/fixtures/SpyCarAdvanced.xml
-- test/unit/kaui/admin_tenant_test.rb
-- test/unit/kaui/payment_test.rb
-- test/unit/kaui/base_test.rb
-- test/unit/kaui/invoice_test.rb
-- test/unit/kaui/allowed_user_test.rb
-- test/unit/kaui/invoice_payment_test.rb
-- test/unit/kaui/account_test.rb
-- test/unit/kaui/invoice_item_test.rb
-- test/unit/kaui/tag_definition_test.rb
-- test/unit/kaui/account_email_test.rb
-- test/unit/kaui/date_helper_test.rb
-- test/unit/kaui/tenant_test.rb
-- test/unit/kaui/money_helper_test.rb
-- test/unit/helpers/kaui/tenants_helper_test.rb
-- test/unit/helpers/kaui/payment_method_helper_test.rb
-- test/unit/helpers/kaui/admin_tenants_helper_test.rb
-- test/unit/helpers/kaui/admin_allowed_users_helper_test.rb
-- test/unit/helpers/kaui/uuid_helper_test.rb
-- test/test_helper.rb
 - test/integration/kaui/integration_test_helper.rb
 - test/integration/kaui/navigation_test.rb
 - test/integration/kaui/date_helper_integration_test.rb
-- test/dummy/public/404.html
+- test/test_helper.rb
+- test/killbill_test_helper.rb
 - test/dummy/public/422.html
+- test/dummy/public/404.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
+- test/dummy/README.rdoc
 - test/dummy/config/secrets.yml
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environment.rb
+- test/dummy/config/application.rb
 - test/dummy/config/routes.rb
-- test/dummy/config/symmetric-encryption.yml
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/database.yml
-- test/dummy/config/initializers/new_framework_defaults_5_1.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/killbill_client.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/new_framework_defaults_5_1.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/symmetric-encryption.yml
 - test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/Rakefile
+- test/dummy/config/locales/en.yml
+- test/dummy/config/database.yml
+- test/dummy/db/schema.rb
 - test/dummy/script/rails
-- test/dummy/README.rdoc
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/config.ru
+- test/dummy/bin/yarn
+- test/dummy/bin/setup
 - test/dummy/bin/rake
 - test/dummy/bin/bundle
 - test/dummy/bin/update
-- test/dummy/bin/setup
-- test/dummy/bin/yarn
 - test/dummy/bin/rails
-- test/dummy/db/schema.rb
-- test/killbill_test_helper.rb
-- test/functional/kaui/transactions_controller_test.rb
-- test/functional/kaui/admin_tenants_controller_test.rb
-- test/functional/kaui/credits_controller_test.rb
-- test/functional/kaui/home_controller_test.rb
-- test/functional/kaui/tag_definitions_controller_test.rb
-- test/functional/kaui/account_children_controller_test.rb
-- test/functional/kaui/account_timelines_controller_test.rb
-- test/functional/kaui/custom_fields_controller_test.rb
-- test/functional/kaui/charges_controller_test.rb
-- test/functional/kaui/account_emails_controller_test.rb
-- test/functional/kaui/queues_controller_test.rb
-- test/functional/kaui/admin_controller_test.rb
-- test/functional/kaui/accounts_controller_test.rb
-- test/functional/kaui/subscriptions_controller_test.rb
-- test/functional/kaui/chargebacks_controller_test.rb
-- test/functional/kaui/payments_controller_test.rb
+- test/dummy/config.ru
+- test/dummy/Rakefile
+- test/functional/kaui/refunds_controller_test.rb
+- test/functional/kaui/registrations_controller_test.rb
 - test/functional/kaui/bundles_controller_test.rb
-- test/functional/kaui/tags_controller_test.rb
 - test/functional/kaui/account_tags_controller_test.rb
+- test/functional/kaui/admin_controller_test.rb
 - test/functional/kaui/functional_test_helper_nosetup.rb
-- test/functional/kaui/account_custom_fields_controller_test.rb
-- test/functional/kaui/invoice_items_controller_test.rb
-- test/functional/kaui/admin_allowed_users_controller_test.rb
-- test/functional/kaui/refunds_controller_test.rb
-- test/functional/kaui/audit_logs_controller_test.rb
-- test/functional/kaui/registrations_controller_test.rb
-- test/functional/kaui/invoices_controller_test.rb
 - test/functional/kaui/role_definitions_controller_test.rb
-- test/functional/kaui/payment_methods_controller_test.rb
+- test/functional/kaui/tags_controller_test.rb
+- test/functional/kaui/queues_controller_test.rb
+- test/functional/kaui/home_controller_test.rb
+- test/functional/kaui/accounts_controller_test.rb
 - test/functional/kaui/bundle_tags_controller_test.rb
+- test/functional/kaui/credits_controller_test.rb
+- test/functional/kaui/account_timelines_controller_test.rb
 - test/functional/kaui/login_proxy_controller_test.rb
 - test/functional/kaui/tenants_controller_test.rb
+- test/functional/kaui/tag_definitions_controller_test.rb
+- test/functional/kaui/admin_allowed_users_controller_test.rb
 - test/functional/kaui/functional_test_helper.rb
+- test/functional/kaui/audit_logs_controller_test.rb
+- test/functional/kaui/account_custom_fields_controller_test.rb
+- test/functional/kaui/transactions_controller_test.rb
+- test/functional/kaui/charges_controller_test.rb
+- test/functional/kaui/chargebacks_controller_test.rb
+- test/functional/kaui/payment_methods_controller_test.rb
+- test/functional/kaui/subscriptions_controller_test.rb
+- test/functional/kaui/custom_fields_controller_test.rb
+- test/functional/kaui/account_children_controller_test.rb
+- test/functional/kaui/payments_controller_test.rb
+- test/functional/kaui/invoices_controller_test.rb
+- test/functional/kaui/admin_tenants_controller_test.rb
+- test/functional/kaui/invoice_items_controller_test.rb
+- test/functional/kaui/account_emails_controller_test.rb
+- test/fixtures/overdue-v1.xml
+- test/fixtures/SpyCarAdvanced.xml
+- test/fixtures/catalog-v1.xml
+- test/fixtures/invoice_template-v1.html
+- test/fixtures/catalog_translation_fr-v1.properties
+- test/fixtures/stripe.yml
+- test/fixtures/invoice_translation_fr-v1.properties
+- test/unit/kaui/invoice_item_test.rb
+- test/unit/kaui/admin_tenant_test.rb
+- test/unit/kaui/base_test.rb
+- test/unit/kaui/money_helper_test.rb
+- test/unit/kaui/payment_test.rb
+- test/unit/kaui/invoice_test.rb
+- test/unit/kaui/tag_definition_test.rb
+- test/unit/kaui/date_helper_test.rb
+- test/unit/kaui/invoice_payment_test.rb
+- test/unit/kaui/allowed_user_test.rb
+- test/unit/kaui/account_test.rb
+- test/unit/kaui/account_email_test.rb
+- test/unit/kaui/tenant_test.rb
+- test/unit/helpers/kaui/tenants_helper_test.rb
+- test/unit/helpers/kaui/admin_tenants_helper_test.rb
+- test/unit/helpers/kaui/admin_allowed_users_helper_test.rb
+- test/unit/helpers/kaui/payment_method_helper_test.rb
+- test/unit/helpers/kaui/uuid_helper_test.rb