strikeiron 0.0.1

data/.gitignore

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

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p194

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem install bundler --pre
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+  - rbx-18mode
+  - rbx-19mode
+script: rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Drew Tempelmeyer
+
+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,71 @@
+# strikeiron
+
+strikeiron uses the Strikeiron Online Sales Tax API to calculate online sales tax to alleviate maintaining tax codes.
+
+For more information on Strikeiron, Inc., go to http://www.strikeiron.com/.
+
+[![Build Status](https://secure.travis-ci.org/drewtempelmeyer/strikeiron.png)](http://travis-ci.org/drewtempelmeyer/strikeiron)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strikeiron'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install strikeiron
+
+## Usage
+
+Usage of strikeiron requires access to Strikeiron Online Sales Tax API.
+
+#### 1. Configure the client
+
+    Strikeiron.configure do |config|
+      config.user_id  = 'your_strikeiron_user_id'
+      config.password = 'your_password'
+    end
+
+#### 2. Obtaining a list of categories
+
+Performing the category lookup does not count against your hits. For performance reasons, I recommend you keep a cached copy. A database is a good start.
+
+    categories = Strikeiron.tax_categories
+    # => [{:category=>"Alcohol", :category_id=>"01051000"}, {:category=>"Alcoholic Beverages", :category_id=>"01050000"}, {:category=>"Beer", :category_id=>"01052000"}, {:category=>"Books", :category_id=>"01501500"}, {:category=>"Charges necessary to complete sale other than delivery and installation", :category_id=>"04800000"}, ...]
+
+#### 3. Calculate sales tax
+
+    from  = Strikeiron::Address.new(:street_address => 'One Microsoft Way', :city => 'Redmond', :state => 'WA', :zip_code => '98052')
+    to    = Strikeiron::Address.new(:street_address => '902 Broadway', :city => 'New York', :state => 'NY', :zip_code => '10010')
+    items = [
+      Strikeiron::TaxValue.new(:category_id => '01151605', :amount => 239.41),
+      Strikeiron::TaxValue.new(:category_id => '01151605', :amount => 239.41)
+    ]
+
+    response = Strikeiron.sales_tax(
+      :from       => from,
+      :to         => to,
+      :tax_values => items
+    )
+    # => #<Strikeiron::TaxResult @from=#<Strikeiron::Address @street_address="ONE MICROSOFT WAY", @city="REDMOND", @state="WA", @zip_code="98052">, @to=#<Strikeiron::Address @street_address="902 BROADWAY", @city="NEW YORK", @state="NY", @zip_code="10010-6041">, @tax_values=[#<Strikeiron::TaxValue @category="Computer Software (both prewritten and non-prewritten) delivered electronically", @category_id="01151605", @tax_amount=21.25, @jurisdictions=[#<Strikeiron::Jurisdiction @fips="36", @name="New York", @tax_amount=9.57>, #<Strikeiron::Jurisdiction @fips="CTD51000", @name="METRO COMMUTER TRANS. DISTRICT", @tax_amount=0.89>, #<Strikeiron::Jurisdiction @fips="061", @name="NEW YORK", @tax_amount=10.77>]>, #<Strikeiron::TaxValue @category="Computer Software (both prewritten and non-prewritten) delivered electronically", @category_id="01151605", @tax_amount=21.25, @jurisdictions=[#<Strikeiron::Jurisdiction @fips="36", @name="New York", @tax_amount=9.57>, #<Strikeiron::Jurisdiction @fips="CTD51000", @name="METRO COMMUTER TRANS. DISTRICT", @tax_amount=0.89>, #<Strikeiron::Jurisdiction @fips="061", @name="NEW YORK", @tax_amount=10.77>]>], @total_tax=42.5>
+
+#### 4. Profit
+
+Hopefully.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Furthermore
+
+I am in no way associated with Strikeiron.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = false
+end
+
+RDoc::Task.new do |rd|
+  README      = 'README.md'
+  rd.main     = README
+  rd.rdoc_dir = 'doc'
+  rd.title    = 'strikeiron'
+  rd.rdoc_files.include(README, 'lib/**/*.rb')
+end

data/lib/strikeiron.rb

@@ -0,0 +1,109 @@
+require "savon"
+require "strikeiron/version"
+require "strikeiron/configuration"
+require "strikeiron/address"
+require "strikeiron/tax_value"
+require "strikeiron/jurisdiction"
+require "strikeiron/tax_result"
+
+# Strikeiron calculates online sales tax for your online service based on your local tax rules.
+module Strikeiron
+
+  # The location of the Strikeiron Online Sales Tax WSDL
+  WSDL = 'https://wsparam.strikeiron.com/SpeedTaxSalesTax3?WSDL'
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure Strikeiron for your account. See Configuration for more information.
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    # Singleton Savon client
+    def client
+      @@client ||= Savon::Client.new do
+        wsdl.document = WSDL
+      end
+    end
+
+    # Get the calculated online sales tax for a product or service
+    #
+    # === Options
+    # * <tt>from</tt> - The origin Address (or your physical location). Required.
+    # * <tt>to</tt> - The destination Address of the customer. Required.
+    # * <tt>tax_values</tt> - An array of TaxValueRequest objects. Required.
+    def sales_tax(options = {})
+      options          = options.inject({}) { |memo,(k, v)| memo[k.to_sym] = v; memo }
+      required_options = %w(from to tax_values)
+
+      # Raise an error if the required option is not defined
+      required_options.each { |val| raise ArgumentError, "Missing option :#{val}" if !options.include?(val.to_sym) }
+
+      response = client.request(:get_sales_tax_value) do |soap|
+        soap.body = {
+          'UserID'          => configuration.user_id,
+          'Password'        => configuration.password,
+          'ShipFrom'        => options[:from].to_soap,
+          'ShipTo'          => options[:to].to_soap,
+          'TaxValueRequests' => { 'TaxValueRequest' => options[:tax_values].map(&:to_soap) }
+        }
+      end
+
+      response_code = response[:get_sales_tax_value_response][:get_sales_tax_value_result][:service_status][:status_nbr]
+
+      # Raise exceptions if there was an error when calculating the tax
+      case response_code.to_i
+      when 401
+        raise RuntimeError, 'Invalid From address.'
+      when 402
+        raise RuntimeError, 'Invalid To address.'
+      when 403
+        raise RuntimeError, 'Invalid Taxability category.'
+      when 500
+        raise RuntimeError, 'Internal Strikeiron server error.'
+      end
+
+      Strikeiron::TaxResult.from_soap(response[:get_sales_tax_value_response][:get_sales_tax_value_result][:service_result])
+    end
+
+    # Performs a request to obtain a list of all available category names and their corresponding ID number.
+    #
+    # === Example
+    #   Strikeiron.tax_categories
+    #   # => [{:category=>"Alcohol", :category_id=>"01051000"}, {:category=>"Alcoholic Beverages", :category_id=>"01050000"}, {:category=>"Beer", :category_id=>"01052000"}, {:category=>"Books", :category_id=>"01501500"}, {:category=>"Charges necessary to complete sale other than delivery and installation", :category_id=>"04800000"}]
+    def tax_categories
+      response = client.request(:get_sales_tax_categories) do |soap|
+        soap.body = {
+          'UserID'   => configuration.user_id,
+          'Password' => configuration.password
+        }
+      end
+
+      # Return an empty array if the response was not successful
+      return [] if response[:get_sales_tax_categories_response][:get_sales_tax_categories_result][:service_status][:status_nbr] != '200'
+
+      response[:get_sales_tax_categories_response][:get_sales_tax_categories_result][:service_result][:sales_tax_category]
+    end
+
+    # The number of API hits remanining for the configured account
+    #
+    # === Example
+    #   Strikeiron.remaining_hits
+    #   # => 100
+    def remaining_hits
+      response = client.request(:get_remaining_hits) do |soap|
+        soap.body = {
+          'UserID'   => configuration.user_id,
+          'Password' => configuration.password
+        }
+      end
+      response[:si_subscription_info][:remaining_hits].to_i
+    end
+
+
+
+  end
+
+end

data/lib/strikeiron/address.rb

@@ -0,0 +1,47 @@
+module Strikeiron #:nodoc:
+
+  # An Address stores information of a physical location for both the seller and customer.
+  #
+  # === Attributes
+  # * <tt>street_address</tt> - The full street address for the seller/customer. Example: 123 Sixth Avenue.
+  # * <tt>city</tt> - The city of the address.
+  # * <tt>state</tt> - The two letter abbreviation for the state. Example: NY.
+  # * <tt>zip_code</tt> - The postal/ZIP code of the address.
+  class Address
+
+    attr_accessor :street_address, :city, :state, :zip_code
+
+    # Creates an Address with the supplied attributes.
+    def initialize(default_values = {})
+      safe_keys = %w(street_address city state zip_code)
+      # Only permit the keys defined in safe_keys
+      default_values.reject! { |key, value| !safe_keys.include?(key.to_s) }
+
+      default_values.each { |key, value| self.send "#{key}=", value }
+    end
+
+    # Convert the object to a Hash for SOAP
+    def to_soap
+      {
+        'StreetAddress' => street_address,
+        'City'          => city,
+        'State'         => state,
+        'ZIPCode'       => zip_code
+      }
+    end
+
+    class << self
+      # Convert the object from a SOAP response to an Address object
+      def from_soap(hash = {})
+        default_values = {
+          :street_address => hash['StreetAddress'],
+          :city           => hash['City'],
+          :state          => hash['State'],
+          :zip_code       => hash['ZIPCode']
+        }
+        new(default_values)
+      end
+    end
+
+  end
+end

data/lib/strikeiron/configuration.rb

@@ -0,0 +1,10 @@
+module Strikeiron #:nodoc:
+  # Configuration values for Strikeiron such as your UserID and Password.
+  #
+  # === Attributes
+  # * <tt>user_id</tt> - The UserID supplied by Strikeiron for API use.
+  # * <tt>password</tt> - The password/key that Strikeiron supplied for API use.
+  class Configuration
+    attr_accessor :user_id, :password
+  end
+end

data/lib/strikeiron/jurisdiction.rb

@@ -0,0 +1,34 @@
+module Strikeiron #:nodoc:
+  # Jurisdiction represents a breakdown of the tax calculations for the taxable region(s).
+  #
+  # === Attributes
+  # * <tt>fips</tt> - The code assigned by the Federal Government or state agencies to uniquely identify a location.
+  # * <tt>name</tt> - Name associated to the corresponding FIPS code.
+  # * <tt>tax_amount</tt> - Sales tax rate for the corresponding FIPS code.
+  class Jurisdiction
+    attr_accessor :fips, :name, :tax_amount
+
+    # Creates a Jurisdiction with the supplied attributes.
+    def initialize(default_values = {})
+      safe_keys = %w(fips name tax_amount)
+      # Only permit the keys defined in safe_keys
+      default_values.reject! { |key, value| !safe_keys.include?(key.to_s) }
+
+      default_values.each { |key, value| self.send "#{key}=", value }
+    end
+
+    class << self
+      # Convert the SOAP response object to a Jurisdiction
+      def from_soap(hash = {})
+        default_values = {
+          :fips       => hash['FIPS'],
+          :name       => hash['Name'],
+          :tax_amount => hash['SalesTaxAmount']
+        }
+
+        new(default_values)
+      end
+    end
+  end
+end
+

data/lib/strikeiron/tax_result.rb

@@ -0,0 +1,39 @@
+module Strikeiron #:nodoc:
+  # Returned after performing a tax calculation
+  #
+  # === Attributes
+  # * <tt>from</tt> - The from Address.
+  # * <tt>to</tt> - The to Address.
+  # * <tt>tax_values</tt> - The TaxValue objects returned from Strikeiron.
+  # * <tt>total_tax</tt> - The total tax amount to be applied.
+  class TaxResult
+    attr_accessor :from, :to, :tax_values, :total_tax
+
+    # Initialize the TaxResult object with the given options
+    def initialize(default_values = {})
+      default_values.each { |key, value| self.send "#{key}=", value }
+    end
+
+    class << self
+      # Convert the object from the Strikeiron response
+      def from_soap(response)
+        tax_values = []
+        response[:results][:tax_value_record].each do |record|
+          tax_values << TaxValue.new(
+            :category      => record[:category],
+            :category_id   => record[:category_id],
+            :tax_amount    => record[:sales_tax_amount].to_f,
+            :jurisdictions => record[:jurisdictions][:sales_tax_value_jurisdiction].map { |j| Jurisdiction.new(:fips => j[:fips], :name => j[:name], :tax_amount => j[:sales_tax_amount].to_f) }
+          )
+        end
+
+        new(
+          :from       => Address.new(response[:resolved_from_address]),
+          :to         => Address.new(response[:resolved_to_address]),
+          :tax_values => tax_values,
+          :total_tax  => tax_values.inject(0) { |sum, tax_value| sum + tax_value.tax_amount }
+        )
+      end
+    end
+  end
+end

data/lib/strikeiron/tax_value.rb

@@ -0,0 +1,46 @@
+module Strikeiron #:nodoc:
+  # Total sales tax rate based on the dollar amount and category from TaxValueRequest.
+  # TaxValueRecord should only be rendered from a SOAP response.
+  #
+  # === Attributes
+  # * <tt>category</tt> - The corresponding category name. A category name and/or ID must be supplied.
+  # * <tt>category_id</tt> - The corresponding category ID. A category name and/or ID must be supplied.
+  # * <tt>amount</tt> - The amount to calculate the tax for.
+  # * <tt>tax_amount</tt> - The combined sales tax rate based on the address and tax category provided
+  #
+  # === Notes
+  # See Strikeiron.tax_categories for information on obtaining category information.
+  class TaxValue
+    attr_accessor :category, :category_id, :amount, :tax_amount, :jurisdictions
+
+    # Creates a TaxValueRecord with the supplied attributes.
+    def initialize(default_values = {})
+      safe_keys = %w(category category_id amount tax_amount jurisdictions)
+      # Only permit the keys defined in safe_keys
+      default_values.reject! { |key, value| !safe_keys.include?(key.to_s) }
+
+      default_values.each { |key, value| self.send "#{key}=", value }
+    end
+
+    # Convert the object to be valid for the SOAP request
+    def to_soap
+      {
+        'SalesTaxCategoryOrCategoryID' => category || category_id,
+        'Amount'                       => amount
+      }
+    end
+
+    class << self
+      # Convert the SOAP response object to a TaxValueRecord
+      def from_soap(hash = {})
+        default_values = {
+          :category    => hash['Category'],
+          :category_id => hash['CategoryID'],
+          :tax_amount  => hash['SalesTaxAmount']
+        }
+
+        new(default_values)
+      end
+    end
+  end
+end