DEVOPS-247: Address rubocop issues.

Author: seth-mg

.rubocop_todo.yml

@@ -1,31 +1,31 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-11-03 23:25:34 +0000 using RuboCop version 0.76.0.
+# on 2019-11-04 18:38:39 +0000 using RuboCop version 0.76.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 4
 Metrics/AbcSize:
   Max: 44
 
-# Offense count: 8
+# Offense count: 10
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 707
+  Max: 786
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 218
+  Max: 228
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 9
+# Offense count: 11
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 51
@@ -39,10 +39,12 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Max: 8
 
-# Offense count: 8
+# Offense count: 10
 # Rubocop not hip to RDoc directives.
 Style/CommentedKeyword:
   Exclude:
+    - 'lib/address_parameter.rb'
+    - 'lib/address_similarity_parameters.rb'
     - 'lib/bad_request_error.rb'
     - 'lib/bad_request_format_error.rb'
     - 'lib/document_parameters.rb'
@@ -67,14 +69,14 @@ Style/IfUnlessModifier:
   Exclude:
     - 'lib/rosette_api.rb'
 
-# Offense count: 12
+# Offense count: 14
 # Cop supports --auto-correct.
 # Configuration parameters: .
 # SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact
 
-# Offense count: 9
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

examples/address_similarity.rb

@@ -1,31 +1,35 @@
+# frozen_string_literal: true
+
 require 'rosette_api'
 
 api_key, url = ARGV
 
-if !url
-  rosette_api = RosetteAPI.new(api_key)
-else
-  rosette_api = RosetteAPI.new(api_key, url)
-end
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
 
 begin
   address1 = AddressParameter.new(
-     'houseNumber': '1600',
-     'road': 'Pennsylvania Ave NW',
-     'city': 'Washington',
-     'state': 'DC',
-     'postCode': '20500'
+    'house_number': '1600',
+    'road': 'Pennsylvania Ave NW',
+    'city': 'Washington',
+    'state': 'DC',
+    'post_code': '20500'
   )
   address2 = AddressParameter.new(
-     'houseNumber': '160',
-     'road': 'Pennsilvana Avenue',
-     'city': 'Washington',
-     'state': 'D.C.',
-     'postCode': '20500'
+    'house_number': '160',
+    'road': 'Pennsilvana Avenue',
+    'city': 'Washington',
+    'state': 'D.C.',
+    'post_code': '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)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
 end

lib/address_parameter.rb

@@ -1,83 +1,85 @@
+# frozen_string_literal: true
+
 # 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
+  # house (optional)
+  attr_accessor :house
+  # house_number (optional)
+  attr_accessor :house_number
+  # 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
+  # city_district (optional)
+  attr_accessor :city_district
+  # city (optional)
+  attr_accessor :city
+  # island (optional)
+  attr_accessor :island
+  # state_district (optional)
+  attr_accessor :state_district
+  # state (optional)
+  attr_accessor :state
+  # country_region (optional)
+  attr_accessor :country_region
+  # country (optional)
+  attr_accessor :country
+  # world_region (optional)
+  attr_accessor :world_region
+  # post_code (optional)
+  attr_accessor :post_code
+  # po_box (optional)
+  attr_accessor :po_box
 
   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
+      house: nil,
+      house_number: nil,
+      road: nil,
+      unit: nil,
+      level: nil,
+      staircase: nil,
+      entrance: nil,
+      suburb: nil,
+      city_district: nil,
+      city: nil,
+      island: nil,
+      state_district: nil,
+      state: nil,
+      country_region: nil,
+      country: nil,
+      world_region: nil,
+      post_code: nil,
+      po_box: nil
     }.update options
     @house = options[:house]
-    @houseNumber = options[:houseNumber]
+    @house_number = options[:house_number]
     @road = options[:road]
     @unit = options[:unit]
     @level = options[:level]
     @staircase = options[:staircase]
     @entrance = options[:entrance]
     @suburb = options[:suburb]
-    @cityDistrict = options[:cityDistrict]
+    @city_district = options[:city_district]
     @city = options[:city]
     @island = options[:island]
-    @stateDistrict = options[:stateDistrict]
+    @state_district = options[:state_district]
     @state = options[:state]
-    @countryRegion = options[:countryRegion]
+    @country_region = options[:country_region]
     @country = options[:country]
-    @worldRegion = options[:worldRegion]
-    @postCode = options[:postCode]
-    @poBox = options[:poBox]
+    @world_region = options[:world_region]
+    @post_code = options[:post_code]
+    @po_box = options[:po_box]
   end
-  
+
   # Converts this class to Hash with its keys in lower CamelCase.
   #
   # Returns the new Hash.
@@ -92,24 +94,24 @@ def load_param
   # 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
+      house: @house,
+      house_number: @house_number,
+      road: @road,
+      unit: @unit,
+      level: @level,
+      staircase: @staircase,
+      entrance: @entrance,
+      suburb: @suburb,
+      city_district: @city_district,
+      city: @city,
+      island: @island,
+      state_district: @state_district,
+      state: @state,
+      country_region: @country_region,
+      country: @country,
+      world_region: @world_region,
+      post_code: @post_code,
+      po_box: @po_box
     }
   end
 end

lib/address_similarity_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'bad_request_error'
 require_relative 'address_parameter'
 
@@ -14,20 +16,25 @@ def initialize(address1, address2) #:notnew:
     @address2 = address2
   end
 
-  # Validates the parameters by checking if address1 and address2 are instances of AddressParameter.
+  # 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 }
+    a1_msg = 'address1 option can only be an instance of an AddressParameter'
+    raise BadRequestError.new(a1_msg) if [AddressParameter].none? { |clazz| @address1.is_a? clazz }
+
+    a2_msg = 'address2 option can only be an instance of an AddressParameter'
+    raise BadRequestError.new(a2_msg) 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
+    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.

lib/rosette_api.rb

@@ -33,7 +33,7 @@ class RosetteAPI
   # Rosette API name-similarity endpoint
   NAME_SIMILARITY_ENDPOINT = '/name-similarity'
   # Rosette API address-similarity endpoint
-  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'.freeze
+  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'
   # Rosette API tokens endpoint
   TOKENS_ENDPOINT = '/tokens'
   # Rosette API sentences endpoint
@@ -334,15 +334,19 @@ def get_name_similarity(params)
   #
   # ==== Attributes
   #
-  # * +params+ - AddressSimilarityParameters helps to build the request body in RequestBuilder.
+  # * +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
+    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, BINDING_VERSION, params, @url_parameters)
+    RequestBuilder.new(@user_key, @alternate_url + ADDRESS_SIMILARITY_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end