atlas_engine 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2236db9cf72e66e7bec983fec0ce919b31e1a795e6509ac65e1f914e8cda1c2b
-  data.tar.gz: c4bb6b2c1c8c927abbdf22d66d7a198052ab772f9243ffbd4c02bccced29b4ea
+  metadata.gz: dde673ac6063402f30381011574f018aee19ac9d6e9b961c04252cf76cfd49e5
+  data.tar.gz: b5c0adce91a39d744004b902e2b3a4a13544a50af756bb1ace003e391b0d3643
 SHA512:
-  metadata.gz: a1ccff91cd2b8026fd568ba9aced9688741bf1fd107fd180a83447e9d62ce20750d1ba8d14efe690ab22db6d239dfc1af51edda770c00de31cf07bfc210dc8cf
-  data.tar.gz: 9ee3408a1926463cf05cef4ba3b835e71fb8f490b61033154ac47dc586e2eb8b20fa971c9ca8c23859cec7fd4f7f8e81370f506fdba16e081b6299595a517f05
+  metadata.gz: dfe8b1e2a4ebe506f55b62a541b57ab22c0cca456ed4ef071007d43e106d0ed0b904389fd22a0424661ca76cd2f7bdc4ed5887866663eaee361f9afd5e7d3ac0
+  data.tar.gz: a632f397142d60a6da29ae440ed686ff920cb15e62349c3abb0ef9a3ccaddd975936870d55aee45867851337f10d46982f6740bbcf3379f9d74aeeed15369577

data/README.md

@@ -7,6 +7,7 @@ Atlas Engine is a rails engine that provides a global end-to-end address validat
 * [Local Development Installation](#local-development-installation)
 * [Address Data Ingestion](#address-data-ingestion)
 * [Elasticsearch Matching Strategy](#elasticsearch-matching-strategy)
+* [Hosted Solution](#hosted-solution)
 
 ## Address Validation API
 
@@ -303,23 +304,24 @@ At the moment, `atlas_engine` supports advanced address validation for the follo
 
 | Country/territory | Two-letter code | Locales  | Street | City | Postal Code | Province/State |
 |-------------------|-----------------|----------|--------|------|-------------|----------------|
-| Australia         | AU              |          |        | x    | x           | x              |
-| Austria           | AT              |          |        | x    | x           | x              |
-| Belgium           | BE              | fr,nl,de |        | x    | x           |                |
+| Australia         | AU              |          | x      | x    | x           | x              |
+| Austria           | AT              |          | x      | x    | x           | x              |
+| Belgium           | BE              | fr,nl,de | x      | x    | x           |                |
 | Bermuda           | BM              |          |        | x    | x           | x              |
 | Czechia           | CZ              |          |        | x    | x           |                |
 | Denmark           | DK              |          |        | x    | x           |                |
 | Faroe Islands     | FO              |          |        | x    | x           |                |
-| France            | FR              |          |        | x    | x           |                |
+| France            | FR              |          | x      | x    | x           |                |
+| Gurnsey           | GG              |          |        | x    | x           |                |
 | Italy             | IT              |          |        |      | x           |                |
 | Liechtenstein     | LI              |          |        | x    | x           | x              |
 | Luxembourg        | LU              | fr,lb    |        | x    | x           |                |
-| Netherlands       | NL              | nl       |        | x    | x           | x              |
-| Poland            | PL              |          |        | x    | x           | x              |
+| Netherlands       | NL              | nl       | x      | x    | x           | x              |
+| Poland            | PL              |          | x      | x    | x           | x              |
 | Portugal          | PT              |          |        | x    | x           | x              |
 | Slovenia          | SI              |          |        | x    | x           | x              |
 | South Korea       | KR              |          |        | x    | x           | x              |
-| Switzerland       | CH              | de,fr,it |        | x    | x           |                |
+| Switzerland       | CH              | de,fr,it | x      | x    | x           |                |
 | United States     | US              | en       | x      | x    | x           | x              |
 
 ### Downloading and indexing instructions
@@ -653,3 +655,19 @@ will produce the response:
 ```
 
 This response has no concerns or suggestions, and the input address is therefore considered to be valid.
+
+## Hosted Solution
+
+If you wish to use the Shopify hosted version of the `atlas_engine` codebase in your applications, you will need to [register for an api key](https://address-validation.shopify.dev/#request-api-key) and agree to our [terms and conditions](https://address-validation.shopify.dev/terms-of-service).
+
+Once you have successfully redeemed an api key, you will be able to access the `/graphql` endpoint, which can be queried using this example curl request:
+
+```
+curl --request POST \
+  --url https://atlas-validation.shopifyapps.com/graphql \
+  --header 'Authorization: Bearer {your-api-key}' \
+  --header 'Content-Type: application/json' \
+  --data '{"query":"query validation { validation(address: { address1: \"233 S Wacker Dr\" address2: \"\" city: \"Chicago\" countryCode: US provinceCode: \"IL\" zip: \"60606\" } locale: \"EN\" ) { validationScope concerns { code fieldNames suggestionIds type typeLevel message } suggestions { id address1 address2 city province provinceCode zip } }}","operationName":"validation"}'
+```
+
+Any updates to the `atlas_engine` codebase that are merged into our `main` branch will be deployed to our hosted solution as well.

data/app/countries/atlas_engine/at/country_profile.yml

@@ -9,7 +9,7 @@ ingestion:
   data_mapper: AtlasEngine::AddressValidation::Es::DataMappers::DecompoundingDataMapper
 validation:
   enabled: true
-  default_matching_strategy: es
+  default_matching_strategy: es_street
   has_provinces: true
   address_parser: AtlasEngine::At::ValidationTranscriber::AddressParser
   normalized_components:

data/app/countries/atlas_engine/au/country_profile.yml

@@ -8,6 +8,6 @@ ingestion:
 validation:
   address_parser: AtlasEngine::Au::ValidationTranscriber::AddressParser
   enabled: true
-  default_matching_strategy: es
+  default_matching_strategy: es_street
 open_address:
   filter: AtlasEngine::Au::AddressImporter::OpenAddress::Filter

data/app/countries/atlas_engine/be/country_profile.yml

@@ -5,9 +5,9 @@ ingestion:
     max_zip_edge_ngram: "4"
 validation:
   enabled: true
-  default_matching_strategy: local
+  default_matching_strategy: es_street
   address_parser: AtlasEngine::Be::ValidationTranscriber::AddressParser
-  has_provinces: false 
+  has_provinces: false
   index_locales:
   - fr
   - nl

data/app/countries/atlas_engine/ch/country_profile.yml

@@ -1,7 +1,7 @@
 id: CH
 validation:
   enabled: true
-  default_matching_strategy: local
+  default_matching_strategy: es_street
   has_provinces: false
   address_parser: AtlasEngine::De::ValidationTranscriber::AddressParser
   index_locales:

data/app/countries/atlas_engine/fr/country_profile.yml

@@ -10,6 +10,6 @@ ingestion:
 validation:
   address_parser: AtlasEngine::Fr::ValidationTranscriber::AddressParser
   enabled: true
-  default_matching_strategy: es
+  default_matching_strategy: es_street
   has_provinces: false
   zip_prefix_length: 3

data/app/countries/atlas_engine/nl/country_profile.yml

@@ -7,7 +7,7 @@ ingestion:
 validation:
   enabled: true
   has_provinces: true
-  default_matching_strategy: es
+  default_matching_strategy: es_street
   normalized_components:
   - street_decompounded
   address_parser: AtlasEngine::Nl::ValidationTranscriber::AddressParser

data/app/countries/atlas_engine/pl/country_profile.yml

@@ -7,7 +7,7 @@ ingestion:
 validation:
   address_parser: AtlasEngine::Pl::ValidationTranscriber::AddressParser
   enabled: true
-  default_matching_strategy: es
+  default_matching_strategy: es_street
   exclusions:
     city:
       - AtlasEngine::Pl::AddressValidation::Exclusions::RuralAddress

data/app/countries/atlas_engine/us/country_profile.yml

@@ -9,6 +9,7 @@ ingestion:
 validation:
   enabled: true
   default_matching_strategy: es_street
+  unmatched_components_suggestion_threshold: 1
   address_parser: AtlasEngine::ValidationTranscriber::AddressParserNorthAmerica
 open_address:
   filter: AtlasEngine::Us::AddressImporter::OpenAddress::Filter

data/app/graphql/atlas_engine/schema.graphql

@@ -6,8 +6,12 @@ input AddressInput {
   address2: String
   city: String
   countryCode: ValidationSupportedCountry
+  line2: String
+  neighborhood: String
   phone: String
   provinceCode: String
+  streetName: String
+  streetNumber: String
   zip: String
 }
 

data/app/graphql/atlas_engine/types/address_validation/address_input.rb

@@ -12,7 +12,11 @@ module AtlasEngine
         description "Address fields used to fulfill a validation request"
 
         argument :address1, String, required: false
+        argument :street_name, String, required: false
+        argument :street_number, String, required: false
         argument :address2, String, required: false
+        argument :line2, String, required: false
+        argument :neighborhood, String, required: false
         argument :city, String, required: false
         argument :country_code, ValidationSupportedCountry, required: false
         argument :province_code, String, required: false

data/app/lib/atlas_engine/validation_transcriber/formatter.rb

@@ -22,7 +22,11 @@ module AtlasEngine
       sig do
         params(
           address1: String,
+          street_name: String,
+          street_number: String,
           address2: String,
+          line2: String,
+          neighborhood: String,
           city: String,
           province_code: String,
           zip: String,
@@ -30,10 +34,15 @@ module AtlasEngine
           phone: String,
         ).returns(AddressValidation::Address)
       end
-      def build_address(address1: "", address2: "", city: "", province_code: "", zip: "", country_code: "", phone: "")
+      def build_address(address1: "", street_name: "", street_number: "", address2: "", line2: "", neighborhood: "",
+        city: "", province_code: "", zip: "", country_code: "", phone: "")
         AddressValidation::Address.new(
           address1: address1,
+          street_name: street_name,
+          street_number: street_number,
           address2: address2,
+          line2: line2,
+          neighborhood: neighborhood,
           city: city,
           province_code: province_code,
           zip: zip,

data/app/models/atlas_engine/address_number_range.rb

@@ -164,7 +164,7 @@ module AtlasEngine
 
     sig { params(value: String).returns(T::Boolean) }
     def include_fractions?(value)
-      %r{^([0-9]+ )?([0-9]+/[0-9]+)?$}.match?(value)
+      %r{^([0-9]+ )?([0-9]+/[1-9][0-9]*)?$}.match?(value)
     end
 
     sig { params(str: String).returns(String) }

data/app/models/atlas_engine/address_validation/abstract_address.rb

@@ -13,9 +13,21 @@ module AtlasEngine
       sig { abstract.returns(ComponentType) }
       def address1; end
 
+      sig { returns(ComponentType) }
+      def street_name; end
+
+      sig { returns(ComponentType) }
+      def street_number; end
+
       sig { abstract.returns(ComponentType) }
       def address2; end
 
+      sig { returns(ComponentType) }
+      def line2; end
+
+      sig { returns(ComponentType) }
+      def neighborhood; end
+
       sig { abstract.returns(ComponentType) }
       def city; end
 

data/app/models/atlas_engine/address_validation/address.rb

@@ -13,7 +13,11 @@ module AtlasEngine
       AddressInput = T.type_alias { Types::AddressValidation::AddressInput }
 
       const :address1, ComponentType
+      const :street_name, ComponentType
+      const :street_number, ComponentType
       const :address2, ComponentType
+      const :line2, ComponentType
+      const :neighborhood, ComponentType
       const :city, ComponentType
       const :province_code, ComponentType
       const :phone, ComponentType
@@ -33,7 +37,11 @@ module AtlasEngine
         def from_address(address:)
           new(
             address1: address.address1,
+            street_name: address.street_name,
+            street_number: address.street_number,
             address2: address.address2,
+            line2: address.line2,
+            neighborhood: address.neighborhood,
             city: address.city,
             country_code: address.country_code,
             province_code: address.province_code,

data/app/models/atlas_engine/address_validation/concern_record.rb

@@ -9,9 +9,21 @@ module AtlasEngine
       sig { returns(String) }
       attr_reader :address1
 
+      sig { returns(String) }
+      attr_reader :street_name
+
+      sig { returns(String) }
+      attr_reader :street_number
+
       sig { returns(String) }
       attr_reader :address2
 
+      sig { returns(String) }
+      attr_reader :line2
+
+      sig { returns(String) }
+      attr_reader :neighborhood
+
       sig { returns(String) }
       attr_reader :city
 
@@ -73,7 +85,11 @@ module AtlasEngine
           timestamp: Time,
           origin: String,
           address1: String,
+          street_name: String,
+          street_number: String,
           address2: String,
+          line2: String,
+          neighborhood: String,
           city: String,
           province_code: String,
           country_code: String,
@@ -87,7 +103,11 @@ module AtlasEngine
         timestamp: Time.zone.now,
         origin: "",
         address1: "",
+        street_name: "",
+        street_number: "",
         address2: "",
+        line2: "",
+        neighborhood: "",
         city: "",
         province_code: "",
         country_code: "",
@@ -100,7 +120,11 @@ module AtlasEngine
         @timestamp = timestamp
         @origin = origin
         @address1 = address1
+        @street_name = street_name
+        @street_number = street_number
         @address2 = address2
+        @line2 = line2
+        @neighborhood = neighborhood
         @city = city
         @province_code = province_code
         @country_code = country_code
@@ -114,7 +138,11 @@ module AtlasEngine
       def address_attributes
         {
           address1: address1,
+          street_name: street_name,
+          street_number: street_number,
           address2: address2,
+          line2: line2,
+          neighborhood: neighborhood,
           city: city,
           province_code: province_code,
           zip: zip,

data/app/models/atlas_engine/address_validation/validators/full_address/suggestion_builder.rb

@@ -12,7 +12,11 @@ module AtlasEngine
               params(
                 address: {
                   address1: T.nilable(String),
+                  street_name: T.nilable(String),
+                  street_number: T.nilable(String),
                   address2: T.nilable(String),
+                  line2: T.nilable(String),
+                  neighborhood: T.nilable(String),
                   city: T.nilable(String),
                   province_code: T.nilable(String),
                   country_code: T.nilable(String),

data/lib/atlas_engine/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module AtlasEngine
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas_engine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: annex_29