Avatax_AddressService 1.0.4 → 1.0.5

data/Avatax_AddressService.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "Avatax_AddressService"
-  s.version = "1.0.4"
-  s.date = "2012-10-28"
+  s.version = "1.0.5"
+  s.date = "2012-12-16"
   s.author = "Graham S Wilson"
   s.email = "support@Avalara.com"
   s.summary = "Ruby SDK for Avatax Address Web Services"

data/lib/avatax_addressservice.rb

@@ -3,178 +3,187 @@ require 'erb'
 require 'nokogiri'
 
 module AvaTax
-
   #Avalara address class
-  class AddressService 
-        
-    def initialize(username,password,name,clientname,adapter,machine)
-            
-        #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 
-        @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"
-               
-        #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)
-       
-        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 validate result
-        @return_data = Hash.new
+  class AddressService
+    def initialize(credentials)
+      
+      #Extract data from hash
+      username = credentials[:username]
+      password = credentials[:password]      
+      name = credentials[:name]
+      clientname = credentials[:clientname]
+      adapter = credentials[:adapter]      
+      machine = credentials[:machine]      
+      
+      #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
+      @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"
+
+      #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)
+
+      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 validate result
+      @return_data = Hash.new
     end
 
-    ############################################################################################################    
-    # ping - Verifies connectivity to the web service and returns version information 
-    ############################################################################################################   
+    ############################################################################################################
+    # ping - Verifies connectivity to the web service and returns version information
+    ############################################################################################################
     def ping(message = nil)
       #Read in the SOAP template
-      @message = message == nil ? "?" : message 
+      @message = message == nil ? "?" : message
 
-      # Subsitute real vales for template place holders  
+      # Subsitute real vales for template place holders
       @soap = @template_ping.result(binding)
-          
+
       #Clear return hash
       @return_data.clear
-      
+
       # 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" 
+      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 
+      @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}
-   
+
       return @return_data
     end
 
     ############################################################################################################
     # validate - call the adddress validation service
     ############################################################################################################
-    def validate(addresscode = nil,
-                  line1 = nil,
-                  line2 = nil,
-                  line3 = nil,
-                  city = nil,
-                  region = nil,
-                  postalcode = nil,
-                  country = nil,
-                  taxregionid = nil,
-                  latitude = nil,
-                  longitude = nil,
-                  textcase = nil,
-                  coordinates = nil,
-                  taxability = nil) 
-      
-        #Set parms passed by user - If Nil then default else use passed value
-        @addresscode = addresscode == nil ? "123" : addresscode 
-        @line1 = line1 == nil ? "" : line1
-        @line2 = line2 == nil ? "" : line2
-        @line3 = line3 == nil ? "" : line3 
-        @city = city == nil ? "" : city 
-        @region = region == nil ? "" : region
-        @postalcode = postalcode == nil ? "" : postalcode
-        @country = country == nil ? "" : country
-        @taxregionid = taxregionid == nil ? "0" : taxregionid
-        @latitude = latitude == nil ? "" : latitude
-        @longitude = longitude == nil ? "" : longitude
-        @textcase = textcase == nil ? "Default" : textcase
-        @coordinates = coordinates == nil ? "true" : coordinates
-        @taxability = taxability == nil ? "false" : taxability
-      
-        # 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
-
-          rescue
-            @log.puts "#{Time.now}: Error calling Validate 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 
-        @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
+    def validate(address)
+
+      #Extract data from hash
+      addresscode = address[:addresscode]
+      line1 = address[:line1]
+      line2 = address[:line2]
+      line3 = address[:line3]
+      city = address[:city]
+      region = address[:region]
+      postalcode = address[:postalcode]
+      country = address[:country]
+      taxregionid = address[:taxregionid]
+      latitude = address[:latitude]
+      longitude = address[:longitude]
+      textcase = address[:textcase]
+      coordinates = address[:coordinates]
+      taxability = address[:taxability]
+
+      #Set parms passed by user - If Nil then default else use passed value
+      @addresscode = addresscode == nil ? "123" : addresscode
+      @line1 = line1 == nil ? "" : line1
+      @line2 = line2 == nil ? "" : line2
+      @line3 = line3 == nil ? "" : line3
+      @city = city == nil ? "" : city
+      @region = region == nil ? "" : region
+      @postalcode = postalcode == nil ? "" : postalcode
+      @country = country == nil ? "" : country
+      @taxregionid = taxregionid == nil ? "0" : taxregionid
+      @latitude = latitude == nil ? "" : latitude
+      @longitude = longitude == nil ? "" : longitude
+      @textcase = textcase == nil ? "Default" : textcase
+      @coordinates = coordinates == nil ? "true" : coordinates
+      @taxability = taxability == nil ? "false" : taxability
+
+      # 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
+
+      rescue
+        @log.puts "#{Time.now}: Error calling Validate 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
+      @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)
       #Read in the SOAP template
-      @operation = operation == nil ? "?" : operation 
+      @operation = operation == nil ? "?" : operation
 
-      # Subsitute real vales for template place holders  
+      # Subsitute real vales for template place holders
       @soap = @template_isauthorized.result(binding)
-          
-       #Clear return hash
+
+      #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" 
+      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 
+      @doc = Nokogiri::XML(@response).remove_namespaces!
+
+      #Read in an array of XPATH pointers
       @isauthorized_xpath = File.readlines(@def_locn + '\xpath_isauthorized.txt')
-      
+
       #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
     end
-  end  
+  end
 end

data/test/test_address.rb

@@ -3,6 +3,12 @@ require 'avatax_addressservice'
 #require green_shoes for the GUI
 require 'green_shoes'
 
+#Create new Credentials hash object
+credentials = Hash.new
+
+#Create new Address hash object
+address = Hash.new
+
 Shoes.app :width => 400, :height => 400 do
   background orange
   border("#BE8",
@@ -11,19 +17,21 @@ Shoes.app :width => 400, :height => 400 do
     para
     para "Enter Avalara credentials"
     para "Username:"
-    @username = edit_line
+    @username = edit_line text: "USERNAME"
     para "Password:"
-    @password = edit_line :secret => true 
+    @password = edit_line text: "PASSWORD", :secret => true 
     para
     @confirm = button "Confirm"
     para
     @confirm.click { 
-      name = 'Avalara Inc.'
-      clientname = 'MyShoppingCart'
-      adapter = 'Avatax SDK for Ruby 1.0.1'
-      machine = 'Lenovo W520 Windows 7'
+      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[:machine] = 'Lenovo W520 Windows 7'
       #Create an address service instance
-      AddrService = AvaTax::AddressService.new(@username.text,@password.text,name,clientname,adapter,machine)
+      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
@@ -59,10 +67,19 @@ Shoes.app :width => 400, :height => 400 do
         
         #When the user clicks the Validate button then call the Validate service
         @validate.click {
+          address[:line1] = @line1.text
+          address[:line2] = @line2.text
+          address[:line3] = @line3.text
+          address[:city] = @city.text
+          address[:region] =  @state.text
+          address[:postalcode] = @zip.text
+          address[:country]= @country.text
+          address[:textcase] = @textcase
+          address[:addresscode] = "123"
+          
+        #Call the validate service - passing the address as a Hash
 
-
-        #Call the validate service
-       val_addr = AddrService.validate(nil, @line1.text, nil, nil, @city.text, @state.text, @zip.text, 'US', nil, nil, nil, @textcase, nil, nil)
+        val_addr = AddrService.validate(address)
 
      
         if val_addr[:ResultCode] == "Success"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Avatax_AddressService
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri