addressfinder 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7560a344ccda446dd9416a1bdd2a46b2e78a4c01fdbd84a17336ce7afa02f23
-  data.tar.gz: 1b1a9d50c4a624663f9aa16a783634257ddec64677c45ab2c6108059709d2636
+  metadata.gz: 8e9d77bd22770090ef74d02d1b2135dd3504130442b4a5dfd0de17b90661c468
+  data.tar.gz: 91f162b6b301ff9f86c3253f8a37c89c5d5f9f8781dd8e674f49a8f6624cd2ff
 SHA512:
-  metadata.gz: 860546a06124a3e95c1c34a357c323a6500e8f9950c1d87a1963f05fdbbe3405f804f1392b0d62380ed87405e44ae1b196dc426c807ff21c527b2aaa9b36e353
-  data.tar.gz: 4a954a4bd36d77ac017daa151182a0e7801dcc9c87883c01945993cab90ecd51162826af42cbee427c547e061b84fe0c4fc61d7c9c075a136d47bafc2001ab41
+  metadata.gz: 076b5eb2c9d1200713f7952a631b70852071db5e31321c89c31264b134fd2e4ebb8e40f5820fa97fb9a4c3b43fa0c71b714c656018458a6aa02d5e0d92c20ae6
+  data.tar.gz: 651f98846af6d9d31ab6cb135775f6e0cae3855e8d6031aeef342e1a4d7983bd3389432123bd4b7b01b207029632e325fbb73c703e15ba27da2a471e5099a40d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Addressfinder 1.13.0 (September 2024) #
+
+* Add client agent versioning
+
 # Addressfinder 1.12.0 (May 2024) #
 
 * Add a batch capability with concurrency for Address Verification

data/README.md

@@ -61,10 +61,10 @@ For available parameters and example responses, see the API documentation pages
 To verify a single New Zealand address, use the following method:
 
 ```ruby
-result = AddressFinder.address_verification(q: '186 Willis St, Wellington', country: 'nz')
+result = AddressFinder.address_verification(q: "186 Willis St, Wellington", country: "nz")
 
 if result
-  $stdout.puts "Success: #{result.postal}"
+  $stdout.puts "Success: '#{result.a}'"
 else
   $stdout.puts "Sorry, can't find that address"
 end
@@ -74,15 +74,16 @@ You can also verify a batch of New Zealand addresses using the following method.
 We suggest that you send up to 100 addresses in each batch. 
 
 ```ruby
-result = AddressFinder.address_verification_nz_batch(addresses: [
-  "186 Willis St, Wellington", 
-  "1 Ghuznee St, Te Aro, Wellington 6011"
-], concurrency: 5)
+addresses = ["186 Willis St, Wellington", "1 Ghuznee St, Te Aro, Wellington 6011", "bad address"]
 
-if result
-  $stdout.puts "Success: #{result.postal}"
-else
-  $stdout.puts "Sorry, can't find that address"
+results = AddressFinder.address_verification_nz_batch(addresses: addresses, concurrency: 10)
+
+results.each_with_index do |result, index|
+  if result
+    $stdout.puts "Success: matched '#{addresses[index]}' with '#{result.a}'"
+  else
+    $stdout.puts "Sorry, can't find address: '#{addresses[index]}'"
+  end
 end
 ```
 
@@ -106,15 +107,16 @@ You can also verify a batch of Australian addresses using the following method:
 We suggest that you send up to 100 addresses in each batch. 
 
 ```ruby
-result = AddressFinder.address_verification_au_batch(addresses: [
-  "10/274 Harbour Drive, Coffs Harbour NSW 2450",
-  "49 CORNISH ST, COBAR NSW 2835"
-], gnaf: "1", concurrency: 5)
+addresses = ["10/274 Harbour Drive, Coffs Harbour NSW 2450", "49 CORNISH ST, COBAR NSW 2835", "bad address"]
 
-if result
-  $stdout.puts "Success: #{result.full_address}"
-else
-  $stdout.puts "Sorry, can't find that address"
+results = AddressFinder.address_verification_au_batch(addresses: addresses, gnaf: "1", concurrency: 10)
+
+results.each_with_index do |result, index|
+  if result
+    $stdout.puts "Success: matched '#{addresses[index]}' with '#{result.a}'"
+  else
+    $stdout.puts "Sorry, can't find address: '#{addresses[index]}'"
+  end
 end
 ```
 

data/demo/verification/README.md

@@ -29,10 +29,12 @@ You can obtain an API key by registering for a free trial account at https://add
 
 ## Example execution
 
-> `export AF_KEY=XXXXXXXXXXXXXXX`
-> `bundle exec ruby process_nz_address_csv.rb sample_addresses_nz.csv`
+Processing a CSV file of New Zealand address records:
 
 ```
+> export AF_KEY=XXXXXXXXXXXXXXX
+> export AF_SECRET=YYYYYYYYYYYYYYY
+> bundle exec ruby process_nz_address_csv.rb sample_addresses_nz.csv
 address_id,address_query,address_query_length,full_address,address_id
 1,133 wilton road wilton wellington,33,"133 Wilton Road, Wilton, Wellington 6012",2-.F.1W.v.Torm
 2,1 ghuznee st te aro wellington 6011,35,"1 Ghuznee Street, Te Aro, Wellington 6011",2-2eNwG1oBJExni2nUFJm1cW
@@ -43,9 +45,10 @@ address_id,address_query,address_query_length,full_address,address_id
 # ...
 ```
 
-> `bundle exec ruby process_au_address_csv.rb sample_addresses_au.csv`
+Processing a CSV file of Australian address records:
 
 ```
+> bundle exec ruby process_au_address_csv.rb sample_addresses_au.csv
 address_id,address_query,address_query_length,full_address,address_id
 1,"10/274 harbour drive, coffs harbour NSW 2450",44,"Unit 10, 274 Harbour Drive, COFFS HARBOUR NSW 2450",670cd8c3-b883-ee24-2874-74440e515b80
 2,"9/274 harbour drive, coffs harbour NSW 2450",43,"Unit 9, 274 Harbour Drive, COFFS HARBOUR NSW 2450",42ae5625-d679-266b-5d66-5ece6bbfb179

data/lib/addressfinder/address_autocomplete.rb

@@ -44,9 +44,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/address_info.rb

@@ -37,9 +37,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/address_search.rb

@@ -37,9 +37,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/configuration.rb

@@ -14,6 +14,7 @@ module AddressFinder
     attr_accessor :domain
     attr_accessor :retries
     attr_accessor :retry_delay
+    attr_accessor :ca
 
     def initialize
       self.hostname = 'api.addressfinder.io'
@@ -23,6 +24,7 @@ module AddressFinder
       self.retry_delay = 5
       self.default_country = 'nz'
       self.verification_version = 'v1'
+      self.ca = "Ruby/#{AddressFinder::VERSION}"
     end
   end
 end

data/lib/addressfinder/http.rb

@@ -15,11 +15,15 @@ module AddressFinder
       end
     end
 
-    def request(args)
+    def request(request_uri)
       retries = 0
       begin
         re_establish_connection if @connection_is_bad
-        net_http.request(args)
+
+        uri = build_uri(request_uri)
+        request = Net::HTTP::Get.new(uri)
+
+        net_http.request(request)
       rescue Net::ReadTimeout, Net::OpenTimeout, SocketError => error
         if retries < config.retries
           retries += 1
@@ -40,6 +44,19 @@ module AddressFinder
       net_http.start
     end
 
+    def build_uri(request_uri)
+      uri = URI(request_uri)
+      encoded_ca = URI.encode_www_form_component(config.ca)
+
+      if uri.query
+        uri.query += "&ca=#{encoded_ca}"
+      else
+        uri.query = "ca=#{encoded_ca}"
+      end
+
+      uri.to_s
+    end
+
     def net_http
       @net_http ||= begin
         http = Net::HTTP.new(config.hostname, config.port, config.proxy_host,

data/lib/addressfinder/location_info.rb

@@ -38,9 +38,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/location_search.rb

@@ -38,9 +38,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/v1/base.rb

@@ -20,12 +20,12 @@ module AddressFinder
         build_request
         execute_request
         build_result
-  
+
         self
       end
 
       private
-  
+
       attr_reader :request_uri, :params, :http, :path
       attr_accessor :response_body, :response_status
       attr_writer :result
@@ -33,20 +33,18 @@ module AddressFinder
       def build_request
         @request_uri = "#{path}?#{encoded_params}"
       end
-  
+
       def encoded_params
         Util.encode_and_join_params(params)
       end
-  
+
       def execute_request
-        request = Net::HTTP::Get.new(request_uri)
-  
-        response = http.request(request)
-  
+        response = http.request(request_uri)
+
         self.response_body = response.body
         self.response_status = response.code
       end
-  
+
       def build_result
         case response_status
         when '200'
@@ -55,15 +53,15 @@ module AddressFinder
           raise AddressFinder::RequestRejectedError.new(response_status, response_body)
         end
       end
-  
+
       def response_hash
         @_response_hash ||= MultiJson.load(response_body)
       end
-  
+
       def config
         @_config ||= AddressFinder.configuration
       end
-  
+
       class Result < OpenStruct
       end
     end

data/lib/addressfinder/v2/au/verification.rb

@@ -56,9 +56,7 @@ module AddressFinder
         end
 
         def execute_request
-          request = Net::HTTP::Get.new(request_uri)
-
-          response = http.request(request)
+          response = http.request(request_uri)
 
           self.response_body = response.body
           self.response_status = response.code

data/lib/addressfinder/verification.rb

@@ -61,9 +61,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = "1.12.0"
+  VERSION = "1.13.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Provides easy access to Addressfinder APIs