corgibytes-tax_cloud 0.9.0

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'vcr'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_*.rb'
+  # REM
+  #test.verbose = false
+end
+
+RDoc::Task.new do |rd|
+  README = 'README.rdoc'.freeze
+  rd.main = README
+  rd.rdoc_files.include(README, 'CHANGELOG.rdoc', 'LICENSE.rdoc', 'lib/**/*.rb')
+  rd.rdoc_dir = 'doc'
+  rd.title = 'tax_cloud'
+end
+
+load 'lib/tasks/tax_cloud.rake'
+load 'lib/tasks/tax_codes.rake'
+load 'lib/tasks/tax_code_groups.rake'
+load 'vcr/tasks/vcr.rake'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :test]

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.7'
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app
+      - bundler-data:/usr/local/bundle
+
+volumes:
+  bundler-data:

data/examples/.env.example

@@ -0,0 +1,2 @@
+TAX_CLOUD_LOGIN_ID=
+TAX_CLOUD_API_KEY=

data/examples/lookup_example.rb

@@ -0,0 +1,139 @@
+##
+# An example of doing a tax lookup that hits TaxCloud.  To run:
+#
+# bundle exec ruby lookup_example.rb
+#
+# Make sure you copy the .env.example to .env an update the
+# values in it before running.  I also recommend no running
+# this script against a live TaxCloud site.  Run it only against
+# test sites.
+##
+
+require 'dotenv/load'
+require 'securerandom'
+
+require_relative '../lib/tax_cloud'
+
+##
+# Load the TaxCloud settings from the environment file.\
+#
+def load_config
+  TaxCloud.configure do |config|
+    config.api_login_id = ENV['TAX_CLOUD_LOGIN_ID']
+    config.api_key = ENV['TAX_CLOUD_API_KEY']
+    config.open_timeout = 10
+    config.read_timeout = 10
+  end
+end
+
+##
+# Display the current TaxCloud settings.
+#
+def display_config
+  TaxCloud.configure do |config|
+    puts "API Login ID: #{config.api_login_id}"
+    puts "API Key: #{config.api_key}"
+    puts "Open timeout: #{config.open_timeout}"
+    puts "Read timeout: #{config.read_timeout}"
+  end
+end
+
+##
+# Create a test transaction with one cart item.
+#
+# Will create a new customer and cart each time using GUIDs for
+# the customer and cart IDs.  This prevents collisions with
+# existing customer/carts when running the script multiple times.
+#
+def create_test_transaction
+  origin = TaxCloud::Address.new(
+      :address1 => '162 East Avenue',
+      :address2 => 'Third Floor',
+      :city => 'Norwalk',
+      :state => 'CT',
+      :zip5 => '06851')
+
+  destination = TaxCloud::Address.new(
+      :address1 => '3121 West Government Way',
+      :address2 => 'Suite 2B',
+      :city => 'Seattle',
+      :state => 'WA',
+      :zip5 => '98199')
+
+  transaction = TaxCloud::Transaction.new(
+      :customer_id => SecureRandom.uuid,
+      :cart_id => SecureRandom.uuid,
+      :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)
+
+  transaction
+end
+
+##
+# Displays information about the transaction:
+#
+# - Customer ID
+# - Cart ID
+# - Origin Address
+# - Destination Address
+# - Cart Items
+#
+# @param [TaxCloud::Transaction] transaction
+#
+def display_transaction(transaction)
+  puts "Customer ID: #{transaction.customer_id}"
+  puts "Cart ID: #{transaction.cart_id}"
+  puts "Origin: #{transaction.origin.to_hash}"
+  puts "Destination: #{transaction.destination.to_hash}"
+  puts "Cart Items: #{transaction.cart_items.map(&:to_hash)}"
+end
+
+##
+# Display the total tax and tax for each cart item.
+#
+# @param [TaxCloud::Responses::Lookup] lookup
+def display_tax(lookup)
+  puts "Total tax amount: #{lookup.tax_amount}"
+
+  lookup.cart_items.each do |cart_item|
+    puts "Tax cart index #{cart_item.cart_item_index}: #{cart_item.tax_amount}"
+  end
+end
+
+
+##
+# Run an example lookup
+##
+puts 'Loading config information from .env file...'
+load_config
+puts 'Config loaded'
+puts
+
+puts 'The TaxCloud config is:'
+display_config
+puts
+
+puts 'Checking config...'
+TaxCloud.configuration.check!
+puts 'Check passed.'
+puts
+
+puts 'Pinging TaxCloud server...'
+puts TaxCloud.client.ping
+
+puts 'Cart values:'
+transaction = create_test_transaction
+display_transaction(transaction)
+puts
+
+puts 'Tax lookup:'
+lookup = transaction.lookup
+display_tax(lookup)
+puts

data/lib/config/locales/en.yml

@@ -0,0 +1,34 @@
+en:
+  taxcloud:
+    errors:
+      messages:
+        missing_config:
+          message: "Missing configuration."
+          summary: "TaxCloud requires an API login ID and key."
+          resolution: "Create a TaxCloud merchant account at http://www.taxcloud.net.
+            Add a website to your TaxCloud account. This will generate an API ID and 
+            API Key that you will need to use the service. Configure the TaxCloud
+            gem. For example, add the following to `config/initializers/tax_cloud.rb`.\n
+            \_\_TaxCloud.configure do |config|\n
+            \_\_\_config.api_login_id = 'your_tax_cloud_api_login_id'\n
+            \_\_\_config.api_key = 'your_tax_cloud_api_key'\n
+            \_\_\_config.usps_username = 'your_usps_username' # optional\n
+            \_\_end\n"
+        missing_config_option:
+          message: "Missing configuration option: %{name}."
+          summary: "A configuration option was not provided when configuring TaxCloud."
+          resolution: "Review your `TaxCloud.configure` code. Are you using an environment
+          variable that has not been set?"
+        soap_error:
+          message: "%{message}"
+          summary: "The server returned a %{code} error."
+          resolution: "Review the parameters passed to the request."
+        unexpected_soap_response:
+          message: "Expected a value for `%{key}` in `%{chain}` in the TaxCloud response."
+          summary: "TaxCloud returned an unexpected response: `%{raw}`."
+          resolution: "This is possibly a bug in the tax_cloud gem.\n
+          Please report it in https://github.com/drewtempelmeyer/tax_cloud/issues."
+        api_error:
+          message: "%{message}"
+          summary: "The TaxCloud server returned an error in the response: `%{raw}`"
+          resolution: "Check the request parameters."

data/lib/hash.rb

@@ -0,0 +1,8 @@
+class Hash #:nodoc: all
+  # Downcase the keys. Use this because <tt>TaxCloud::Address.verify</tt> requires downcased keys
+  def downcase_keys
+    each_with_object({}) do |(k, v), h|
+      h[k.downcase] = v
+    end
+  end
+end

data/lib/savon_soap_xml.rb

@@ -0,0 +1,32 @@
+# 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/tasks/tax_cloud.rake

@@ -0,0 +1,18 @@
+require 'tax_cloud'
+
+namespace :tax_cloud do
+  desc 'Configure TaxCloud.'
+  task :configure do
+    unless TaxCloud.configured?
+      TaxCloud.configure do |config|
+        config.api_login_id = ENV['TAXCLOUD_API_LOGIN_ID']
+        config.api_key = ENV['TAXCLOUD_API_KEY']
+        config.usps_username = ENV['TAXCLOUD_USPS_USERNAME']
+      end
+      Savon.configure do |config|
+        config.log = false
+      end
+      HTTPI.log = false
+    end
+  end
+end

data/lib/tasks/tax_code_groups.rake

@@ -0,0 +1,37 @@
+namespace :tax_cloud do
+  desc 'Generate tax code groups.'
+  task tax_code_groups: :configure do
+    filename = 'lib/tax_cloud/tax_code_group_constants.rb'
+
+    begin
+      groups = TaxCloud::TaxCode::Groups.all.values
+
+      File.open filename, 'wt' do |f|
+        f.write "module TaxCloud\n"
+        f.write "  class TaxCode\n"
+        f.write "    # Tax Code Groups.\n"
+        f.write "    class Groups\n"
+
+        groups.each do |group|
+          puts " #{group.description}"
+          code = group.description.upcase
+          code.gsub! /[^A-Z0-9]/, '_'
+          code.gsub! /_$/, ''
+          code.gsub! /\_+/, '_'
+          f.write "      \# #{group.description}\n"
+          f.write "      #{code} = #{group.group_id}\n"
+        end
+
+        f.write "    end\n"
+        f.write "  end\n"
+        f.write "end\n"
+      end
+
+      puts "Done, #{filename}."
+    rescue => e
+      puts 'ERROR: Unable to generate a new list of tax codes.'
+      puts e.message
+      raise e
+    end
+  end
+end

data/lib/tasks/tax_codes.rake

@@ -0,0 +1,43 @@
+namespace :tax_cloud do
+  desc 'Generate tax codes.'
+  task tax_codes: :configure do
+    filename = 'lib/tax_cloud/tax_code_constants.rb'
+
+    begin
+      groups = TaxCloud::TaxCode::Groups.all.values
+      groups_and_tax_codes = Hash[groups.map do |group|
+        [group, group.tax_codes.values]
+      end]
+      File.open filename, 'wt' do |f|
+        f.write "module TaxCloud\n"
+        f.write "  # Tax Codes.\n"
+        f.write "  class TaxCodes\n"
+        f.write "\n"
+        codes = {}
+        groups_and_tax_codes.each_pair do |group, tax_codes|
+          puts " #{group.description}"
+          f.write "    \# #{group.description}\n\n"
+          tax_codes.each do |tax_code|
+            code = tax_code.description.upcase
+            code.gsub! /[^A-Z0-9]/, '_'
+            code.gsub! /\_+$/, ''
+            code.gsub! /\_+/, '_'
+            # avoid duplicates
+            code_id = codes[code] ? "#{code}_#{codes[code]}" : code
+            codes[code] = (codes[code] || 0) + 1
+            f.write "    \# #{group.description}: #{tax_code.description}\n"
+            f.write "    #{code_id} = #{tax_code.ticid}\n"
+          end
+          f.write "\n"
+        end
+        f.write "  end\n"
+        f.write "end\n"
+      end
+      puts "Done, #{filename}."
+    rescue => e
+      puts 'ERROR: Unable to generate a new list of tax codes.'
+      puts e.message
+      raise e
+    end
+  end
+end

data/lib/tax_cloud.rb

@@ -0,0 +1,70 @@
+require 'savon'
+require 'i18n'
+require 'hash'
+require 'savon_soap_xml'
+
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'tax_cloud/version'
+require 'tax_cloud/errors'
+require 'tax_cloud/responses'
+require 'tax_cloud/record'
+require 'tax_cloud/transaction'
+require 'tax_cloud/address'
+require 'tax_cloud/cart_item'
+require 'tax_cloud/tax_code'
+require 'tax_cloud/tax_code_group'
+require 'tax_cloud/tax_codes'
+require 'tax_cloud/tax_code_constants'
+require 'tax_cloud/tax_code_groups'
+require 'tax_cloud/tax_code_group_constants'
+require 'tax_cloud/configuration'
+require 'tax_cloud/client'
+
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
+
+# 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 API.
+  WSDL_URL = 'https://api.taxcloud.net/1.0/?wsdl'.freeze
+
+  # TaxCloud API version.
+  API_VERSION = '1.0'.freeze
+
+  class << self
+    # TaxCloud gem configuration.
+    attr_accessor :configuration
+
+    # Returns true if the gem has been configured.
+    def configured?
+      configuration.present?
+    end
+
+    # Configure the gem.
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    # Reset the current configuration.
+    def reset!
+      self.configuration = nil
+      @client = nil
+    end
+
+    # The configured SOAP client to the TaxCloud service.
+    def client
+      check_configuration!
+      @client ||= TaxCloud::Client.new
+    end
+
+    private
+
+    def check_configuration!
+      raise TaxCloud::Errors::MissingConfig.new unless self.configuration
+      self.configuration.check!
+    end
+  end
+end

data/lib/tax_cloud/address.rb

@@ -0,0 +1,50 @@
+module TaxCloud #:nodoc:
+  # An <tt>Address</tt> defines an address in the United States.
+  class Address < Record
+    # First line of address.
+    attr_accessor :address1
+    # Second line of adress.
+    attr_accessor :address2
+    # City.
+    attr_accessor :city
+    # State.
+    attr_accessor :state
+    # 5-digit Zip Code.
+    attr_accessor :zip5
+    # 4-digit Zip Code.
+    attr_accessor :zip4
+
+    # Verify this address.
+    #
+    # Returns a verified TaxCloud::Address.
+    def verify
+      params = to_hash.downcase_keys
+      if TaxCloud.configuration.usps_username
+        params = params.merge(
+          'uspsUserID' => TaxCloud.configuration.usps_username
+        )
+      end
+      response = TaxCloud.client.request(:verify_address, params)
+      TaxCloud::Responses::VerifyAddress.parse(response)
+    end
+
+    # Complete zip code.
+    # Returns a 9-digit Zip Code, when available.
+    def zip
+      return nil unless zip5 && !zip5.empty?
+      [zip5, zip4].select { |z| z && !z.empty? }.join('-')
+    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