tax_cloud 0.3.0 → 0.5.0

data/LICENSE.rdoc

@@ -1,22 +0,0 @@
-MIT License
-
-Copyright (c) 2011-2012 Drew Tempelmeyer & Contributors
-
-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.rdoc

@@ -1,140 +0,0 @@
-= TaxCloud
-
-{<img src="https://travis-ci.org/drewtempelmeyer/tax_cloud.png" />}[https://travis-ci.org/drewtempelmeyer/tax_cloud]
-
-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.
-
-=== 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'
-    end
-
-=== 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].
-
-=== Running Tests
-* 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.
-* Run tests.
-    rake test
-* If you need to record new requests against TaxCloud, set your keys first.
-    TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... rake test
-  The mocks will filter out your configuration details.
-
-=== Bugs, fixes, etc
-* Fork.
-* Write test(s).
-* Fix.
-* Commit.
-* Submit pull request.
-
-=== License
-
-Copyright Drew Tempelmeyer and contributors, 2011-2014.
-
-This gem is licensed under the MIT license.