atlas_engine 0.1.0

data/db/data/validation_pipelines/es.yml

@@ -0,0 +1,58 @@
+id: es
+pipeline:
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::Exists
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::ValidForZip
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::Exists
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::ValidForCountry
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Zip::Present
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::City::Present
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::Present
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: phone
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid
+
+full_address_validator: AtlasEngine::AddressValidation::Es::Validators::FullAddress

data/db/data/validation_pipelines/es_street.yml

@@ -0,0 +1,58 @@
+id: es_street
+pipeline:
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::Exists
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::ValidForZip
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::Exists
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::ValidForCountry
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Zip::Present
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::City::Present
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::Present
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: phone
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid
+
+full_address_validator: AtlasEngine::AddressValidation::Es::Validators::FullAddressStreet

data/db/data/validation_pipelines/local.yml

@@ -0,0 +1,60 @@
+id: local
+pipeline:
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::Exists
+  - field: country
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Country::ValidForZip
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::Exists
+  - field: province
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Province::ValidForCountry
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Zip::Present
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Zip::ValidForProvince
+  - field: zip
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Zip::ValidForCountry
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::City::Present
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: city
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::Present
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
+  - field: address1
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: phone
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid

data/db/migrate/20230919173037_create_atlas_engine_post_addresses.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class CreateAtlasEnginePostAddresses < ActiveRecord::Migration[7.0]
+  def change
+    create_table(:atlas_engine_post_addresses, if_not_exists: true) do |t|
+      t.string(:source_id)
+      t.string(:locale)
+      t.string(:country_code, index: true)
+      t.string(:province_code, index: true)
+      t.string(:region1)
+      t.string(:region2)
+      t.string(:region3)
+      t.string(:region4)
+      t.string(:city, index: true)
+      t.string(:suburb)
+      t.string(:zip, index: true)
+      t.string(:street, index: true)
+      t.string(:building_name)
+      t.float(:latitude)
+      t.float(:longitude)
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231117142735_add_building_and_unit_ranges_column.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddBuildingAndUnitRangesColumn < ActiveRecord::Migration[7.0]
+  def change
+    add_column(:atlas_engine_post_addresses, :building_and_unit_ranges, :json)
+  end
+end

data/db/migrate/20231117143536_create_atlas_engine_country_imports.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateAtlasEngineCountryImports < ActiveRecord::Migration[7.0]
+  def change
+    create_table(:atlas_engine_country_imports, if_not_exists: true) do |t|
+      t.string(:country_code, null: false)
+      t.string(:state, default: "pending")
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231117145844_create_atlas_engine_events_table.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateAtlasEngineEventsTable < ActiveRecord::Migration[7.0]
+  def change
+    create_table(:atlas_engine_events, if_not_exists: true) do |t|
+      t.bigint(:country_import_id, null: false, index: true)
+      t.text(:message)
+      t.json(:additional_params)
+      t.integer(:category, default: 0)
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231123153554_add_unique_index_to_atlas_engine_post_addresses.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddUniqueIndexToAtlasEnginePostAddresses < ActiveRecord::Migration[7.0]
+  def change
+    add_index(
+      :atlas_engine_post_addresses,
+      [:province_code, :zip, :street, :city, :locale],
+      name: "index_atlas_engine_post_addresses_on_pc_zp_st_ct_lc",
+      unique: true,
+      length: { province_code: 10, zip: 10, street: 100, city: 255, locale: 10 },
+      if_not_exists: true,
+    )
+  end
+end

data/db/migrate/20231123154658_add_index_to_post_addresses_on_source_id_locale_country_code.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class AddIndexToPostAddressesOnSourceIdLocaleCountryCode < ActiveRecord::Migration[7.0]
+  def change
+    add_index(
+      :atlas_engine_post_addresses,
+      [:source_id, :locale, :country_code],
+      name: "index_atlas_engine_post_addresses_on_srcid_loc_cc",
+      if_not_exists: true,
+    )
+  end
+end

data/lib/atlas_engine/engine.rb

@@ -0,0 +1,10 @@
+# typed: true
+# frozen_string_literal: true
+
+require "rails/all"
+
+module AtlasEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace AtlasEngine
+  end
+end

data/lib/atlas_engine/version.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+module AtlasEngine
+  VERSION = "0.1.0"
+end

data/lib/atlas_engine.rb

@@ -0,0 +1,66 @@
+# typed: false
+# frozen_string_literal: true
+
+require "atlas_engine/version"
+require "atlas_engine/engine"
+require "graphql"
+require "graphiql/rails"
+require "elastic-transport"
+require "elasticsearch/model"
+require "elasticsearch/rails"
+require "worldwide"
+require "state_machines-activerecord"
+require "zip"
+require "frozen_record"
+require "annex_29"
+require "maintenance_tasks"
+require "htmlentities"
+require "sorbet-runtime"
+require "statsd-instrument"
+
+module AtlasEngine
+  # @!attribute elasticsearch_repository
+  #   @scope class
+  #
+  #   The elasticsearch repository implementation that the es datastore will use.
+  #
+  #   @return [String] the class name of the elasticsearch repository implementation.
+  mattr_accessor :elasticsearch_repository, default: "AtlasEngine::Elasticsearch::Repository"
+
+  # @!attribute log_base
+  #
+  #   The parent module for logging. Must be a module that implements the
+  #   `log_message` method.
+  #
+  #   @return [String] the name of the parent module for loggers.
+  mattr_accessor :log_base, default: "AtlasEngine::LogBase"
+
+  # @!attribute validation_eligibility
+  #
+  #   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.
+  #
+  #   @return [String] the name of the module for validation elibility.
+  mattr_accessor :validation_eligibility, default: "AtlasEngine::Services::ValidationEligibility"
+
+  # @!attribute address_importer_additional_field_validations
+  #   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],
+  #   }
+  mattr_accessor :address_importer_additional_field_validations, default: {}
+
+  # @!attribute import_events_notifier
+  #   The Host application can define its own notifier for import events by configuring
+  #   AtlasEngine.address_importer_notifier = MyCustomNotifier
+  mattr_accessor :address_importer_notifier, default: "AtlasEngine::AddressImporter::ImportEventsNotifier::Notifier"
+end

data/lib/tasks/atlas_engine/address_importer.rake

@@ -0,0 +1,20 @@
+# typed: false
+# frozen_string_literal: true
+
+namespace :atlas_engine do
+  namespace :address_importer do
+    desc "Import addresses from a CSV file."
+    task run: :environment do
+      file_path = ENV["file_path"]
+      if file_path.nil?
+        raise ArgumentError, "file_path variable is required for csv import"
+      end
+
+      puts "\nRunning the Address Importer."
+
+      AtlasEngine::PostAddressImporter.new(file_path).import
+
+      puts "\nAddress Importer task complete."
+    end
+  end
+end