Add /address-similarity

Author: jkho

.gitignore

@@ -11,6 +11,9 @@
 /test/version_tmp/
 /tmp/
 
+# Jetbrains
+**/.idea/*
+
 ## Specific to RubyMotion:
 .dat*
 .repl_history

.rubocop.yml

@@ -143,6 +143,7 @@ Style/FrozenStringLiteralComment:
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
+    - 'lib/address_similarity_parameters.rb'
     - 'lib/name_similarity_parameters.rb'
     - 'lib/name_translation_parameters.rb'
     - 'lib/request_builder.rb'
@@ -230,6 +231,8 @@ Style/RaiseArgs:
 # Cop supports --auto-correct.
 Style/RedundantSelf:
   Exclude:
+    - 'lib/address_parameter.rb'
+    - 'lib/address_similarity_parameters.rb'
     - 'lib/document_parameters.rb'
     - 'lib/name_parameter.rb'
     - 'lib/name_similarity_parameters.rb'
@@ -239,6 +242,7 @@ Style/RedundantSelf:
 # Cop supports --auto-correct.
 Style/SpaceAfterColon:
   Exclude:
+    - 'examples/address_similarity.rb'
     - 'examples/name_similarity.rb'
 
 # Offense count: 2
@@ -265,6 +269,7 @@ Style/SpaceInsideHashLiteralBraces:
 Style/StringLiterals:
   Exclude:
     - 'Gemfile'
+    - 'examples/address_similarity.rb'
     - 'examples/categories.rb'
     - 'examples/entities.rb'
     - 'examples/language.rb'
@@ -284,6 +289,7 @@ Style/StringLiterals:
 # SupportedStyles: final_newline, final_blank_line
 Style/TrailingBlankLines:
   Exclude:
+    - 'examples/address_similarity.rb'
     - 'examples/info.rb'
     - 'examples/language.rb'
     - 'examples/morphology_compound-components.rb'

LICENSE

@@ -1,6 +1,6 @@
 Basis Technology Corp
 
-Copyright (C) 2015-2015 by Basis Technology Corp and the contributors
+Copyright (C) 2015-2019 by Basis Technology Corp and the contributors
 
 Complete list of developers available at our web site:
 

examples/address_similarity.rb

@@ -0,0 +1,31 @@
+require 'rosette_api'
+
+api_key, url = ARGV
+
+if !url
+  rosette_api = RosetteAPI.new(api_key)
+else
+  rosette_api = RosetteAPI.new(api_key, url)
+end
+
+begin
+  address1 = AddressParameter.new(
+     'houseNumber': '1600',
+     'road': 'Pennsylvania Ave NW',
+     'city': 'Washington',
+     'state': 'DC',
+     'postCode': '20500'
+  )
+  address2 = AddressParameter.new(
+     'houseNumber': '160',
+     'road': 'Pennsilvana Avenue',
+     'city': 'Washington',
+     'state': 'D.C.',
+     'postCode': '20500'
+  )
+  params = AddressSimilarityParameters.new(address1, address2)
+  response = rosette_api.get_address_similarity(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => rosette_api_error
+  printf('Rosette API Error (%s): %s', rosette_api_error.status_code, rosette_api_error.message)
+end

examples/docker/run_ruby.sh

@@ -30,7 +30,7 @@ function checkAPI {
 
 #Checks for valid url
 function validateURL() {
-    match=$(curl "${ping_url}/ping" -H "X-RosetteAPI-Key: ${API_KEY}" |  grep -o "Rosette API")
+    match=$(curl "${ping_url}/ping" -H "X-RosetteAPI-Key: ${API_KEY}" |  grep -o "Rosette at your service")
     if [ "${match}" = "" ]; then
         echo -e "\n${ping_url} server not responding\n"
         exit 1

lib/address_parameter.rb

@@ -0,0 +1,115 @@
+# This class represents an address in Rosette API.
+class AddressParameter
+	# house (optional)
+        attr_accessor :house
+	# houseNumber (optional)
+        attr_accessor :houseNumber
+	# road (optional)
+        attr_accessor :road
+	# unit (optional)
+        attr_accessor :unit
+	# level (optional)
+        attr_accessor :level
+	# staircase (optional)
+        attr_accessor :staircase
+	# entrance (optional)
+        attr_accessor :entrance
+	# suburb (optional)
+        attr_accessor :suburb
+	# cityDistrict (optional)
+        attr_accessor :cityDistrict
+	# city (optional)
+        attr_accessor :city
+	# island (optional)
+        attr_accessor :island
+	# stateDistrict (optional)
+        attr_accessor :stateDistrict
+	# state (optional)
+        attr_accessor :state
+	# countryRegion (optional)
+        attr_accessor :countryRegion
+	# country (optional)
+        attr_accessor :country
+	# worldRegion (optional)
+        attr_accessor :worldRegion
+	# postCode (optional)
+        attr_accessor :postCode
+	# poBox (optional)
+        attr_accessor :poBox
+
+  def initialize(options = {}) #:notnew:
+    options = {
+        house: nil,
+        houseNumber: nil,
+        road: nil,
+        unit: nil,
+        level: nil,
+        staircase: nil,
+        entrance: nil,
+        suburb: nil,
+        cityDistrict: nil,
+        city: nil,
+        island: nil,
+        stateDistrict: nil,
+        state: nil,
+        countryRegion: nil,
+        country: nil,
+        worldRegion: nil,
+        postCode: nil,
+        poBox: nil
+    }.update options
+    @house = options[:house]
+    @houseNumber = options[:houseNumber]
+    @road = options[:road]
+    @unit = options[:unit]
+    @level = options[:level]
+    @staircase = options[:staircase]
+    @entrance = options[:entrance]
+    @suburb = options[:suburb]
+    @cityDistrict = options[:cityDistrict]
+    @city = options[:city]
+    @island = options[:island]
+    @stateDistrict = options[:stateDistrict]
+    @state = options[:state]
+    @countryRegion = options[:countryRegion]
+    @country = options[:country]
+    @worldRegion = options[:worldRegion]
+    @postCode = options[:postCode]
+    @poBox = options[:poBox]
+  end
+  
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_param
+    to_hash.select { |_key, value| value }
+           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+           .to_h
+  end
+
+  # Converts this class to Hash.
+  #
+  # Returns the new Hash.
+  def to_hash
+    {
+        house: @house,
+        houseNumber: @houseNumber,
+        road: @road,
+        unit: @unit,
+        level: @level,
+        staircase: @staircase,
+        entrance: @entrance,
+        suburb: @suburb,
+        cityDistrict: @cityDistrict,
+        city: @city,
+        island: @island,
+        stateDistrict: @stateDistrict,
+        state: @state,
+        countryRegion: @countryRegion,
+        country: @country,
+        worldRegion: @worldRegion,
+        postCode: @postCode,
+        poBox: @poBox
+    }
+  end
+end

lib/address_similarity_parameters.rb

@@ -0,0 +1,42 @@
+require_relative 'bad_request_error'
+require_relative 'address_parameter'
+
+# This class encapsulates parameters that are needed for address-similarity in
+# Rosette API.
+class AddressSimilarityParameters
+  # Address to be compared to address2
+  attr_accessor :address1
+  # Address to be compared to address1
+  attr_accessor :address2
+
+  def initialize(address1, address2) #:notnew:
+    @address1 = address1
+    @address2 = address2
+  end
+
+  # Validates the parameters by checking if address1 and address2 are instances of AddressParameter.
+  def validate_params
+    raise BadRequestError.new('address1 option can only be an instance of an AddressParameter') if [AddressParameter].none? { |clazz| @address1.is_a? clazz }
+    raise BadRequestError.new('address2 option can only be an instance of an AddressParameter') if [AddressParameter].none? { |clazz| @address2.is_a? clazz }
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_params
+    validate_params
+    to_hash.reject { |_key, value| value.nil? }
+           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+           .to_h
+  end
+
+  # Converts this class to Hash.
+  #
+  # Returns the new Hash.
+  def to_hash
+    {
+      address1: @address1.is_a?(AddressParameter) ? @address1.load_param : @address1,
+      address2: @address2.is_a?(AddressParameter) ? @address2.load_param : @address2
+    }
+  end
+end

lib/rosette_api.rb

@@ -3,14 +3,15 @@
 require_relative 'name_deduplication_parameters'
 require_relative 'name_translation_parameters'
 require_relative 'name_similarity_parameters'
+require_relative 'address_similarity_parameters'
 require_relative 'rosette_api_error'
 require_relative 'bad_request_error'
 require_relative 'bad_request_format_error'
 
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.12.1'
+  BINDING_VERSION = '1.14.3'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'.freeze
   # Rosette API morphology endpoint
@@ -29,6 +30,8 @@ class RosetteAPI
   NAME_TRANSLATION_ENDPOINT = '/name-translation'.freeze
   # Rosette API name-similarity endpoint
   NAME_SIMILARITY_ENDPOINT = '/name-similarity'.freeze
+  # Rosette API address-similarity endpoint
+  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'.freeze
   # Rosette API tokens endpoint
   TOKENS_ENDPOINT = '/tokens'.freeze
   # Rosette API sentences endpoint
@@ -289,6 +292,22 @@ def get_name_similarity(params)
                   .send_post_request
   end
 
+  # Compares two addresses and returns a match score from 0 to 1.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - AddressSimilarityParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns the confidence score of matching 2 addresses.
+  def get_address_similarity(params)
+    check_params params, 'Expects a AddressSimilarityParameters type as an argument', AddressSimilarityParameters
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + ADDRESS_SIMILARITY_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+                  .send_post_request
+  end
+
   # Divides the input into tokens.
   #
   # ==== Attributes

rosette_api.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
 
   s.name               = 'rosette_api'
-  s.version            = '1.12.1'
+  s.version            = '1.14.3'
   s.license            = 'MIT'
 
   s.summary       = 'Rosette API gem that supports multilingual text-analytics.'