vat-gst-calculator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eadf3b8ac32a3ae3ebb44b73968fb452e84a06bd0aa14cf21ec0ae1a87cb079c
+  data.tar.gz: ed189868daaff98f1d610917c3be707c1fca1762c0b70ef66ab050f31a27154e
+SHA512:
+  metadata.gz: ed1f8a387f82d7c52c3f451e828c51f00a65abd73924d77f4bd3322e744f5bd0abd1368ae90f3571edf705c47f052c82a5d8bd37d3ab292ccc64325afd358a20
+  data.tar.gz: 8a03f400e292989f10d2c94c2dcf5c85a13f29227710765a0e91be5e6638302841645a02867e48aba023982624023d7b070af8cd5c25a505425c0a04ed67bb0c

data/.gitignore

@@ -0,0 +1,3 @@
+.byebug_history
+.rspec_status
+Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at y.alohac@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vat-gst-calculator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aloha Chen
+
+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,49 @@
+# Easyship::SalesTax::Calculator
+
+To calculate VAT/GST/QST
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vat-gst-calculator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vat-gst-calculator
+
+## Usage
+
+```ruby
+Easyship::SalesTax::Calculator.calculate(
+  origin_country_alpha2: origin_country_alpha2,
+  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)
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/easyship/vat-gst-calculator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Easyship::SalesTax::Calculator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/easyship/vat-gst-calculator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easyship/sales_tax/calculator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/easyship/sales_tax/calculator.rb

@@ -0,0 +1,48 @@
+require "easyship/sales_tax/calculator/version"
+require "easyship/sales_tax/calculator/formula"
+require "easyship/sales_tax/calculator/fee"
+
+module Easyship
+  module SalesTax
+    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)
+
+        # TODO(Aloha): support international
+        return fallback_value if origin_country_alpha2 != destination_country_alpha2
+        return fallback_value if Formula::DOMESTIC[destination_country_alpha2.to_s].nil? || Formula::DOMESTIC[destination_country_alpha2.to_s].empty?
+
+        {
+          sales_tax: tax_calculate(Formula::DOMESTIC[destination_country_alpha2.to_s][:sales_tax], nil, destination_state, fees, false),
+          provincial_sales_tax: tax_calculate(Formula::DOMESTIC[destination_country_alpha2.to_s][:provincial_sales_taxes], origin_state, destination_state, fees, true)
+        }
+      rescue
+        fallback_value
+      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
+          # 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.sales_tax_website_name(country_alpha2)
+        return unless Formula::DOMESTIC[country_alpha2.to_s].present?
+        Formula::DOMESTIC[country_alpha2][:sales_tax_website_name]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Easyship
+  module SalesTax
+    Fee = Struct.new(:shipment_charge_total, :insurance_fee, :pickup_fee, :residential_surcharge)
+  end
+end

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

@@ -0,0 +1,87 @@
+module Easyship
+  module SalesTax
+    module Formula
+      class Error < StandardError; end
+      class << self
+        def build_fee_struct(shipment_charge_total, insurance_fee, pickup_fee, residential_surcharge)
+          {
+            shipment_charge_total: shipment_charge_total,
+            insurance_fee: insurance_fee,
+            pickup_fee: pickup_fee,
+            residential_surcharge: residential_surcharge
+          }
+        end
+
+        def no_taxes
+          build_fee_struct(0, 0, 0, 0)
+        end
+      end
+
+      DOMESTIC = {
+        'AU' => {
+          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_website_name: 'VAT',
+          sales_tax: { '_ALL': build_fee_struct(0.2, 0, 0, 0.2) }, # TBC
+          provincial_sales_taxes: { '_ALL': no_taxes }
+        },
+        'CA' => {
+          sales_tax_website_name: 'Taxes',
+          sales_tax: {
+            'AB' => build_fee_struct(0.05, 0, 0.05, 0.05), # Alberta
+            'BC' => build_fee_struct(0.05, 0, 0.05, 0.05), # British Columbia
+            'MB' => build_fee_struct(0.05, 0, 0.05, 0.05), # Manitoba
+            'NB' => build_fee_struct(0.15, 0, 0.15, 0.15), # New Brunswick
+            'NL' => build_fee_struct(0.15, 0, 0.15, 0.15), # Newfoundland and Labrador
+            'NT' => build_fee_struct(0.05, 0, 0.05, 0.05), # Northwest Territories
+            'NS' => build_fee_struct(0.15, 0, 0.15, 0.15), # Nova Scotia
+            'NU' => build_fee_struct(0.05, 0, 0.05, 0.05), # Nunavut
+            'ON' => build_fee_struct(0.13, 0, 0.13, 0.13), # Ontario
+            'PE' => build_fee_struct(0.15, 0, 0.15, 0.15), # Prince Edward Island
+            'QC' => build_fee_struct(0.05, 0, 0.05, 0.05), # Quebec
+            'SK' => build_fee_struct(0.05, 0, 0.05, 0.05), # Saskatchewan
+            '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
+            'QC' => build_fee_struct(0.09975, 0, 0.09975, 0.09975), # Quebec
+            'SK' => no_taxes, # Saskatchewan
+            'YT' => no_taxes, # Yukon
+          }
+        },
+        'SG' => {
+          sales_tax_website_name: 'GST',
+          sales_tax: { '_ALL': build_fee_struct(0.07, 0, 0, 0) },
+          provincial_sales_taxes: { '_ALL': no_taxes }
+        },
+        'HK' => {
+          sales_tax_website_name: nil,
+          sales_tax: { '_ALL': no_taxes },
+          provincial_sales_taxes: { '_ALL': no_taxes }
+        },
+        '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' => {
+          sales_tax_website_name: nil,
+          sales_tax: { '_ALL': no_taxes },
+          provincial_sales_taxes: { '_ALL': no_taxes }
+        }
+      }.freeze
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Easyship
+  module SalesTax
+    module Calculator
+      VERSION = "0.1.0"
+    end
+  end
+end

data/vat-gst-calculator.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easyship/sales_tax/calculator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vat-gst-calculator"
+  spec.version       = Easyship::SalesTax::Calculator::VERSION
+  spec.authors       = ["Aloha Chen"]
+  spec.email         = ["y.alohac@gmail.com"]
+
+  spec.summary       = %q{Calculate Sales Tax}
+  spec.description   = %q{Calculating VAT/GST/PST based on shipping rate, insurance fee, pickup_fee...etc}
+  spec.homepage      = "https://github.com/easyship/vat-gst-calculator"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: vat-gst-calculator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aloha Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-18 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculating VAT/GST/PST based on shipping rate, insurance fee, pickup_fee...etc
+email:
+- y.alohac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/easyship/sales_tax/calculator.rb
+- lib/easyship/sales_tax/calculator/fee.rb
+- lib/easyship/sales_tax/calculator/formula.rb
+- lib/easyship/sales_tax/calculator/version.rb
+- vat-gst-calculator.gemspec
+homepage: https://github.com/easyship/vat-gst-calculator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Calculate Sales Tax
+test_files: []