killbill-avatax 0.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a3897328ca491b74d95b73e0b88646f384d6e3
-  data.tar.gz: 358aabaeb09c912fc676b1a20e224cff8b8b573d
+  metadata.gz: 649bcd5e1b0d3b47a658a12d5b66ec84b005ea46
+  data.tar.gz: 901a135544d1d1908b55c01afb77a4177aa1cb30
 SHA512:
-  metadata.gz: 668451206aa3d018f6456cc401dca2d561e693735673af0054dea975510298162417d063df1a8cbb9b6e2e7b62fd24885b035f93b13e285435a07e1c144afff9
-  data.tar.gz: 243ba53ded70ca620c3c5eb071df161669536344ac9391a68a418676963c37016e2c98a46d320a41314d60ddd16503ea8959630187ac57170bee6f52f60f992d
+  metadata.gz: eecf8bef864704fe7972936dfd53b1aac91a41dace7ecffeb26437f993d3ffb7da152ec5098f042fd6f1e84cb4794f1de4511d8c073fb5d88e2ee88847366ce4
+  data.tar.gz: 0d4f6ad68dd2933b2257017c63d2c5f8b317bf21ed49ddeedc52a4626d2ca4866d724df779f8425adccad7a6ec4962050aa0e7ed345cab4fcb00216ac4b5c01d

data/README.md

@@ -4,8 +4,19 @@ 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.
+* See [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 started with the Kill Bill Admin UI.
+
+Kill Bill compatibility
+-----------------------
+
+| Avatax UI version | Kill Bill version |
+| ----------------: | ----------------: |
+| 0.0.y             | 0.16.z            |
+| 0.1.y             | 0.18.z (Rails 4)  |
+| 0.2.y             | 0.18.z (Rails 5)  |
+| 1.x.y             | 0.20.z            |
+| 2.x.y             | 0.22.z            |
 
 Functionality
 -------------
@@ -32,8 +43,12 @@ KillBillClient.api_secret = 'lazar'
 Then, simply run:
 
 ```
-bundle install
-export RAILS_ENV=development
-cd test/dummy
-rails server
+rails s
+```
+
+
+To run tests:
+
+```
+rails t
 ```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,14 +16,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+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'
@@ -33,5 +32,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/assets/javascripts/application.js

@@ -10,15 +10,9 @@
 // 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/stylesheets/application.css

@@ -11,9 +11,9 @@
  * file per style scope.
  *
  *= require_self
- *= require bootstrap-datepicker3
  *= require dataTables/jquery.dataTables
  *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+ *= require font-awesome
  *= require bootstrap_and_overrides
  *= require avatax/avatax
  */

data/app/assets/stylesheets/bootstrap_and_overrides.css

@@ -1,9 +1,5 @@
 /*
  *= 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 */

data/app/controllers/avatax/configuration_controller.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'avatax/client'
 
 module Avatax
   class ConfigurationController < EngineController
-
     def index
       @tax_codes = ::Killbill::Avatax::AvataxClient.get_tax_codes(options_for_klient)
       @exemptions = exempt_accounts
@@ -13,7 +14,7 @@ module Avatax
     #
 
     def set_tax_code
-      @products = KillBillClient::Model::Catalog.simple_catalog(options_for_klient).products.map(&:name)
+      @products = KillBillClient::Model::Catalog.simple_catalog(options_for_klient).last.products.map(&:name)
     end
 
     def do_set_tax_code
@@ -25,7 +26,7 @@ module Avatax
                                                     options_for_klient)
 
       flash[:notice] = 'Tax code successfully saved'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     def remove_tax_code
@@ -36,15 +37,14 @@ module Avatax
                                                        options_for_klient)
 
       flash[:notice] = 'Tax code successfully removed'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     #
     # Exemptions
     #
 
-    def set_exemption
-    end
+    def set_exemption; end
 
     def do_set_exemption
       ::Killbill::Avatax::AvataxClient.set_exemption(params.require(:account_id),
@@ -55,7 +55,7 @@ module Avatax
                                                      options_for_klient)
 
       flash[:notice] = 'Exemption successfully saved'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     def remove_exemption
@@ -66,7 +66,7 @@ module Avatax
                                                         options_for_klient)
 
       flash[:notice] = 'Exemption successfully removed'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     #
@@ -82,26 +82,44 @@ module Avatax
       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'
+        when 'org.killbill.billing.plugin.avatax.accountId'
+          @configuration[:account_id] = 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'}"
+      plugin_config = "org.killbill.billing.plugin.avatax.accountId=#{params.require(:account_id)}
+org.killbill.billing.plugin.avatax.licenseKey=#{params.require(:license_key)}\n"
+      plugin_config << "org.killbill.billing.plugin.avatax.commitDocuments=#{params[:commit_documents] == '1'}\n"
+      plugin_config << "org.killbill.billing.plugin.avatax.companyCode=#{params[:company_code]}\n" unless params[:company_code].blank?
+
+      # Merge the new values with the current config. The config will likely contain additional fields that we don't want to clobber.
+      # The user should really use the more powerful /admin_tenants screen - this plugin screen was just created
+      # to be able to pass the initial AvaTax certification.
+      current_config = KillBillClient::Model::Tenant.get_tenant_plugin_config('killbill-avatax', options_for_klient)
+
+      (current_config.values || ['']).first.split.each do |property|
+        k, v = property.split('=')
+        plugin_config << case k
+                         when 'org.killbill.billing.plugin.avatax.accountId'
+                           next
+                         when 'org.killbill.billing.plugin.avatax.licenseKey'
+                           next
+                         when 'org.killbill.billing.plugin.avatax.companyCode'
+                           next
+                         when 'org.killbill.billing.plugin.avatax.commitDocuments'
+                           next
+                         else
+                           "#{k}=#{v}\n"
+                         end
+      end
 
       KillBillClient::Model::Tenant.upload_tenant_plugin_config('killbill-avatax',
                                                                 plugin_config,
@@ -111,31 +129,27 @@ org.killbill.billing.plugin.avatax.commitDocuments=#{params[:commit_documents] =
                                                                 options_for_klient)
 
       flash[:notice] = 'Configuration successfully saved'
-      redirect_to :action => :index
+      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} }
+                                        .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]
+        username: user[:username],
+        password: user[:password],
+        session_id: user[:session_id],
+        api_key: user[:api_key],
+        api_secret: user[:api_secret]
       }
     end
   end

data/app/controllers/avatax/engine_controller.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Avatax
   class EngineController < ApplicationController
-
     layout :get_layout
 
     def get_layout
@@ -13,6 +14,5 @@ module Avatax
       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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avatax
   module ApplicationHelper
   end

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

@@ -1,8 +1,8 @@
 <%= 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' %>
+      <%= label_tag :account_id, 'Account ID', :class => 'col-sm-2 control-label' %>
       <div class="col-sm-10">
-        <%= text_field_tag :account_number, @configuration[:account_number], :class => 'form-control' %>
+        <%= text_field_tag :account_id, @configuration[:account_id], :class => 'form-control' %>
       </div>
     </div>
     <div class="form-group">
@@ -26,15 +26,6 @@
         </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' %>

data/config/routes.rb

@@ -1,8 +1,9 @@
-Avatax::Engine.routes.draw do
+# frozen_string_literal: true
 
+Avatax::Engine.routes.draw do
   root to: 'configuration#index'
 
-  resources :configuration, :only => [:index]
+  resources :configuration, only: [:index]
 
   scope '/configuration' do
     match '/tax_code' => 'configuration#set_tax_code', :via => :get, :as => 'set_tax_code_configuration'
@@ -16,5 +17,4 @@ Avatax::Engine.routes.draw do
     match '/plugin' => 'configuration#plugin_configuration', :via => :get, :as => 'plugin_configuration'
     match '/plugin' => 'configuration#update_plugin_configuration', :via => :post, :as => 'update_plugin_configuration'
   end
-
 end

data/lib/avatax.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 require 'avatax/engine'
 
 module Avatax
-
   mattr_accessor :current_tenant_user
   mattr_accessor :layout
 
-  self.current_tenant_user = lambda { |session, user|
-    {:username => 'admin',
-     :password => 'password',
-     :session_id => nil,
-     :api_key => KillBillClient.api_key,
-     :api_secret => KillBillClient.api_secret}
+  self.current_tenant_user = lambda { |_session, _user|
+    { username: 'admin',
+      password: 'password',
+      session_id: nil,
+      api_key: KillBillClient.api_key,
+      api_secret: KillBillClient.api_secret }
   }
 
-  def self.config(&block)
+  def self.config
     {
-        :layout => layout || 'avatax/layouts/avatax_application',
+      layout: layout || 'avatax/layouts/avatax_application'
     }
   end
-
 end

data/lib/avatax/client.rb

@@ -1,29 +1,28 @@
+# frozen_string_literal: true
+
 module Killbill
   module Avatax
-
     class AvataxClient < KillBillClient::Model::Resource
-
       KILLBILL_AVATAX_PREFIX = '/plugins/killbill-avatax'
 
       class << self
-
         def set_exemption(account_id, customer_usage_type, user, reason, comment, options = {})
-          exemptionCustomFieldName = 'customerUsageType'
+          exemption_cf_name = 'customerUsageType'
 
           account = KillBillClient::Model::Account.find_by_id(account_id, false, false, options)
 
           # Remove existing exemption(s) first
           account.custom_fields('NONE', options).each do |custom_field|
-            account.remove_custom_field(custom_field.custom_field_id, user, reason, comment, options) if custom_field.name == exemptionCustomFieldName
+            account.remove_custom_field(custom_field.custom_field_id, user, reason, comment, options) if custom_field.name == exemption_cf_name
           end
 
-          unless customer_usage_type.nil?
-            # Set the exemption
-            custom_field = KillBillClient::Model::CustomField.new
-            custom_field.name = exemptionCustomFieldName
-            custom_field.value = customer_usage_type
-            account.add_custom_field(custom_field, user, reason, comment, options)
-          end
+          return if customer_usage_type.nil?
+
+          # Set the exemption
+          custom_field = KillBillClient::Model::CustomField.new
+          custom_field.name = exemption_cf_name
+          custom_field.value = customer_usage_type
+          account.add_custom_field(custom_field, user, reason, comment, options)
         end
 
         def remove_exemption(account_id, user, reason, comment, options = {})
@@ -42,22 +41,19 @@ module Killbill
           JSON.parse(response.body).symbolize_keys
         end
 
-        def set_tax_code(product_name, tax_code, user, reason, comment, options = {})
-          body = {:productName => product_name, :taxCode => tax_code}.to_json
+        def set_tax_code(product_name, tax_code, _user, _reason, _comment, options = {})
+          body = { productName: product_name, taxCode: tax_code }.to_json
 
           path = "#{KILLBILL_AVATAX_PREFIX}/taxCodes"
           response = KillBillClient::API.post path, body, {}, options
           response.body
         end
 
-        def remove_tax_code(product_name, user, reason, comment, options= {})
+        def remove_tax_code(product_name, _user, _reason, _comment, options = {})
           path = "#{KILLBILL_AVATAX_PREFIX}/taxCodes/#{product_name}"
           KillBillClient::API.delete path, nil, {}, options
         end
-
       end
-
     end
-
   end
 end