tax_cloud 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/*
+html/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,40 @@
+= TaxCloud
+
+TaxCloud is a service to calculate sales tax and generate tax reports.
+tax\_cloud allows you to easily integrate with TaxCloud's API.
+
+=== Setup
+Add the gem to your Gemfile
+  gem 'tax_cloud', '~> 0.1.0'
+
+Configure your environment. For example, create an initializer in Rails in *config/initializers/tax_cloud.rb*
+  TaxCloud.configure do |config|
+    config.api_login_id = 'your_tax_cloud_api_login_id'
+    config.api_key = 'your_tax_cloud_api_key'
+    config.usps_username = 'your_usps_username'
+  end
+
+=== Using TaxCloud
+Define the destination and origin addresses using <tt>TaxCloud::Address</tt>.
+  origin = TaxCloud::Address.new(:address1 => '123 Fake Street', :city => 'New York', :state => 'NY', :zip5 => '10001')
+  destination = TaxCloud::Address.new(:address1 => '239 Hollywood Drive', :city => 'Beverly Hills', :state => 'CA', :zip5 => '90210')
+
+Create your Transaction and set up your cart items
+  transaction = TaxCloud::Transaction.new(:customer_id => '1', :cart_id => '1', :origin => origin, :destination => destination)
+  transaction.cart_items << TaxCloud::CartItem.new(:index => 0, :item_id => 'SKU-100', :tic => TaxCloud::TaxCodes::GENERAL, :price => 10.00, :quantity => 1)
+  lookup = transaction.lookup # this will return a Savon response object
+
+After you've authorized and captured the transaction via your merchant account, you should do the same with TaxCloud for maintaining accurate tax information.
+  transaction.order_id = 100
+  transaction.authorized_with_capture # return Savon response object
+
+=== Todo
+* Instead of returning Savon response objects, it should return TransactionLookupResponse, TransactionAuthorizedResponse, TransactionCapturedResponse, etc.
+* Add all tax codes to TaxCloud::TaxCodes
+
+=== Bugs, fixes, etc
+* Fork.
+* Write test(s).
+* Fix.
+* Commit.
+* Submit pull request.

data/Rakefile

@@ -0,0 +1,22 @@
+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
+
+Rake::RDocTask.new do |rd|
+  README = 'README.rdoc'
+  rd.main = README
+  rd.rdoc_files.include(README, "lib/**/*.rb")
+  rd.rdoc_dir = 'doc'
+  rd.title = 'TaxCloud'
+  rd.options << '-f' << 'horo'
+  rd.options << '-c' << 'utf-8'
+  rd.options << '-m' << README
+end
+
+

data/lib/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  # Downcase the keys. Use this because <tt>TaxCloud::Address.verify</tt> requires downcased keys
+  def downcase_keys!
+    keys.each do |key|
+      self[key.to_s.downcase] = delete(key)
+    end
+    self
+  end
+end

data/lib/savon_xml_override.rb

@@ -0,0 +1,30 @@
+# Hack Savon to work properly with arrays
+module Savon #:nodoc:
+  module SOAP #:nodoc:
+    class XML #:nodoc:
+      private
+      old_add_namespaces_to_body = self.instance_method(:add_namespaces_to_body)
+
+      def add_namespaces_to_body(hash, path = [input[1].to_s])
+        return unless hash
+        return hash if hash.kind_of? Array
+        return hash.to_s unless hash.kind_of? Hash
+
+        hash.inject({}) do |newhash, (key, value)|
+          camelcased_key = Gyoku::XMLKey.create(key)
+          newpath = path + [camelcased_key]
+
+          if used_namespaces[newpath]
+            newhash.merge(
+              "#{used_namespaces[newpath]}:#{camelcased_key}" =>
+                add_namespaces_to_body(value, types[newpath] ? [types[newpath]] : newpath)
+            )
+          else
+            newhash.merge(key => value)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/tax_cloud.rb

@@ -0,0 +1,44 @@
+require 'savon'
+require 'savon_xml_override'
+require 'tax_cloud/version'
+require 'tax_cloud/transaction'
+require 'tax_cloud/address'
+require 'tax_cloud/cart_item'
+require 'tax_cloud/tax_codes'
+require 'tax_cloud/configuration'
+require 'hash'
+
+# TaxCloud is a web service to calculate and track sales tax for your ecommerce platform. Integration is easy to use.
+# For information on configuring and using the TaxCloud API, look at the <tt>README</tt> file.
+module TaxCloud
+  # WSDL location for TaxCloud
+  WSDL_URL = 'https://api.taxcloud.net/1.0/?wsdl'
+  # TaxCloud API version
+  API_VERSION = '1.0'
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure the variables
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    # Method to define and retrieve the SOAP methods
+    def client
+      @@client ||= Savon::Client.new do
+        wsdl.document = TaxCloud::WSDL_URL
+      end
+    end
+
+    # Authorization hash to use with all SOAP requests
+    def auth_params
+      {
+        'apiLoginID' => configuration.api_login_id,
+        'apiKey' => configuration.api_key
+      }
+    end
+  end
+
+end

data/lib/tax_cloud/address.rb

@@ -0,0 +1,37 @@
+module TaxCloud
+  # An address
+  class Address
+    attr_accessor :address1, :address2, :city, :state, :zip5, :zip4
+
+    # Initialize the object with the given variables
+    def initialize(attrs = {})
+      attrs.each do |sym, val|
+        self.send "#{sym}=", val
+      end
+      super
+    end
+
+    # Verify the address via TaxCloud
+    def verify
+      request_params = {
+        'apiLoginId' => TaxCloud.configuration.api_login_id,
+        'apiKey' => TaxCloud.configuration.api_key,
+        'uspsUserID' => TaxCloud.configuration.usps_username
+      }.merge(to_hash.downcase_keys!)
+      response = TaxCloud.client.request :verify_address, :body => request_params
+    end
+
+    # Convert the object to a usable hash for SOAP requests
+    def to_hash
+      {
+        'Address1' => address1,
+        'Address2' => address2,
+        'City' => city,
+        'State' => state,
+        'Zip5' => zip5,
+        'Zip4' => zip4
+      }
+    end
+
+  end
+end

data/lib/tax_cloud/cart_item.rb

@@ -0,0 +1,34 @@
+require 'builder'
+
+module TaxCloud
+  # A <tt>CartItem</tt> defines a single line item for the purchase. Used to calculate the tax amount.
+  #
+  # === Attributes
+  # * <tt>index</tt> - The unique index number for the line item. Must be unique for the scope of the cart.
+  # * <tt>item_id</tt> - The stock keeping unit (SKU) number
+  # * <tt>tic</tt> - The taxable information code. See <tt>TaxCloud::TaxCodes</tt>.
+  # * <tt>price</tt> - The price of the item. All prices are USD. Do not include currency symbol.
+  # * <tt>quantity</tt> - The total number of items.
+  class CartItem
+    attr_accessor :index, :item_id, :tic, :price, :quantity
+
+    def initialize(attrs = {})
+      attrs.each do |sym, val|
+        self.send "#{sym}=", val
+      end
+      super
+    end
+
+    # Convert the object to a usable hash for SOAP requests
+    def to_hash
+      {
+        'Index' => index,
+        'ItemID' => item_id,
+        'TIC' => tic,
+        'Price' => price,
+        'Qty' => quantity
+      }
+    end
+
+  end
+end

data/lib/tax_cloud/configuration.rb

@@ -0,0 +1,5 @@
+module TaxCloud
+  class Configuration
+    attr_accessor :api_login_id, :api_key, :usps_username
+  end
+end

data/lib/tax_cloud/tax_codes.rb

@@ -0,0 +1,52 @@
+module TaxCloud
+  class TaxCodes
+    GENERAL = '00000'
+
+    # SHIPPING AND ADMINISTRATIVE
+    GIFT_CARD = '10005'
+    SERVICE_FEE = '10010'
+    INSTALLATION_FEE = '10040'
+    TRADE_IN_VALUE = '10060'
+    TELECOM = '10070'
+    HANDLING_FEE = '11000'
+    POSTAGE = '11010'
+    DMAIL_HANDLING_FEE = '11020'
+    DMAIL_TRANSPORTATION = '11021'
+    DMAIL_POSTAGE = '11022'
+
+    # CLOTHING, SPORTS, AND ACCESSORIES
+    CLOTHING = '20010'
+    ESSENTIAL_CLOTHING = '20015'
+    CLOTHING_ACCESSORY = '20020'
+    PROTECTIVE_EQUIPMENT = '20030'
+    SPORT_EQUIPMENT = '20040'
+    FUR_CLOTHING = '20050'
+    CLOTHING_TAX_HOLIDAY = '20130'
+    SCHOOL_SUPPLY = '20070'
+
+    DISASTER_PREPAREDNESS_SUPPLY = '20150'
+
+    # COMPUTERS, ELECTRONICS, AND APPLIANCES
+    ENERGY_STAR_APPLIANCE = '20060'
+    CUSTOM_SOFTWARE = '30015'
+    SOFTWARE = '30040'
+    COMPUTER = '30100'
+    DIGITAL_PRODUCT = '31000'
+
+    # FOOD RELATED
+    CANDY = '40010'
+    DIETARY_SUPPLEMENT = '40020'
+    FOOD = '40030'
+    VENDING_FOOD = '40040'
+    SOFT_DRINK = '40050'
+    BOTTLED_WATER = '40060'
+    PREPARED_FOOD = '41000'
+    BULK_FOOD__FROM_MANUFACTURER = '41010'
+    BULK_FOOD = '41020'
+    BAKERY_ITEM = '41030'
+
+    # MEDICAL AND HYGENE RELATED
+
+
+  end
+end

data/lib/tax_cloud/transaction.rb

@@ -0,0 +1,91 @@
+module TaxCloud
+  # Lookup tax rate, authorize, and capture the information to be logged into TaxCloud.
+  #
+  # *Note:* The Transaction must not change between the <tt>lookup</tt> and <tt>authorization</tt> method calls.
+  #
+  # === Attributes
+  # * <tt>customer_id</tt> - Your defined customer ID for the <tt>Transaction</tt>.
+  # * <tt>cart_id</tt> - Your defined cart ID for the order.
+  # * <tt>cart_items</tt> - Array of <tt>CartItem</tt>s.
+  # * <tt>order_id</tt> - The order ID for <tt>authorized</tt>, <tt>captured</tt>, and <tt>authorzied_with_captured</tt> methods.
+  # * <tt>origin</tt> - The <tt>Address</tt> of which the shipment originates.
+  # * <tt>destination</tt> - The <tt>Address</tt> of which the shipment arrives.
+  class Transaction
+    attr_accessor :customer_id, :cart_id, :cart_items, :order_id, :origin, :destination
+
+    # Creates a new <tt>Transaction</tt> object with the given parameters
+    def initialize(params = {})
+      params = { :cart_items => [] }.merge(params)
+      params.each do |key, value|
+        self.send "#{key}=", value
+      end
+    end
+
+    # Lookup the tax rate for the transaction. The returned information is based on the originating address, destination address, and cart items.
+    def lookup
+      request_params = {
+        'customerID' => customer_id,
+        'cartID' => cart_id,
+        'cartItems' => { 'CartItem' => cart_items.map(&:to_hash) },
+        'origin' => origin.to_hash,
+        'destination' => destination.to_hash
+      }.merge(TaxCloud.auth_params)
+
+      response = TaxCloud.client.request :lookup, :body => request_params
+
+      # In the event that a cart_id wasn't specified, TaxCloud will give you one
+      self.cart_id = response[:lookup_response][:lookup_result][:cart_id] if response[:lookup_response][:lookup_result][:cart_id]
+      return response
+    end
+
+    # Once a purchase has been made and payment has been authorized, this method must be called. A matching Lookup call must have been made before this is called.
+    #
+    # === Options
+    # * <tt>date_authorized</tt> - The date the transaction was authorized. Default is today.
+    def authorized(options = {})
+      options = { :date_authorized => Date.today }.merge(options)
+      request_params = {
+        'customerID' => customer_id,
+        'cartID' => cart_id,
+        'orderID' => order_id,
+        'dateAuthorized' => options[:date_authorized]
+      }.merge(TaxCloud.auth_params)
+
+      response = TaxCloud.client.request :authorized, :body => request_params
+    end
+
+    # Complete the transaction. The <tt>order_id</tt> passed into <tt>captured</tt> must match the <tt>order_id</tt> that was passed into <tt>authorized</tt>.
+    #
+    # === Options
+    # * <tt>date_captured</tt> - The time the transaction was captured. Default is today.
+    def captured(options = {})
+      options = { :date_captured => Date.today }.merge(options)
+      request_params = {
+        'customerID' => customer_id,
+        'cartID' => cart_id,
+        'orderID' => order_id,
+        'dateCaptured' => options[:date_captured]
+      }.merge(TaxCloud.auth_params)
+
+      response = TaxCloud.client.request :captured, :body => request_params
+    end
+
+    # Combines the <tt>authorized</tt> and <tt>captured</tt> methods into a single call
+    #
+    # === Options
+    # * <tt>date_authorized</tt> - The date the transaction was authorized. Default is today.
+    # * <tt>date_captured</tt> - The date the transaction was captured. Default is today.
+    def authorized_with_capture(options = {})
+      options = { :date_authorized => Date.today, :date_captured => Date.today }.merge(options)
+      request_params = {
+        'customerID' => customer_id,
+        'cartID' => cart_id,
+        'orderID' => order_id,
+        'dateAuthorized' => options[:date_authorized],
+        'dateCaptured' => options[:date_captured]
+      }.merge(TaxCloud.auth_params)
+
+      response = TaxCloud.client.request :authorized_with_capture, :body => request_params
+    end
+  end
+end

data/lib/tax_cloud/version.rb

@@ -0,0 +1,4 @@
+module TaxCloud
+  # TaxCloud gem version
+  VERSION = "0.1.0"
+end

data/tax_cloud.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "tax_cloud/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tax_cloud"
+  s.version     = TaxCloud::VERSION
+  s.authors     = ["Drew Tempelmeyer"]
+  s.email       = ["drewtemp@gmail.com"]
+  s.homepage    = "https://github.com/drewtempelmeyer/tax_cloud"
+  s.summary     = %q{Calculate sales tax using the TaxCloud.net API}
+  s.description = %q{Calculate sales tax using the TaxCloud.net API}
+
+  s.rubyforge_project = "tax_cloud"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'savon', '~> 0.9.6'
+
+  # Development depencies
+  s.add_development_dependency 'rake', '0.9.2'
+  s.add_development_dependency 'horo'
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'tax_cloud'
+require 'json'
+
+class Test::Unit::TestCase
+  def setup
+    TaxCloud.configure do |config|
+      config.api_login_id = 'taxcloud_api_login_id'
+      config.api_key = 'taxcloud_api_key'
+      config.usps_username = 'usps_username'
+    end
+  end
+end
+
+Savon.configure do |config|
+#  config.log = false
+end
+

data/test/test_address.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestAddress < Test::Unit::TestCase
+
+  def setup
+    super
+    @address = TaxCloud::Address.new :address1 => '888 6th Ave', :city => 'New York', :state => 'New York', :zip5 => '10001'
+  end
+
+  def test_initialize
+    assert_equal '888 6th Ave', @address.address1
+    assert_equal nil, @address.address2
+    assert_equal 'New York', @address.city
+    assert_equal 'New York', @address.state
+    assert_equal '10001', @address.zip5
+    assert_equal nil, @address.zip4
+  end
+
+  def test_address_verify
+    assert_respond_to @address, :verify
+    verify = @address.verify
+    assert_equal '0', verify[:verify_address_response][:verify_address_result][:err_number]
+    bad_address = TaxCloud::Address.new :address1 => '10001 Test Street', :city => 'New York', :state => 'New York', :zip5 => '99999'
+    verify = bad_address.verify
+    assert_not_equal '0', verify[:verify_address_response][:verify_address_result][:err_number]
+  end
+
+end

data/test/test_cart_item.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestCartItem < Test::Unit::TestCase
+
+  def setup
+    @cart_item = TaxCloud::CartItem.new :index => 0, :item_id => 'SKU-100', :tic => '0000', :price => 50.00, :quantity => 3
+  end
+
+  def test_variables
+    assert_equal 0, @cart_item.index
+    assert_equal 'SKU-100', @cart_item.item_id
+    assert_equal '0000', @cart_item.tic
+    assert_equal 50.00, @cart_item.price
+    assert_equal 3, @cart_item.quantity
+  end
+
+end

data/test/test_transaction.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestTransaction < Test::Unit::TestCase
+
+  def setup
+    super
+    origin = TaxCloud::Address.new :address1 => '888 6th Ave', :city => 'New York', :state => 'NY', :zip5 => '10001'
+    destination = TaxCloud::Address.new :address1 => '888 6th Ave', :city => 'New York', :state => 'NY', :zip5 => '10001'
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(:index => 0, :item_id => 'SKU-TEST', :tic => TaxCloud::TaxCodes::GENERAL, :quantity => 1, :price => 50.00)
+    cart_items << TaxCloud::CartItem.new(:index => 1, :item_id => 'SKU-TEST1', :tic => TaxCloud::TaxCodes::GENERAL, :quantity => 1, :price => 50.00)
+    @transaction = TaxCloud::Transaction.new(:customer_id => rand(9999), :cart_id => rand(9999), :order_id => rand(9999), :cart_items => cart_items, :origin => origin, :destination => destination)
+  end
+
+  def test_lookup
+    result = @transaction.lookup[:lookup_response][:lookup_result]
+    result[:cart_items_response][:cart_item_response].each { |item| assert_not_nil item[:tax_amount] }
+  end
+
+  def test_authorized
+    @transaction.lookup[:lookup_response][:lookup_result]
+    result = @transaction.authorized
+    assert_equal 'OK', result[:authorized_response][:authorized_result][:response_type]
+  end
+
+  def test_captured
+    @transaction.lookup[:lookup_response][:lookup_result]
+    @transaction.authorized
+    result = @transaction.captured
+    assert_equal 'OK', result[:captured_response][:captured_result][:response_type]
+  end
+
+  def test_authorized_with_capture
+    @transaction.lookup[:lookup_response][:lookup_result]
+    result = @transaction.authorized_with_capture
+    assert_equal 'OK', result[:authorized_with_capture_response][:authorized_with_capture_result][:response_type]
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tax_cloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Drew Tempelmeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &2158465280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2158465280
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2158464760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *2158464760
+- !ruby/object:Gem::Dependency
+  name: horo
+  requirement: &2158464380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158464380
+description: Calculate sales tax using the TaxCloud.net API
+email:
+- drewtemp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/hash.rb
+- lib/savon_xml_override.rb
+- lib/tax_cloud.rb
+- lib/tax_cloud/address.rb
+- lib/tax_cloud/cart_item.rb
+- lib/tax_cloud/configuration.rb
+- lib/tax_cloud/tax_codes.rb
+- lib/tax_cloud/transaction.rb
+- lib/tax_cloud/version.rb
+- tax_cloud.gemspec
+- test/helper.rb
+- test/test_address.rb
+- test/test_cart_item.rb
+- test/test_transaction.rb
+homepage: https://github.com/drewtempelmeyer/tax_cloud
+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'
+      segments:
+      - 0
+      hash: -748120043381049506
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -748120043381049506
+requirements: []
+rubyforge_project: tax_cloud
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Calculate sales tax using the TaxCloud.net API
+test_files: []