ziptax 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c03de0d5649f47596a9c9faddaeb2f51aa30501
+  data.tar.gz: 7f4ec97a2e2200d2a33f136c7a3f14ffaada37bf
+SHA512:
+  metadata.gz: 17bc5d039af1a6db1993176a36a59453ff8fe410214a33b1d2af12bc2cde7da40bad84bda8c520f807ac72d7ab03e54500498a99e3d3f829f464155d711981fb
+  data.tar.gz: cda8978e29f8a71fe83eea5574df2316c058886e9fbcd69bf67ddc270ee12fd9e262e531bfb36912b2bb0e364bf736d6c68f63aae6d2f03b9ab2542d1f183343

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

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) 2014 Bryce McDonnell
+
+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,90 @@
+# ZipTax
+
+Zip-Tax.com provides a very simple API for querying sales and use tax
+rates in most zip codes in the United States. This gem provides a thin
+wrapper around the API to quickly and easily retrieve sales tax rates by
+zip code.
+
+[Official documentation for the API](http://docs.zip-tax.com/en/latest/index.html) is hosted by Zip-Tax.
+
+You will need an API key to get started (sadly, no free developer accounts exist)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ziptax'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ziptax
+
+## Usage
+
+Try it out in irb:
+
+```bash
+gem install ziptax
+irb -r ziptax
+```
+```ruby
+ZipTax::SalesTax.request_for(key: '<yourkeyhere>', postalcode: '10003')
+# => {
+  "version": "v20",
+  "rCode": 100,
+  "results": [
+    {
+      "geoPostalCode": "10003",
+      "geoCity": "NEW YORK CITY",
+      "geoCounty": "NEW YORK",
+      "geoState": "NY",
+      "taxSales": 0.088749997317791,
+      "taxUse": 0.088749997317791,
+      "txbService": "L",
+      "txbFreight": "Y",
+      "stateSalesTax": 0.03999999910593,
+      "stateUseTax": 0.03999999910593,
+      "citySalesTax": 0.045000001788139,
+      "cityUseTax": 0.045000001788139,
+      "cityTaxCode": "NE 8081",
+      "countySalesTax": 0,
+      "countyUseTax": 0,
+      "countyTaxCode": "",
+      "districtSalesTax": 0.003749999916181,
+      "districtUseTax": 0.003749999916181
+    },
+    {
+      "geoPostalCode": "10003",
+      "geoCity": "NEW YORK",
+      "geoCounty": "NEW YORK",
+      "geoState": "NY",
+      "taxSales": 0.088749997317791,
+      "taxUse": 0.088749997317791,
+      "txbService": "L",
+      "txbFreight": "Y",
+      "stateSalesTax": 0.03999999910593,
+      "stateUseTax": 0.03999999910593,
+      "citySalesTax": 0.045000001788139,
+      "cityUseTax": 0.045000001788139,
+      "cityTaxCode": "NE 8081",
+      "countySalesTax": 0,
+      "countyUseTax": 0,
+      "countyTaxCode": "",
+      "districtSalesTax": 0.003749999916181,
+      "districtUseTax": 0.003749999916181
+    }
+  ]
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/brycemcd/ziptax/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/zip_tax.rb

@@ -0,0 +1,7 @@
+module ZipTax
+end
+
+require "zip_tax/version"
+require_relative 'zip_tax/sales_tax'
+require_relative 'zip_tax/response'
+require_relative 'zip_tax/result'

data/lib/zip_tax/response.rb

@@ -0,0 +1,17 @@
+module ZipTax
+  class Response < OpenStruct
+
+    def success?
+      self.rCode && self.rCode == 100
+    end
+
+    def self.new_from_http_request(response_hsh)
+      #NOTE: xml is not supported by this gem right now
+      # it is supported in the API
+      hsh = JSON.parse(response_hsh)
+      resp = ZipTax::Response.new(hsh)
+      resp.results = hsh['results'].collect { |result| ZipTax::Result.new(result) }
+      resp
+    end
+  end
+end

data/lib/zip_tax/result.rb

@@ -0,0 +1,4 @@
+module ZipTax
+  class Result < OpenStruct
+  end
+end

data/lib/zip_tax/sales_tax.rb

@@ -0,0 +1,41 @@
+require 'rack/utils'
+require 'ostruct'
+require 'json'
+
+module ZipTax
+  class SalesTax
+    attr_reader :key, :postalcode, :state, :city, :format
+
+    BASE_URL="http://api.zip-tax.com/request/v20"
+
+    def initialize(key: nil,
+                   postalcode: nil,
+                   state: nil,
+                   city: nil)
+
+      fail ArgumentError, "postalcode and key (api key) are required arguments" if !key || !postalcode
+      @key = key
+      @postalcode = postalcode.to_s
+      @state = state
+      @city = city
+      @format = 'json'
+    end
+
+    def request_url
+      query = {key: @key, postalcode: @postalcode, state: @state, city: @city, format: @format}
+      "#{BASE_URL}?#{Rack::Utils.build_query(query)}"
+    end
+
+    def request_tax
+      url = URI(request_url)
+      resp = Net::HTTP.get(url)
+      ZipTax::Response.new_from_http_request(resp)
+    end
+
+    def self.request_for(key: nil, postalcode: nil, state: nil, city: nil)
+
+      rt = self.new(key: key, postalcode: postalcode, state: state, city: city)
+      rt.request_tax
+    end
+  end
+end

data/lib/zip_tax/version.rb

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

data/spec/lib/zip_tax/response_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe ZipTax::Response do
+  let(:fake_response) {
+    <<-STR
+    {
+      "version": "v20",
+      "rCode": 100,
+      "results": [
+        {
+        "geoPostalCode": "10801",
+        "geoCity": "NEW ROCHELLE",
+        "geoCounty": "WESTCHESTER",
+        "geoState": "NY",
+        "taxSales": 0.083750002086163,
+        "taxUse": 0.083750002086163,
+        "txbService": "L",
+        "txbFreight": "Y",
+        "stateSalesTax": 0.03999999910593,
+        "stateUseTax": 0.03999999910593,
+        "citySalesTax": 0.03999999910593,
+        "cityUseTax": 0.03999999910593,
+        "cityTaxCode": "NE 6861",
+        "countySalesTax": 0,
+        "countyUseTax": 0,
+        "countyTaxCode": "WE 5581",
+        "districtSalesTax": 0.003749999916181,
+        "districtUseTax": 0.003749999916181
+        }
+       ]
+      }
+    STR
+  }
+  describe '.new_from_http_request' do
+    context "on success" do
+      let(:resp) { ZipTax::Response.new_from_http_request(fake_response) }
+      it "creates a new Response object" do
+        expect(resp).to be_kind_of ZipTax::Response
+      end
+
+      it "creates result objects" do
+        expect(resp.results).to be_kind_of Array
+        expect(resp.results.first).to be_kind_of ZipTax::Result
+      end
+    end
+  end
+
+  describe "#success?" do
+    it "is true if rCode == 100" do
+      expect(ZipTax::Response.new({rCode: 100}).success?).to be_truthy
+    end
+
+    it "is false if rCode != 100" do
+      expect(ZipTax::Response.new({rCode: 101}).success?).to be_falsey
+    end
+
+    it "is false if no rCode" do
+      expect(ZipTax::Response.new({notrCode: 101}).success?).to be_falsey
+    end
+  end
+end

data/spec/lib/zip_tax/sales_tax_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe ZipTax::SalesTax do
+  let(:fake_response) {
+    <<-STR
+    {
+      "version": "v20",
+      "rCode": 100,
+      "results": [
+        {
+        "geoPostalCode": "10801",
+        "geoCity": "NEW ROCHELLE",
+        "geoCounty": "WESTCHESTER",
+        "geoState": "NY",
+        "taxSales": 0.083750002086163,
+        "taxUse": 0.083750002086163,
+        "txbService": "L",
+        "txbFreight": "Y",
+        "stateSalesTax": 0.03999999910593,
+        "stateUseTax": 0.03999999910593,
+        "citySalesTax": 0.03999999910593,
+        "cityUseTax": 0.03999999910593,
+        "cityTaxCode": "NE 6861",
+        "countySalesTax": 0,
+        "countyUseTax": 0,
+        "countyTaxCode": "WE 5581",
+        "districtSalesTax": 0.003749999916181,
+        "districtUseTax": 0.003749999916181
+        }
+       ]
+      }
+    STR
+  }
+  describe "#new" do
+    it "errors if key or postal code are not set" do
+     expect {
+       ZipTax::SalesTax.new(postalcode: '001245')
+     }.to raise_exception(ArgumentError, /api key/i)
+
+     expect {
+       ZipTax::SalesTax.new(key: 'abc123')
+     }.to raise_exception(ArgumentError, /postalcode/i)
+    end
+
+    it "sets all possible parameters to the api" do
+      rq = ZipTax::SalesTax.new(key: 'abc123',
+                                postalcode: '000123',
+                                state: 'NY',
+                                city: 'New York'
+                               )
+      expect(rq).to be_kind_of ZipTax::SalesTax
+      [:key, :postalcode, :state, :city].each do |attr|
+        expect(rq.send(attr.to_sym)).to_not be_nil
+      end
+    end
+  end
+
+  describe "#request_tax" do
+    context "success" do
+      it "returns a json response" do
+        expect(Net::HTTP).to receive(:get).and_return(fake_response)
+        rq = ZipTax::SalesTax.new(key: 'abc123', postalcode: 000123)
+        resp = rq.request_tax
+        expect(resp).to be_kind_of ZipTax::Response
+      end
+    end
+  end
+
+  describe "#request_url" do
+    it "includes the keys/values included as get params on the base url" do
+      rq = ZipTax::SalesTax.new(key: 'abc123', postalcode: "00012")
+      expect(rq.request_url).to eql("#{ZipTax::SalesTax::BASE_URL}?key=abc123&postalcode=00012&state&city&format=json")
+    end
+  end
+
+  describe ".request_for" do
+    it "calls the API endpoing in one method call" do
+      expect(Net::HTTP).to receive(:get).and_return(fake_response)
+      rq = ZipTax::SalesTax.request_for(key: 'abc123', postalcode: '00123')
+      expect(rq).to be_kind_of ZipTax::Response
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/zip_tax'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/ziptax.gemspec

@@ -0,0 +1,26 @@
+# coding: 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 |spec|
+  spec.name          = "ziptax"
+  spec.version       = ZipTax::VERSION
+  spec.authors       = ["Bryce McDonnell"]
+  spec.email         = ["bryce@bridgetownint.com"]
+  spec.summary       = %q{Consumes Zip-Tax.com API and returns tax rates}
+  spec.description   = %q{Fetch calculated sales tax rate at the zip code area of specificity by consuming the Zip-Tax.com API}
+  spec.homepage      = "https://github.com/brycemcd/ziptax"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_dependency 'rack', '~> 1.4'
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ziptax
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryce McDonnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Fetch calculated sales tax rate at the zip code area of specificity by
+  consuming the Zip-Tax.com API
+email:
+- bryce@bridgetownint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zip_tax.rb
+- lib/zip_tax/response.rb
+- lib/zip_tax/result.rb
+- lib/zip_tax/sales_tax.rb
+- lib/zip_tax/version.rb
+- spec/lib/zip_tax/response_spec.rb
+- spec/lib/zip_tax/sales_tax_spec.rb
+- spec/spec_helper.rb
+- ziptax.gemspec
+homepage: https://github.com/brycemcd/ziptax
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Consumes Zip-Tax.com API and returns tax rates
+test_files:
+- spec/lib/zip_tax/response_spec.rb
+- spec/lib/zip_tax/sales_tax_spec.rb
+- spec/spec_helper.rb