vat-gst-calculator 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b41f3eb40c2fc01049599af67185633c146994e9e8aa68ef2518ecee6d4cdc3f
-  data.tar.gz: 7603c43981f2bcb359a77be92d714873dbfbb0b0e8d035ab401b94e6e5b995e6
+  metadata.gz: 4c0b1547695777a69f063993628affe4eaf28498180236ca0bd2e5902d5bd7d7
+  data.tar.gz: 5f7fd7051a155b3f5c0187ec2ebde52df83991a35491e0d8abf780d93ff94aed
 SHA512:
-  metadata.gz: b61a549c2b33e5549bce687e018516f4f8b2218634c25ac81c799d732239cc3461f73a8b502b24749c3657abe206b09f4695284c2167836f300882c40aa1bb5b
-  data.tar.gz: 7ef3a105c047ed5c26806df2bc2a5f7da234c7a36b079c19a13c40d19481ce7f2be781e67554e3c2050e60e993e419fe933d040325fa0951014a16e92573c6fc
+  metadata.gz: 444a34ccad4d894adca304083e25cc4baae48ae6a6abb7d1aabcd0c074a87d790120f0c6abd6ff2bfa242174c9939a00957c53a399151d68fe1acc0a551d7fbb
+  data.tar.gz: a7b0bcf732ca7a34da47c703e6b9f85fdae33461ad2602c73058f5770284b0e50204a3938b6674fd30a46317ab5481971a2d5d282665fccc70e713f1c9c8a28c

data/.gitignore

@@ -1,3 +1,6 @@
 .byebug_history
 .rspec_status
 Gemfile.lock
+.idea/*
+*.swp
+tags

data/README.md

@@ -26,7 +26,9 @@ Easyship::SalesTax::Calculator.calculate(
   destination_country_alpha2: destination_country_alpha2,
   origin_state: origin_state,
   destination_state: destination_state,
-  fees: Easyship::SalesTax::Fee.new(10, 20, 30, 40) # (shipment_charge_total, insurance_fee, pickup_fee, residential_surcharge)
+  fees: Easyship::SalesTax::Fee.new(10, 20, 30, 40), # (shipment_charge_total, insurance_fee, pickup_fee, residential_surcharge)
+  effective_timestamp: "2023-01-01", # String and Time instances are supported. Default to current time (utc)
+  effective_country_alpha2s: ["HK", "US"] # when empty or not specified, all avalilable country data is used
 )
 ```
 

data/lib/easyship/sales_tax/calculator/formula.rb

@@ -1,7 +1,19 @@
+require "time"
+
 module Easyship
   module SalesTax
     module Formula
       class Error < StandardError; end
+
+      NO_TAX = {
+        shipment_charge_total: 0,
+        insurance_fee: 0,
+        pickup_fee: 0,
+        residential_surcharge: 0
+      }.freeze
+
+      DEFAULT_EFFECTIVE_TIMESTAMP = Time.at(0).utc.freeze
+
       class << self
         def build_fee_struct(shipment_charge_total, insurance_fee, pickup_fee, residential_surcharge)
           {
@@ -12,23 +24,42 @@ module Easyship
           }
         end
 
-        def no_taxes
-          build_fee_struct(0, 0, 0, 0)
+        def effective_data(country_alpha2, effective_timestamp = nil, effective_country_alpha2s = [])
+          DOMESTIC
+            .slice(*(effective_country_alpha2s.empty? ? DEFAULT_EFFECTIVE_COUNTRY_ALPHA2S : effective_country_alpha2s))
+            .fetch(country_alpha2, [])
+            .find { |rates| rates[:effective_timestamp] <= effective_time(effective_timestamp) }
+        end
+
+        private
+
+        def effective_time(effective_timestamp)
+          case effective_timestamp
+          when String
+            Time.parse(effective_timestamp).utc
+          when Time
+            effective_timestamp
+          else
+            Time.now.utc
+          end
         end
       end
 
       DOMESTIC = {
-        'AU' => {
+        'AU' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: 'GST',
-          sales_tax: { '_ALL': build_fee_struct(0.1, 0, 0.1, 0) },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
-        'GB' => {
+          sales_tax: {'_ALL': build_fee_struct(0.1, 0, 0.1, 0)},
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
+        'GB' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: 'VAT',
-          sales_tax: { '_ALL': build_fee_struct(0.2, 0, 0.2, 0.2) }, # TBC
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
-        'CA' => {
+          sales_tax: {'_ALL': build_fee_struct(0.2, 0, 0.2, 0.2)}, # TBC
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
+        'CA' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: 'Taxes',
           sales_tax: {
             'AB' => build_fee_struct(0.05, 0, 0.05, 0.05), # Alberta
@@ -46,41 +77,52 @@ module Easyship
             'YT' => build_fee_struct(0.05, 0, 0.05, 0.05), # Yukon
           },
           provincial_sales_taxes: {
-            'AB' => no_taxes, # Alberta
-            'BC' => no_taxes, # British Columbia
-            'MB' => no_taxes, # Manitoba
-            'NB' => no_taxes, # New Brunswick
-            'NL' => no_taxes, # Newfoundland and Labrador
-            'NT' => no_taxes, # Northwest Territories
-            'NS' => no_taxes, # Nova Scotia
-            'NU' => no_taxes, # Nunavut
-            'ON' => no_taxes, # Ontario
-            'PE' => no_taxes, # Prince Edward Island
+            'AB' => NO_TAX, # Alberta
+            'BC' => NO_TAX, # British Columbia
+            'MB' => NO_TAX, # Manitoba
+            'NB' => NO_TAX, # New Brunswick
+            'NL' => NO_TAX, # Newfoundland and Labrador
+            'NT' => NO_TAX, # Northwest Territories
+            'NS' => NO_TAX, # Nova Scotia
+            'NU' => NO_TAX, # Nunavut
+            'ON' => NO_TAX, # Ontario
+            'PE' => NO_TAX, # Prince Edward Island
             'QC' => build_fee_struct(0.09975, 0, 0.09975, 0.09975), # Quebec
-            'SK' => no_taxes, # Saskatchewan
-            'YT' => no_taxes, # Yukon
+            'SK' => NO_TAX, # Saskatchewan
+            'YT' => NO_TAX, # Yukon
           }
-        },
-        'SG' => {
-          sales_tax_website_name: 'GST',
-          sales_tax: { '_ALL': build_fee_struct(0.07, 0.07, 0.07, 0.07) },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
-        'HK' => {
+        }],
+        'SG' => [
+          {
+            effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
+            sales_tax_website_name: 'GST',
+            sales_tax: {'_ALL': build_fee_struct(0.07, 0.07, 0.07, 0.07)},
+            provincial_sales_taxes: {'_ALL': NO_TAX}
+          },
+          {
+            effective_timestamp: Time.utc(2023, 1, 1, 8),
+            sales_tax_website_name: 'GST',
+            sales_tax: {'_ALL': build_fee_struct(0.08, 0.08, 0.08, 0.08)},
+            provincial_sales_taxes: {'_ALL': NO_TAX}
+          }
+        ],
+        'HK' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: nil,
-          sales_tax: { '_ALL': no_taxes },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
+          sales_tax: {'_ALL': NO_TAX},
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
         # 'NL' => {
         #   sales_tax_website_name: 'VAT',
         #   sales_tax: { '_ALL': build_fee_struct(0.21, 0, 0.21, 0.21) },
         #   provincial_sales_taxes: { '_ALL': no_taxes }
         # },
-        'US' => {
+        'US' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: nil,
-          sales_tax: { '_ALL': no_taxes },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
+          sales_tax: {'_ALL': NO_TAX},
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
         # 'DE' => {
         #   sales_tax_website_name: 'VAT',
         #   sales_tax: { '_ALL': build_fee_struct(0.19, 0, 0, 0) },
@@ -126,16 +168,18 @@ module Easyship
         #   sales_tax: { '_ALL': build_fee_struct(0.2, 0, 0, 0) },
         #   provincial_sales_taxes: { '_ALL': no_taxes }
         # },
-        'AE' => {
+        'AE' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: 'VAT',
-          sales_tax: { '_ALL': build_fee_struct(0.05, 0, 0, 0) },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
-        # 'IE' => {
-        #   sales_tax_website_name: 'VAT',
-        #   sales_tax: { '_ALL': build_fee_struct(0.23, 0, 0, 0) },
-        #   provincial_sales_taxes: { '_ALL': no_taxes }
-        # },
+          sales_tax: {'_ALL': build_fee_struct(0.05, 0, 0, 0)},
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
+        'IE' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
+          sales_tax_website_name: 'VAT',
+          sales_tax: { '_ALL': build_fee_struct(0.23, 0, 0.23, 0.23) },
+          provincial_sales_taxes: { '_ALL': NO_TAX }
+        }],
         # 'DK' => {
         #   sales_tax_website_name: 'VAT',
         #   sales_tax: { '_ALL': build_fee_struct(0.25, 0, 0, 0) },
@@ -176,11 +220,12 @@ module Easyship
         #   sales_tax: { '_ALL': build_fee_struct(0.1, 0, 0, 0) },
         #   provincial_sales_taxes: { '_ALL': no_taxes }
         # },
-        'NZ' => {
+        'NZ' => [{
+          effective_timestamp: DEFAULT_EFFECTIVE_TIMESTAMP,
           sales_tax_website_name: 'VAT',
-          sales_tax: { '_ALL': build_fee_struct(0.15, 0.15, 0.15, 0.15) },
-          provincial_sales_taxes: { '_ALL': no_taxes }
-        },
+          sales_tax: {'_ALL': build_fee_struct(0.15, 0.15, 0.15, 0.15)},
+          provincial_sales_taxes: {'_ALL': NO_TAX}
+        }],
         # 'IN' => {
         #   sales_tax_website_name: 'VAT',
         #   sales_tax: { '_ALL': build_fee_struct(0.15, 0, 0, 0) },
@@ -196,7 +241,9 @@ module Easyship
         #   sales_tax: { '_ALL': build_fee_struct(0.16, 0, 0, 0) },
         #   provincial_sales_taxes: { '_ALL': no_taxes }
         # }
-      }.freeze
+      }.transform_values { |value| value.sort_by { |rates| -rates[:effective_timestamp].to_i } }.freeze
+
+      DEFAULT_EFFECTIVE_COUNTRY_ALPHA2S = DOMESTIC.keys.freeze
     end
   end
 end

data/lib/easyship/sales_tax/calculator/version.rb

@@ -1,7 +1,7 @@
 module Easyship
   module SalesTax
     module Calculator
-      VERSION = "0.5.0"
+      VERSION = "0.7.0"
     end
   end
 end

data/lib/easyship/sales_tax/calculator.rb

@@ -6,33 +6,45 @@ module Easyship
     module Calculator
       class Error < StandardError; end
 
-      def self.calculate(origin_country_alpha2: nil, destination_country_alpha2: nil, origin_state: nil, destination_state: nil, fees: nil)
-        return fallback_value if origin_country_alpha2.nil? || origin_country_alpha2.empty? || destination_country_alpha2.nil? || destination_country_alpha2.empty?
-        return fallback_value unless fees.is_a?(Fee)
+      FALLBACK_VALUE = {sales_tax: 0, provincial_sales_tax: 0}.freeze
+
+      def self.calculate(origin_country_alpha2: nil, destination_country_alpha2: nil, origin_state: nil, destination_state: nil, fees: nil, effective_timestamp: nil, effective_country_alpha2s: [])
+        return FALLBACK_VALUE if origin_country_alpha2.nil? || origin_country_alpha2.empty? || destination_country_alpha2.nil? || destination_country_alpha2.empty?
+        return FALLBACK_VALUE unless fees.is_a?(Fee)
 
         if domestic?(origin_country_alpha2, destination_country_alpha2) || within_eu?(origin_country_alpha2, destination_country_alpha2)
-          domestic_value(origin_country_alpha2: origin_country_alpha2, origin_state: origin_state, destination_state: destination_state, fees: fees)
+          domestic_value(
+            origin_country_alpha2: origin_country_alpha2,
+            origin_state: origin_state,
+            destination_state: destination_state,
+            fees: fees,
+            effective_timestamp: effective_timestamp,
+            effective_country_alpha2s: effective_country_alpha2s
+          )
         else
-          fallback_value
+          FALLBACK_VALUE
         end
       rescue
-        fallback_value
+        FALLBACK_VALUE
+      end
+
+      def self.sales_tax_website_name(country_alpha2, effective_timestamp = nil)
+        rates = Formula.effective_data(country_alpha2, effective_timestamp)
+        (rates || {}).dig(:sales_tax_website_name)
       end
 
-      def self.domestic_value(origin_country_alpha2: nil, origin_state: nil, destination_state: nil, fees: nil)
-        domestic_rates = Formula::DOMESTIC[origin_country_alpha2.to_s]
-        return fallback_value if domestic_rates.nil? || domestic_rates.empty?
+      private
+
+      def self.domestic_value(origin_country_alpha2: nil, origin_state: nil, destination_state: nil, fees: nil, effective_timestamp: nil, effective_country_alpha2s: [])
+        rates = Formula.effective_data(origin_country_alpha2, effective_timestamp, effective_country_alpha2s)
+        return FALLBACK_VALUE if rates.nil?
 
         {
-          sales_tax: tax_calculate(domestic_rates[:sales_tax], nil, destination_state, fees, false),
-          provincial_sales_tax: tax_calculate(domestic_rates[:provincial_sales_taxes], origin_state, destination_state, fees, true)
+          sales_tax: tax_calculate(rates[:sales_tax], nil, destination_state, fees, false),
+          provincial_sales_tax: tax_calculate(rates[:provincial_sales_taxes], origin_state, destination_state, fees, true)
         }
       end
 
-      def self.fallback_value
-        { sales_tax: 0, provincial_sales_tax: 0 }
-      end
-
       def self.tax_calculate(formula, origin_state, destination_state, fees, is_provincial_sales_taxes)
         if (tax_destination_formula = formula[destination_state.to_s.upcase])
           # ONLY CA has provincial_sales_taxes(QST/PST) and it only apply when ship within same state
@@ -46,11 +58,6 @@ module Easyship
         end
       end
 
-      def self.sales_tax_website_name(country_alpha2)
-        return if Formula::DOMESTIC[country_alpha2.to_s].nil? || Formula::DOMESTIC[country_alpha2.to_s].empty?
-        Formula::DOMESTIC[country_alpha2][:sales_tax_website_name]
-      end
-
       def self.in_eu?(country_alpha2)
        %w(NL LU EE LT HU BE PT SK HR CZ IT FI PL MT DE SI RO BG AT SE CY DK FR IE ES GR LV).include?(country_alpha2)
       end

data/vat-gst-calculator.gemspec

@@ -23,8 +23,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vat-gst-calculator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Aloha Chen
@@ -9,36 +9,8 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement