strikeiron2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7685d04a103055ad322859be6238c7341d56d64e
+  data.tar.gz: 027fef100b7b0547c243ffca404d2d4e80a5744d
+SHA512:
+  metadata.gz: a2bfeeb62393f4b5aca6013bf09d595c6c0864192af8a36ef01beca831ca7b3c3fe45beff26ac5193a95d03fc4e894bfe2e55122bd4b2004bc7d3b93a7c37ac2
+  data.tar.gz: 19e4d0cfc52de1bf5f825f267d876a53a886360e5cf0a269f06d6e0c246e2202d95ee411b4daaaefd930fe70fb59b1cbe7721e24416c0375276ad60a9d6f2e40

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 strikeiron2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Sturgill
+
+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,29 @@
+# Strikeiron2
+
+Gem for interacting with StrikeIron's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strikeiron2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strikeiron2
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/strikeiron2.rb

@@ -0,0 +1,67 @@
+require 'savon'
+require "strikeiron2/version"
+require "strikeiron2/exceptions"
+require "strikeiron2/configuration"
+require "strikeiron2/client"
+require 'strikeiron2/address'
+require 'strikeiron2/jurisdiction'
+require 'strikeiron2/tax_result'
+require 'strikeiron2/tax_value'
+
+module Strikeiron
+  class << self
+    attr_accessor :configuration
+    
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+    
+    def client
+      @@client ||= nil
+      return @@client if !@@client.nil?
+      raise Strikeiron::ConfigurationException, 'You must set up your configuration before making requests' if configuration.nil?
+      @@client = Client.new configuration
+    end
+    
+    def sales_tax(options={})
+      options = options.inject({}) { |hsh,(k,v)| hsh[k.to_sym] = v; hsh }
+      required_options = [:from, :to, :tax_values]
+      
+      # Raise an error if a required option is not defined
+      raise ArgumentError, "You must pass all required options: #{required_options}" if (required_options - options.keys).length > 0
+      
+      data = {
+        'ShipFrom' => options[:from].to_soap,
+        'ShipTo' => options[:to].to_soap,
+        'TaxValueRequests' => { 'TaxValueRequest' => options[:tax_values].collect(&:to_soap) }
+      }
+      
+      response = self.client.request :get_sales_tax_value, data
+      response_code = response.body[:get_sales_tax_value_response][:get_sales_tax_value_result][:service_status][:status_nbr].to_i
+      
+      case response_code
+      when 401 then raise Strikeiron::AddressException, 'Invalid From address.'
+      when 402 then raise Strikeiron::AddressException, 'Invalid To address.'
+      when 403 then raise Strikeiron::TaxCategoryException, 'Invalid Taxability category.'
+      when 500 then raise Strikeiron::InternalError, 'Internal Strikeiron server error.'
+      end
+      
+      TaxResult.from_soap(response.body[:get_sales_tax_value_response][:get_sales_tax_value_result][:service_result])
+    end
+    
+    def tax_categories
+      response = self.client.request :get_sales_tax_categories
+      
+      # Return an empty array if the response was not successful
+      return [] if response.body[:get_sales_tax_categories_response][:get_sales_tax_categories_result][:service_status][:status_nbr].to_i != 200
+      
+      response.body[:get_sales_tax_categories_response][:get_sales_tax_categories_result][:service_result][:sales_tax_category]
+    end
+    
+    def remaining_hits
+      response = self.client.request :get_remaining_hits
+      response.body[:si_subscription_info][:remaining_hits].to_i
+    end
+  end
+end

data/lib/strikeiron2/address.rb

@@ -0,0 +1,36 @@
+module Strikeiron
+  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)
+      
+      default_values.each do |key, value|
+        next unless safe_keys.include? key.to_s # Only permit the keys defined in safe_keys
+        self.send "#{key}=", value
+      end
+    end
+
+    # Convert the object to a Hash for SOAP
+    def to_soap
+      {
+        'StreetAddress' => street_address,
+        'City'          => city,
+        'State'         => state,
+        'ZIPCode'       => zip_code
+      }
+    end
+        
+    # Convert the object from a SOAP response to an Address object
+    def self.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

data/lib/strikeiron2/client.rb

@@ -0,0 +1,16 @@
+module Strikeiron
+  class Client
+    # The location of the Strikeiron Online Sales Tax WSDL
+    WSDL = 'https://wsparam.strikeiron.com/SpeedTaxSalesTax3?WSDL'
+    
+    def initialize(configuration)
+      @configuration = configuration
+      @savon_client = Savon::Client.new(:wsdl => WSDL, :ssl_version => @configuration.ssl_version, :ssl_verify_mode => @configuration.ssl_verify_mode)
+    end
+    
+    def request(action, msg={})
+      msg = { 'UserID' => @configuration.user_id, 'Password' => @configuration.password }.merge(msg)
+      @savon_client.call action, :message => msg
+    end
+  end
+end

data/lib/strikeiron2/configuration.rb

@@ -0,0 +1,11 @@
+module Strikeiron
+  class Configuration
+    attr_accessor :user_id, :password, :ssl_version, :ssl_verify_mode
+    
+    def initialize
+      # set default options (can be overwritten in configure block)
+      self.ssl_version = :TLSv1
+      self.ssl_verify_mode = :none
+    end
+  end
+end

data/lib/strikeiron2/exceptions.rb

@@ -0,0 +1,4 @@
+class Strikeiron::ConfigurationException < StandardError; end
+class Strikeiron::AddressException < StandardError; end
+class Strikeiron::TaxCategoryException < StandardError; end
+class Strikeiron::InternalError < StandardError; end

data/lib/strikeiron2/jurisdiction.rb

@@ -0,0 +1,33 @@
+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)
+      
+      default_values.each do |key, value|
+        next unless safe_keys.include? key.to_s # Only permit the keys defined in safe_keys
+        self.send "#{key}=", value
+      end
+    end
+
+    # Convert the SOAP response object to a Jurisdiction
+    def self.from_soap(hash = {})
+      default_values = {
+        :fips       => hash['FIPS'],
+        :name       => hash['Name'],
+        :tax_amount => hash['SalesTaxAmount']
+      }
+
+      new(default_values)
+    end
+  end
+end
+

data/lib/strikeiron2/tax_result.rb

@@ -0,0 +1,34 @@
+module Strikeiron
+  class TaxResult
+    attr_accessor :from, :to, :tax_values, :total_tax
+    
+    def initialize(default_values = {})
+      default_values.each { |key, value| self.send "#{key}=", value }
+    end
+    
+    def self.from_soap(response)
+      tax_values       = []
+      response_records = response[:results][:tax_value_record]
+      response_records = [ response_records ] if response_records.is_a?(Hash)
+
+      response_records.each do |record|
+        jurisdictions = record[:jurisdictions][:sales_tax_value_jurisdiction]
+        jurisdictions = [ jurisdictions ] if jurisdictions.is_a?(Hash)
+
+        tax_values << TaxValue.new(
+          :category      => record[:category],
+          :category_id   => record[:category_id],
+          :tax_amount    => record[:sales_tax_amount].to_f,
+          :jurisdictions => jurisdictions.collect { |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

data/lib/strikeiron2/tax_value.rb

@@ -0,0 +1,45 @@
+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)
+      
+      default_values.each do |key, value|
+        next unless safe_keys.include? key.to_s # Only permit the keys defined in safe_keys
+        self.send "#{key}=", value
+      end
+    end
+
+    # Convert the object to be valid for the SOAP request
+    def to_soap
+      {
+        'SalesTaxCategoryOrCategoryID' => category || category_id,
+        'Amount'                       => amount
+      }
+    end
+
+    # Convert the SOAP response object to a TaxValueRecord
+    def self.from_soap(hash = {})
+      default_values = {
+        :category    => hash['Category'],
+        :category_id => hash['CategoryID'],
+        :tax_amount  => hash['SalesTaxAmount']
+      }
+
+      new(default_values)
+    end
+  end
+end

data/lib/strikeiron2/version.rb

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

data/strikeiron2.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strikeiron2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "strikeiron2"
+  spec.version       = Strikeiron::VERSION
+  spec.authors       = ["Chris Sturgill"]
+  spec.email         = ["chris@thesturgills.com"]
+  spec.description   = %q{Write a gem description}
+  spec.summary       = %q{Write a gem summary}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'savon', '2.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: strikeiron2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Sturgill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Write a gem description
+email:
+- chris@thesturgills.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/strikeiron2.rb
+- lib/strikeiron2/address.rb
+- lib/strikeiron2/client.rb
+- lib/strikeiron2/configuration.rb
+- lib/strikeiron2/exceptions.rb
+- lib/strikeiron2/jurisdiction.rb
+- lib/strikeiron2/tax_result.rb
+- lib/strikeiron2/tax_value.rb
+- lib/strikeiron2/version.rb
+- strikeiron2.gemspec
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Write a gem summary
+test_files: []