super_good-solidus_taxjar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b11c5166cfe6ab6a6642c8b08d3cedc8faae319c
+  data.tar.gz: 0f59931ebbf60fdae8b42510fc00111e12488d49
+SHA512:
+  metadata.gz: 64bb574adc61f27623381fdd6bcabf0e5f0dd508a73e97442c3e2d1b66a62036e89f4ed569a5a62dddbdf9088789e2c2670c12744c1f66bb454a8f6271352f56
+  data.tar.gz: e6d919c2de1225d5ec329bea08c0e30b922fa7e7bb053aca39c8e1f8517af99f62d9c8fe157af82afd8be406893e4429a645c4045ee81dedb0de1afe08c29474

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+/spec/dummy

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v2.4 DB=postgres RAILS_VERSION="~> 5.1.0"
+before_install:
+  - gem update --system
+  - gem install bundler

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 contact@super.gd. 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,21 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+
+gem "solidus", github: "solidusio/solidus", branch: branch
+
+if ENV['RAILS_VERSION']
+  gem "rails", ENV['RAILS_VERSON']
+end
+
+if ENV.fetch('DB') == 'postgres'
+  gem 'pg'
+end
+
+group :development, :test do
+  gem "pry"
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jared Norman
+
+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,59 @@
+# `SuperGood::SolidusTaxJar` [![Build Status](https://travis-ci.com/SuperGoodSoft/solidus_taxjar.svg?token=rc5QTgHvLLF7cpqkmyfd&branch=master)](https://travis-ci.com/SuperGoodSoft/solidus_taxjar)
+
+`SuperGood::SolidusTaxJar` is a [Solidus](https://github.com/solidusio/solidus) extension that allows Solidus stores to use [TaxJar](https://www.taxjar.com/) for tax calculations.
+
+This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spree_taxjar), like [solidus_taxjar](https://github.com/boomerdigital/solidus_taxjar). Instead, `SuperGood::SolidusTaxJar` uses the new configurable tax system [introduced by @adammathys](https://github.com/solidusio/solidus/pull/1892) in Solidus 2.4.
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'super_good-solidus_taxjar'
+   ```
+
+   And then execute:
+
+       $ bundle
+
+2. Next, configure Solidus to use this gem:
+
+   ```ruby
+   # Put this in config/initializers/solidus.rb
+
+   Spree.config do |config|
+     config.tax_calculator_class = SuperGood::SolidusTaxJar::TaxCalculator
+   end
+   ```
+
+3. Also, configure your error handling:
+
+   ```ruby
+   # Put this in config/initializers/taxjar.rb
+
+   SuperGood::SolidusTaxJar::TaxCalculator.exception_handler = ->(e) {
+     # Report exceptions in here. For example, if you were using the Sentry's
+     # raven-ruby gem to report errors, you might do this:
+     Raven.capture_exception(e)
+   }
+   ```
+
+4. Finally, make sure that the `TAXJAR_API_KEY` environment variable is set to a your TaxJar API key and make sure that you have a `Spree::TaxRate` with the name "Sales Tax". This will be used as the source for the tax adjustments that Solidus creates.
+
+## 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/SuperGoodSoft/solidus_taxjar. 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 `SuperGood::SolidusTaxjar` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SuperGoodSoft/solidus_taxjar/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'super_good/solidus_taxjar'
+  Rake::Task['extension:test_app'].invoke
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "super_good/solidus_taxjar"
+require "pry"
+
+Pry.start

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/super_good/solidus_taxjar/api.rb

@@ -0,0 +1,48 @@
+module SuperGood
+  module SolidusTaxJar
+    class API
+      def self.default_taxjar_client
+        ::Taxjar::Client.new(
+          api_key: ENV.fetch("TAXJAR_API_KEY"),
+          api_url: 'https://api.sandbox.taxjar.com'
+        )
+      end
+
+      def initialize(taxjar_client: self.class.default_taxjar_client)
+        @taxjar_client = taxjar_client
+      end
+
+      def tax_for(order)
+        taxjar_client.tax_for_order order_params(order)
+      end
+
+      private
+
+      attr_reader :taxjar_client
+
+      def order_params(order)
+        tax_address = order.tax_address
+
+        {
+          to_country: tax_address.country.iso,
+          to_zip: tax_address.zipcode,
+          to_city: tax_address.city,
+          to_state: tax_address&.state&.abbr || tax_address.state_name,
+          to_street: tax_address.address1,
+
+          shipping: order.shipment_total,
+
+          line_items: order.line_items.map do |line_item|
+            {
+              id: line_item.id,
+              quantity: line_item.quantity,
+              unit_price: line_item.price,
+              discount: -line_item.adjustment_total,
+              product_tax_code: line_item.tax_category&.tax_code
+            }
+          end
+        }
+      end
+    end
+  end
+end

data/lib/super_good/solidus_taxjar/tax_calculator.rb

@@ -0,0 +1,147 @@
+module SuperGood
+  module SolidusTaxJar
+    class TaxCalculator
+      class_attribute :exception_handler
+      self.exception_handler = ->(e) {
+        Rails.logger.error "An error occurred while fetching TaxJar tax rates - #{e}: #{e.message}"
+      }
+
+      def self.default_api
+        ::SuperGood::SolidusTaxJar::API.new
+      end
+
+      def initialize(order, api: self.class.default_api)
+        @order = order
+        @api = api
+      end
+
+      def calculate
+        return no_tax if order.tax_address.empty?
+
+        cache do
+          next no_tax unless taxjar_breakdown
+
+          Spree::Tax::OrderTax.new(
+            order_id: order.id,
+            line_item_taxes: line_item_taxes,
+            shipment_taxes: shipment_taxes
+          )
+        end
+      rescue StandardError => e
+        exception_handler.(e)
+        no_tax
+      end
+
+      private
+
+      attr_reader :order, :api
+
+      def line_item_taxes
+        @line_item_taxes ||=
+          taxjar_breakdown.line_items.map do |line_item|
+            Spree::Tax::ItemTax.new(
+              item_id: line_item.id.to_i,
+              label: "Sales Tax",
+              tax_rate: tax_rate,
+              amount: line_item.tax_collectable,
+              included_in_price: false
+            )
+          end
+      end
+
+      def shipment_taxes
+        @shipment_taxes ||=
+          if taxjar_breakdown.shipping? &&
+            (total_shipping_tax = taxjar_breakdown.shipping.tax_collectable) != 0
+
+            # Distribute shipping tax across shipments:
+            # TaxJar does not provide a breakdown of shipping taxes, so we have
+            # to proportionally distribute the tax across the shipments,
+            # accounting for rounding errors.
+            tax_items = []
+            remaining_tax = total_shipping_tax
+            shipments = order.shipments.to_a
+            total_shipping_cost = shipments.sum(&:total_before_tax)
+
+            shipments[0...-1].each do |shipment|
+              percentage_of_tax = shipment.total_before_tax / total_shipping_cost
+              shipping_tax = (percentage_of_tax * total_shipping_tax).round(2)
+              remaining_tax -= shipping_tax
+
+              tax_items << ::Spree::Tax::ItemTax.new(
+                item_id: shipment.id,
+                label: "Sales Tax",
+                tax_rate: tax_rate,
+                amount: shipping_tax,
+                included_in_price: false
+              )
+            end
+
+            tax_items << ::Spree::Tax::ItemTax.new(
+              item_id: shipments.last.id,
+              label: "Sales Tax",
+              tax_rate: tax_rate,
+              amount: remaining_tax,
+              included_in_price: false
+            )
+
+            tax_items
+          else
+            []
+          end
+      end
+
+      def taxjar_breakdown
+        @taxjar_breakdown ||= taxjar_tax.breakdown
+      end
+
+      def taxjar_tax
+        @taxjar_taxes ||= api.tax_for(order)
+      end
+
+      def no_tax
+        Spree::Tax::OrderTax.new(
+          order_id: order.id,
+          line_item_taxes: [],
+          shipment_taxes: []
+        )
+      end
+
+      def tax_rate
+        Spree::TaxRate.find_by(name: "Sales Tax")
+      end
+
+      def cache
+        if !Rails.env.test?
+          Rails.cache.fetch(cache_key, expires_in: 10.minutes) { yield }
+        else
+          yield
+        end
+      end
+
+      def cache_key
+        tax_address = order.tax_address
+
+        {
+          to_country: tax_address.country.iso,
+          to_zip: tax_address.zipcode,
+          to_city: tax_address.city,
+          to_state: tax_address&.state&.abbr || tax_address.state_name,
+          to_street: tax_address.address1,
+
+          shipping: order.shipment_total,
+
+          line_items: order.line_items.map do |line_item|
+            {
+              id: line_item.id,
+              quantity: line_item.quantity,
+              unit_price: line_item.price,
+              discount: -line_item.adjustment_total,
+              product_tax_code: line_item.tax_category&.tax_code
+            }
+          end.hash
+        }
+      end
+    end
+  end
+end

data/lib/super_good/solidus_taxjar/version.rb

@@ -0,0 +1,5 @@
+module SuperGood
+  module SolidusTaxJar
+    VERSION = "0.1.0"
+  end
+end

data/lib/super_good/solidus_taxjar.rb

@@ -0,0 +1,12 @@
+require 'solidus_core'
+require 'solidus_support'
+require 'taxjar'
+
+module SuperGood
+  module SolidusTaxJar
+  end
+end
+
+require "super_good/solidus_taxjar/version"
+require "super_good/solidus_taxjar/api"
+require "super_good/solidus_taxjar/tax_calculator"

data/super_good-solidus_taxjar.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "super_good/solidus_taxjar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "super_good-solidus_taxjar"
+  spec.version       = SuperGood::SolidusTaxJar::VERSION
+  spec.authors       = ["Jared Norman"]
+  spec.email         = ["jared@super.gd"]
+
+  spec.summary       = "Support for using TaxJar to handle tax calculations in Solidus"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/SuperGoodSoft/solidus_taxjar"
+  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_dependency "solidus_core", ">= 2.4.0"
+  spec.add_dependency "solidus_support"
+  spec.add_dependency "taxjar-ruby"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: super_good-solidus_taxjar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared Norman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: taxjar-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !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: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Support for using TaxJar to handle tax calculations in Solidus
+email:
+- jared@super.gd
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/super_good/solidus_taxjar.rb
+- lib/super_good/solidus_taxjar/api.rb
+- lib/super_good/solidus_taxjar/tax_calculator.rb
+- lib/super_good/solidus_taxjar/version.rb
+- super_good-solidus_taxjar.gemspec
+homepage: https://github.com/SuperGoodSoft/solidus_taxjar
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Support for using TaxJar to handle tax calculations in Solidus
+test_files: []