active_tax 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4d0012857ee4032097f829452269524e44fe789
-  data.tar.gz: 94956a278ff955a87884fbdf7b0888492f57943a
+  metadata.gz: 0709470838c0295b2053399c4db34539d0267c22
+  data.tar.gz: d709eba5a20e3f2cac2b2200f68937573216c1e2
 SHA512:
-  metadata.gz: 00dde154464596f7d955d96f2fc6d9e0cd6e4511ed5433c380f1c32482faf38fe66052c79f23612da4f144ff79c9e4262ab2dc8bccbc8a4475b09d159b9394e8
-  data.tar.gz: ef24236126b982b04238e1ad2fa2ae0bd58eb9835132051da0f58c380cc73bedc608dbb90dc7ac3c632d0f613a9dbac3ea7f701b5b29391653b4cb1fdf502520
+  metadata.gz: 028982ffd0f26d9b33b3e3be95b966db52f48eb94859d15f4f879dc920b7da8145ec6d6654224553247e6293c6a5a3c8d07a791f8596ab1bc2e9bde98e8c953f
+  data.tar.gz: 08fed24e91b981bc2770c211ca60128b226b0c7f19d6face2326e4fb283f2903f8f43faa5b04f89a498a07eef6a276d634c58688554df0aaf1a4e32b9bbdec0b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jamon Holmgren
+Copyright (c) 2012-2014 Jamon Holmgren
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,8 @@
 # ActiveTax
 
-A Ruby gem for retrieving local sales tax rates from various government APIs. Currently
-only supports Washington State sales tax, but feel free to write your own state's implementations
-and do pull requests.
+A Ruby gem for retrieving local sales tax rates from various government APIs.
+Currently only supports Washington State sales tax, but feel free to write your
+own state's implementations and do pull requests.
 
 ## Installation
 
@@ -10,26 +10,21 @@ Add this line to your application's Gemfile:
 
     gem 'active_tax'
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install active_tax
-
 ## Usage
 
 ```ruby
-
-tax_rate = ActiveTax::Tax.rate({
+tax = ActiveTax::Tax.new({
   address: "6500 Linderson Way",
-  city: "",
+  city: "Tumwater",
+  state: "WA", # must be two-letter state abbreviation
   zip: "98501",
-  state: "WA"
 })
 
-puts tax_rate #=> 0.087
+# tax is a Struct with #rate, #location_code, and #result_code properties.
+
+puts tax.rate #=> 0.087
+puts tax.location_code #=> "3406"
+puts tax.result_code #=> "0"
 ```
 
 ## Contributing
@@ -40,3 +35,7 @@ Contributions are very welcome!
 2. Commit your changes (`git commit -am 'Added some feature'`)
 3. Push to the branch (`git push origin my-new-feature`)
 4. Create new Pull Request
+
+## License
+
+MIT

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/test_*.rb"
+end

data/active_tax.gemspec

@@ -7,13 +7,18 @@ Gem::Specification.new do |gem|
   gem.description   = "A Ruby gem for retrieving local sales tax rates from various government APIs. Currently only supports Washington State tax, but feel free to submit pull requests."
   gem.summary       = "A Ruby gem for retrieving local sales tax rates from various government APIs."
   gem.homepage      = "https://github.com/jamonholmgren/active_tax"
+  gem.license       = "MIT"
 
   gem.platform     = Gem::Platform::RUBY
 
   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.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test)/})
   gem.name          = "active_tax"
   gem.require_paths = ["lib"]
   gem.version       = ActiveTax::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "minitest-reporters"
 end

data/lib/active_tax/states/wa.rb

@@ -3,7 +3,7 @@ module ActiveTax
     class WA
       API_URI = "http://dor.wa.gov/AddressRates.aspx"
 
-      def self.rate(address={})
+      def self.tax(address={})
         # http://dor.wa.gov/AddressRates.aspx?output=text&addr=6500%20Linderson%20way&city=&zip=98501
         params = {
           output: "text",
@@ -13,7 +13,7 @@ module ActiveTax
         }
 
         require 'net/http' # Needed for HTTP requests
-      
+
         uri = URI("#{API_URI}")
         uri.query = URI.encode_www_form(params)
 
@@ -21,13 +21,17 @@ module ActiveTax
 
         # LocationCode=3406 Rate=0.087 ResultCode=0
         if res.is_a?(Net::HTTPSuccess)
-          result = self.parse_result(res.body)
-          return result["Rate"].to_f
+          normalize(self.parse_result(res.body))
         else
-          return false
+          false
         end
       end
 
+      def self.rate(address={})
+        tax_data = tax(address)
+        tax_data && tax_data.rate
+      end
+
       def self.parse_result(text)
         r = {}
         items = text.split(" ")
@@ -37,6 +41,11 @@ module ActiveTax
         end
         r
       end
+
+      def self.normalize(tax_data)
+        Struct.new(:rate,                 :location_code,           :result_code)
+              .new(tax_data["Rate"].to_f, tax_data["LocationCode"], tax_data["ResultCode"])
+      end
     end
     WASHINGTON = WA unless defined?(WASHINGTON)
   end

data/lib/active_tax/tax.rb

@@ -1,27 +1,50 @@
 module ActiveTax
   class Tax
-    attr_accessor :state, :api_class
+    attr_accessor :state, :address, :api_class
 
     def self.rate(address={})
       raise StandardError, "You must provide a state to use ActiveTax::Tax.rate" unless address[:state]
-      self.new(address[:state]).rate_from_address(address)
+      self.new(address).rate
     end
 
-    def initialize(state)
-      self.state = state
+    def initialize(address)
+      self.state = address[:state]
+      self.address = address
+
+      determine_state_api
     end
 
     def rate_from_address(address={})
-      self.state = address[:state] if address[:state]
+      raise "#rate_from_address is deprecated. Use #rate instead."
+    end
+
+    def tax
+      @tax ||= self.api_class.tax(address)
+    end
 
+    def rate
+      tax.rate
+    end
+
+    def location_code
+      tax.location_code
+    end
+
+    def result_code
+      tax.result_code
+    end
+
+    private
+
+    def determine_state_api
       case self.state.upcase
-      when "WA", "WASHINGTON"
-        self.api_class = States::WA
-      else
-        raise StandardError, "API for #{self.state.upcase} not yet implemented in ActiveTax."
+      when "WA", "WASHINGTON" then self.api_class = States::WA
+      else raise StandardError, "API for #{self.state.upcase} not yet implemented in ActiveTax."
       end
+    end
+
+    def api_data
 
-      self.api_class.rate(address)
     end
   end
 end

data/lib/active_tax/version.rb

@@ -1,3 +1,3 @@
 module ActiveTax
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'active_tax'
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new(color: true)

data/test/test_tax.rb

@@ -0,0 +1,38 @@
+require_relative './test_helper'
+
+class TestTax < Minitest::Unit::TestCase
+  def test_real_rate
+    rate = ActiveTax::Tax.rate({
+      address: "6500 Linderson Way",
+      city: "",
+      zip: "98501",
+      state: "WA"
+    })
+
+    assert_in_delta rate * 100.0, 8.2, 2.5 # 8.2%, within about 2.5%
+  end
+
+  def test_bad_rate
+    rate = ActiveTax::Tax.rate({
+      address: "",
+      city: "",
+      zip: "",
+      state: "WA"
+    })
+
+    assert_equal rate, -1
+  end
+
+  def test_other_tax_info
+    tax = ActiveTax::Tax.new({
+      address: "6500 Linderson Way",
+      city: "Tumwater",
+      zip: "98501",
+      state: "WA"
+    })
+
+    assert_in_delta tax.rate * 100.0, 8.2, 2.5 # 8.2%, within about 2.5%
+    assert_equal tax.location_code, "3406"
+    assert_equal tax.result_code, "0"
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: active_tax
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jamon Holmgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
-dependencies: []
+date: 2016-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: minitest-reporters
+  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: A Ruby gem for retrieving local sales tax rates from various government
   APIs. Currently only supports Washington State tax, but feel free to submit pull
   requests.
@@ -19,8 +61,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
-- .gitignore
+- ".DS_Store"
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -30,8 +72,11 @@ files:
 - lib/active_tax/states/wa.rb
 - lib/active_tax/tax.rb
 - lib/active_tax/version.rb
+- test/test_helper.rb
+- test/test_tax.rb
 homepage: https://github.com/jamonholmgren/active_tax
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -39,18 +84,20 @@ 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.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for retrieving local sales tax rates from various government APIs.
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/test_tax.rb