Avatax_AddressService 1.0.6 → 1.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTRjMDdhZmFjZGUxNzdjZjA5N2EyMDM5OTIwNGM4NWEyZDBmNGQzMQ==
+    MmFjMjMyYzQxYmNkMGNhNDZjYTU0NjM2MDk3NTA0ZDA1NDAyZjFjMQ==
   data.tar.gz: !binary |-
-    MjAyYjBhYmMxN2RjMjM3MGZlNWIxZTgzODE0MjU2MWI4NTIwZDM3OA==
+    MmQwMjA5ZjQwMGViNzJmOWE2NzhjYTkxNzU5NWUwYzExZGQ3Njk5Mg==
 SHA512:
   metadata.gz: !binary |-
-    Yzc2ZWIwNTMxNGRkZDkyODk3NDNkOGZiMGM2YTBhNzg4NGMxMTdhN2IxZTY3
-    YzY3Nzk3YWY5NzY1M2ViOTBmZDljMzU0YWU2MThlYjAwMTg2OGUxZTg2N2Qx
-    YTI2Nzc5ODVjZDUzMDY4NWU3OWZhZTEwYmM3ZDVjNzkxYTE0NGY=
+    ZDU3ZDQ1OWNiMWQzMDMyMmIyMWNjMTZmYmI1NTFiYjVhOWRmYWU3OTA1Njlm
+    NjY1Mjk3NGQ3ZjEwZWE1ZDJhYTI1NGY4YTVlNTM1YjkzYjI4N2U0ZjZmZWE1
+    MzQxMWUzMTg5ZDI3NTI3MDM2YTY1NzdlYzgyNGEzN2VlNjVmYzM=
   data.tar.gz: !binary |-
-    NmRiOTVmYzIzMTcxZmQ0YjMwMGE2NjU0MDdhNmUyNDkzMjdkMTU2M2E3Mzc3
-    ZThhMmFjNWQ0ODdmNDgxZGRkNTRhOTU5MzJmNzU0MDUzZjgyMWE5N2RlY2E4
-    MWY1MzdiYTVjMWMyMzdiNGJlMmU0NDVmNDA0NTgyNzgyZjE3NzE=
+    NzBiZTY2ZTIzMzJjMWIzNjgzYzcxYzY1MWVkYWFhNDFhNDBmNmQ2NjQxMjY2
+    NjE1NDFhOGEwNTYxMDkyOWU5YzA1MmY5MDIwYzlkMjUzNDgyNmQwMDI0ZWI4
+    MGVlYmQ0ZDY4NzZkOTdiN2YxYzlhOGVlOGU2NWU2MGVjYWZiNWI=

data/Avatax_AddressService.gemspec

@@ -1,19 +1,17 @@
 Gem::Specification.new do |s|
   s.name = "Avatax_AddressService"
-  s.version = "1.0.6"
+  s.version = "1.0.7"
   s.date = "2012-12-16"
   s.author = "Graham S Wilson"
   s.email = "support@Avalara.com"
-  s.summary = "Ruby SDK for Avatax Address Web Services"
+  s.summary = "Ruby SDK for Avatax Address Web Services "
   s.homepage = "http://www.avalara.com/"
   s.license = 'MIT'
   s.description = "Ruby SDK provides means of communication with Avatax Web Services."
   s.files = ["lib/address_log.txt", "lib/addressservice_dev.wsdl", "lib/addressservice_prd.wsdl", "lib/avatax_addressservice.rb",
-             "lib/template_validate.erb","lib/template_ping.erb","lib/template_isauthorized.erb",
-             "lib/xpath_validate.txt", "lib/xpath_ping.txt","lib/xpath_isauthorized.txt","test/test_address.rb",
+             "lib/template_validate.erb","lib/template_ping.erb","lib/template_isauthorized.erb","test/test_address.rb",
              "Avatax_AddressService.gemspec", "Avatax Ruby SDK Guide.docx", "LICENSE.txt"]
   # s.add_dependency "nokogiri", ">= 1.4.0", "< 1.6"
-  s.add_dependency "nokogiri", ">= 1.4.0"
   s.add_dependency "savon", ">= 2.3.0"
   s.required_ruby_version = '>=1.9.1'
   s.post_install_message = 'Thanks for installing the Avalara AddressService Ruby SDK. Refer to "Avatax Ruby SDK User Guide.docx" to get started.'

data/lib/avatax_addressservice.rb

@@ -1,40 +1,49 @@
 require 'savon'
 require 'erb'
-require 'nokogiri'
 
 module AvaTax
   #Avalara address class
   class AddressService
     def initialize(credentials)
       
+      #Set @def_locn to the Avatax-x.x.x gem install library. This enables the ruby programs to
+      #find other objects that it needs.
+      spec = Gem::Specification.find_by_name("Avatax_AddressService")
+      gem_root = spec.gem_dir
+      @def_locn = gem_root + "/lib"
+      
       #Extract data from hash
       username = credentials[:username]
       password = credentials[:password]      
       name = credentials[:name]
       clientname = credentials[:clientname]
       adapter = credentials[:adapter]      
-      machine = credentials[:machine]      
+      machine = credentials[:machine] 
+      use_production_account = credentials[:use_production_account]     
       
       #Set credentials and Profile information
       @username = username == nil ? "" : username
       @password = password == nil ? "" : password
       @name = name == nil ? "" : name
-      @clientname = clientname == nil ? "" : clientname
-      @adapter = adapter == nil ? "" : adapter
+      @clientname = (clientname == nil or clientname == "") ? "Avatax Address Service SDK for Ruby Default Client Name" : clientname
+      @adapter = (adapter == nil or adapter == "") ? spec.summary + spec.version.to_s : adapter
       @machine = machine == nil ? "" : machine
-
-      #Set @def_locn to the Avatax-x.x.x gem install library. This enables the ruby programs to
-      #find other objects that it needs.
-      spec = Gem::Specification.find_by_name("Avatax_AddressService")
-      gem_root = spec.gem_dir
-      @def_locn = gem_root + "/lib"
+      @use_production_account = (use_production_account != true) ? false : use_production_account
 
       #Open Avatax Error Log
       @log = File.new(@def_locn + '/address_log.txt', "w")
-      @log.puts "#{Time.now}: Address service started"
-
-      #log :false turns off HTTP logging
-      @client = Savon.client(wsdl: @def_locn + '/addressservice_dev.wsdl', log: false)
+      
+      #Get service details from WSDL - control_array[2] contains the WSDL read from the address_control file
+      #log :false turns off HTTP logging. Select either Dev or Prod depending on the value of the boolean value 'use_production_account'
+      if @use_production_account
+        @log.puts "#{Time.now}: Avalara Production Address service started"
+        #log :false turns off HTTP logging
+        @client = Savon.client(wsdl: @def_locn + '/addressservice_prd.wsdl', log: false)
+      else
+        @log.puts "#{Time.now}: Avalara Development Address service started"
+        #log :false turns off HTTP logging
+        @client = Savon.client(wsdl: @def_locn + '/addressservice_dev.wsdl', log: false)
+      end
 
       begin
       #Read in the SOAP template for Ping
@@ -56,14 +65,18 @@ module AvaTax
       rescue
         @log.puts "#{Time.now}: Error loading the IsAuthorized template"
       end
-      # Create hash for validate result
-      @return_data = Hash.new
+      
+      # Create hash for result
+      @response = Hash.new
     end
 
     ############################################################################################################
     # ping - Verifies connectivity to the web service and returns version information
     ############################################################################################################
     def ping(message = nil)
+      
+      @service = 'Ping'
+      
       #Read in the SOAP template
       @message = message == nil ? "?" : message
 
@@ -75,20 +88,14 @@ module AvaTax
 
       # Make the call to the Avalara Ping service
       begin
-        @response = @client.call(:ping, xml: @soap).to_s
-      rescue
-        @log.puts "#{Time.now}: Error calling Ping service ... check username and password"
-      end
-      # Load the response into a Nokogiri object and remove namespaces
-      @doc = Nokogiri::XML(@response).remove_namespaces!
-
-      #Read in an array of XPATH pointers
-      @ping_xpath = File.readlines(@def_locn + '/xpath_ping.txt')
-
-      #Read each array element, extract the result returned by the service and place in a the @return_data hash
-      @ping_xpath.each{|xpath| @return_data[xpath[2...xpath.length].chomp.to_sym] = @doc.xpath(xpath).text}
+        @response = @client.call(:ping, xml: @soap).to_hash
 
-      return @return_data
+      return @response
+      
+      #Capture unexpected errors
+      rescue Savon::Error => error
+        abend(error)
+      end
     end
 
     ############################################################################################################
@@ -96,6 +103,8 @@ module AvaTax
     ############################################################################################################
     def validate(address)
 
+      @service = 'Validate'
+
       #Extract data from hash
       addresscode = address[:addresscode]
       line1 = address[:line1]
@@ -131,59 +140,55 @@ module AvaTax
       # Subsitute real vales for template place holders
       @soap = @template_validate.result(binding)
 
-      #Clear return hash
-      @return_data.clear
-
       # Make the call to the Avalara Validate service
       begin
-        @response = @client.call(:validate, xml: @soap).to_s
+        @response = @client.call(:validate, xml: @soap).to_hash
 
-      rescue
-        @log.puts "#{Time.now}: Error calling Validate service ... check username and password"
+      return @response
+      
+      #Capture unexpected errors
+      rescue Savon::Error => error
+        abend(error)
       end
-
-      # Load the response into a Nokogiri object and remove namespaces
-      @doc = Nokogiri::XML(@response).remove_namespaces!
-
-      #Read in an array of XPATH pointers
-      @validate_xpath = File.readlines(@def_locn + '/xpath_validate.txt')
-
-      #Read each array element, extract the result returned by the service and place in a the @return_data hash
-      @validate_xpath.each{|xpath| @return_data[xpath[2...xpath.length].chomp.to_sym] = @doc.xpath(xpath).text}
-
-      return @return_data
     end
 
     ############################################################################################################
     #Verifies connectivity to the web service and returns version information about the service.
     ############################################################################################################
     def isauthorized(operation = nil)
+      
+      @service = 'IsAuthorized'
+      
       #Read in the SOAP template
       @operation = operation == nil ? "?" : operation
 
       # Subsitute real vales for template place holders
       @soap = @template_isauthorized.result(binding)
 
-      #Clear return hash
-      @return_data.clear
-
       # Make the call to the Avalara Ping service
       begin
-        @response = @client.call(:is_authorized, xml: @soap).to_s
-      rescue
-        @log.puts "#{Time.now}: Error calling IsAuthorized service ... check username and password"
-      end
-
-      # Load the response into a Nokogiri object and remove namespaces
-      @doc = Nokogiri::XML(@response).remove_namespaces!
-
-      #Read in an array of XPATH pointers
-      @isauthorized_xpath = File.readlines(@def_locn + '/xpath_isauthorized.txt')
+        @response = @client.call(:is_authorized, xml: @soap).to_hash
 
-      #Read each array element, extract the result returned by the service and place in a the @return_data hash
-      @isauthorized_xpath.each{|xpath| @return_data[xpath[2...xpath.length].chomp.to_sym] = @doc.xpath(xpath).text}
-
-      return @return_data
+      return @response
+      
+      #Capture unexpected errors
+      rescue Savon::Error => error
+        abend(error)
+      end
+    end
+    
+    private
+    ############################################################################################################
+    # abend - Unexpected error handling
+    ############################################################################################################
+    def abend(error)
+      @log.puts "An unexpected error occurred: Response from server = #{error}"   
+      @log.puts "#{Time.now}: Error calling #{@service} service ... check that your account name and password are correct."
+      @response = error.to_hash
+      @response[:result_code] = 'Error'
+      @response[:summary] = @response[:fault][:faultcode]
+      @response[:details] = @response[:fault][:faultstring]   
+      return @response
     end
   end
 end

data/test/test_address.rb

@@ -8,8 +8,9 @@ credentials = Hash.new
 
 #Create new Address hash object
 address = Hash.new
+val_addr = Hash.new
 
-Shoes.app :width => 400, :height => 400 do
+Shoes.app :width => 400, :height => 460 do
   background orange
   border("#BE8",
   strokewidth: 6)
@@ -19,7 +20,9 @@ Shoes.app :width => 400, :height => 400 do
     para "Username:"
     @username = edit_line text: "USERNAME"
     para "Password:"
-    @password = edit_line text: "PASSWORD", :secret => true 
+    @password = edit_line text: "PASSWORD", :secret => true
+    para "Test Production:"
+    @use_production_account = edit_line text: "false" 
     para
     @confirm = button "Confirm"
     para
@@ -27,12 +30,18 @@ Shoes.app :width => 400, :height => 400 do
       credentials[:username] = @username.text
       credentials[:password] = @password.text
       credentials[:name] = 'Avalara Inc.'
-      credentials[:clientname] = 'MyShoppingCart'
-      credentials[:adapter] = 'Avatax SDK for Ruby 1.0.5'
+      credentials[:clientname] = ''
+      credentials[:adapter] = ''
       credentials[:machine] = 'Lenovo W520 Windows 7'
+      if @use_production_account.text == 'true' then
+       credentials[:use_production_account] = !!@use_production_account
+      else
+       credentials[:use_production_account] = nil 
+      end
+       
       #Create an address service instance
       AddrService = AvaTax::AddressService.new(credentials)
-    
+      
       #Open a window to get the address to validate
       Shoes.app :width => 400, :height => 700, :title => "Avalara - Address Validation Tester" do
   
@@ -78,50 +87,62 @@ Shoes.app :width => 400, :height => 400 do
           address[:addresscode] = "123"
           
         #Call the validate service - passing the address as a Hash
-
         val_addr = AddrService.validate(address)
-
-     
-        if val_addr[:ResultCode] == "Success"
+ 
+        if val_addr[:validate_response][:validate_result][:result_code] == "Success"
           #Display validated result in a new window  
-          Shoes.app :width => 400, :height => 700, :left => 1000, :title => "Avalara - Address Validation Result" do
+          Shoes.app :width => 400, :height => 1000, :left => 1000, :title => "Avalara - Address Validation Result" do
           
             background orange..blue
-      
+    
             stack :margin => 10  do 
               #Display result
-              para "Line 1:"
-              edit_line :text => val_addr[:Line1]
+              para "Line 1:"          
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:line1]            
               para "Line 2:"
-              edit_line :text => val_addr[:Line2]
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:line2]
               para "Line 3:"
-              edit_line :text => val_addr[:Line3]
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:line3]
               para "City"
-              edit_line :text => val_addr[:City]
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:city]
               para "State" 
-              edit_line :text => val_addr[:Region] 
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:region] 
               para "Zip" 
-              edit_line :text => val_addr[:PostalCode]
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:postal_code]         
               para "Country"
-              edit_line :text => val_addr[:Country]
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:country]
+              para
+              para "Latitude"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:latitude]
+              para "Longitude"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:longitude]
+              para "County"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:county]
+              para "FIPS Code"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:fips_code]
+              para "Carrier Route"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:carrier_route]
+              para "Post Net"
+              edit_line :text => val_addr[:validate_response][:validate_result][:valid_addresses][:valid_address][:post_net]                                             
             end
           end   
-        else
+        else   
           #Display error message in a new window  
           Shoes.app :width => 400, :height => 500, :title => "Address Validation Error" do
           
             background orange..red
        
-            if val_addr[:ResultCode] == "Error"
+            if val_addr[:validate_response][:validate_result][:result_code] == "Error"
+           
               stack  :margin => 10  do 
                 #Dispay error details 
-                para "RESULT: #{val_addr[:ResultCode]}"
-                para "SUMMARY: #{val_addr[:Summary]}"
-                para "DETAILS: #{val_addr[:Details]}"
-                para "HELP LINK: #{val_addr[:Helplink]}"
-                para "REFERS TO: #{val_addr[:RefersTo]}"
-                para "SEVERITY: #{val_addr[:Severity]}"
-                para "SOURCE #{val_addr[:Source]}"
+                para "RESULT: #{val_addr[:validate_response][:validate_result][:result_code]}"
+                para "SUMMARY: #{val_addr[:validate_response][:validate_result][:messages][:message][:summary]}"
+                para "DETAILS: #{val_addr[:validate_response][:validate_result][:messages][:message][:details]}"
+                para "HELP LINK: #{val_addr[:validate_response][:validate_result][:messages][:message][:help_link]}"
+                para "REFERS TO: #{val_addr[:validate_response][:validate_result][:messages][:message][:refers_to]}"
+                para "SEVERITY: #{val_addr[:validate_response][:validate_result][:messages][:message][:severity]}"
+                para "SOURCE #{val_addr[:validate_response][:validate_result][:messages][:message][:source]}"
               end
             else
               #Dispay error details
@@ -129,8 +150,8 @@ Shoes.app :width => 400, :height => 400 do
               para "SUMMARY: Unexpected error"
               para "DETAILS: An unexpected error has occurred ... please check address_log.txt for details"
             end  
-         end    
+         end   
       end}
    end}
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Avatax_AddressService
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Graham S Wilson
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -51,9 +37,6 @@ files:
 - lib/template_validate.erb
 - lib/template_ping.erb
 - lib/template_isauthorized.erb
-- lib/xpath_validate.txt
-- lib/xpath_ping.txt
-- lib/xpath_isauthorized.txt
 - test/test_address.rb
 - Avatax_AddressService.gemspec
 - Avatax Ruby SDK Guide.docx

data/lib/xpath_isauthorized.txt

@@ -1,4 +0,0 @@
-//TransactionId
-//ResultCode
-//Operations
-//Expires

data/lib/xpath_ping.txt

@@ -1,9 +0,0 @@
-//TransactionId
-//ResultCode
-//Summary
-//Details
-//Helplink
-//RefersTo
-//Severity
-//Source
-//Version

data/lib/xpath_validate.txt

@@ -1,29 +0,0 @@
-//TransactionId
-//ResultCode
-//Summary
-//Details
-//Helplink
-//RefersTo
-//Severity
-//Source
-//AddressCode
-//Line1
-//Line2
-//Line3
-//Line4
-//City
-//Region
-//PostalCode
-//Country
-//TaxRegionId
-//Latitude
-//Longitude
-//County
-//FipsCode
-//CarrierRoute
-//PostNet
-//AddressType
-//Longitude
-//ValidateStatus
-//Geocode
-//Taxable