vat-gst-calculator 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f39992ff401d87c4d256cbbe7da9ef39e03e134b9e21ca5f4ba258d9ad613497
-  data.tar.gz: 118ee1b247f9536cdaf16aad6246ba8d61d48ee817a02ba7510c1245ccf4d52d
+  metadata.gz: 4c0b1547695777a69f063993628affe4eaf28498180236ca0bd2e5902d5bd7d7
+  data.tar.gz: 5f7fd7051a155b3f5c0187ec2ebde52df83991a35491e0d8abf780d93ff94aed
 SHA512:
-  metadata.gz: 8ba20e1380d4264138c446a675d5e1a6b5147e39713dcf7d441b706d09295214a0661f75e47411136f459dbf38843a38443d400d98cfc29e3d748e39ef426199
-  data.tar.gz: 490338962e3e8146c6a851aaa4c027a491cc6bb9f276206a00d8687af5b80ab2e7891565d3308086cbd099e5cd71913441124e5590e851519622f211824f531b
+  metadata.gz: 444a34ccad4d894adca304083e25cc4baae48ae6a6abb7d1aabcd0c074a87d790120f0c6abd6ff2bfa242174c9939a00957c53a399151d68fe1acc0a551d7fbb
+  data.tar.gz: a7b0bcf732ca7a34da47c703e6b9f85fdae33461ad2602c73058f5770284b0e50204a3938b6674fd30a46317ab5481971a2d5d282665fccc70e713f1c9c8a28c

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.7.0"
     end
   end
 end

data/lib/easyship/sales_tax/calculator.rb

@@ -8,12 +8,19 @@ module Easyship
 
       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)
+      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, effective_timestamp: effective_timestamp)
+          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
         end
@@ -28,8 +35,8 @@ module Easyship
 
       private
 
-      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)
+      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?
 
         {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vat-gst-calculator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.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-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec