zip_tax 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zip_tax.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eric Steele
+
+MIT License
+
+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,124 @@
+# ZipTax
+
+This is a Ruby wrapper for working with the [Zip-Tax API]('http://www.zip-tax.com/documentation'). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zip_tax'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zip_tax
+
+## Usage
+
+### ZipTax.key
+
+Before you do anything, make sure you set your Zip-Tax api key.
+
+```ruby
+ZipTax.key = "123456789" #sets the api key
+```
+
+### ZipTax.request
+  
+```ruby
+ZipTax.request(90210) #returns the raw request, jsonified.
+
+=> { "version" => "v20",
+     "rCode"   => 100,
+     "results" => [ 
+       { "geoPostalCode"   => "90210",
+         "geoCity"         => "BEVERLY HILLS",
+         "geoCounty"       => "LOS ANGELES",
+         "geoState"        => "CA",
+         "taxSales"        => 0.087499998509884,
+         "taxUse"          => 0.087499998509884,
+         "txbService"      => "N",
+         "txbFreight"      => "N",
+         "stateSalesTax"   => 0.0625,
+         "stateUseTax"     => 0.0625,
+         "citySalesTax"    => 0,
+         "cityUseTax"      => 0,
+         "cityTaxCode"     => "",
+         "countySalesTax"  => 0.0099999997764826,
+         "countyUseTax"    => 0.0099999997764826,
+         "countyTaxCode"   => "19",
+         "districtSalesTax"=> 0.014999999664724,
+         "districtUseTax"  => 0.014999999664724 },
+       { "geoPostalCode"   => "90210",
+         "geoCity"         => "WESTLAKE",
+         "geoCounty"       => "LOS ANGELES",
+         "geoState"        => "CA",
+         "taxSales"        => 0.087499998509884,
+         "taxUse"          => 0.087499998509884,
+         "txbService"      => "N",
+         "txbFreight"      => "N",
+         "stateSalesTax"   => 0.0625,
+         "stateUseTax"     => 0.0625,
+         "citySalesTax"    => 0,
+         "cityUseTax"      => 0,
+         "cityTaxCode"     => "19",
+         "countySalesTax"  => 0.0099999997764826,
+         "countyUseTax"    => 0.0099999997764826,
+         "countyTaxCode"   => "19",
+         "districtSalesTax"=> 0.014999999664724,
+         "districtUseTax"  => 0.014999999664724 }
+       ]
+   }
+```
+
+### ZipTax.rate(zip)
+
+```ruby
+ZipTax.rate(90210) #returns the sales tax rate for that zip code
+=> 0.087499998509884
+```
+
+```ruby
+ZipTax.rate(90210, 'CA') #returns the sales tax rate for an item sold in a specific state
+=> 0.087499998509884
+```
+
+```ruby
+ZipTax.rate(90210, 'TX') #returns 0.0 if sales tax isn't neccessary in that state
+=> 0.0
+```
+
+### ZipTax.info(zip)
+
+```ruby
+ZipTax.info(90210) #returns a hash of information about a specified zip code
+=> { "geoPostalCode"   => "90210",
+     "geoCity"         => "BEVERLY HILLS",
+     "geoCounty"       => "LOS ANGELES",
+     "geoState"        => "CA",
+     "taxSales"        => 0.087499998509884,
+     "taxUse"          => 0.087499998509884,
+     "txbService"      => "N",
+     "txbFreight"      => "N",
+     "stateSalesTax"   => 0.0625,
+     "stateUseTax"     => 0.0625,
+     "citySalesTax"    => 0,
+     "cityUseTax"      => 0,
+     "cityTaxCode"     => "",
+     "countySalesTax"  => 0.0099999997764826,
+     "countyUseTax"    => 0.0099999997764826,
+     "countyTaxCode"   => "19",
+     "districtSalesTax"=> 0.014999999664724,
+     "districtUseTax"  => 0.014999999664724 }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/zip_tax.rb

@@ -0,0 +1,36 @@
+require "zip_tax/version"
+require 'net/http'
+require 'json'
+
+module ZipTax
+  @@host = 'api.zip-tax.com'
+  @@key ||= nil
+  
+  def self.key=(key)
+    @@key = key
+  end
+  
+  def self.key
+    @@key
+  end
+  
+  def self.request(zip)
+    key = @@key
+    host = @@host
+    raise ArgumentError, "Zip-Tax API key must be set using ZipTax.key=" if key.nil?
+    path = "/request/v20?key=#{key}&postalcode=#{zip}"
+    response = JSON.parse(Net::HTTP.get(host, path))
+    raise StandardError, "Zip-Tax returned an empty response using the zip code #{zip}" if response["results"].empty?
+    return response
+  end
+  
+  def self.rate(zip, state = nil)
+    response = request(zip)
+    state.nil? || state.upcase == response['results'][0]['geoState'] ? response['results'][0]['taxSales'] : 0.0
+  end
+  
+  def self.info(zip)
+    response = request(zip)
+    return response['results'][0]
+  end
+end

data/lib/zip_tax/version.rb

@@ -0,0 +1,3 @@
+module ZipTax
+  VERSION = "1.0.0"
+end

data/zip_tax.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zip_tax/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "zip_tax"
+  gem.version       = ZipTax::VERSION
+  gem.authors       = ["Eric Steele"]
+  gem.email         = ["eric@notvelcro.com"]
+  gem.description   = %q{Ruby wrapper for the Zip-Tax api}
+  gem.summary       = %q{This is a Ruby wrapper for interacting with the Zip-Tax API}
+  gem.homepage      = "https://github.com/genericsteele/zip_tax"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: zip_tax
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Steele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper for the Zip-Tax api
+email:
+- eric@notvelcro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zip_tax.rb
+- lib/zip_tax/version.rb
+- zip_tax.gemspec
+homepage: https://github.com/genericsteele/zip_tax
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This is a Ruby wrapper for interacting with the Zip-Tax API
+test_files: []