avatax 14.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3736689d2d8927f029e447408ee98d02b0aabd71
+  data.tar.gz: 12f35a4c17e68dc07d5db16149563dba452882dd
+SHA512:
+  metadata.gz: 4abca3a479c296590de269d39e6bdd36c0934baf3c8dda00269138318426758d122ebab67a55a988d79ad598fad9a121ec56652b0ebbecf96c57a161c8a815d7
+  data.tar.gz: 43a9e9c5f5590c39bac0912c2ccefff39cc9fc491f0c074eac96144eefc0cec8c94ebfa83c490ac5eff699981f129e3187ab3d5af752394b4fbbc6266a2c353e

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,60 @@
+avatax.rb
+=====================
+
+This is a Ruby client library for the [AvaTax REST API](http://developer.avalara.com/api-docs/rest)
+methods:
+[tax/get POST](http://developer.avalara.com/api-docs/rest/tax/post/),
+[tax/get GET](http://developer.avalara.com/api-docs/rest/tax/get),
+[tax/cancel POST](http://developer.avalara.com/api-docs/rest/tax/cancel), and
+[address/validate GET](http://developer.avalara.com/api-docs/rest/address-validation).
+
+For more information on the use of these methods and the AvaTax product, please
+visit our [developer site](http://developer.avalara.com/) or [homepage](http://www.avalara.com/)
+
+Dependencies
+-----------
+- Ruby 1.9.2 or later
+- [Bundler](http://bundler.io)
+
+Requirements
+----------
+- Add the `avatax` gem to your Gemfile with `gem 'avatax'`
+- Run `bundle install` to retrieve `avatax` and all its dependencies
+- Authentication requires an valid **Account Number** and **License Key**. If you do not have an AvaTax account, a free trial account can be acquired through our [developer site](http://developer.avalara.com/api-get-started)
+- Specify your authentication credentials as
+  - environment variables,
+  - YAML file (see `credentials.yml.example`), or
+  - in source
+
+Credentials as environment variables
+------------------------------------
+```shell
+$ AVATAX_ACCOUNT_NUMBER=1234567890 AVATAX_LICENSE_KEY=A1B2C3D4E5F6G7H8 AVATAX_SERVICE_URL=https://development.avalara.net bundle exec ruby examples/PingTest.rb
+```
+
+Credentials from YAML file
+--------------------------
+```ruby
+AvaTax.configure_from 'credentials.yml.example'
+```
+
+Credentials in source
+---------------------
+```ruby
+AvaTax.configure do
+  account_number '1234567890'
+  license_key 'A1B2C3D4E5F6G7H8'
+  service_url 'https://development.avalara.net'
+end
+```
+
+Examples
+--------
+
+| Filename           | Description |
+| :----------------- | :---------- |
+| CancelTaxTest.rb   | Demonstrates [AvaTax::TaxService.cancel](http://developer.avalara.com/api-docs/rest/tax/cancel) used to [void a document](http://developer.avalara.com/api-docs/api-reference/canceltax) |
+| EstimateTaxTest.rb | Demonstrates the [AvaTax::TaxService.estimate](http://developer.avalara.com/api-docs/rest/tax/get) method used for product- and line- indifferent tax estimates. |
+| GetTaxTest.rb      | Demonstrates the [AvaTax::TaxService.get](http://developer.avalara.com/api-docs/rest/tax/post) method used for product- and line- specific [calculation](http://developer.avalara.com/api-docs/api-reference/gettax). **NOTE:** This will generate a new transaction/document each time. |
+| PingTest.rb        | Uses a hardcoded `AvaTax::TaxService.estimate` call to test connectivity and credential information. |
+| ValidateTest.rb    | Demonstrates the [AvaTax::AddressService.validate](http://developer.avalara.com/api-docs/rest/address-validation) method to [normalize an address](http://developer.avalara.com/api-docs/api-reference/address-validation). |

data/lib/avatax.rb

@@ -0,0 +1,20 @@
+require_relative 'avatax/configuration'
+module AvaTax
+
+  def self.configure(&block)
+    Configuration.instance.instance_eval(&block)
+  end
+
+  def self.configure_from(yaml_file)
+    require 'yaml'
+    config = YAML.load_file yaml_file
+    configure do
+      account_number config['account_number']
+      license_key config['license_key']
+      service_url config['service_url']
+    end
+  end
+
+end
+require_relative 'avatax/tax_service'
+require_relative 'avatax/address_service'

data/lib/avatax/address_service.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'net/http'
+require 'addressable/uri'
+require 'base64'
+require_relative 'configuration'
+
+class AvaTax::AddressService
+  @@service_path = '/1.0/address/'
+  attr_accessor :account_number, :license_key, :service_url
+
+  def initialize()
+    @account_number = AvaTax::Configuration.instance.account_number
+    @license_key = AvaTax::Configuration.instance.license_key
+    @service_url = AvaTax::Configuration.instance.service_url
+  end
+
+  def validate(address)
+    return address if address.nil?
+    encodedquery = Addressable::URI.new
+    encodedquery.query_values = address
+    uri = URI(@service_url + @@service_path  + "validate?"+ encodedquery.query)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+    cred = 'Basic '+ Base64.encode64(@account_number + ":"+ @license_key)
+    res = http.get(uri.request_uri, 'Authorization' => cred)
+    JSON.parse(res.body)
+  end
+
+end

data/lib/avatax/configuration.rb

@@ -0,0 +1,29 @@
+require 'singleton'
+
+module AvaTax
+  class Configuration
+    include Singleton
+
+    def initialize
+      @account_number = ENV['AVATAX_ACCOUNT_NUMBER']
+      @license_key = ENV['AVATAX_LICENSE_KEY']
+      @service_url = ENV['AVATAX_SERVICE_URL']
+      super
+    end
+
+    def account_number(acct_num = nil)
+      return @account_number if @account_number and acct_num.nil?
+      @account_number = acct_num
+    end
+
+    def license_key(license = nil)
+      return @license_key if @license_key and license.nil?
+      @license_key = license
+    end
+
+    def service_url(url = nil)
+      return @service_url if @service_url and url.nil?
+      @service_url = url
+    end
+  end
+end

data/lib/avatax/tax_service.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'net/http'
+require 'addressable/uri'
+require 'base64'
+require 'rest-client'
+require_relative 'configuration'
+
+class AvaTax::TaxService
+  @@service_path = "/1.0/tax/"
+  attr_accessor :account_number, :license_key, :service_url
+
+  def initialize()
+    #puts AvaTax::Configuration.instance.inspect
+    @account_number = AvaTax::Configuration.instance.account_number
+    @license_key = AvaTax::Configuration.instance.license_key
+    @service_url = AvaTax::Configuration.instance.service_url
+  end
+
+  def get(request_hash)
+    uri = @service_url + @@service_path + "get"
+    cred = 'Basic '+ Base64.encode64(@account_number + ":"+ @license_key)
+    #puts JSON.generate(request_hash)
+    res = RestClient.post(uri, JSON.generate(request_hash), :authorization => cred){|response, request, result| response}
+    JSON.parse(res.body)
+  end
+
+
+  def cancel(request_hash)
+    uri = @service_url + @@service_path + "cancel"
+    cred = 'Basic '+ Base64.encode64(@account_number + ":"+ @license_key)
+    res = RestClient.post uri, JSON.generate(request_hash), :authorization => cred
+    JSON.parse(res.body)["CancelTaxResult"]
+    #You may notice that this is slightly different from CalcTax, etc. The CancelTax result is  nested in this result object - this makes it consumable in a way that is consistant with the other response formats.
+  end
+
+  def estimate(coordinates, sale_amount)
+    # coordinates should be a hash with latitude and longitude
+    # sale_amount should be a decimal
+    return nil if coordinates.nil?
+    sale_amount = 0 if sale_amount.nil?
+    uri = URI(@service_url + @@service_path  +
+      coordinates[:latitude].to_s + "," + coordinates[:longitude].to_s +
+      "/get?saleamount=" + sale_amount.to_s )
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    cred = 'Basic '+ Base64.encode64(@account_number + ":"+ @license_key)
+    res = http.get(uri.request_uri, 'Authorization' => cred)
+    JSON.parse(res.body)
+  end
+
+  def ping
+    #There is no actual ping in the REST API, so this is a mockup that calls EstimateTax with 
+    #hardcoded values.
+    self.estimate(
+        { :latitude => "47.627935",
+          :longitude => "-122.51702"},
+          0 )
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: avatax
+version: !ruby/object:Gem::Version
+  version: 14.4.2
+platform: ruby
+authors:
+- Anya Stettler
+- Jeff Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Provides a straightforward way to access and communicate with the all
+  methods exposed by the Avalara AvaTax REST API.
+email: anya.stettler@avalara.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/avatax.rb
+- lib/avatax/address_service.rb
+- lib/avatax/configuration.rb
+- lib/avatax/tax_service.rb
+homepage: http://www.avalara.com/
+licenses:
+- Apache-2.0
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Library for accessing Avalara's AvaTax and Address Validation services
+test_files: []