sales_tax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5011f177f821f6b3468d1ecab3d8829cabc7ddae
+  data.tar.gz: 381b02e2d0ce3bcd8412b631906313e4b232f382
+SHA512:
+  metadata.gz: 6ddf68e4a9f6e088f178e61364bb08d4893b026fab4a66203fc48affc7f3e65d3354824899f49f53ef691463d624ca6b7cb836af0b06c3fe0f972043bd4e9432
+  data.tar.gz: 9d085887bc28ee666dad29f9dee04af40ef0357de1277e44fb8683f9bc40228d3ea80ab20f7f92ae065ed01b01e8443625c838c54540a9ec9d7707c862b11ac4

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+data/*.csv
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - '2.3.0'
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sales_tax (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rake (~> 10.4.2)
+  rspec (~> 3.4.0)
+  sales_tax!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Dirk Gadsden
+
+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,46 @@
+# sales_tax
+
+Interface to the public [Avalara TaxRates](http://www.taxrates.com/) database for sales taxes in the United States of America. Easily look up combined, state, and county rates by zip code.
+
+**Notice**: This is a development tool only; it is not intended for use as tax compliance software and should not be relied upon for financial decisions. As detailed in the [LICENSE](LICENSE), **use of this software is at your own risk**. The author(s) disclaim all warranties and by your use of this software you agree to waive the author(s) of any and all liabilities. You should consult with a tax professional before collecting or paying taxes.
+
+[![Build Status](https://travis-ci.org/dirk/sales_tax.svg)](https://travis-ci.org/dirk/sales_tax)
+
+## Installation
+
+Install via Rubygems or add the dependency via Bundler:
+
+```sh
+# Rubygems directly
+gem install sales_tax
+
+# In your Gemfile
+gem 'sales_tax'
+```
+
+After installation you will need to download the publicly available CSV data from Avalara's [taxrates.com](http://www.taxrates.com/download-tax-tables/):
+
+```sh
+# Ensure the gem is loaded when `rake` is called (this is done automatically
+# if you're using Rails and the gem is in your Gemfile)
+bundle exec rake sales_tax:download
+```
+
+## Basic usage
+
+You can look up the tax rates via zip code:
+
+```ruby
+SalesTax['94107']
+# => <struct SalesTax::Rate region_name="SAN FRANCISCO COUNTY",
+#                           region_code="AIUQ",
+#                           combined_rate=0.0875,
+#                           state_rate=0.065,
+#                           county_rate=0.01,
+#                           city_rate=0.0,
+#                           special_rate=0.0125>
+```
+
+## License
+
+Licensed under the MIT license. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+require 'sales_tax'

data/data/taxrates_download_list.txt

@@ -0,0 +1,55 @@
+# This is a list of public CSV URLs from:
+# http://www.taxrates.com/download-tax-tables/
+
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_AL201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_AK201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_AZ201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_AR201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_CA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_CO201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_CT201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_DE201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_FL201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_GA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_HI201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_ID201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_IL201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_WV201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_VA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_TX201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_SC201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_PA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_OH201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NY201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NH201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MT201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MN201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MD201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_KY201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_IN201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_IA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_LA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MS201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NE201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NJ201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NC201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_OK201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_PR201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_SD201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_UT201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_WA201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_WI201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_WY201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_DC201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_VT201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_TN201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_RI201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_OR201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_ND201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NM201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_NV201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MO201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_MI201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_ME201602.csv
+http://taxrates.csv.s3.amazonaws.com/TAXRATES_ZIP5_KS201602.csv

data/lib/sales_tax/auto_load.rb

@@ -0,0 +1,16 @@
+module SalesTax
+  def self.auto_load
+    data_path  = File.join Dir.getwd, 'data'
+    data_files = Dir.glob(File.join data_path, '*.csv')
+
+    if data_files.empty?
+      raise "No data files found in #{data_path}"
+    end
+
+    data_files.each do |path|
+      SalesTax::Data.load_csv_file path
+    end
+  end
+end
+
+SalesTax.auto_load

data/lib/sales_tax/base.rb

@@ -0,0 +1,9 @@
+require 'sales_tax/rate_store'
+
+module SalesTax
+  Data = RateStore.new
+
+  def self.[](zip_code)
+    Data.find_by_zip_code zip_code
+  end
+end

data/lib/sales_tax/rate_store.rb

@@ -0,0 +1,42 @@
+require 'csv'
+
+module SalesTax
+  Rate = Struct.new(:region_name, :region_code, :combined_rate, :state_rate, :county_rate, :city_rate, :special_rate)
+
+  class RateStore
+    def initialize
+      # Map of 5-digit US zip code to `Rate` instances
+      @data = {}
+    end
+
+    def empty?
+      @data.empty?
+    end
+
+    def find_by_zip_code(zip_code)
+      @data[zip_code.to_s]
+    end
+
+    FIELDS_MAP = [
+      ['TaxRegionName' , :to_s],
+      ['TaxRegionCode' , :to_s],
+      ['CombinedRate'  , :to_f],
+      ['StateRate'     , :to_f],
+      ['CountyRate'    , :to_f],
+      ['CityRate'      , :to_f],
+      ['SpecialRate'   , :to_f],
+    ]
+
+    def load_csv_file(path)
+      CSV.foreach(path, headers: :first_row) do |row|
+        zip_code = row['ZipCode']
+
+        fields = FIELDS_MAP.map do |(row_key, transform)|
+          row[row_key].send transform
+        end
+
+        @data[zip_code] = Rate.new *fields
+      end
+    end
+  end
+end

data/lib/sales_tax/tasks/download.rake

@@ -0,0 +1,28 @@
+require 'open-uri'
+
+namespace 'sales_tax' do
+
+  desc 'Download CSVs'
+  task 'download' do
+    list_file_path = File.expand_path '../../../../data/taxrates_download_list.txt', __FILE__
+
+    list_file = File.read list_file_path
+
+    list = list_file
+      .split("\n")
+      .map(&:strip)
+      .reject {|line| line.start_with?('#') || line.empty? }
+
+    output_base_path = File.join Dir.getwd, 'data'
+
+    list.each do |url|
+      print "Downloading #{url} ..."
+
+      output_path = File.join output_base_path, File.basename(url)
+      File.write output_path, open(url).read
+
+      print " Done\n"
+    end
+  end
+
+end # namespace sales_tax

data/lib/sales_tax/version.rb

@@ -0,0 +1,3 @@
+module SalesTax
+  VERSION = '0.1.0'
+end

data/lib/sales_tax.rb

@@ -0,0 +1,7 @@
+require 'sales_tax/version'
+require 'sales_tax/base'
+require 'sales_tax/auto_load'
+
+if defined? Rake
+  load File.join(File.dirname(__FILE__), 'sales_tax', 'tasks', 'download.rake')
+end

data/sales_tax.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sales_tax/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sales_tax'
+  s.version     = SalesTax::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Dirk Gadsden']
+  s.email       = ['dirk@esherido.com']
+  s.homepage    = 'https://github.com/dirk/sales_tax'
+  s.summary     = 'Look up sales tax rates by zip code.'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split "\n"
+  s.test_files    = `git ls-files -- {test}/*`.split "\n"
+  s.require_paths = ['lib']
+
+  # s.add_dependency 'ffi', '~> 1.9.10'
+
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.4.2'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
+end

data/spec/auto_load_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SalesTax do
+  let(:mock_row) {
+      {
+        'State'         => 'AA',
+        'ZipCode'       => '12345',
+        'TaxRegionName' => 'A SUNNY SOCIALIST WORLD',
+        'TaxRegionCode' => 'ABCD',
+        'CombinedRate'  => '0.03',
+        'StateRate'     => '0.02',
+        'CountyRate'    => '0.01',
+        'CityRate'      => '0',
+        'SpecialRate'   => '0',
+    }
+  }
+
+  it 'auto-loads CSV data' do
+    allow(CSV).to receive(:foreach).and_yield(mock_row)
+    allow(Dir).to receive(:glob).and_return(['a/b.csv'])
+
+    require 'sales_tax/auto_load'
+
+    expect(SalesTax::Data).not_to be_empty
+
+    row = SalesTax::Data.find_by_zip_code '12345'
+
+    expect(row).not_to be_nil
+    expect(row.region_code).to eq 'ABCD'
+    expect(row.combined_rate).to eq 0.03
+  end
+end

data/spec/rate_store_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe SalesTax::RateStore do
+  before(:each) do
+    @rate_store = SalesTax::RateStore.new
+
+    @rate_store.instance_eval do
+      fake_rate = SalesTax::Rate.new(
+        region_name:   'A SUNNY SOCIALIST WORLD',
+        region_code:   'ABCD',
+        combined_rate: 0.03,
+        state_rate:    0.02,
+        county_rate:   0.01,
+        city_rate:     0.0,
+        special_rate:  0.0,
+      )
+
+      @data = {
+        '12345' => fake_rate
+      }
+    end
+  end
+
+  describe '#find_by_zip_code' do
+    it 'finds a rate by zip code' do
+      expect(@rate_store.find_by_zip_code '12345').not_to be_nil
+    end
+
+    it 'returns nil if rate not found' do
+      expect(@rate_store.find_by_zip_code 'bad-zip').to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sales_tax/base'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sales_tax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dirk Gadsden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Look up sales tax rates by zip code.
+email:
+- dirk@esherido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- data/taxrates_download_list.txt
+- lib/sales_tax.rb
+- lib/sales_tax/auto_load.rb
+- lib/sales_tax/base.rb
+- lib/sales_tax/rate_store.rb
+- lib/sales_tax/tasks/download.rake
+- lib/sales_tax/version.rb
+- sales_tax.gemspec
+- spec/auto_load_spec.rb
+- spec/rate_store_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dirk/sales_tax
+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.1
+signing_key: 
+specification_version: 4
+summary: Look up sales tax rates by zip code.
+test_files: []
+has_rdoc: