atlas_engine 1.0.0 → 1.2.0

data/app/models/atlas_engine/address_validation/validators/predicates/neighborhood/present.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module AtlasEngine
+  module AddressValidation
+    module Validators
+      module Predicates
+        module Neighborhood
+          class Present < Predicate
+            sig { override.returns(T.nilable(Concern)) }
+            def evaluate
+              build_concern if @address.neighborhood.blank? && @cache.country.neighborhood_required?
+            end
+
+            private
+
+            sig { returns(Concern) }
+            def build_concern
+              Concern.new(
+                field_names: [:neighborhood],
+                code: :neighborhood_blank,
+                type: T.must(Concern::TYPES[:error]),
+                type_level: 3,
+                suggestion_ids: [],
+                message: @cache.country.field(key: :neighborhood).error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/atlas_engine/address_validation/validators/predicates/not_exceed_max_length.rb

@@ -6,14 +6,29 @@ module AtlasEngine
     module Validators
       module Predicates
         class NotExceedMaxLength < Predicate
-          MAX_COMPONENT_LENGTH = 255
+          MAX_COMPONENT_LENGTH = T.let(
+            {
+              street_name: 200,
+              street_number: 50,
+              line2: 175,
+              neighborhood: 75,
+              default: 255,
+            },
+            T::Hash[Symbol, Integer],
+          )
+
           sig { override.returns(T.nilable(Concern)) }
           def evaluate
-            build_concern if address.send(@field).to_s.length > MAX_COMPONENT_LENGTH
+            build_concern if address.send(@field).to_s.length > limit
           end
 
           private
 
+          sig { returns(Integer) }
+          def limit
+            @limit ||= T.let(MAX_COMPONENT_LENGTH[@field] || T.must(MAX_COMPONENT_LENGTH[:default]), T.nilable(Integer))
+          end
+
           sig { returns(Concern) }
           def build_concern
             Concern.new(
@@ -22,7 +37,7 @@ module AtlasEngine
               type: T.must(Concern::TYPES[:error]),
               type_level: 3,
               suggestion_ids: [],
-              message: @cache.country.field(key: @field)&.error(code: :too_long).to_s,
+              message: @cache.country.field(key: @field)&.error(code: :too_long, options: { limit: limit }).to_s,
             )
           end
         end

data/app/models/atlas_engine/address_validation/validators/predicates/phone/valid.rb

@@ -28,7 +28,9 @@ module AtlasEngine
                 type: T.must(Concern::TYPES[:error]),
                 type_level: 3,
                 suggestion_ids: [],
-                message: @cache.country.field(key: :phone).error(code: :invalid).to_s,
+                message: @cache.country.field(key: :phone).error(
+                  code: "invalid_#{message_format.serialize}".to_sym,
+                ).to_s,
               )
             end
           end

data/app/models/atlas_engine/address_validation/validators/predicates/predicate.rb

@@ -19,13 +19,17 @@ module AtlasEngine
           sig { returns(Cache) }
           attr_reader :cache
 
+          sig { returns(MessageFormat) }
+          attr_reader :message_format
+
           delegate :address1, :address2, :city, :zip, :province_code, :country_code, to: :address
 
-          sig { params(field: Symbol, address: Address, cache: Cache).void }
-          def initialize(field:, address:, cache: Cache.new(address))
+          sig { params(field: Symbol, address: Address, message_format: MessageFormat, cache: Cache).void }
+          def initialize(field:, address:, message_format: MessageFormat::Instructional, cache: Cache.new(address))
             @field = field
             @address = address
             @cache = cache
+            @message_format = message_format
           end
 
           sig { abstract.returns(T.nilable(Concern)) }

data/app/models/atlas_engine/address_validation/validators/predicates/province/exists.rb

@@ -26,7 +26,9 @@ module AtlasEngine
                 type: T.must(Concern::TYPES[:error]),
                 type_level: 3,
                 suggestion_ids: [],
-                message: @cache.country.field(key: :province)&.error(code: :blank).to_s,
+                message: @cache.country.field(key: :province)&.error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
               )
             end
 

data/app/models/atlas_engine/address_validation/validators/predicates/province/valid_for_country.rb

@@ -28,7 +28,9 @@ module AtlasEngine
                 type: T.must(Concern::TYPES[:error]),
                 type_level: 3,
                 suggestion_ids: [],
-                message: @cache.country.field(key: :province).error(code: :blank),
+                message: @cache.country.field(key: :province).error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
               )
             end
 

data/app/models/atlas_engine/address_validation/validators/predicates/street/present.rb

@@ -22,7 +22,9 @@ module AtlasEngine
                 type: T.must(Concern::TYPES[:error]),
                 type_level: 3,
                 suggestion_ids: [],
-                message: @cache.country.field(key: :address1).error(code: :blank).to_s,
+                message: @cache.country.field(key: :address1).error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
               )
             end
           end

data/app/models/atlas_engine/address_validation/validators/predicates/street_name/present.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module AtlasEngine
+  module AddressValidation
+    module Validators
+      module Predicates
+        module StreetName
+          class Present < Predicate
+            sig { override.returns(T.nilable(Concern)) }
+            def evaluate
+              build_concern if @address.street_name.blank? && @cache.country.street_name_required?
+            end
+
+            private
+
+            sig { returns(Concern) }
+            def build_concern
+              Concern.new(
+                field_names: [:street_name],
+                code: :street_name_blank,
+                type: T.must(Concern::TYPES[:error]),
+                type_level: 3,
+                suggestion_ids: [],
+                message: @cache.country.field(key: :street_name).error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/atlas_engine/address_validation/validators/predicates/street_number/present.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module AtlasEngine
+  module AddressValidation
+    module Validators
+      module Predicates
+        module StreetNumber
+          class Present < Predicate
+            sig { override.returns(T.nilable(Concern)) }
+            def evaluate
+              build_concern if @address.street_number.blank? && @cache.country.street_number_required?
+            end
+
+            private
+
+            sig { returns(Concern) }
+            def build_concern
+              Concern.new(
+                field_names: [:street_number],
+                code: :street_number_blank,
+                type: T.must(Concern::TYPES[:error]),
+                type_level: 3,
+                suggestion_ids: [],
+                message: @cache.country.field(key: :street_number).error(
+                  code: "blank_#{message_format.serialize}".to_sym,
+                ).to_s,
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/atlas_engine/address_validation/validators/predicates/zip/present.rb

@@ -40,12 +40,12 @@ module AtlasEngine
               province_name = @cache.province.province? ? @cache.province.full_name : address.province_code
               if province_name.present?
                 @cache.country.field(key: :zip).error(
-                  code: :invalid_for_province,
+                  code: "invalid_for_province_#{message_format.serialize}".to_sym,
                   options: { province: province_name },
                 ).to_s
               else
                 @cache.country.field(key: :zip).error(
-                  code: :invalid_for_country,
+                  code: "invalid_for_country_#{message_format.serialize}".to_sym,
                   options: { country: @cache.country.short_name },
                 ).to_s
               end

data/app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_country.rb

@@ -32,7 +32,7 @@ module AtlasEngine
                 type_level: 3,
                 suggestion_ids: [],
                 message: @cache.country.field(key: :zip).error(
-                  code: :invalid_for_country,
+                  code: "invalid_for_country_#{message_format.serialize}".to_sym,
                   options: { country: @cache.country.short_name },
                 ).to_s,
               )

data/app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_province.rb

@@ -43,7 +43,7 @@ module AtlasEngine
               province_name = @cache.province.province? ? @cache.province.full_name : address.province_code
 
               @cache.country.field(key: :zip).error(
-                code: :invalid_for_province,
+                code: "invalid_for_province_#{message_format.serialize}".to_sym,
                 options: { province: province_name },
               ).to_s
             end

data/app/models/atlas_engine/services/validation.rb

@@ -22,11 +22,15 @@ module AtlasEngine
               AddressValidation::MatchingStrategies::Local
             end
 
+            message_format = AddressValidation::MessageFormat.try_deserialize(request.message_format) ||
+              AddressValidation::MessageFormat::Instructional
+
             validator = AddressValidation::Validator.new(
               address: request.address,
               locale: request.locale,
               matching_strategy: matching_strategy,
               context: request.address.context.to_h,
+              message_format: message_format,
             )
             result = validator.run
 

data/db/data/validation_pipelines/es.yml

@@ -52,6 +52,52 @@ pipeline:
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
   - field: address1
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetName::Present
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetNumber::Present
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Neighborhood::Present
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
   - field: phone
     class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid
 

data/db/data/validation_pipelines/es_street.yml

@@ -52,6 +52,52 @@ pipeline:
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
   - field: address1
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetName::Present
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetNumber::Present
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Neighborhood::Present
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
   - field: phone
     class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid
 

data/db/data/validation_pipelines/local.yml

@@ -56,5 +56,51 @@ pipeline:
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1OrAddress2
   - field: address1
     class: AtlasEngine::AddressValidation::Validators::Predicates::Street::BuildingNumberInAddress1
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetName::Present
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_name
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::StreetNumber::Present
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: street_number
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::Neighborhood::Present
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: neighborhood
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoEmojis
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxTokenCount
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NotExceedMaxLength
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoUrl
+  - field: line2
+    class: AtlasEngine::AddressValidation::Validators::Predicates::NoHtmlTags
   - field: phone
     class: AtlasEngine::AddressValidation::Validators::Predicates::Phone::Valid

data/lib/atlas_engine/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module AtlasEngine
-  VERSION = "1.0.0"
+  VERSION = "1.2.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.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: annex_29
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-model
   requirement: !ruby/object:Gem::Requirement
@@ -240,14 +254,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The Atlas Engine is a rails engine that provides a GraphQL API for address
   validation.
 email: developers@shopify.com
@@ -400,6 +428,7 @@ files:
 - app/graphql/atlas_engine/types/base_scalar.rb
 - app/graphql/atlas_engine/types/base_union.rb
 - app/graphql/atlas_engine/types/matching_strategy_type.rb
+- app/graphql/atlas_engine/types/message_format_type.rb
 - app/graphql/atlas_engine/types/mutation_type.rb
 - app/graphql/atlas_engine/types/query_type.rb
 - app/graphql/atlas_engine/types/validation_supported_country.rb
@@ -478,8 +507,10 @@ files:
 - app/models/atlas_engine/address_validation/full_address_validator_base.rb
 - app/models/atlas_engine/address_validation/log_emitter.rb
 - app/models/atlas_engine/address_validation/matching_strategies.rb
+- app/models/atlas_engine/address_validation/message_format.rb
 - app/models/atlas_engine/address_validation/normalizer.rb
 - app/models/atlas_engine/address_validation/predicate_pipeline.rb
+- app/models/atlas_engine/address_validation/predicate_pipeline_builder.rb
 - app/models/atlas_engine/address_validation/request.rb
 - app/models/atlas_engine/address_validation/result.rb
 - app/models/atlas_engine/address_validation/runs_validation.rb
@@ -522,6 +553,7 @@ files:
 - app/models/atlas_engine/address_validation/validators/predicates/city/present.rb
 - app/models/atlas_engine/address_validation/validators/predicates/country/exists.rb
 - app/models/atlas_engine/address_validation/validators/predicates/country/valid_for_zip.rb
+- app/models/atlas_engine/address_validation/validators/predicates/neighborhood/present.rb
 - app/models/atlas_engine/address_validation/validators/predicates/no_emojis.rb
 - app/models/atlas_engine/address_validation/validators/predicates/no_html_tags.rb
 - app/models/atlas_engine/address_validation/validators/predicates/no_url.rb
@@ -534,6 +566,8 @@ files:
 - app/models/atlas_engine/address_validation/validators/predicates/street/building_number_in_address1.rb
 - app/models/atlas_engine/address_validation/validators/predicates/street/building_number_in_address1_or_address2.rb
 - app/models/atlas_engine/address_validation/validators/predicates/street/present.rb
+- app/models/atlas_engine/address_validation/validators/predicates/street_name/present.rb
+- app/models/atlas_engine/address_validation/validators/predicates/street_number/present.rb
 - app/models/atlas_engine/address_validation/validators/predicates/zip/present.rb
 - app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_country.rb
 - app/models/atlas_engine/address_validation/validators/predicates/zip/valid_for_province.rb
@@ -615,7 +649,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.13
 signing_key: 
 specification_version: 4
 summary: Address Validation API