vizjerai-avalara 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTIyNGQ4OTYzZTE1ZDg0MmZlZDFkNTU5NTY1MWE5NmU4MThkZWM2MA==
+  data.tar.gz: !binary |-
+    NmE4M2RhMTRjZmVmM2NjODhjZTNiZGY0ZDZiNWFhOWVmMDFiY2NkNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjE3NjE2Njk1OWFhMGI5NzMxMzY3ZmFiZmI0MTgxYmJiNjc0YWE0MDdmMDE0
+    ZDBhNjg5ZWQ2ZWY3Zjg0MTg5YzQyZjMwZmUzZmVkNzVhNDhlMDBkZDJhYzJm
+    OTAyZTQ2NjlhZjkzN2I0YjY0OTljYzM5NmQ1YmY4NDM3NjMyMDk=
+  data.tar.gz: !binary |-
+    N2UzMGIzOWQzMjIxYjhlN2IxOTNjYmJiNTVmZDQwNjczYjE0ZDIyNTg5ZGYz
+    ZGEzODI0MzgzY2U0ZjE5MTk5MTljMDA4NTdiMjQ5NWU5NGQxYWRiNzMwNDY0
+    ZTczZjVkMzk1NzBlNDRlY2Q5NTIyMjlkNmQ1MzNhNDk3NDk0YTE=

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+spec/avalara.yml

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.1.0 - June 13, 2013
+- Updated tests and gems
+- Added missing specs for geographical_tax
+- Added validate address
+- Added cancel tax
+
+## 0.0.2 - May 7, 2012 - Updated tests for test endpoint.
+
+- Looks like the tests were initally run against the production database (whops). I re-ran them against test and they're still working.
+- No code changes for this, other than documenting the test endpoint.
+
+## 0.0.1 - February 3, 2012 - Initial Release with get_tax call
+
+- Not much in the way of features so far, but the rough draft of the get_tax call is in, as well as error and warning message handling. Still need to update the docs with it once an API to the gem is finalized.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Assarattanakul
+
+MIT License
+
+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

@@ -0,0 +1,5 @@
+Avalara
+=====
+
+This API provides access to the [Avalara](http://www.avalara.com/) AvaTax API.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/avalara/api.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+require 'httparty'
+
+module Avalara
+  class API
+    include HTTParty
+    headers 'Accept' => 'application/json', 'Content-Type' => 'text/json'
+    format :json
+
+    def self.headers_for(content_length = 0)
+      {
+        'Accept'         => 'application/json',
+        'Content-Type'   => 'text/json',
+        'Date'           => Time.now.httpdate(),
+        'User-Agent'     => user_agent_string,
+        "Content-Length" => content_length.to_s
+      }
+    end
+
+    private
+
+    def self.user_agent_string
+      "avalara/#{Avalara::VERSION} (Rubygems; Ruby #{RUBY_VERSION} #{RUBY_PLATFORM})"
+    end
+  end
+end

data/lib/avalara/configuration.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+class Avalara::Configuration
+
+  attr_writer :endpoint
+  attr_accessor :password
+  attr_accessor :username
+  attr_writer :version
+
+  ##
+  # Public: Get the API endpoint used by the configuration.  Unless explicitly
+  # set, the endpoint will default to the official production endpoint at
+  # 'https://rest.avalara.net'.
+  #
+  # If you want to set this to the test endpoint, use 'https://development.avalara.net' 
+  #
+  # Returns the String for the API endpoint.
+  #
+  def endpoint
+    @endpoint ||= 'https://rest.avalara.net'
+  end
+
+  ##
+  # Public: Get the API version. Defaults to 1.0.
+  #
+  # Returns the String for the API version.
+  #
+  def version
+    @version ||= '1.0'
+  end
+end

data/lib/avalara/errors.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+module Avalara
+  class Error < StandardError       ; end
+  class TimeoutError < Error        ; end
+  class NotImplementedError < Error ; end
+  class ApiError < Error            ; end
+end

data/lib/avalara/request/address.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+module Avalara
+  module Request
+    class Address < Avalara::Types::Stash
+      property :Line1,      :from => :line_1
+      property :Line2,      :from => :line_2
+      property :Line3,      :from => :line_3
+      property :City,       :from => :city
+      property :Region,     :from => :region
+      property :Country,    :from => :country
+      property :PostalCode, :from => :postal_code
+    end
+  end
+end

data/lib/avalara/request/cancel_tax.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+require 'multi_json'
+
+module Avalara
+  module Request
+    class CancelTax < Avalara::Types::Stash
+      property :CompanyCode, :from => :company_code
+      property :DocType,     :from => :doc_type
+      property :DocCode,     :from => :doc_code
+      property :CancelCode,  :from => :cancel_code
+      property :DocId,       :from => :doc_id
+
+      def to_json
+        MultiJson.encode(self.to_hash, :pretty => true)
+      end
+    end
+  end
+end

data/lib/avalara/request/detail_level.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module Avalara
+  module Request
+    class DetailLevel < Avalara::Types::Stash
+      property :Line,       :from => :line
+      property :Summary,    :from => :summary
+      property :Document,   :from => :document
+      property :Tax,        :from => :tax
+      property :Diagnostic, :from => :diagnostic
+    end
+  end
+end

data/lib/avalara/request/invoice.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+require 'multi_json'
+
+module Avalara
+  module Request
+    # Same as GetTaxRequest
+    class Invoice < Avalara::Types::Stash
+      coerce_key :DocDate, Avalara::Types::Date
+
+      # Set outgoing
+      property :CustomerCode,      :from => :customer_code
+      property :DocDate,           :from => :doc_date
+      property :CompanyCode,       :from => :company_code
+      property :Commit,            :from => :commit
+      property :CustomerUsageType, :from => :customer_usage_type
+      property :Discount,          :from => :discount
+      property :DocCode,           :from => :doc_code
+      property :PurchaseOrderNo,   :from => :purchase_order_no
+      property :ExemptionNo,       :from => :exemption_no
+      property :DetailLevel,       :from => :detail_level
+      property :DocType,           :from => :doc_type
+      property :Lines,             :from => :lines
+      property :Addresses,         :from => :addresses
+      property :ReferenceCode,     :from => :reference_code
+
+      # Shipping Addresses
+      def addresses=(addresses)
+        self.Addresses = addresses.map {|address| InvoiceAddress.new(address)}
+      end
+
+      def lines=(lines)
+        self.Lines = lines.map {|line| Line.new(line)}
+      end
+
+      def to_json
+        MultiJson.encode(self.to_hash, :pretty => true)
+      end
+    end
+  end
+end

data/lib/avalara/request/invoice_address.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module Avalara
+  module Request
+    class InvoiceAddress < Avalara::Types::Stash
+      property :AddressCode, :from => :address_code,  :required => true
+      property :Line1,       :from => :line_1
+      property :Line2,       :from => :line_2
+      property :Line3,       :from => :line_3
+      property :City,        :from => :city
+      property :Region,      :from => :region
+      property :Country,     :from => :country
+      property :PostalCode,  :from => :postal_code
+      property :Latitude,    :from => :latitude
+      property :Longitude,   :from => :longitude
+      property :TaxRegionId, :from => :tax_region_id
+    end
+  end
+end

data/lib/avalara/request/line.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+module Avalara
+  module Request
+    class Line < Avalara::Types::Stash
+      property :LineNo,            :from => :line_no,             :required => true
+      property :DestinationCode,   :from => :destination_code,    :required => true
+      property :OriginCode,        :from => :origin_code,         :required => true
+      property :ItemCode,          :from => :item_code
+      property :TaxCode,           :from => :tax_code
+      property :CustomerUsageType, :from => :customer_usage_type
+      property :Description,       :from => :description
+      property :Qty,               :from => :qty,                 :required => true
+
+      # Amount: (decimal)
+      # - in dollars as a decimal. AvaTax will round to 2 decimal places
+      property :Amount,            :from => :amount,              :required => true
+      property :Discounted,        :from => :discounted
+      property :TaxIncluded,       :from => :tax_included
+      property :Ref1,              :from => :ref_1
+      property :Ref2,              :from => :ref_2
+    end
+  end
+end

data/lib/avalara/request.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module Avalara
+  module Request
+    autoload :Address,        'avalara/request/address'
+    autoload :CancelTax,      'avalara/request/cancel_tax'
+    autoload :DetailLevel,    'avalara/request/detail_level'
+    autoload :Invoice,        'avalara/request/invoice'
+    autoload :InvoiceAddress, 'avalara/request/invoice_address'
+    autoload :Line,           'avalara/request/line'
+    autoload :Message,        'avalara/request/message'
+  end
+end

data/lib/avalara/response/address_validation.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class AddressValidation < Avalara::Types::Stash
+      property :address,     :from => :Address
+
+      property :result_code, :from => :ResultCode
+      property :messages,    :from => :Messages
+
+      def success?
+        result_code == 'Success'
+      end
+
+      def Address=(address)
+        self.address = ValidationAddress.new(address)
+      end
+
+      def Messages=(new_messages)
+        self.messages = new_messages.map {|message| Message.new(message)}
+      end
+    end
+  end
+end

data/lib/avalara/response/cancel_tax.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class CancelTax < Avalara::Types::Stash
+      property :cancel_tax_result, :from => :CancelTaxResult
+
+      delegate :success?,       :to => :cancel_tax_result
+
+      delegate :transaction_id, :to => :cancel_tax_result
+      delegate :result_code,    :to => :cancel_tax_result
+      delegate :doc_id,         :to => :cancel_tax_result
+      delegate :messages,       :to => :cancel_tax_result
+
+      def CancelTaxResult=(result)
+        self.cancel_tax_result = CancelTaxResult.new(result)
+      end
+    end
+  end
+end

data/lib/avalara/response/cancel_tax_result.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class CancelTaxResult < Avalara::Types::Stash
+      property :transaction_id, :from => :TransactionId
+      property :result_code,    :from => :ResultCode
+      property :doc_id,         :from => :DocId
+      property :messages,       :from => :Messages
+
+      def success?
+        result_code == 'Success'
+      end
+
+      def Messages=(new_messages)
+        self.messages = new_messages.map {|message| Message.new(message)}
+      end
+    end
+  end
+end

data/lib/avalara/response/invoice.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class Invoice < Avalara::Types::Stash
+      property :doc_code,             :from => :DocCode
+      property :doc_date,             :from => :DocDate
+      property :timestamp,            :from => :Timestamp
+      property :total_amount,         :from => :TotalAmount
+      property :total_discount,       :from => :TotalDiscount
+      property :total_exemption,      :from => :TotalExemption
+      property :total_taxable,        :from => :TotalTaxable
+      property :total_tax,            :from => :TotalTax
+      property :total_tax_calculated, :from => :TotalTaxCalculated
+      property :tax_date,             :from => :TaxDate
+      property :tax_lines,            :from => :TaxLines
+      property :tax_addresses,        :from => :TaxAddresses
+      property :result_code,          :from => :ResultCode
+      property :messages,             :from => :Messages
+
+      def success?
+        result_code == 'Success'
+      end
+
+      def Messages=(new_messages)
+        self.messages = new_messages.map {|message| Message.new(message)}
+      end
+
+      def TaxLines=(lines)
+        self.tax_lines = lines.map {|line| TaxLine.new(line)}
+      end
+
+      def TaxAddresses=(addresses)
+        self.tax_addresses = addresses.map {|address| TaxAddress.new(address)}
+      end
+    end
+  end
+end

data/lib/avalara/response/message.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class Message < Avalara::Types::Stash
+      property :summary,   :from => :Summary
+      property :details,   :from => :Details
+      property :refers_to, :from => :RefersTo
+      property :severity,  :from => :Severity
+      property :source,    :from => :Source
+    end
+  end
+end

data/lib/avalara/response/tax.rb

@@ -0,0 +1,24 @@
+module Avalara
+  module Response
+    class Tax < Avalara::Types::Stash
+      property :rate,        :from => :Rate
+      property :tax,         :from => :Tax
+      property :tax_details, :from => :TaxDetails
+
+      property :result_code, :from => :ResultCode
+      property :messages,    :from => :Messages
+
+      def success?
+        result_code != 'Error'
+      end
+
+      def Messages=(new_messages)
+        self.messages = new_messages.map {|message| Message.new(message)}
+      end
+
+      def TaxDetails=(details)
+        self.tax_details = details.map {|tax_detail| TaxDetail.new(tax_detail)}
+      end
+    end
+  end
+end

data/lib/avalara/response/tax_address.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class TaxAddress < Avalara::Types::Stash
+      property :address,       :from => :Address
+      property :address_code,  :from => :AddressCode
+      property :city,          :from => :City
+      property :country,       :from => :Country
+      property :postal_code,   :from => :PostalCode
+      property :region,        :from => :Region
+      property :tax_region_id, :from => :TaxRegionId
+      property :juris_code,    :from => :JurisCode
+    end
+  end
+end

data/lib/avalara/response/tax_detail.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class TaxDetail < Avalara::Types::Stash
+      property :taxable,    :from => :Taxable
+      property :rate,       :from => :Rate
+      property :tax,        :from => :Tax
+      property :region,     :from => :Region
+      property :country,    :from => :Country
+      property :juris_type, :from => :JurisType
+      property :juris_name, :from => :JurisName
+      property :tax_name,   :from => :TaxName
+    end
+  end
+end

data/lib/avalara/response/tax_line.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class TaxLine < Avalara::Types::Stash
+      property :line_no,        :from => :LineNo
+      property :tax_code,       :from => :TaxCode
+      property :taxability,     :from => :Taxability
+      property :taxable,        :from => :Taxable
+      property :rate,           :from => :Rate
+      property :tax,            :from => :Tax
+      property :tax_details,    :from => :TaxDetails
+      property :discount,       :from => :Discount
+      property :tax_calculated, :from => :TaxCalculated
+      property :exemption,      :from => :Exemption
+
+      def TaxDetails=(tax_details)
+        self.tax_details = tax_details.map {|tax_detail| TaxDetail.new(tax_detail)}
+      end
+    end
+  end
+end

data/lib/avalara/response/validation_address.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    class ValidationAddress < Avalara::Types::Stash
+      ADDRESS_TYPE_NAME = {
+        'F' => 'Firm or company address',
+        'G' => 'General Delivery address',
+        'H' => 'High-rise or business complex',
+        'P' => 'PO Box address',
+        'R' => 'Rural route address',
+        'S' => 'Street or residential address'
+      }
+      CARRIER_TYPE = {
+        'B' => 'PO Box',
+        'C' => 'City delivery',
+        'G' => 'General delivery',
+        'H' => 'Highway contract',
+        'R' => 'Rural route'
+      }
+
+      property :line_1,        :from => :Line1
+      property :line_2,        :from => :Line2
+      property :line_3,        :from => :Line3
+      property :city,          :from => :City
+      property :region,        :from => :Region
+      property :country,       :from => :Country
+      property :address_type,  :from => :AddressType
+      property :postal_code,   :from => :PostalCode
+      property :county,        :from => :County
+      property :fips_code,     :from => :FipsCode
+      property :carrier_route, :from => :CarrierRoute
+      property :tax_region_id, :from => :TaxRegionId
+      property :post_net,      :from => :PostNet
+
+      def address_type_name
+        ADDRESS_TYPE_NAME[address_type]
+      end
+
+      def carrier_route_name
+        return carrier_route if carrier_route.nil? || carrier_route.empty?
+        CARRIER_TYPE[carrier_route[0]]
+      end
+    end
+  end
+end

data/lib/avalara/response.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Avalara
+  module Response
+    autoload :AddressValidation, 'avalara/response/address_validation'
+    autoload :CancelTax,         'avalara/response/cancel_tax'
+    autoload :CancelTaxResult,   'avalara/response/cancel_tax_result'
+    autoload :Invoice,           'avalara/response/invoice'
+    autoload :Message,           'avalara/response/message'
+    autoload :TaxLine,           'avalara/response/tax_line'
+    autoload :TaxDetail,         'avalara/response/tax_detail'
+    autoload :TaxAddress,        'avalara/response/tax_address'
+    autoload :Tax,               'avalara/response/tax'
+    autoload :ValidationAddress, 'avalara/response/validation_address'
+  end
+end

data/lib/avalara/types/date.rb

@@ -0,0 +1,10 @@
+module Avalara
+  module Types
+    class Date
+      def self.coerce(object)
+        return object unless object.respond_to?(:strftime)
+        return object.strftime("%Y-%m-%d")
+      end
+    end
+  end
+end

data/lib/avalara/types/stash.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'hashie/trash'
+require 'hashie/extensions/coercion'
+
+module Avalara
+  module Types
+    ##
+    # A Stash is a 'suppressing' Hashie::Trash where keys that are not defined
+    # are simply ignored and unavailable to the local object.
+    #
+    # A Stash is useful when you need to read data from another application,
+    # but you only want a predefined subset of the returned data to become
+    # available, locally.
+    #
+    class Stash < ::Hashie::Trash
+      include Hashie::Extensions::Coercion
+
+
+      private
+
+
+      def property_exists?(property)
+        self.class.property?(property.to_sym)
+      end
+    end
+  end
+end

data/lib/avalara/types.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+module Avalara
+  module Types
+    autoload :Date,  'avalara/types/date'
+    autoload :Stash, 'avalara/types/stash'
+  end
+end

data/lib/avalara/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module Avalara
+  VERSION = '0.1.0'
+end