Module: AtlasEngine

Defined in:
lib/atlas_engine/version.rb,
lib/atlas_engine.rb,
lib/atlas_engine/engine.rb,
app/models/atlas_engine/event.rb,
app/models/atlas_engine/street.rb,
app/graphql/atlas_engine/schema.rb,
app/helpers/atlas_engine/log_base.rb,
app/helpers/atlas_engine/log_helper.rb,
app/models/atlas_engine/coded_error.rb,
app/models/atlas_engine/coded_errors.rb,
app/models/atlas_engine/post_address.rb,
app/jobs/atlas_engine/application_job.rb,
app/concerns/atlas_engine/handles_blob.rb,
app/lib/atlas_engine/concern_formatter.rb,
app/lib/atlas_engine/restrictions/base.rb,
app/models/atlas_engine/address_number.rb,
app/models/atlas_engine/country_import.rb,
app/helpers/atlas_engine/metrics_helper.rb,
app/models/atlas_engine/country_profile.rb,
app/graphql/atlas_engine/types/base_enum.rb,
app/graphql/atlas_engine/types/base_field.rb,
app/graphql/atlas_engine/types/base_union.rb,
app/graphql/atlas_engine/types/query_type.rb,
app/graphql/atlas_engine/types/base_object.rb,
app/graphql/atlas_engine/types/base_scalar.rb,
app/models/atlas_engine/application_record.rb,
app/models/atlas_engine/country_repository.rb,
app/models/atlas_engine/field_decompounder.rb,
app/helpers/atlas_engine/application_helper.rb,
app/mailers/atlas_engine/application_mailer.rb,
app/models/atlas_engine/elasticsearch/error.rb,
app/models/atlas_engine/services/validation.rb,
app/graphql/atlas_engine/types/base_argument.rb,
app/graphql/atlas_engine/types/mutation_type.rb,
app/models/atlas_engine/address_number_range.rb,
app/models/atlas_engine/elasticsearch/client.rb,
app/graphql/atlas_engine/types/base_interface.rb,
app/helpers/atlas_engine/locale_format_helper.rb,
app/models/atlas_engine/post_address_importer.rb,
app/concerns/atlas_engine/handles_interruption.rb,
app/graphql/atlas_engine/types/validation_type.rb,
app/models/atlas_engine/elasticsearch/response.rb,
app/controllers/atlas_engine/graphql_controller.rb,
app/models/atlas_engine/services/service_helper.rb,
app/graphql/atlas_engine/types/base_input_object.rb,
app/models/atlas_engine/address_validation/field.rb,
app/models/atlas_engine/address_validation/token.rb,
app/models/atlas_engine/elasticsearch/repository.rb,
app/models/atlas_engine/address_validation/errors.rb,
app/models/atlas_engine/address_validation/result.rb,
app/graphql/atlas_engine/types/message_format_type.rb,
app/models/atlas_engine/address_validation/address.rb,
app/models/atlas_engine/address_validation/concern.rb,
app/models/atlas_engine/address_validation/request.rb,
app/controllers/atlas_engine/application_controller.rb,
app/models/atlas_engine/country_profile_subset_base.rb,
app/models/atlas_engine/index_configuration_factory.rb,
app/controllers/atlas_engine/connectivity_controller.rb,
app/lib/atlas_engine/restrictions/unsupported_script.rb,
app/models/atlas_engine/address_validation/candidate.rb,
app/models/atlas_engine/address_validation/validator.rb,
app/graphql/atlas_engine/types/matching_strategy_type.rb,
app/lib/atlas_engine/validation_transcriber/constants.rb,
app/lib/atlas_engine/validation_transcriber/formatter.rb,
app/models/atlas_engine/address_importer/open_address.rb,
app/models/atlas_engine/address_validation/normalizer.rb,
app/models/atlas_engine/address_validation/strategies.rb,
app/models/atlas_engine/address_validation/suggestion.rb,
app/models/atlas_engine/address_validation/log_emitter.rb,
app/models/atlas_engine/elasticsearch/client_interface.rb,
app/controllers/atlas_engine/country_imports_controller.rb,
app/models/atlas_engine/address_validation/es/datastore.rb,
app/models/atlas_engine/services/validation_eligibility.rb,
app/graphql/atlas_engine/errors/locale_unsupported_error.rb,
app/jobs/atlas_engine/address_importer/clear_records_job.rb,
app/models/atlas_engine/address_validation/concern_queue.rb,
app/models/atlas_engine/address_validation/zip_truncator.rb,
app/models/atlas_engine/country_profile_ingestion_subset.rb,
app/lib/atlas_engine/validation_transcriber/street_parser.rb,
app/models/atlas_engine/address_validation/concern_record.rb,
app/models/atlas_engine/address_validation/datastore_base.rb,
app/models/atlas_engine/address_validation/message_format.rb,
app/models/atlas_engine/address_validation/statsd_emitter.rb,
app/models/atlas_engine/address_validation/token/sequence.rb,
app/models/atlas_engine/address_validation/token/synonyms.rb,
app/models/atlas_engine/country_profile_validation_subset.rb,
app/jobs/atlas_engine/address_importer/street_backfill_job.rb,
app/lib/atlas_engine/validation_transcriber/zip_normalizer.rb,
app/models/atlas_engine/address_validation/es/term_vectors.rb,
app/models/atlas_engine/address_validation/runs_validation.rb,
app/models/atlas_engine/elasticsearch/repository_interface.rb,
app/graphql/atlas_engine/types/validation_supported_country.rb,
app/helpers/atlas_engine/address_importer/import_log_helper.rb,
app/jobs/atlas_engine/address_importer/resumable_import_job.rb,
app/models/atlas_engine/address_importer/validation/wrapper.rb,
app/models/atlas_engine/address_validation/abstract_address.rb,
app/models/atlas_engine/address_validation/concern_producer.rb,
app/models/atlas_engine/address_validation/es/query_builder.rb,
app/models/atlas_engine/address_validation/token/comparator.rb,
app/models/atlas_engine/address_validation/token/comparison.rb,
app/graphql/atlas_engine/types/address_validation/field_type.rb,
app/lib/atlas_engine/validation_transcriber/address_parsings.rb,
app/models/atlas_engine/address_importer/open_address/filter.rb,
app/models/atlas_engine/address_importer/open_address/loader.rb,
app/models/atlas_engine/address_importer/validation/validator.rb,
app/models/atlas_engine/address_validation/predicate_pipeline.rb,
app/graphql/atlas_engine/types/address_validation/concern_type.rb,
app/jobs/atlas_engine/concerns/address_importer/handles_errors.rb,
app/models/atlas_engine/address_importer/corrections/corrector.rb,
app/models/atlas_engine/address_validation/matching_strategies.rb,
app/countries/atlas_engine/jp/address_validation/es/data_mapper.rb,
app/graphql/atlas_engine/types/address_validation/address_input.rb,
app/lib/atlas_engine/validation_transcriber/address_parser_base.rb,
app/lib/atlas_engine/validation_transcriber/french_street_parser.rb,
app/models/atlas_engine/address_validation/es/candidate_selector.rb,
app/countries/atlas_engine/cz/address_validation/es/query_builder.rb,
app/countries/atlas_engine/gb/address_validation/es/query_builder.rb,
app/graphql/atlas_engine/types/address_validation/suggestion_type.rb,
app/lib/atlas_engine/validation_transcriber/english_street_parser.rb,
app/models/atlas_engine/address_importer/open_address/transformer.rb,
app/countries/atlas_engine/au/address_importer/open_address/filter.rb,
app/countries/atlas_engine/au/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/bm/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/ch/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/it/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/kr/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/pt/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/si/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/tt/address_importer/open_address/mapper.rb,
app/countries/atlas_engine/us/address_importer/open_address/filter.rb,
app/countries/atlas_engine/us/address_importer/open_address/mapper.rb,
app/lib/atlas_engine/validation_transcriber/address_parser_factory.rb,
app/lib/atlas_engine/validation_transcriber/address_parser_oceanic.rb,
app/lib/atlas_engine/validation_transcriber/address_parsing_helper.rb,
app/models/atlas_engine/address_importer/validation/base_validator.rb,
app/countries/atlas_engine/at/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/au/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/be/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/cz/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/de/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/dk/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/es/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/fr/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/gb/validation_transcriber/parsed_address.rb,
app/countries/atlas_engine/gg/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/kr/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/lt/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/lu/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/nl/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/pl/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/pt/validation_transcriber/address_parser.rb,
app/countries/atlas_engine/si/validation_transcriber/address_parser.rb,
app/models/atlas_engine/address_validation/es/default_query_builder.rb,
app/graphql/atlas_engine/types/address_validation/enums/concern_enum.rb,
app/lib/atlas_engine/validation_transcriber/province_code_normalizer.rb,
app/models/atlas_engine/address_importer/import_events_notifier/base.rb,
app/models/atlas_engine/address_importer/open_address/default_mapper.rb,
app/models/atlas_engine/address_importer/open_address/feature_helper.rb,
app/models/atlas_engine/address_validation/token/sequence/comparator.rb,
app/models/atlas_engine/address_validation/token/sequence/comparison.rb,
app/models/atlas_engine/address_importer/validation/default_validator.rb,
app/models/atlas_engine/address_validation/es/validators/full_address.rb,
app/models/atlas_engine/address_validation/predicate_pipeline_builder.rb,
app/models/atlas_engine/address_validation/full_address_validator_base.rb,
app/models/atlas_engine/address_validation/validators/predicates/cache.rb,
app/countries/atlas_engine/us/jobs/address_importer/combined_import_job.rb,
app/jobs/atlas_engine/address_importer/open_address/geo_json_import_job.rb,
app/lib/atlas_engine/validation_transcriber/address_parser_preprocessor.rb,
app/models/atlas_engine/address_validation/validators/predicates/no_url.rb,
app/countries/atlas_engine/gb/validation_transcriber/full_address_parser.rb,
app/countries/atlas_engine/si/address_validation/exclusions/unknown_city.rb,
app/lib/atlas_engine/validation_transcriber/address_parser_north_america.rb,
app/models/atlas_engine/address_importer/import_events_notifier/notifier.rb,
app/countries/atlas_engine/pl/address_validation/exclusions/rural_address.rb,
app/models/atlas_engine/address_importer/validation/field_validations/zip.rb,
app/jobs/atlas_engine/address_importer/open_address/prepares_geo_json_file.rb,
app/models/atlas_engine/address_importer/validation/field_validations/city.rb,
app/models/atlas_engine/address_validation/validators/predicates/no_emojis.rb,
app/models/atlas_engine/address_validation/validators/predicates/predicate.rb,
app/models/atlas_engine/address_validation/token/sequence/comparison_policy.rb,
app/models/atlas_engine/address_validation/es/validators/full_address_street.rb,
app/models/atlas_engine/address_validation/validators/predicates/phone/valid.rb,
app/models/atlas_engine/address_validation/validators/predicates/zip/present.rb,
app/models/atlas_engine/address_validation/validators/predicates/city/present.rb,
app/models/atlas_engine/address_validation/validators/predicates/no_html_tags.rb,
app/models/atlas_engine/address_validation/validators/predicates/zip/zip_base.rb,
app/countries/atlas_engine/ch/locales/fr/validation_transcriber/address_parser.rb,
app/models/atlas_engine/address_importer/validation/field_validations/province.rb,
app/models/atlas_engine/address_validation/es/data_mappers/default_data_mapper.rb,
app/models/atlas_engine/address_validation/es/validators/restriction_evaluator.rb,
app/models/atlas_engine/address_importer/validation/field_validations/interface.rb,
app/models/atlas_engine/address_validation/validators/predicates/country/exists.rb,
app/models/atlas_engine/address_validation/validators/predicates/street/present.rb,
app/jobs/atlas_engine/address_importer/open_address/geo_json_import_launcher_job.rb,
app/models/atlas_engine/address_validation/validators/predicates/province/exists.rb,
app/models/atlas_engine/address_validation/validators/full_address/zip_comparison.rb,
app/models/atlas_engine/address_validation/validators/full_address/city_comparison.rb,
app/models/atlas_engine/address_validation/validators/full_address/concern_builder.rb,
app/countries/atlas_engine/pl/address_validation/exclusions/placeholder_postal_code.rb,
app/models/atlas_engine/address_validation/validators/full_address/candidate_result.rb,
app/models/atlas_engine/address_validation/es/data_mappers/decompounding_data_mapper.rb,
app/models/atlas_engine/address_validation/validators/full_address/number_comparison.rb,
app/models/atlas_engine/address_validation/validators/full_address/street_comparison.rb,
app/models/atlas_engine/address_validation/validators/predicates/street_name/present.rb,
app/models/atlas_engine/address_validation/validators/full_address/address_comparison.rb,
app/models/atlas_engine/address_validation/validators/full_address/suggestion_builder.rb,
app/models/atlas_engine/address_validation/validators/predicates/neighborhood/present.rb,
app/countries/atlas_engine/at/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/ch/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/fo/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/fr/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/gg/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/it/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/li/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/lu/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/nl/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/pl/address_importer/corrections/open_address/city_corrector.rb,
app/countries/atlas_engine/pt/address_importer/corrections/open_address/city_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/building_comparison.rb,
app/models/atlas_engine/address_validation/validators/full_address/no_candidate_result.rb,
app/models/atlas_engine/address_validation/validators/full_address/postal_code_matcher.rb,
app/models/atlas_engine/address_validation/validators/full_address/relevant_components.rb,
app/models/atlas_engine/address_validation/validators/predicates/country/valid_for_zip.rb,
app/models/atlas_engine/address_validation/validators/predicates/not_exceed_max_length.rb,
app/models/atlas_engine/address_validation/validators/predicates/street_number/present.rb,
app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_country.rb,
app/countries/atlas_engine/pt/address_validation/validators/full_address/exclusions/zip.rb,
app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_province.rb,
app/countries/atlas_engine/ch/address_importer/corrections/open_address/locale_corrector.rb,
app/countries/atlas_engine/gg/address_validation/validators/full_address/exclusions/city.rb,
app/countries/atlas_engine/it/address_validation/validators/full_address/exclusions/city.rb,
app/countries/atlas_engine/kr/address_validation/validators/full_address/exclusions/city.rb,
app/countries/atlas_engine/lu/address_importer/corrections/open_address/locale_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/candidate_result_base.rb,
app/models/atlas_engine/address_validation/validators/full_address/field_comparison_base.rb,
app/countries/atlas_engine/it/address_importer/corrections/open_address/province_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/province_code_comparison.rb,
app/models/atlas_engine/address_validation/validators/predicates/not_exceed_max_token_count.rb,
app/models/atlas_engine/address_validation/validators/predicates/province/valid_for_country.rb,
app/countries/atlas_engine/bm/address_importer/corrections/open_address/city_alias_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/exclusions/exclusion_base.rb,
app/models/atlas_engine/address_validation/validators/full_address/unsupported_script_result.rb,
app/countries/atlas_engine/pl/address_importer/corrections/open_address/empty_street_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/invalid_zip_concern_builder.rb,
app/countries/atlas_engine/si/address_importer/open_address/corrections/city_district_corrector.rb,
app/models/atlas_engine/address_validation/validators/full_address/unknown_address_concern_builder.rb,
app/models/atlas_engine/address_validation/validators/full_address/unmatched_field_concern_builder.rb,
app/models/atlas_engine/address_validation/validators/full_address/unknown_province_concern_builder.rb,
app/models/atlas_engine/address_validation/validators/predicates/street/building_number_in_address1.rb,
app/countries/atlas_engine/gg/address_validation/validators/full_address/restrictions/unsupported_city.rb,
app/models/atlas_engine/address_validation/validators/full_address/invalid_zip_for_country_concern_builder.rb,
app/models/atlas_engine/address_validation/validators/full_address/invalid_zip_for_province_concern_builder.rb,
app/models/atlas_engine/address_validation/validators/predicates/street/building_number_in_address1_or_address2.rb

Overview

typed: strict frozen_string_literal: true

Defined Under Namespace

Modules: AddressImporter, AddressValidation, ApplicationHelper, At, Au, Be, Bm, Ch, ConcernFormatter, Concerns, Cz, De, Dk, Elasticsearch, Errors, Es, Fo, Fr, Gb, Gg, HandlesBlob, HandlesInterruption, It, Jp, Kr, Li, LocaleFormatHelper, LogBase, LogHelper, Lt, Lu, MetricsHelper, Nl, Pl, Pt, Restrictions, Services, Si, Tt, Types, Us, ValidationTranscriber Classes: AddressNumber, AddressNumberRange, ApplicationController, ApplicationJob, ApplicationMailer, ApplicationRecord, CodedError, CodedErrors, ConnectivityController, CountryImport, CountryImportsController, CountryProfile, CountryProfileIngestionSubset, CountryProfileSubsetBase, CountryProfileValidationSubset, CountryRepository, Engine, Event, FieldDecompounder, GraphqlController, IndexConfigurationFactory, PostAddress, PostAddressImporter, Schema, Street

Constant Summary collapse

VERSION = 
"1.2.0"

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Attribute Details

.elasticsearch_repository ⇒ String

The elasticsearch repository implementation that the es datastore will use.

Returns:

  • (String) —

    the class name of the elasticsearch repository implementation.



28
 
# File 'lib/atlas_engine.rb', line 28

mattr_accessor :elasticsearch_repository, default: "AtlasEngine::Elasticsearch::Repository"

Instance Attribute Details

#address_importer_additional_field_validations ⇒ Object

The Host application can add additional validations to the address importer by setting this attribute to a hash of the following format: 

field_name: [Array of additional validation classes]

example: AtlasEngine.address_importer_additional_field_validations = 

city: [MyCustomCityValidator],
province_code: [MyCustomProvinceValidator],
zip: [MyCustomZipValidator],




60
 
# File 'lib/atlas_engine.rb', line 60

mattr_accessor :address_importer_additional_field_validations, default: {}

#import_events_notifier ⇒ Object

The Host application can define its own notifier for import events by configuring AtlasEngine.address_importer_notifier = MyCustomNotifier



65
 
# File 'lib/atlas_engine.rb', line 65

mattr_accessor :address_importer_notifier, default: "AtlasEngine::AddressImporter::ImportEventsNotifier::Notifier"

#log_base ⇒ String

The parent module for logging. Must be a module that implements the ‘log_message` method.

Returns:

  • (String) —

    the name of the parent module for loggers.



36
 
# File 'lib/atlas_engine.rb', line 36

mattr_accessor :log_base, default: "AtlasEngine::LogBase"

#validation_eligibility ⇒ String

The module for validation eligibility. Must be a module that implements the ‘validation_enabled(address)` method which returns a boolean that indicates if the provided address is eligible for validation.

Returns:

  • (String) —

    the name of the module for validation elibility.



45
 
# File 'lib/atlas_engine.rb', line 45

mattr_accessor :validation_eligibility, default: "AtlasEngine::Services::ValidationEligibility"