Class: DefraRuby::Address::OsApiAddressLookupV1Service

Inherits:
BaseService
  • Object
show all
Defined in:
lib/defra_ruby/address/services/os_api_address_lookup_v1_service.rb

Constant Summary collapse

FIELD_MAPPING =

Mapping from OS API DPA field names to EaAddressFacade field names rubocop:disable Layout/HashAlignment

{
  "UPRN"                           => "uprn",
  "ADDRESS"                        => "address",
  "ORGANISATION_NAME"              => "organisation",
  "BUILDING_NAME"                  => "premises",
  "THOROUGHFARE_NAME"              => "street_address",
  "DEPENDENT_LOCALITY"             => "locality",
  "POST_TOWN"                      => "city",
  "POSTCODE"                       => "postcode",
  "X_COORDINATE"                   => "x",
  "Y_COORDINATE"                   => "y",
  "BLPU_STATE_DATE"                => "blpu_state_date",
  "BLPU_STATE_CODE"                => "blpu_state_code",
  "POSTAL_ADDRESS_CODE"            => "postal_address_code",
  "LOGICAL_STATUS_CODE"            => "logical_status_code",
  "BLPU_STATE_CODE_DESCRIPTION"    => "blpu_state_code_description",
  "CLASSIFICATION_CODE"            => "classification_code",
  "CLASSIFICATION_CODE_DESCRIPTION" => "classification_code_description",
  "MATCH"                          => "match",
  "MATCH_DESCRIPTION"              => "match_description",
  "TOPOGRAPHY_LAYER_TOID"          => "topography_layer_toid",
  "PARENT_UPRN"                    => "parent_uprn",
  "LAST_UPDATE_DATE"               => "last_update_date",
  "STATUS"                         => "status",
  "ENTRY_DATE"                     => "entry_date",
  "POSTAL_ADDRESS_CODE_DESCRIPTION" => "postal_address_code_description",
  "USRN"                           => "usrn",
  "LANGUAGE"                       => "language"
}.freeze
DEFAULT_HOST =

rubocop:enable Layout/HashAlignment

"https://api.os.uk/search/places/v1"

Instance Method Summary collapse

Methods inherited from BaseService

run

Instance Method Details

#run(postcode) ⇒ Object 



42
43
44
45
 
# File 'lib/defra_ruby/address/services/os_api_address_lookup_v1_service.rb', line 42

def run(postcode)
  @postcode = postcode
  Response.new(response_exe)
end