killbill-avatax 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3285db47eceafe1937d8442d8805988a36c4af21
+  data.tar.gz: bd8fe2e0c1cfbf658d4d669ee7ea6f1dc89669bb
+SHA512:
+  metadata.gz: 6283e0e3bd7962ccb15e80879273222733b043799e458883d0f8a8797465af23b62b5efe28ece5f387a125f1d34b37763f07ffd796950e1ed5cf3fa0a4b13a35
+  data.tar.gz: 8dff593076931351517f0b5deb345b0b94b9b7b17c02f11cdd16c3cf50b485b8d154bed74f5636da7e7a7df9de13e18e8a827ef2778e67670c0cb4527c07bf19

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,39 @@
+
+Overview
+========
+
+This Rails mountable engine allows you to manage your Avatax integration in Kill Bill.
+
+* See [killbill/killbill-avatax-plugin](https://github.com/killbill/killbill-avatax-plugin) to get started with the Avatax plugin.
+* See [killbill-admin-ui-standalone](https://github.com/killbill/killbill-admin-ui-standalone) to get start with the Kill Bill Admin UI.
+
+Functionality
+-------------
+
+This app lets you:
+
+* configure tax codes associated with products in your catalog
+* set tax exemption codes on Kill Bill accounts
+* configure your Avatax credentials
+
+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:
+
+```
+bundle install
+export RAILS_ENV=development
+cd test/dummy
+rails server
+```

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    = 'Avatax'
+  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'
+
+
+
+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,24 @@
+// 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 js-routes
+//= require moment
+//= require spin
+//= require jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require dataTables/jquery.dataTables
+//= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+//= require d3
+//= require bootstrap-datepicker
+//= require jquery.spin
+//= require avatax/avatax

data/app/assets/javascripts/avatax/avatax.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 bootstrap-datepicker3
+ *= require dataTables/jquery.dataTables
+ *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+ *= require bootstrap_and_overrides
+ *= require avatax/avatax
+ */

data/app/assets/stylesheets/avatax/avatax.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/assets/stylesheets/bootstrap_and_overrides.css

@@ -0,0 +1,17 @@
+/*
+ *= require twitter-bootstrap-static/bootstrap
+ *
+ * Use Font Awesome icons (default)
+ * To use Glyphicons sprites instead of Font Awesome, replace with "require twitter-bootstrap-static/sprites"
+ *= require twitter-bootstrap-static/fontawesome
+*/
+
+/* 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/controllers/avatax/configuration_controller.rb

@@ -0,0 +1,142 @@
+require 'avatax/client'
+
+module Avatax
+  class ConfigurationController < EngineController
+
+    def index
+      @tax_codes = ::Killbill::Avatax::AvataxClient.get_tax_codes(options_for_klient)
+      @exemptions = exempt_accounts
+    end
+
+    #
+    # Tax Codes
+    #
+
+    def set_tax_code
+      @products = KillBillClient::Model::Catalog.simple_catalog(options_for_klient).products.map(&:name)
+    end
+
+    def do_set_tax_code
+      ::Killbill::Avatax::AvataxClient.set_tax_code(params.require(:product_name),
+                                                    params.require(:tax_code),
+                                                    options_for_klient[:username],
+                                                    params[:reason],
+                                                    params[:comment],
+                                                    options_for_klient)
+
+      flash[:notice] = 'Tax code successfully saved'
+      redirect_to :action => :index
+    end
+
+    def remove_tax_code
+      ::Killbill::Avatax::AvataxClient.remove_tax_code(params.require(:product_name),
+                                                       options_for_klient[:username],
+                                                       params[:reason],
+                                                       params[:comment],
+                                                       options_for_klient)
+
+      flash[:notice] = 'Tax code successfully removed'
+      redirect_to :action => :index
+    end
+
+    #
+    # Exemptions
+    #
+
+    def set_exemption
+    end
+
+    def do_set_exemption
+      ::Killbill::Avatax::AvataxClient.set_exemption(params.require(:account_id),
+                                                     params.require(:customer_usage_type),
+                                                     options_for_klient[:username],
+                                                     params[:reason],
+                                                     params[:comment],
+                                                     options_for_klient)
+
+      flash[:notice] = 'Exemption successfully saved'
+      redirect_to :action => :index
+    end
+
+    def remove_exemption
+      ::Killbill::Avatax::AvataxClient.remove_exemption(params.require(:account_id),
+                                                        options_for_klient[:username],
+                                                        params[:reason],
+                                                        params[:comment],
+                                                        options_for_klient)
+
+      flash[:notice] = 'Exemption successfully removed'
+      redirect_to :action => :index
+    end
+
+    #
+    # Settings
+    #
+
+    def plugin_configuration
+      @configuration = {}
+
+      config = KillBillClient::Model::Tenant.get_tenant_plugin_config('killbill-avatax', options_for_klient)
+      return if config.values.empty?
+
+      config.values.first.split.each do |property|
+        k, v = property.split('=')
+        case k
+          when 'org.killbill.billing.plugin.avatax.url'
+            @configuration[:test] = avatax_url(true) == v
+          when 'org.killbill.billing.plugin.avatax.accountNumber'
+            @configuration[:account_number] = v
+          when 'org.killbill.billing.plugin.avatax.licenseKey'
+            @configuration[:license_key] = v
+          when 'org.killbill.billing.plugin.avatax.companyCode'
+            @configuration[:company_code] = v
+          when 'org.killbill.billing.plugin.avatax.commitDocuments'
+            @configuration[:commit_documents] = v == 'true'
+        end
+      end
+    end
+
+    def update_plugin_configuration
+      plugin_config = "org.killbill.billing.plugin.avatax.url=#{avatax_url(params[:test] == '1')}
+org.killbill.billing.plugin.avatax.accountNumber=#{params.require(:account_number)}
+org.killbill.billing.plugin.avatax.licenseKey=#{params.require(:license_key)}
+org.killbill.billing.plugin.avatax.companyCode=#{params[:company_code]}
+org.killbill.billing.plugin.avatax.commitDocuments=#{params[:commit_documents] == '1'}"
+
+      KillBillClient::Model::Tenant.upload_tenant_plugin_config('killbill-avatax',
+                                                                plugin_config,
+                                                                options_for_klient[:username],
+                                                                params[:reason],
+                                                                params[:comment],
+                                                                options_for_klient)
+
+      flash[:notice] = 'Configuration successfully saved'
+      redirect_to :action => :index
+    end
+
+    private
+
+    def avatax_url(test)
+      "https://#{test ? 'development' : 'avatax'}.avalara.net"
+    end
+
+    def exempt_accounts(offset = 0, limit = 100)
+      custom_field_value = 'customerUsageType'
+
+      KillBillClient::Model::CustomField.find_in_batches_by_search_key(custom_field_value, offset, limit, options_for_klient)
+          .select { |cf| cf.name == custom_field_value && cf.object_type == 'ACCOUNT' }
+          .map { |cf| {:account_id => cf.object_id, :customer_usage_type => cf.value} }
+    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/avatax/engine_controller.rb

@@ -0,0 +1,18 @@
+module Avatax
+  class EngineController < ApplicationController
+
+    layout :get_layout
+
+    def get_layout
+      layout ||= Avatax.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)
+      Avatax.current_tenant_user.call(session, user)
+    end
+
+  end
+end

data/app/helpers/avatax/application_helper.rb

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

data/app/views/avatax/configuration/_exemptions_form.html.erb

@@ -0,0 +1,20 @@
+<%= form_tag do_set_exemption_configuration_path, :class => 'form-horizontal' do %>
+    <div class="form-group">
+      <%= label_tag :account_id, 'Account ID', :class => 'col-sm-2 control-label' %>
+
+      <div class="col-sm-10">
+        <%= text_field_tag :account_id, nil, :class => 'form-control' %>
+      </div>
+    </div>
+    <div class="form-group">
+      <%= label_tag :customer_usage_type, 'Customer Usage Type', :class => 'col-sm-2 control-label' %>
+      <div class="col-sm-10">
+        <%= text_field_tag :customer_usage_type, nil, :class => 'form-control' %>
+      </div>
+    </div>
+    <div class="form-group">
+      <div class="col-sm-offset-2 col-sm-10">
+        <%= submit_tag 'Save', :class => 'btn btn-default' %>
+      </div>
+    </div>
+<% end %>

data/app/views/avatax/configuration/_exemptions_table.html.erb

@@ -0,0 +1,34 @@
+<table id="exemptions-table" class="table table-condensed table-striped mobile-data">
+  <thead>
+  <tr>
+    <th>Account ID</th>
+    <th>Customer Usage Type</th>
+    <th></th>
+  </tr>
+  </thead>
+  <tbody>
+  <% exemptions.each do |exemption| %>
+      <tr>
+        <td><%= exemption[:account_id] %></td>
+        <td><%= exemption[:customer_usage_type] %></td>
+        <td>
+          <%= link_to '<i class="fa fa-times"></i>'.html_safe, remove_exemption_configuration_path(:account_id => exemption[:account_id]), :method => :delete %>
+        </td>
+      </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= javascript_tag do %>
+  $(document).ready(function() {
+    $('#exemptions-table').dataTable({
+      "dom": "t",
+      "paging": false,
+      "columns": [
+        null,
+        null,
+        { "orderable": false }
+      ]
+    });
+  });
+<% end %>

data/app/views/avatax/configuration/_plugin_form.html.erb

@@ -0,0 +1,43 @@
+<%= form_tag update_plugin_configuration_path, :class => 'form-horizontal' do %>
+    <div class="form-group">
+      <%= label_tag :account_number, 'Account number', :class => 'col-sm-2 control-label' %>
+      <div class="col-sm-10">
+        <%= text_field_tag :account_number, @configuration[:account_number], :class => 'form-control' %>
+      </div>
+    </div>
+    <div class="form-group">
+      <%= label_tag :license_key, 'License key', :class => 'col-sm-2 control-label' %>
+      <div class="col-sm-10">
+        <%= text_field_tag :license_key, @configuration[:license_key], :class => 'form-control' %>
+      </div>
+    </div>
+    <div class="form-group">
+      <%= label_tag :company_code, 'Company code', :class => 'col-sm-2 control-label' %>
+      <div class="col-sm-10">
+        <%= text_field_tag :company_code, @configuration[:company_code], :class => 'form-control' %>
+      </div>
+    </div>
+    <div class="form-group">
+      <div class="col-sm-offset-2 col-sm-10">
+        <div class="checkbox">
+          <%= label_tag :commit_documents, 'Commit documents', :class => 'control-label' do %>
+              <%= check_box_tag :commit_documents, '1', @configuration[:commit_documents] %>Commit documents?
+          <% end %>
+        </div>
+      </div>
+    </div>
+    <div class="form-group">
+      <div class="col-sm-offset-2 col-sm-10">
+        <div class="checkbox">
+          <%= label_tag :test, 'Test mode', :class => 'control-label' do %>
+              <%= check_box_tag :test, '1', @configuration[:test] %>Test mode?
+          <% end %>
+        </div>
+      </div>
+    </div>
+    <div class="form-group">
+      <div class="col-sm-offset-2 col-sm-10">
+        <%= submit_tag 'Save', :class => 'btn btn-default' %>
+      </div>
+    </div>
+<% end %>