vat-gst-calculator 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f39992ff401d87c4d256cbbe7da9ef39e03e134b9e21ca5f4ba258d9ad613497
-  data.tar.gz: 118ee1b247f9536cdaf16aad6246ba8d61d48ee817a02ba7510c1245ccf4d52d
+  metadata.gz: 47259f182d190ca603c7694139e25c002852bc1c60952dbc8967ae170031dea5
+  data.tar.gz: 76f58ac22a22144627b1144ef6b9469179b68034ed104e0f369c1d726e53c8ac
 SHA512:
-  metadata.gz: 8ba20e1380d4264138c446a675d5e1a6b5147e39713dcf7d441b706d09295214a0661f75e47411136f459dbf38843a38443d400d98cfc29e3d748e39ef426199
-  data.tar.gz: 490338962e3e8146c6a851aaa4c027a491cc6bb9f276206a00d8687af5b80ab2e7891565d3308086cbd099e5cd71913441124e5590e851519622f211824f531b
+  metadata.gz: 89e1e20dabc983e4bcd34a3ace0982ebab08a56f6242ee2037b8cdf5a9608814064603fe7e3bffb9e3c49f6240ef85ba614eac96d2ea85435191f769d48f719a
+  data.tar.gz: 39b36cf998538c48282da9ec6462f29770b701dba666bc90501deaac39326a2ab12c5de231875b8a2f75b02895bac7b18477f2ec413c5ae8185d6e5844d97661

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 .idea/*
 *.swp
 tags
+.tool-versions

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

@@ -11,6 +11,7 @@ module Easyship
         pickup_fee: 0,
         residential_surcharge: 0
       }.freeze
+
       DEFAULT_EFFECTIVE_TIMESTAMP = Time.at(0).utc.freeze
 
       class << self
@@ -23,10 +24,11 @@ module Easyship
           }
         end
 
-        def effective_data(country_alpha2, effective_timestamp = nil)
-          data = DOMESTIC.fetch(country_alpha2, [])
-
-          data.find { |rates| rates[:effective_timestamp] <= effective_time(effective_timestamp) }
+        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
@@ -172,11 +174,12 @@ module Easyship
           sales_tax: {'_ALL': build_fee_struct(0.05, 0, 0, 0)},
           provincial_sales_taxes: {'_ALL': NO_TAX}
         }],
-        # 'IE' => {
-        #   sales_tax_website_name: 'VAT',
-        #   sales_tax: { '_ALL': build_fee_struct(0.23, 0, 0, 0) },
-        #   provincial_sales_taxes: { '_ALL': no_taxes }
-        # },
+        '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) },
@@ -239,6 +242,8 @@ module Easyship
         #   provincial_sales_taxes: { '_ALL': no_taxes }
         # }
       }.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.6.0"
+      VERSION = "0.8.0"
     end
   end
 end

data/lib/easyship/sales_tax/calculator.rb

@@ -7,60 +7,122 @@ module Easyship
       class Error < StandardError; end
 
       FALLBACK_VALUE = {sales_tax: 0, provincial_sales_tax: 0}.freeze
+      FALLBACK_VALUE_WITH_DETAILS =
+        {
+          sales_tax: 0,
+          provincial_sales_tax: 0,
+          sales_tax_detail: Easyship::SalesTax::Formula::NO_TAX,
+          provincial_sales_tax_detail: Easyship::SalesTax::Formula::NO_TAX
+        }.freeze
+      EU_COUNTRY_ALPHA2S = %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].freeze
 
-      def self.calculate(origin_country_alpha2: nil, destination_country_alpha2: nil, origin_state: nil, destination_state: nil, fees: nil, effective_timestamp: 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)
+      class << self
+        def calculate(
+          origin_country_alpha2: nil,
+          destination_country_alpha2: nil,
+          origin_state: nil,
+          destination_state: nil,
+          fees: nil,
+          effective_timestamp: nil,
+          effective_country_alpha2s: [],
+          with_detail: false
+        )
+          return fallback_value(with_detail: with_detail) if origin_country_alpha2&.strip&.empty? || destination_country_alpha2&.strip&.empty?
+          return fallback_value(with_detail: with_detail) unless fees.is_a?(Fee)
+          return fallback_value(with_detail: with_detail) unless tax_eligible?(origin_country_alpha2, destination_country_alpha2)
 
-        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, effective_timestamp: effective_timestamp)
-        else
-          FALLBACK_VALUE
+          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,
+            with_detail: with_detail
+          )
+        rescue
+          fallback_value(with_detail: with_detail)
         end
-      rescue
-        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 calculate_with_detail(**kwargs)
+          calculate(with_detail: true, **kwargs)
+        end
 
-      private
+        def 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, effective_timestamp: nil)
-        rates = Formula.effective_data(origin_country_alpha2, effective_timestamp)
-        return FALLBACK_VALUE if rates.nil?
+        private
 
-        {
-          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 domestic_value(
+          origin_country_alpha2: nil,
+          origin_state: nil,
+          destination_state: nil,
+          fees: nil,
+          effective_timestamp: nil,
+          effective_country_alpha2s: [],
+          with_detail: false
+        )
+          rates = Formula.effective_data(origin_country_alpha2, effective_timestamp, effective_country_alpha2s)
+          return fallback_value(with_detail: with_detail) if rates.nil?
+
+          {}.tap do |h|
+            h[:sales_tax] = tax_calculate(rates[:sales_tax], nil, destination_state, fees, false)
+            h[:provincial_sales_tax] = tax_calculate(rates[:provincial_sales_taxes], origin_state, destination_state, fees, true)
 
-      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
-          # https://www.fedex.com/en-ca/news/canadian-sales-taxes.html
-          return 0 if origin_state != destination_state && is_provincial_sales_taxes
-          fees.to_h.inject(0) { |sum, (k, v)| sum + (tax_destination_formula[k] * v.to_f) }.round(2)
-        elsif formula[:_ALL]
-          fees.to_h.inject(0) { |sum, (k, v)| sum + (formula[:_ALL][k] * v.to_f) }.round(2)
-        else
-          0
+            if with_detail
+              h[:sales_tax_detail] = tax_detail(rates[:sales_tax], nil, destination_state, fees, false)
+              h[:provincial_sales_tax_detail] = tax_detail(rates[:provincial_sales_taxes], origin_state, destination_state, fees, true)
+            end
+          end
         end
-      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
+        def 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
+            # https://www.fedex.com/en-ca/news/canadian-sales-taxes.html
+            return 0 if origin_state != destination_state && is_provincial_sales_taxes
+            fees.to_h.inject(0) { |sum, (k, v)| sum + (tax_destination_formula[k] * v.to_f) }.round(2)
+          elsif formula[:_ALL]
+            fees.to_h.inject(0) { |sum, (k, v)| sum + (formula[:_ALL][k] * v.to_f) }.round(2)
+          else
+            0
+          end
+        end
 
-      def self.domestic?(origin_country_alpha2 = nil, destination_country_alpha2 = nil)
-        !origin_country_alpha2.nil? && !origin_country_alpha2.empty? && origin_country_alpha2 == destination_country_alpha2
-      end
+        def tax_detail(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
+            # https://www.fedex.com/en-ca/news/canadian-sales-taxes.html
+            return Easyship::SalesTax::Formula::NO_TAX if origin_state != destination_state && is_provincial_sales_taxes
+            fees.to_h.each_with_object({}) { |(k, v), hash| hash[k] = (tax_destination_formula[k] * v.to_f).round(2) }
+          elsif formula[:_ALL]
+            fees.to_h.each_with_object({}) { |(k, v), hash| hash[k] = (formula[:_ALL][k] * v.to_f).round(2) }
+          else
+            Easyship::SalesTax::Formula::NO_TAX
+          end
+        end
+
+        def in_eu?(country_alpha2)
+          EU_COUNTRY_ALPHA2S.include?(country_alpha2)
+        end
+
+        def domestic?(origin_country_alpha2 = nil, destination_country_alpha2 = nil)
+          !origin_country_alpha2&.strip&.empty? && origin_country_alpha2 == destination_country_alpha2
+        end
 
-      def self.within_eu?(origin_country_alpha2 = nil, destination_country_alpha2 = nil)
-        in_eu?(origin_country_alpha2) && in_eu?(destination_country_alpha2)
+        def within_eu?(origin_country_alpha2 = nil, destination_country_alpha2 = nil)
+          in_eu?(origin_country_alpha2) && in_eu?(destination_country_alpha2)
+        end
+
+        def tax_eligible?(...)
+          domestic?(...) || within_eu?(...)
+        end
+
+        def fallback_value(with_detail: false)
+          with_detail ? FALLBACK_VALUE_WITH_DETAILS : FALLBACK_VALUE
+        end
       end
     end
   end

data/vat-gst-calculator.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 3.0.6"
+
   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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aloha Chen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -72,14 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Calculate Sales Tax