Avatax_TaxService 1.0.11 → 1.0.12

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# spec/awesome_gem/awesome.rb
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+$: << File.join(APP_ROOT, 'lib') # so rspec knows where your file could be
+require 'avatax_taxservice.rb' # this loads the class you want to test
+require 'yaml'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/spec/taxservice_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe "TaxService" do
+  before :each do
+    credentials = YAML::load(File.open('credentials.yml'))
+    @creds = {:username => credentials['username'], 
+          :password => credentials['password'],  
+          :clientname => credentials['clientname'],
+          :use_production_url => credentials['production']}
+  end
+
+  describe "does not allow instantiation with" do
+    it "no values" do
+      lambda { AvaTax::TaxService.new }.should raise_exception
+    end
+    it "optional values only" do
+      lambda { AvaTax::TaxService.new(
+      :clientname => @creds[:clientname],
+      :adapter => "AvaTaxCalcRuby",
+      :machine => "MyComputer",
+      :use_production_account => @creds[:use_production_url] ) }.should raise_exception
+    end
+  end
+  describe "allows instantiation with" do
+    it "required values only" do
+      lambda { AvaTax::TaxService.new(
+      :username => @creds[:username], 
+      :password => @creds[:password],  
+      :clientname => @creds[:clientname]) }.should_not raise_exception
+    end
+    it "required and optional values" do
+      lambda { AvaTax::TaxService.new(
+      :username => @creds[:username], 
+      :password => @creds[:password],  
+      :clientname => @creds[:clientname],
+      :adapter => "AvaTaxCalcRuby",
+      :machine => "MyComputer",
+      :use_production_account => false ) }.should_not raise_exception
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Avatax_TaxService
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Graham S Wilson
@@ -43,10 +43,24 @@ files:
 - lib/template_ping.erb
 - lib/template_posttax.erb
 - lib/template_reconciletaxhistory.erb
-- test/test_adjtax.rb
-- test/test_gettax.rb
-- test/test_gettaxhistory.rb
-- test/test_reconciletaxhistory.rb
+- samples/CancelTax.rb
+- samples/credentials.yml
+- samples/GetTax.rb
+- samples/GetTaxHistory.rb
+- samples/Ping.rb
+- samples/PostTax.rb
+- samples/Validate.rb
+- spec/adjusttax_spec.rb
+- spec/canceltax_spec.rb
+- spec/committax_spec.rb
+- spec/gettax_spec.rb
+- spec/gettaxhistory_spec.rb
+- spec/isauthorized_spec.rb
+- spec/ping_spec.rb
+- spec/posttax_spec.rb
+- spec/reconciletaxhistory_spec.rb
+- spec/spec_helper.rb
+- spec/taxservice_spec.rb
 - Avatax_TaxService.gemspec
 - Avatax Ruby SDK Guide.docx
 - LICENSE.txt
@@ -54,7 +68,7 @@ homepage: http://www.avalara.com/
 licenses:
 - MIT
 metadata: {}
-post_install_message: Thanks for installing the Avalara AddressService Ruby SDK. Refer
+post_install_message: Thanks for installing the Avalara TaxService Ruby SDK. Refer
   to "Avatax Ruby SDK User Guide.docx" to get started.
 rdoc_options: []
 require_paths:

data/test/test_adjtax.rb

@@ -1,127 +0,0 @@
-#Load the Avalara Address Service module
-require 'avatax_taxservice' 
-#Load the Avalara Address Service module
-require 'avatax_addressservice' 
-
-#Create new credentials hash object
-credentials = Hash.new
-
-#Create new document hash object
-document = Hash.new
-
-#Create new address hash object
-address = Hash.new
-
-credentials[:username] = 'USERNAME'
-credentials[:password] = 'PASSWORD'
-credentials[:name] = 'Avalara Inc.'
-credentials[:clientname] = 'MyShoppingCart'
-credentials[:adapter] = 'Avatax SDK for Ruby 1.0.6'
-credentials[:machine] = 'Lenovo W520 Windows 7'
-# Determine whether the DEV or PROD service is used. false = DEV  true = PROD
-credentials[:use_production_account] = false
-
-#Create a tax service instance
-TaxServ = AvaTax::TaxService.new(credentials) 
-
-#Create an address service instance
-AddrService = AvaTax::AddressService.new(credentials)
-
-#Populate the fields required by the GetTax call
-document[:adjustmentreason] = "5"
-document[:adjustmentdescription] = "Hey I adjusted the tax"
-document[:companycode] = 'APITrialCompany'
-document[:doctype] = 'SalesInvoice'
-document[:doccode] = "MyDocCode"    
-document[:docdate] = "2013-10-11" 
-document[:salespersoncode] = "Bill Sales" 
-document[:customercode] = "CUS001"
-document[:customerusagetype] = ""    
-document[:discount] = ".0000"             
-document[:purchaseorderno]= "PO123456"
-document[:exemptionno] = ""
-document[:origincode] = "123"     
-document[:destinationcode] = "456"
-#Pass addresses as an array
-#  <AddressCode>123</AddressCode>
-#  <Line1>100 Ravine Lane</Line1>
-#  <Line2/>
-#  <Line3/>
-#  <City>Bainbridge Island</City>
-#  <Region>WA</Region>
-#  <PostalCode>98110</PostalCode>
-#  <Country>US</Country>
-#  <TaxRegionId>0</TaxRegionId>
-#  <Latitude/>
-#  <Longitude/>
-document[:addresses]= [
-  {:addresscode => "123",:line1 => "100 ravine lane",:city => "Bainbridge Island",:region => "WA",:postalcode => "98110",:country => "US",:taxregionid => "0",:latitude => "",:longitude => ""},
-  {:addresscode => "456",:line1 => "7070 West Arlington Drive",:city => "Lakewood",:region => "CO",:postalcode => "80123",:country => "US",:taxregionid => "0"}
-  ]
-#Pass order/invoice lines as an array
-# <No>1</No>
-# <OriginCode></OriginCode>
-# <DestinationCode></DestinationCode>
-# <ItemCode>Canoe</ItemCode>
-# <TaxCode></TaxCode>
-# <Qty>1</Qty>
-# <Amount>300</Amount>
-# <Discounted>false</Discounted>
-# <RevAcct></RevAcct>
-# <Ref1>ref1</Ref1>
-# <Ref2>ref2</Ref2>
-# <ExemptionNo></ExemptionNo>
-# <CustomerUsageType></CustomerUsageType>
-# <Description>Blue canoe</Description>
-# <TaxOverrideType>TaxAmount</TaxOverrideType>
-# <TaxAmount>10</TaxAmount>
-# <TaxDate>1900-01-01</TaxDate>
-# <Reason>Tax Credit</Reason>
-# <TaxIncluded>false</TaxIncluded>
-# <BusinessIdentificationNo></BusinessIdentificationNo> 
-document[:lines] = [
-  {:no => "1",:itemcode => "Canoe",:qty => "1",:amount => "300.43",:discounted => "false",:ref1 => "ref1",:ref2 => "ref2",:description => "Blue canoe",:taxoverridetypeline => "TaxAmount",:taxamountline => "10",:taxdateline => "1900-01-01",:reasonline => "Tax credit",:taxincluded => "false"},
-  {:no => "2",:itemcode => "Rowing boat",:qty => "1",:amount => "800.12",:discounted => "false",:ref1 => "ref3",:ref2 => "ref4",:description => "Red rowing boat",:taxoverridetypeline => "None",:taxamountline => "0",:taxdateline => "1900-01-01",:taxincluded => "false"}
-]
-document[:detaillevel] = "Tax"                 #The level of detail you want returned by the service     
-document[:referencecode] = ""                  #Reference code - used for returns
-document[:hashcode] = "0"                      #Set to 0
-document[:locationcode] = ""                   #Store Location, Outlet Id, or Outlet code.
-document[:commit] = "false"                    #Invoice will be committed if this flag has been set to true.
-document[:batchcode] = ""                      #Optional Batch Code
-document[:taxoverridetype] = "None"            #Type of TaxOverride  
-document[:taxamount]= ".0000"                  #The TaxAmount overrides the total tax for the document, if not 0
-document[:taxdate] = "1900-01-01"              #Tax Date is the date used to calculate tax
-document[:reason] = ""                         #Reason for applying TaxOverride. = ""
-document[:currencycode] = "USD"                #3 character ISO 4217 currency code (for example, USD) 
-document[:servicemode] = "Remote"              #All lines are calculated by AvaTax remote server
-document[:paymentdate] = "2013-09-26"          #Indicates the date payment was applied to this invoice
-document[:exchangerate] = ".0000"              #Indicates the currency exchange rate
-document[:exchangerateeffdate] = "1900-01-01"  #Indicates the effective date of the exchange rate.
-document[:poslanecode] = ""                    #Optional POS Lane Code
-document[:businessidentificationno] = ""       #Optional Business Identification Number
-document[:debug] = false                       #Run in debug move - writes data to tax_log.txt
-document[:validate]= false                     #If true - addresses will be validated before the tax call 
-
-#Create empty hash for the tax result details 
-tax_result = Hash.new
-
-#Call the tax service
-tax_result = TaxServ.adjusttax(document) 
-
-require 'pp'
-pp tax_result
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    

data/test/test_gettax.rb

@@ -1,150 +0,0 @@
-#Load the Avalara Address Service module
-require 'avatax_taxservice' 
-#Load the Avalara Address Service module - optional
-require 'avatax_addressservice' 
-
-#Create new credentials hash object
-credentials = Hash.new
-
-#Create new document hash object
-document = Hash.new
-
-#Create new address hash object
-address = Hash.new
-
-credentials[:username] = 'USERNAME'
-credentials[:password] = 'PASSWORD'
-credentials[:name] = 'Avalara Inc.'
-credentials[:clientname] = ''
-credentials[:adapter] = ''
-credentials[:machine] = 'Lenovo W520 Windows 7'
-# Determine whether the DEV or PROD service is used. false = DEV  true = PROD
-credentials[:use_production_account] = false
-
-#Create a tax service instance
-TaxServ = AvaTax::TaxService.new(credentials) 
-
-#Create an address service instance
-AddrService = AvaTax::AddressService.new(credentials)
-
-#Populate the fields required by the GetTax call
-document[:companycode] = 'APITrialCompany'
-document[:doctype] = 'SalesOrder'
-document[:doccode] = "MyDocCode100"    
-document[:docdate] = "2013-10-11" 
-document[:salespersoncode] = "Bill Sales" 
-document[:customercode] = "CUS001"
-document[:customerusagetype] = ""    
-document[:discount] = ".0000"             
-document[:purchaseorderno]= "PO123456"
-document[:exemptionno] = ""
-document[:origincode] = "123"     
-document[:destinationcode] = "456"
-
-#Pass addresses as an array of hashes
-#  <AddressCode>123</AddressCode>
-#  <Line1>100 Ravine Lane</Line1>
-#  <Line2/>
-#  <Line3/>
-#  <City>Bainbridge Island</City>
-#  <Region>WA</Region>
-#  <PostalCode>98110</PostalCode>
-#  <Country>US</Country>
-#  <TaxRegionId>0</TaxRegionId>
-#  <Latitude/>
-#  <Longitude/>
-document[:addresses]= [
-  {:addresscode => "123",:line1 => "100 ravine lane", :line2 => "Suite 21",:city => "Bainbridge Island",:region => "WA",:postalcode => "98110",:country => "US",:taxregionid => "0",:latitude => "",:longitude => ""},
-  {:addresscode => "456",:line1 => "9436 NE Blue Wave Ct",:city => "Bainbridge Island",:region => "WA",:postalcode => "98110",:country => "US",:taxregionid => "0"}
-  ]
-
-#Pass order/invoice lines as an array of hashes
-# <No>1</No>
-# <OriginCode></OriginCode>
-# <DestinationCode></DestinationCode>
-# <ItemCode>Canoe</ItemCode>
-# <TaxCode></TaxCode>
-# <Qty>1</Qty>
-# <Amount>300</Amount>
-# <Discounted>false</Discounted>
-# <RevAcct></RevAcct>
-# <Ref1>ref1</Ref1>
-# <Ref2>ref2</Ref2>
-# <ExemptionNo></ExemptionNo>
-# <CustomerUsageType></CustomerUsageType>
-# <Description>Blue canoe</Description>
-# <TaxOverrideType>TaxAmount</TaxOverrideType>
-# <TaxAmount>10</TaxAmount>
-# <TaxDate>1900-01-01</TaxDate>
-# <Reason>Tax Credit</Reason>
-# <TaxIncluded>false</TaxIncluded>
-# <BusinessIdentificationNo></BusinessIdentificationNo>  
-document[:lines] = [
-  {:no => "1",:itemcode => "Canoe",:qty => "1",:amount => "300.43",:discounted => "false",:ref1 => "ref1",:ref2 => "ref2",:description => "Blue canoe",:taxoverridetypeline => "TaxAmount",:taxamountline => "10",:taxdateline => "1900-01-01",:reasonline => "Tax credit",:taxincluded => "false"},
-  {:no => "2",:itemcode => "Rowing boat",:qty => "1",:amount => "800.12",:discounted => "false",:ref1 => "ref3",:ref2 => "ref4",:description => "Red rowing boat",:taxoverridetypeline => "None",:taxamountline => "0",:taxdateline => "1900-01-01",:taxincluded => "false"}
-]
-document[:detaillevel] = "Tax"                 #The level of detail you want returned by the service     
-document[:referencecode] = ""                  #Reference code - used for returns
-document[:hashcode] = "0"                      #Set to 0
-document[:locationcode] = ""                   #Store Location, Outlet Id, or Outlet code.
-document[:commit] = "false"                    #Invoice will be committed if this flag has been set to true.
-document[:batchcode] = ""                      #Optional Batch Code
-document[:taxoverridetype] = "None"            #Type of TaxOverride  
-document[:taxamount]= ".0000"                  #The TaxAmount overrides the total tax for the document, if not 0
-document[:taxdate] = "1900-01-01"              #Tax Date is the date used to calculate tax
-document[:reason] = ""                         #Reason for applying TaxOverride. = ""
-document[:currencycode] = "USD"                #3 character ISO 4217 currency code (for example, USD) 
-document[:servicemode] = "Remote"              #All lines are calculated by AvaTax remote server
-document[:paymentdate] = "2013-09-26"          #Indicates the date payment was applied to this invoice
-document[:exchangerate] = ".0000"              #Indicates the currency exchange rate
-document[:exchangerateeffdate] = "1900-01-01"  #Indicates the effective date of the exchange rate.
-document[:poslanecode] = ""                    #Optional POS Lane Code
-document[:businessidentificationno] = ""       #Optional Business Identification Number
-document[:debug] = false                       #Run in debug move - writes data to tax_log.txt
-document[:validate]= false                     #If true - addresses will be validated before the tax call 
-
-
-#Create empty hash for the tax result details 
-tax_result = Hash.new
-
-#Call the Avatax tax service
-tax_result = TaxServ.gettax(document) 
-
-#Print out the returned hash
-require 'pp'
-pp tax_result
-puts
-
-puts "Result Code = #{tax_result[:get_tax_result][:result_code]}"
-puts "Total Taxable = #{tax_result[:get_tax_result][:total_taxable]}"
-puts "Total Tax = #{tax_result[:get_tax_result][:total_tax]}"
-puts
-#Get total taxable
-puts tax_result[:get_tax_result][:total_taxable]
-puts
-
-#Get first tax line
-pp tax_result[:get_tax_result][:tax_lines][:tax_line][0]
-
-puts
-#Get tax details for line 2
-pp tax_result[:get_tax_result][:tax_lines][:tax_line][1][:tax_details]
-
-puts
-#Get tax line 2 .. first level of tax detail
-pp tax_result[:get_tax_result][:tax_lines][:tax_line][1][:tax_details][:tax_detail][0]
-
-puts
-#Get tax line 2 - country
-pp tax_result[:get_tax_result][:tax_lines][:tax_line][1][:tax_details][:tax_detail][0][:country]
-
-
-if tax_result[:get_tax_result][:result_code] == "Success" then
-     puts "The GetTax call was successful"
-else
-     puts "The GetTax call failed"
-end
-
-
-
-

data/test/test_gettaxhistory.rb

@@ -1,55 +0,0 @@
-#Load the Avalara Address Service module
-require 'avatax_taxservice' 
-
-#Create new credentials hash object
-credentials = Hash.new
-
-#Create new document hash object
-document = Hash.new
-
-credentials[:username] = 'USERNAME'
-credentials[:password] = 'PASSWORD'
-credentials[:name] = 'Avalara Inc.'
-credentials[:clientname] = 'MyShoppingCart'
-credentials[:adapter] = 'Avatax SDK for Ruby 1.0.6'
-credentials[:machine] = 'Lenovo W520 Windows 7'
-# Determine whether the DEV or PROD service is used. false = DEV  true = PROD
-credentials[:use_production_account] = false
-
-#Create a tax service instance
-TaxServ = AvaTax::TaxService.new(credentials) 
-
-document[:docid] = "" 
-document[:companycode] = 'APITrialCompany'
-document[:doctype] = 'SalesInvoice'
-document[:doccode] = "MyDocCode100"    
-document[:detaillevel] = "Line"
-document[:debug] = true
-
-#Create empty hash for the tax result details 
-tax_result = Hash.new
-
-#Call the gettax service
-tax_result = TaxServ.gettaxhistory(document)
-
-require 'pp'
-pp tax_result
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    

data/test/test_reconciletaxhistory.rb

@@ -1,63 +0,0 @@
-#Load the Avalara Address Service module
-require 'avatax_taxservice' 
-
-#Create new credentials hash object
-credentials = Hash.new
-
-#Create new document hash object
-document = Hash.new
-
-credentials[:username] = 'USERNAME'
-credentials[:password] = 'PASSWORD'
-credentials[:name] = 'Avalara Inc.'
-credentials[:clientname] = 'MyShoppingCart'
-credentials[:adapter] = 'Avatax SDK for Ruby 1.0.6'
-credentials[:machine] = 'Lenovo W520 Windows 7'
-# Determine whether the DEV or PROD service is used. false = DEV  true = PROD
-credentials[:use_production_account] = false
-
-#Create a tax service instance
-TaxServ = AvaTax::TaxService.new(credentials)
-
-document[:companycode] = 'APITrialCompany'
-document[:lastdocid] = '99999999'
-document[:reconciled] = false
-document[:startdate] = '2013-01-01'
-document[:enddate] = '2013-10-15'
-document[:docstatus] = "Any"
-document[:doctype] = 'SalesInvoice'
-document[:lastdoccode] = ''
-document[:pagesize] = '1'
-document[:debug] = true
-
-#Create empty hash for the tax result details 
-tax_result = Hash.new
-
-#Call the gettax service
-tax_result = TaxServ.reconciletaxhistory(document)
-
-require 'pp'
-pp tax_result
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-