corgibytes-tax_cloud 0.9.0

checksums.yaml

@@ -0,0 +1,17 @@
+---
+!binary "U0hBMjU2":
+  metadata.gz: !binary |-
+    NmU1Y2YyYmFlZjM4NzlkODhkMTBhYTc5MWQxNjg4NTU4YWM2NmE2YjBmZGQ0
+    MzZiMWY1NDI0MDc5ZmYwMDRiNA==
+  data.tar.gz: !binary |-
+    YzI0NWVlYWM5OGI0ZDJiZDc4ODViMzg1YTM5NmFhNjhhN2M3OTcyZDkwMmE0
+    YzYyMTgyMWI4NTkxN2Y4ODQ5Nw==
+SHA512:
+  metadata.gz: !binary |-
+    NDY2YTliMmM2OTc5ZWUxN2RlNmUxMmNlYmQ2ZDA2NjViMjBhZWU5NzBmZjBl
+    MmM5YzNjZmQ2ZjMwMTFkNDVhMWJlNzhiMzhmOWJiN2Y0ZTczYzg3OWFiMjBl
+    NTA2Yzc5N2ZkYzE1OWU1Y2JiOWEzOTE4OGQwZmYxMDVmNmVjMTQ=
+  data.tar.gz: !binary |-
+    NTNlMzkwYTQyOGVhMDAyNDE5YThlM2MyNGE5NmUxYjg4MmU0OGJjYmIwZWYz
+    ZTFjM2EyNmJjMGQzY2Q4ZTU2OTVjZDg0N2E3OGVhOGRlOTlkOTA2M2IwOWIx
+    MTE0YmZlNmNiNDMxZDc1NTNiNzA3YzRmNTBhZTA4MmI4Zjc3Mjg=

data/.circleci/config.yml

@@ -0,0 +1,81 @@
+version: 2
+jobs:
+  build:
+    docker:
+      # Image to run Ruby 1.9.3 with the latest bundler, RubyGems, etc.
+      - image: corgibytes/ruby-1.9.3:1.0.0
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # Run the tests using the minitest-ci gem.  This will
+      # create the test/reports folder.
+      - run: bundle exec rake test
+
+      - store_test_results:
+          path: test/reports
+      - store_artifacts:
+          path: test/reports
+
+
+  deploy:
+    docker:
+      - image: corgibytes/ruby-1.9.3:1.0.0
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Create the RubyGems credential file which as the
+      # RubyGems API key in it.  See the sh file for details
+      # about the Environment variable that should be setup.
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      # Assumes the version number in the version.rb file
+      # is the same as the tag.  If not then this will fail.
+      - run:
+          name: Publish to Rubygems
+          command: |
+            VERSION=${CIRCLE_TAG/v/''}
+            gem build tax_cloud.gemspec
+            mkdir artifacts
+            cp corgibytes-tax_cloud-$VERSION.gem artifacts
+            gem push corgibytes-tax_cloud-$VERSION.gem
+
+      - store_artifacts:
+          path: artifacts
+
+# Do the build on every commit but only do the
+# the deploy to RubyGems on tags.  The tag should be
+# v#.#.#.  Don't forget to update the version.rb
+# file before tagging the build.
+workflows:
+  version: 2
+  test-deploy:
+    jobs:
+      # By default the tag filter is set to ignore all (i.e. /.*/).
+      # This is a problem as deploy depends on build but build
+      # won't run on tags by default.  To fix this allow
+      # build to run on any tags.
+      - build:
+          filters:
+            tags:
+              only: /.*/
+      - deploy:
+          requires:
+            - build
+          filters:
+            tags:
+              only: /^v[0-9.]+/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# Store the RubyGems password in the credentials file
+# when doing the CI build.  Assumes the CI build has
+# a RUBYGEMS_API_KEY value setup.
+
+mkdir -p ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 ~/.gem/credentials

data/.gitignore

@@ -0,0 +1,67 @@
+# Ignore RubyMine files.  I know RubyMine says to not ignore all
+# idea files but that only seems to cause problems and not everyone
+# uses RubyMine.
+.idea/
+
+# Test files generated by minitest-ci for Circle CI builds.
+test/reports
+
+# Created by https://www.gitignore.io/api/ruby
+# Edit at https://www.gitignore.io/?templates=ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# Ignore all .env, even the ones in the examples folder.
+**/.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**
+    - bin/**
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,66 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-11-09 23:32:49 -0500 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'lib/tasks/tax_code_groups.rake'
+    - 'lib/tasks/tax_codes.rake'
+
+# Offense count: 2
+Lint/RescueWithoutErrorClass:
+  Exclude:
+    - 'lib/tasks/tax_code_groups.rake'
+    - 'lib/tasks/tax_codes.rake'
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 39
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 261
+
+# Offense count: 236
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 235
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/tax_cloud/tax_codes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedOctalStyle, SupportedOctalStyles.
+# SupportedOctalStyles: zero_with_o, zero_only
+Style/NumericLiteralPrefix:
+  Exclude:
+    - 'lib/tax_cloud/tax_codes.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+  - gem update bundler
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.4.2

data/CHANGELOG.rdoc

@@ -0,0 +1,48 @@
+=== 0.3.1 (Next)
+
+* Add <tt>open_timeout</tt> and <tt>read_timeout</tt> options into configuration - @ka8725.
+* Switch to using BigDecimal for <tt>tax_amount</tt> to avoid floating point arithmetic errors - @paulhenrich.
+* Your contribution here.
+
+=== 0.3.0 (1/9/2014)
+
+* #19: Support Savon 2 - @drewtempelmeyer.
+* Implemented Rubocop, Ruby style linter - @dblock.
+* Ruby 1.8.7 and 1.9.2 are no longer supported - @dblock.
+
+=== 0.2.2 (4/29/2013)
+
+* Relaxed thirdparty gem dependency versions - @mperham.
+
+=== 0.2.1 (3/3/2013)
+
+* Fixed date formatting in API requests with localized applications - @soulcutter.
+
+=== 0.2.0 (11/26/2012)
+
+* The gem is now licensed under the MIT license - @dblock.
+* Raise specialized configuration and SOAP errors - @dblock.
+* Added <tt>TaxCloud::Client.ping</tt> - @dblock.
+* Returning a verified <tt>TaxCloud::Address</tt> from <tt>TaxCloud::Address.verify</tt> - @dblock.
+* Added <tt>TaxCloud::Address.zip</tt> that returns a 9-digit address zip code, when available - @dblock.
+* Returning a <tt>TaxCloud::Responses::Lookup</tt> from <tt>TaxCloud::Transaction.lookup</tt> - @dblock.
+* Returning transaction state, ie. <tt>"OK"</tt> from all other TaxCloud transactions. Exceptions are raised on error - @dblock.
+* Added support for tax codes and tax code groups lookup with <tt>TaxCloud::TaxCodes</tt> and <tt>TaxCloud::TaxCode::Groups</tt> - @dblock.
+
+=== 0.1.5 (5/9/2012)
+
+* Fixed compatibility with Ruby 1.8.7 and 1.9.3, removed super from constructors for classes which inherit from <tt>Object</tt> - @gfmurphy.
+
+=== 0.1.4 (10/20/2011)
+
+* Upgraded rdoc - @drewtempelmeyer.
+* Fixed <tt>.gemspec</tt> dependency declaration for savon - @drewtempelmeyer.
+
+=== 0.1.3 (9/19/2011)
+
+* Added support for the "returned" request - @danielmorrison.
+* Refactoreted tests to use vcr and webmock - @danielmorrison.
+
+=== 0.1.0 (8/23/2011)
+
+* Initial public release - @drewtempelmeyer.

data/CONTRIBUTORS.txt

@@ -0,0 +1,23 @@
+tax_cloud Contributors
+
+Lead Developers
+=======================
+* Drew Tempelmeyer
+  * Twitter: @tempelmeyer
+  * App.net: @tempelmeyer
+  * Github: drewtempelmeyer
+
+* Daniel Doubrovkine
+  * Twitter: @dblockdotorg
+  * Github: dblock
+
+Contributors
+=======================
+* Daniel Morrison
+  * Github: danielmorrison
+
+* George F Murphy
+  * Github: gfmurphy
+
+* Bradley Schaefer
+  * Github: soulcutter

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM corgibytes/ruby-1.9.3:1.0.0
+
+# Working folder.
+RUN mkdir /app
+WORKDIR /app
+COPY . .
+
+# Install the Gems
+RUN bundle install

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # Rubocop 0.41.2 is the lastest version to support
+  # Ruby 1.9.3.
+  gem 'rubocop', '~>0.41.2'
+  gem 'dotenv'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-ci'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :development, :test do
+  gem 'rake', '~>12.2.1'
+  gem 'rdoc'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2011-2014 Drew Tempelmeyer & Contributors
+Copyright (c) 2019 Corgibytes LLC.
+
+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,190 @@
+# TaxCloud
+
+[TaxCloud](http://www.taxcloud.com) is a free service to calculate sales tax and generate tax reports. The <tt>tax_cloud</tt> gem allows you to easily integrate with TaxCloud's API.
+
+[Forked](https://github.com/drewtempelmeyer/tax_cloud) to add support for running this Gem on Ruby 1.9.3.  See issue [#39](https://github.com/drewtempelmeyer/tax_cloud/issues/39) on the original repo for more details.
+
+### Getting Started
+Create a [TaxCloud](http://www.taxcloud.com) merchant account at http://www.taxcloud.net. Add a website to your account under [Locations](https://taxcloud.net/account/locations). This will generate an API ID and API Key that you will need to use the service.
+
+[TaxCloud](http://www.taxcloud.com) also offers an optional address verification API. To use it, you need a USPS (United States Postal Service) Address API UserID. To obtain your USPS UserID:
+1. Download and Install the USPS Shipping Assistant from http://www.usps.com/shippingassistant.
+2. Launch the USPS Shipping Assistant and go through the Shipping Assistant registration process.
+3. Once you have registered for your Shipping Assistant account, you can find your USPS Shipping Assistant UserID in the "About" box, in parentheses to the right of the name of the registered user.
+
+### Setup
+Add the gem to your Gemfile.
+
+    gem 'tax_cloud'
+
+Configure your environment. For example, create an initializer in Rails in <tt>config/initializers/tax_cloud.rb</tt>.
+
+    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' # optional
+      config.open_timeout = 1 # optional
+      config.read_timeout = 1 # optional
+    end
+
+The <tt>open_timeout</tt> and <tt>read_timeout</tt> options are used to specify waiting time for the TaxCloud web service response in seconds. Default values: <tt>open_timeout = 2</tt> and <tt>read_timeout = 2</tt>.
+
+### Using TaxCloud
+Define the destination and origin addresses using <tt>TaxCloud::Address</tt>.
+
+    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')
+
+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 TaxCloud::Responses::Lookup instance
+    lookup.tax_amount # total tax amount
+    lookup.cart_items.each do |cart_item|
+      cart_item.tax_amount # tax for a single item
+    end
+
+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 # returns "OK" or raises an error
+
+Later, you may need to mark some cart items as returned. TaxCloud will ignore any cart items that you don't include.
+
+    transaction.order_id = 100
+    transaction.cart_items << TaxCloud::CartItem.new(
+      :index => 0,
+      :item_id => 'SKU-100',
+      :tic => TaxCloud::TaxCodes::GENERAL,
+      :price => 10.00,
+      :quantity => 1)
+    transaction.returned # returns "OK" or raises an error
+
+### Verifying Addresses
+
+[TaxCloud](http://www.taxcloud.com) optionally integrates with the USPS Address API. An address can be verified, which can also yield a 9-digit zip code that helps determine a more accurate tax rate.
+
+    address = TaxCloud::Address.new({
+      :address1 => '888 6th Ave',
+      :city => 'New York',
+      :state => 'New York',
+      :zip5 => '10001'
+    })
+
+    verified_address = address.verify
+    verified_address.zip5 # 10001
+    verified_address.zip4 # 3502
+    verified_address.zip # 10001-3502
+
+### Tax Codes
+[TaxCloud](http://www.taxcloud.com) maintains a list of all Taxability Information Codes or TICs, which can be found at https://taxcloud.net/tic.
+
+You can obtain all tax codes as well as lookup a tax code by ID.
+
+    TaxCloud::TaxCodes.all # a hash of all codes
+    tax_code = TaxCloud::TaxCodes[TaxCloud::TaxCodes::DIRECT_MAIL_RELATED]
+    tax_code.ticid # 11000 or TaxCloud::TaxCodes::DIRECT_MAIL_RELATED
+    tax_code.description # "Direct-mail related"
+
+Tax codes are organized in groups.
+
+    TaxCloud::TaxCode::Groups.all # a hash of all groups
+    tax_code_group = TaxCloud::TaxCode::Groups[TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS]
+    tax_code_group.group_id # 3 or TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS
+    tax_code_group.description # School Related Products
+    tax_code_group.tax_codes # a hash of all codes in this group
+
+Tax code constants are defined in <tt>tax_code_constants.rb</tt> and tax code group constants in <tt>tax_code_group_constants.rb</tt>. These files can be generated by running the following rake tasks.
+
+    TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... tax_cloud:tax_codes
+    TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... tax_cloud:tax_code_groups
+
+### Tax States
+TaxCloud manages a list of states in which you can calculate sales tax. The default setup will only have SSUTA (Streamlined Sales and Use Tax Agreement) states enabled. All other states will return $0 for tax values. To enable other states, go to https://taxcloud.net/account/states. You can find more information about SSUTA [here](http://www.streamlinedsalestax.org/index.php?page=About-Us]).
+
+# Developer Setup
+The project is setup to use [Docker](https://www.docker.com/) to run the tests and example programs.  Once you have Docker installed you can build the container via:
+
+````bash
+docker-compose build
+````
+
+Once the container is built you can run access the command line to run these tests or example programs via:
+
+````bash
+docker-compose run app bash
+````
+
+## Running the tests
+Run the test and Rubocop using the following command:
+
+````bash
+rake
+````
+
+If you want to just run the tests and not Rubocop:
+
+````bash
+rake test
+````
+
+[VCR](https://github.com/vcr/vcr) and WebMock are used to replay requests and avoid hitting the API each time. To refresh the mocks, simply delete the <tt>test/cassettes</tt> directory.  If you need to record new requests against TaxCloud, set your keys first.
+
+````bash
+TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... rake test
+````
+
+The mocks will filter out your configuration details.
+
+Note: The tests all pass but will raise a bunch of warnings.  See [issue #3](https://github.com/corgibytes/tax_cloud/issues/3) for more details.
+
+## Running the example programs
+The example programs run directly against TaxCloud (i.e. no VCR mocks).  Make sure you aren't running against a live TaxCloud site but a one that is in test mode.
+
+To run the example programs you need to copy the `.env.example` file to `.env` and update it with your TaxCloud credentials.  Then run the following command from the examples directory so it can find the .env file:
+
+````bash
+bundle exec ruby <example>.rb
+````
+
+For example, to run the lookups example:
+
+````bash
+bundle exec ruby lookup_example.rb
+````
+
+If you login to your TaxCloud account you will see the API activity caused by the example programs.
+
+# Bugs, fixes, etc
+* Fork.
+* Write test(s).
+* Fix.
+* Commit.
+* Submit pull request.
+
+# License
+
+This gem is licensed under the [MIT license](LICENSE).
+
+# Acknowledgements
+Thanks for [Drew Tempelmeyer](https://github.com/drewtempelmeyer) and other [contributors](https://github.com/drewtempelmeyer/tax_cloud/graphs/contributors) for creating and maintaining this helpful gem.