killbill-deposit 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09496c07a7db3caa0dcf65fc18faf53d19a0cb17'
+  data.tar.gz: 76ce6e54f69e81e6159f1f5af4851d31f6ca2fd0
+SHA512:
+  metadata.gz: 451564c625a229a0f661a2eb6c2df28ad60ba80d61e019bef72cc0029dc333ca6f52f044459e40c4275a5b5540d5665bc8788261bf41b4277c4d076a5e452c43
+  data.tar.gz: 2bd27f8b964de1455b9d6d1c8c9e04556b4b752d2157438c1e8212c2fa7c1a4ff0e15eb93deecdae4bba7725ee015817634ccae20a6a09a54ebd68860d823aab

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2021 Equinix, Inc
+Copyright 2021 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,48 @@
+Overview
+========
+
+This Rails mountable engine allows you to manage your Deposit integration in Kill Bill.
+
+* See [killbill-deposit-plugin](https://github.com/killbill/killbill-deposit-plugin) to get started with the Deposit 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
+-----------------------
+
+| Deposit UI version | Kill Bill version |
+| ----------------: | ----------------: |
+| 0.0.y             | 0.22.z            |
+
+Functionality
+-------------
+
+This app lets you:
+
+* Record and categorize external payments as Cash, Check, Bank Transfer, etc.
+* Apply payments to one or multiple invoices.
+* Identify invoice line items that are unpaid (e.g. if the customer is disputing a subset of the invoice).
+
+Getting Started
+---------------
+
+You can run this locally by using the test/dummy app provided.
+
+To do so, specify your Kill Bill server url, api key and secret in ```test/dummy/config/initializers/killbill_client.rb```:
+
+```
+KillBillClient.url = 'http://127.0.0.1:8080/'
+KillBillClient.api_key = 'bob'
+KillBillClient.api_secret = 'lazar'
+```
+
+Then, simply run:
+
+```
+rails s
+```
+
+To run tests:
+
+```
+rails t
+```

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+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    = 'Deposit'
+  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', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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
+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 deposit/deposit

data/app/assets/javascripts/deposit/deposit.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 deposit/deposit
+ */

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/deposit/deposit.css

@@ -0,0 +1,16 @@
+/*
+ * 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 .
+*/
+
+.payment_amount_invoice {
+    width: 100%;
+}
+
+#deposit_amount_mismatch {
+    text-align: right;
+    padding-top: 15px;
+    visibility: hidden;
+}

data/app/controllers/deposit/collection_controller.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'deposit/client'
+
+module Deposit
+  class CollectionController < EngineController
+    def index
+      @account_id = params[:account_id]
+      @currency = params[:currency] || 'USD'
+    end
+
+    def record_payments
+      cached_options_for_klient = options_for_klient
+
+      payments = {}
+      params.each do |k, amount|
+        next unless k.start_with?('payment_amount_')
+
+        _, invoice_nb = k.split('payment_amount_')
+        payments[invoice_nb] = amount
+      end
+
+      begin
+        Killbill::Deposit::DepositClient.record_payments(params[:account_id],
+                                                         params[:effective_date],
+                                                         params[:payment_reference_number],
+                                                         params[:deposit_type],
+                                                         payments,
+                                                         cached_options_for_klient[:username],
+                                                         params[:reason],
+                                                         params[:comment],
+                                                         cached_options_for_klient)
+
+        flash[:notice] = 'Deposit successfully collected'
+        redirect_to kaui_engine.account_path(params[:account_id])
+      rescue StandardError => e
+        flash.now[:error] = case e
+                            when ::KillBillClient::API::NotFound
+                              'Unable to record payment: invoice not found'
+                            when ::KillBillClient::API::BadRequest
+                              'Unable to record payment: deposit type, reference date, and reference number must be specified'
+                            when ::KillBillClient::API::UnprocessableEntity
+                              'Unable to record payment: amount too small or payment in UNKNOWN state'
+                            else
+                              "Internal error: #{as_string(e)}"
+                            end
+
+        @account_id = params[:account_id]
+        @currency = params[:currency] || 'USD'
+
+        render :index
+      end
+    end
+
+    def account_invoices
+      cached_options_for_klient = options_for_klient
+
+      searcher = lambda do |search_key, _offset, _limit|
+        account = begin
+          KillBillClient::Model::Account.find_by_id(search_key, false, false,
+                                                    cached_options_for_klient)
+                  rescue StandardError
+                    nil
+        end
+        if account.nil?
+          []
+        else
+          account.invoices(cached_options_for_klient)
+        end
+      end
+
+      data_extractor = lambda do |invoice, column|
+        [
+          invoice.invoice_number.to_i,
+          invoice.invoice_date,
+          invoice.amount,
+          invoice.balance,
+          nil
+        ][column]
+      end
+
+      formatter = lambda do |invoice|
+        [
+          invoice.invoice_number,
+          invoice.invoice_date,
+          view_context.humanized_money_with_symbol(Money.from_amount(invoice.amount.to_f, invoice.currency)),
+          view_context.humanized_money_with_symbol(Money.from_amount(invoice.balance.to_f, invoice.currency)),
+          nil
+        ]
+      end
+
+      begin
+        search_key = (params[:search] || {})[:value].presence
+        offset = (params[:start] || 0).to_i
+        limit = (params[:length] || 50).to_i
+        pages = searcher.call(search_key, offset, limit)
+      rescue StandardError => e
+        error = e.to_s
+      end
+
+      json = {
+        draw: (params[:draw] || 0).to_i,
+        # We need to fill-in a number to make DataTables happy
+        recordsTotal: pages.nil? ? 0 : limit,
+        recordsFiltered: pages.nil? ? 0 : limit,
+        data: []
+      }
+      json[:error] = error unless error.nil?
+
+      pages ||= []
+
+      # Until we support server-side sorting
+      ordering = ((params[:order] || {})[:'0'] || {})
+      ordering_column = (ordering[:column] || 0).to_i
+      ordering_dir = ordering[:dir] || 'asc'
+      unless search_key.nil?
+        pages.sort! do |a, b|
+          a = data_extractor.call(a, ordering_column)
+          b = data_extractor.call(b, ordering_column)
+          sort = a <=> b
+          sort.nil? ? -1 : sort
+        end
+      end
+      pages.reverse! if ordering_dir == 'desc' && limit >= 0 || ordering_dir == 'asc' && limit.negative?
+
+      pages.each { |page| json[:data] << formatter.call(page) }
+
+      respond_to do |format|
+        format.json { render json: json }
+      end
+    end
+
+    private
+
+    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],
+        # Pass the X-Request-Id seen by Rails to Kill Bill
+        # Note that this means that subsequent requests issued by a single action will share the same X-Request-Id in Kill Bill
+        request_id: request.request_id
+      }
+    end
+  end
+end

data/app/controllers/deposit/engine_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Deposit
+  class EngineController < ApplicationController
+    layout :get_layout
+
+    # Used to format flash error messages
+    def as_string(e)
+      if e.is_a?(KillBillClient::API::ResponseError)
+        "Error #{e.response.code}: #{as_string_from_response(e.response.body)}"
+      else
+        log_rescue_error(e)
+        e.message
+      end
+    end
+
+    def log_rescue_error(error)
+      Rails.logger.warn "#{error.class} #{error.to_s}. #{error.backtrace.join("\n")}"
+    end
+
+    def get_layout
+      layout ||= Deposit.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)
+      Deposit.current_tenant_user.call(session, user)
+    end
+  end
+end

data/app/helpers/deposit/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Deposit
+  module ApplicationHelper
+  end
+end

data/app/views/deposit/collection/_invoices_table.html.erb

@@ -0,0 +1,68 @@
+<div class="search">
+
+  <div class="column-block">
+
+    <h1>Invoices</h1>
+
+    <table id="invoices-table" class="table table-condensed mobile-data">
+      <thead>
+      <tr>
+        <th>Number</th>
+        <th>Date</th>
+        <th>Amount</th>
+        <th>Balance</th>
+        <th>Payment</th>
+      </tr>
+      </thead>
+      <tbody>
+      <tr>
+        <td colspan="1" class="dataTables_empty">Loading data from server</td>
+      </tr>
+      </tbody>
+    </table>
+
+    <div id="deposit_amount_mismatch" class="text-danger">
+      Warning! Total amount doesn't match deposit.
+    </div>
+  </div>
+
+</div>
+
+<%= javascript_tag do %>
+$(document).ready(function() {
+  var table = $('#invoices-table').DataTable({
+    "dom": "t",
+    "paging": false,
+    "ajax": "<%= account_invoices_path :format => :json %>",
+    "processing": true,
+    "serverSide": true,
+    "search": {"search": $('#account_id').val()},
+    "columnDefs": [
+        {
+          "targets": [ 4 ],
+          "orderable": false
+        }
+      ],
+    createdRow: function(row, data, dataIndex) {
+      $('td', row).eq(4).html('<input class="payment_amount_invoice" type="number" name="payment_amount_' + data[0] + '" id="payment_amount_' + dataIndex + '" step="any" class="form-control">')
+    },
+    drawCallback: function() {
+      $('input').change(function() {
+        var table = $('#invoices-table').DataTable();
+        var total = 0;
+        table.rows().every(function (rowIdx, tableLoop, rowLoop) {
+          var d = this.data();
+          total += parseFloat($('#payment_amount_' + rowIdx).val(), 10);
+        });
+        if (total != parseFloat($('#payment_amount').val(), 10)) {
+          $('#deposit_amount_mismatch').css('visibility', 'visible');
+          $('#submit-btn').prop('disabled', true);
+        } else {
+          $('#deposit_amount_mismatch').css('visibility', 'hidden');
+          $('#submit-btn').prop('disabled', false);
+        }
+      });
+    }
+  });
+});
+<% end %>