Avatax_AddressService 1.0.12 → 2.0.1

data/lib/avatax_addressservice.rb

@@ -1,200 +1,188 @@
-require 'savon'
-require 'erb'
-
-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]  
-      if username.nil? and password.nil?   
-        raise ArgumentError, "username and password are required"
-      end
-      name = credentials[:name]
-      clientname = credentials[:clientname]
-      adapter = credentials[:adapter]      
-      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 or clientname == "") ? "AvataxRubySDK" : clientname
-      @adapter = (adapter == nil or adapter == "") ? spec.summary + spec.version.to_s : adapter
-      @machine = machine == nil ? "" : machine
-      @use_production_account = (use_production_account != true) ? false : use_production_account
-
-      #Open Avatax Error Log
-      @log = File.new(@def_locn + '/address_log.txt', "w")
-      
-      #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
-        @template_ping = ERB.new(File.read(@def_locn + '/template_ping.erb'))
-      rescue
-        @log.puts "#{Time.now}: Error loading the Ping template"
-      end
-
-      begin
-      #Read in the SOAP template for Validate
-        @template_validate = ERB.new(File.read(@def_locn + '/template_validate.erb'))
-      rescue
-        @log.puts "#{Time.now}: Error loading the Validate template"
-      end
-
-      begin
-      #Read in the SOAP template for IsAuthorized
-        @template_isauthorized = ERB.new(File.read(@def_locn + '/template_isauthorized.erb'))
-      rescue
-        @log.puts "#{Time.now}: Error loading the IsAuthorized template"
-      end
-      
-      # 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
-
-      # Subsitute real vales for template place holders
-      @soap = @template_ping.result(binding)
-
-      # Make the call to the Avalara Ping service
-      begin
-        @response = @client.call(:ping, xml: @soap).to_hash
-
-      #Strip off outer layer of the hash - not needed
-      return messages_to_array(@response[:ping_response][:ping_result])
-
-      
-      #Capture unexpected errors
-      rescue Savon::Error => error
-        abend(error)
-      end
-    end
-
-    ############################################################################################################
-    # validate - call the adddress validation service
-    ############################################################################################################
-    def validate(address)
-
-      @service = 'Validate'
-      
-      #create instance variables for each entry in input      
-      address.each do |k,v|
-        instance_variable_set("@#{k}",v)
-      end
-      #set required default values for missing required inputs
-      @taxregionid ||= "0"
-      @textcase ||= "Default"
-      @coordinates ||= false 
-      @taxability ||= false 
-      
-      # Subsitute real values for template place holders
-      @soap = @template_validate.result(binding)
-
-      # Make the call to the Avalara Validate service
-      begin
-        @response = @client.call(:validate, xml: @soap).to_hash
-
-      #Strip off outer layer of the hash - not needed
-      return messages_to_array(@response[:validate_response][:validate_result])
-
-      
-      #Capture unexpected errors
-      rescue Savon::Error => error
-        abend(error)
-      end
-    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)
-
-      # Make the call to the Avalara Ping service
-      begin
-        @response = @client.call(:is_authorized, xml: @soap).to_hash
-
-      #Strip off outer layer of the hash - not needed
-      return messages_to_array(@response[:is_authorized_response][:is_authorized_result])
-      
-      #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 messages_to_array(@response)
-    end
-    
-    ############################################################################################################
-    #standardizes error message format to an array of messages - nokogiri will collapse a single element array into the response hash.
-    ############################################################################################################
-    def messages_to_array(response)
-      if not response[:messages].nil? 
-        return response
-      end
-      # add the messages array to the response - if we got here, there was only one error.
-      response[:messages] = [{
-        :summary => response[:summary],
-        :details => response[:details],
-        :helplink => response[:helplink],
-        :refersto => response[:refersto],
-        :severity => response[:severity],
-        :source => response[:source]
-        }]
-      #remove all the error information from the hash  
-      response[:messages][0].each do |k,v|
-        response.delete(k)
-      end  
-      return response
-    end
-  end
+require 'savon'
+require 'erb'
+
+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] || ""
+      service_url = credentials[:service_url]   
+      if service_url.nil? or service_url.empty?
+        raise ArgumentError, "service_url is required"
+      end
+      name = credentials[:name] || ""
+      clientname = (credentials[:clientname].nil? or credentials[:clientname].empty? ) ? "AvataxRubySDK" : credentials[:clientname]
+      adapter = (credentials[:adapter].nil? or credentials[:adapter].empty?) ? spec.summary + spec.version.to_s : credentials[:adapter] 
+      machine = credentials[:machine] || ""
+
+      
+      #Set credentials and Profile information
+      @username = username 
+      @password = password 
+      @name = name
+      @clientname = clientname
+      @adapter = adapter
+      @machine = machine 
+
+      #Open Avatax Error Log
+      @log = File.new(@def_locn + '/address_log.txt', "w")
+      
+      #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'
+      @log.puts "#{Time.now}: Avalara Address service started"
+      #log :false turns off HTTP logging
+      @client = Savon.client(wsdl: @def_locn + '/addressservice.wsdl', endpoint: URI.parse(service_url+"/Address/AddressSvc.asmx"), log: false)
+
+      begin
+      #Read in the SOAP template for Ping
+        @template_ping = ERB.new(File.read(@def_locn + '/template_ping.erb'))
+      rescue
+        @log.puts "#{Time.now}: Error loading the Ping template"
+      end
+
+      begin
+      #Read in the SOAP template for Validate
+        @template_validate = ERB.new(File.read(@def_locn + '/template_validate.erb'))
+      rescue
+        @log.puts "#{Time.now}: Error loading the Validate template"
+      end
+
+      begin
+      #Read in the SOAP template for IsAuthorized
+        @template_isauthorized = ERB.new(File.read(@def_locn + '/template_isauthorized.erb'))
+      rescue
+        @log.puts "#{Time.now}: Error loading the IsAuthorized template"
+      end
+      
+      # Create hash for result
+      @response = Hash.new
+    end
+
+    ############################################################################################################
+    # ping - Verifies connectivity to the web service and returns version information
+    ############################################################################################################
+    def ping(message = nil)
+
+      #Read in the SOAP template
+      @message = message == nil ? "?" : message
+
+      # Subsitute real vales for template place holders
+      @soap = @template_ping.result(binding)
+
+      # Make the call to the Avalara Ping service
+      begin
+        @response = @client.call(:ping, xml: @soap).to_hash
+
+      #Strip off outer layer of the hash - not needed
+      return messages_to_array(@response[:ping_response][:ping_result])
+
+      
+      #Capture unexpected errors
+      rescue Savon::Error => error
+        abend(error)
+      end
+    end
+
+    ############################################################################################################
+    # validate - call the adddress validation service
+    ############################################################################################################
+    def validate(address)
+      
+      #create instance variables for each entry in input      
+      address.each do |k,v|
+        instance_variable_set("@#{k}",v)
+      end
+      #set required default values for missing required inputs
+      @taxregionid ||= "0"
+      @textcase ||= "Default"
+      @coordinates ||= false 
+      @taxability ||= false 
+      
+      # Subsitute real values for template place holders
+      @soap = @template_validate.result(binding)
+
+      # Make the call to the Avalara Validate service
+      begin
+        @response = @client.call(:validate, xml: @soap).to_hash
+
+      #Strip off outer layer of the hash - not needed
+      return messages_to_array(@response[:validate_response][:validate_result])
+
+      
+      #Capture unexpected errors
+      rescue Savon::Error => error
+        abend(error)
+      end
+    end
+
+    ############################################################################################################
+    #Verifies connectivity to the web service and returns version information about the service.
+    ############################################################################################################
+    def isauthorized(operation = nil)
+      
+      #Read in the SOAP template
+      @operation = operation == nil ? "?" : operation
+
+      # Subsitute real vales for template place holders
+      @soap = @template_isauthorized.result(binding)
+
+      # Make the call to the Avalara Ping service
+      begin
+        @response = @client.call(:is_authorized, xml: @soap).to_hash
+
+      #Strip off outer layer of the hash - not needed
+      return messages_to_array(@response[:is_authorized_response][:is_authorized_result])
+      
+      #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 messages_to_array(@response)
+    end
+    
+    ############################################################################################################
+    #standardizes error message format to an array of messages - nokogiri will collapse a single element array into the response hash.
+    ############################################################################################################
+    def messages_to_array(response)
+      if not response[:messages].nil? 
+        return response
+      end
+      # add the messages array to the response - if we got here, there was only one error.
+      response[:messages] = [{
+        :summary => response[:summary],
+        :details => response[:details],
+        :helplink => response[:helplink],
+        :refersto => response[:refersto],
+        :severity => response[:severity],
+        :source => response[:source]
+        }]
+      #remove all the error information from the hash  
+      response[:messages][0].each do |k,v|
+        response.delete(k)
+      end  
+      return response
+    end
+  end
 end

data/lib/template_isauthorized.erb

@@ -1,22 +1,22 @@
-<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://avatax.avalara.com/services">
-   <soapenv:Header>
-      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
-         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
-            <wsse:Username><%= @username %></wsse:Username>
-            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"><%= @password %></wsse:Password>
-            <wsu:Created>2012-03-02T23:41:44.511Z</wsu:Created>
-         </wsse:UsernameToken>
-      </wsse:Security>
-      <ser:Profile>
-         <ser:Name><%= @name %></ser:Name>
-         <ser:Client><%= @clientname %></ser:Client>
-         <ser:Adapter><%= @adapter %></ser:Adapter>
-         <ser:Machine><%= @machine %></ser:Machine>
-      </ser:Profile>
-   </soapenv:Header>
-      <soapenv:Body>
-      <ser:IsAuthorized>
-         <ser:Operations><%= @operation %></ser:Operations>
-      </ser:IsAuthorized>
-   </soapenv:Body>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://avatax.avalara.com/services">
+   <soapenv:Header>
+      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+            <wsse:Username><%= @username %></wsse:Username>
+            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"><%= @password %></wsse:Password>
+            <wsu:Created>2012-03-02T23:41:44.511Z</wsu:Created>
+         </wsse:UsernameToken>
+      </wsse:Security>
+      <ser:Profile>
+         <ser:Name><%= @name %></ser:Name>
+         <ser:Client><%= @clientname %></ser:Client>
+         <ser:Adapter><%= @adapter %></ser:Adapter>
+         <ser:Machine><%= @machine %></ser:Machine>
+      </ser:Profile>
+   </soapenv:Header>
+      <soapenv:Body>
+      <ser:IsAuthorized>
+         <ser:Operations><%= @operation %></ser:Operations>
+      </ser:IsAuthorized>
+   </soapenv:Body>
 </soapenv:Envelope>

data/lib/template_ping.erb

@@ -1,22 +1,22 @@
-<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://avatax.avalara.com/services">
-   <soapenv:Header>
-      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
-         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
-            <wsse:Username><%= @username %></wsse:Username>
-            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"><%= @password %></wsse:Password>
-            <wsu:Created>2012-03-02T23:41:44.511Z</wsu:Created>
-         </wsse:UsernameToken>
-      </wsse:Security>
-      <ser:Profile>
-         <ser:Name><%= @name %></ser:Name>
-         <ser:Client><%= @clientname %></ser:Client>
-         <ser:Adapter><%= @adapter %></ser:Adapter>
-         <ser:Machine><%= @machine %></ser:Machine>
-      </ser:Profile>
-   </soapenv:Header>
-   <soapenv:Body>
-      <ser:Ping>
-         <ser:Message><%= @ping_message %></ser:Message>
-      </ser:Ping>
-   </soapenv:Body>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://avatax.avalara.com/services">
+   <soapenv:Header>
+      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+            <wsse:Username><%= @username %></wsse:Username>
+            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"><%= @password %></wsse:Password>
+            <wsu:Created>2012-03-02T23:41:44.511Z</wsu:Created>
+         </wsse:UsernameToken>
+      </wsse:Security>
+      <ser:Profile>
+         <ser:Name><%= @name %></ser:Name>
+         <ser:Client><%= @clientname %></ser:Client>
+         <ser:Adapter><%= @adapter %></ser:Adapter>
+         <ser:Machine><%= @machine %></ser:Machine>
+      </ser:Profile>
+   </soapenv:Header>
+   <soapenv:Body>
+      <ser:Ping>
+         <ser:Message><%= @ping_message %></ser:Message>
+      </ser:Ping>
+   </soapenv:Body>
 </soapenv:Envelope>