activerecord-s3-bucket-name-validator 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db90636507488edf3d8fd10ff6d162cc3602535cc5393c1dc978e30453af4a1
-  data.tar.gz: a2e5f151e3e5b4ac5fd1e155e7effb88a7a4a1779c9b288730ffe46a592f83d5
+  metadata.gz: 12b96ad2afb8713382346c19e7c7589e41014735d7481754e26a9d03329d7c7f
+  data.tar.gz: a4a67ed0a9e5dc9b30bc69faafe9f82f74b77df66f60c0cac9076158165a595f
 SHA512:
-  metadata.gz: 949db64c400b317437bf4db49782f5249024d660a05c35ad9fec7c93ba4f53c2eaed39cc5d29249d9e99756f4a8ae06406c409e22c48bb092ab3e31617fecf5c
-  data.tar.gz: 8a9113a96a8d1fa4afcf1224ed7a48a0d8eaf99958884abe00bac0c83f878b07faa50d9d756c262e9beb198a32203dbe89813b9b790eed83134f55f7d81eb4aa
+  metadata.gz: 0e8698e66b8494c850a9618d7ba8fa2cc5088511195f96991817293e2269fe0fa1f20c66872a066265fbee592d51cab5ab18bf7c4cd27158707352c0413e0d20
+  data.tar.gz: 395899fab1991707c6cdbcb04b61dba595d23952229963fd9717598c9e5a2a87670d271b69673987aafb279e04933084ae367abae5f93feeca75825116e84567

data/README.md

@@ -4,6 +4,7 @@ ActiveModel validator for Amazon S3 bucket names. It implements the official AWS
 - General purpose buckets (classic S3)
 - Directory buckets (S3 Express One Zone)
 - S3 Tables buckets
+- S3 vector buckets
 
 Works in any class using ActiveModel::Validations and in Rails/ActiveRecord models. Ships with i18n messages in multiple locales.
 
@@ -49,15 +50,18 @@ end
 
 ## Options
 
-- `type` — `:general_purpose` (default), `:directory`, or `:table`
+- `type` — `:general_purpose` (default), `:directory`, `:table`, or `:vector`
+- `namespace` — `:account_regional` allows the official account-regional general-purpose bucket suffix (`-<account-id>-<region>-an`)
 - `transfer_acceleration` — when `true`, periods are forbidden for general-purpose buckets
 
 Examples:
 
 ```ruby
 validates :bucket_name, s3_bucket_name: { transfer_acceleration: true }
+validates :bucket_name, s3_bucket_name: { namespace: :account_regional }
 validates :bucket_name, s3_bucket_name: { type: :directory }
 validates :bucket_name, s3_bucket_name: { type: :table }
+validates :bucket_name, s3_bucket_name: { type: :vector }
 ```
 
 ## i18n
@@ -67,6 +71,7 @@ Error keys provided:
 - `activemodel.errors.messages.s3_bucket_name_invalid_transfer_acceleration`
 - `activemodel.errors.messages.s3_bucket_name_invalid_directory`
 - `activemodel.errors.messages.s3_bucket_name_invalid_table`
+- `activemodel.errors.messages.s3_bucket_name_invalid_vector`
 
 Locales shipped: en, es, it, fr, de, pt-BR, ja, ko, zh-CN, zh-TW, ru, nl.
 
@@ -76,12 +81,14 @@ Rails loads locales via a Railtie; plain ActiveModel loads them at require-time.
 
 - Length 3–63, allowed characters, begin/end alphanumeric
 - No adjacent periods; not IP-like (general purpose)
-- Reserved prefixes/suffixes per AWS docs (for example `xn--`, `sthree-`, `amzn-s3-demo-`, `-s3alias`, `--ol-s3`, `.mrap`, `--x-s3`, `--table-s3`)
+- Reserved prefixes/suffixes per AWS docs (for example `xn--`, `sthree-`, `amzn-s3-demo-`, `-s3alias`, `--ol-s3`, `.mrap`, `--x-s3`, `--table-s3`, `-an`)
+- Account-regional general-purpose buckets must use `bucket-name-prefix-accountId-region-an` and require `namespace: :account_regional`
 - Directory buckets must end with `--<zone-id>--x-s3`
 - S3 Tables buckets disallow periods and underscores
+- S3 vector buckets disallow periods and underscores
 - Optional TA mode forbids periods
 
-Note: Global/partition uniqueness and immutability are service-side constraints and not enforced locally.
+Note: namespace uniqueness and immutability are service-side constraints and not enforced locally.
 
 ## Examples
 

data/activerecord-s3-bucket-name-validator.gemspec

@@ -1,18 +1,17 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "activerecord/s3/bucket/name/validator/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "activerecord-s3-bucket-name-validator"
-  spec.version       = Activerecord::S3::Bucket::Name::Validator::VERSION
-  spec.authors       = ["Claudio Poli"]
-  spec.email         = ["masterkain@gmail.com"]
+  spec.name = "activerecord-s3-bucket-name-validator"
+  spec.version = Activerecord::S3::Bucket::Name::Validator::VERSION
+  spec.authors = ["Claudio Poli"]
+  spec.email = ["masterkain@gmail.com"]
 
-  spec.summary       = %q{ActiveModel/ActiveRecord validator for Amazon S3 bucket naming rules}
-  spec.description   = %q{Validate S3 bucket names on your models against the official AWS rules (general purpose, directory buckets, and S3 Tables).}
-  spec.homepage      = "https://github.com/icoretech/activerecord-s3-bucket-name-validator"
-  spec.license       = "MIT"
+  spec.summary = "ActiveModel/ActiveRecord validator for Amazon S3 bucket naming rules"
+  spec.description = "Validate S3 bucket names on your models against the official AWS rules (general purpose, directory buckets, S3 Tables, and S3 Vectors)."
+  spec.homepage = "https://github.com/icoretech/activerecord-s3-bucket-name-validator"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -37,8 +36,8 @@ Gem::Specification.new do |spec|
     "LICENSE*",
     "*.gemspec"
   ]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 3.1"
@@ -51,4 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.17"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "minitest", ">= 5.0"
+  spec.add_development_dependency "simplecov", ">= 0.22"
 end

data/config/locales/de.yml

@@ -6,4 +6,5 @@ de:
         s3_bucket_name_invalid_transfer_acceleration: "darf keine Punkte enthalten, wenn S3 Transfer Acceleration verwendet wird"
         s3_bucket_name_invalid_directory: "ist kein gültiger S3-Verzeichnis-Bucket-Name (3–63 Zeichen; Kleinbuchstaben, Ziffern oder Bindestriche; muss mit --<zone-id>--x-s3 enden; reservierte Präfixe/Suffixe nicht erlaubt)"
         s3_bucket_name_invalid_table: "ist kein gültiger S3-Tables-Bucket-Name (3–63 Zeichen; Kleinbuchstaben, Ziffern oder Bindestriche; keine Punkte oder Unterstriche; keine reservierten Präfixe/Suffixe)"
+        s3_bucket_name_invalid_vector: "ist kein gültiger S3-Vectors-Bucket-Name (3–63 Zeichen; Kleinbuchstaben, Ziffern oder Bindestriche; keine Punkte oder Unterstriche; beginnt/endet alphanumerisch)"
         s3_bucket_name_invalid: "ist kein gültiger S3-Bucket-Name"

data/config/locales/en.yml

@@ -6,4 +6,5 @@ en:
         s3_bucket_name_invalid_transfer_acceleration: "cannot contain periods when using S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "is not a valid S3 directory bucket name (3–63 chars; lowercase letters, numbers or hyphens; must end with --<zone-id>--x-s3; reserved prefixes/suffixes not allowed)"
         s3_bucket_name_invalid_table: "is not a valid S3 Tables bucket name (3–63 chars; lowercase letters, numbers or hyphens; no periods or underscores; reserved prefixes/suffixes not allowed)"
+        s3_bucket_name_invalid_vector: "is not a valid S3 Vectors bucket name (3–63 chars; lowercase letters, numbers or hyphens; no periods or underscores; start/end alphanumeric)"
         s3_bucket_name_invalid: "is not a valid S3 bucket name"

data/config/locales/es.yml

@@ -6,4 +6,5 @@ es:
         s3_bucket_name_invalid_transfer_acceleration: "no puede contener puntos cuando se usa S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "no es un nombre de bucket de directorio S3 válido (3–63 caracteres; letras minúsculas, números o guiones; debe terminar con --<zone-id>--x-s3; prefijos/sufijos reservados no permitidos)"
         s3_bucket_name_invalid_table: "no es un nombre de bucket S3 Tables válido (3–63 caracteres; letras minúsculas, números o guiones; sin puntos ni guiones bajos; sin prefijos/sufijos reservados)"
+        s3_bucket_name_invalid_vector: "no es un nombre de bucket S3 Vectors válido (3–63 caracteres; letras minúsculas, números o guiones; sin puntos ni guiones bajos; empieza y termina alfanumérico)"
         s3_bucket_name_invalid: "no es un nombre de bucket S3 válido"

data/config/locales/fr.yml

@@ -6,4 +6,5 @@ fr:
         s3_bucket_name_invalid_transfer_acceleration: "ne peut pas contenir de points avec S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "n’est pas un nom de bucket de répertoire S3 valide (3–63 caractères ; lettres minuscules, chiffres ou tirets ; doit se terminer par --<zone-id>--x-s3 ; préfixes/suffixes réservés interdits)"
         s3_bucket_name_invalid_table: "n’est pas un nom de bucket S3 Tables valide (3–63 caractères ; lettres minuscules, chiffres ou tirets ; sans points ni underscores ; pas de préfixes/suffixes réservés)"
+        s3_bucket_name_invalid_vector: "n’est pas un nom de bucket S3 Vectors valide (3–63 caractères ; lettres minuscules, chiffres ou tirets ; sans points ni underscores ; commence et se termine par un caractère alphanumérique)"
         s3_bucket_name_invalid: "n’est pas un nom de bucket S3 valide"

data/config/locales/it.yml

@@ -6,4 +6,5 @@ it:
         s3_bucket_name_invalid_transfer_acceleration: "non può contenere punti quando si usa S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "non è un nome bucket directory S3 valido (3–63 caratteri; lettere minuscole, numeri o trattini; deve terminare con --<zone-id>--x-s3; prefissi/suffissi riservati non consentiti)"
         s3_bucket_name_invalid_table: "non è un nome bucket S3 Tables valido (3–63 caratteri; lettere minuscole, numeri o trattini; senza punti o underscore; senza prefissi/suffissi riservati)"
+        s3_bucket_name_invalid_vector: "non è un nome bucket S3 Vectors valido (3–63 caratteri; lettere minuscole, numeri o trattini; senza punti o underscore; inizia/termina alfanumerico)"
         s3_bucket_name_invalid: "non è un nome bucket S3 valido"

data/config/locales/ja.yml

@@ -6,4 +6,5 @@ ja:
         s3_bucket_name_invalid_transfer_acceleration: "S3 Transfer Acceleration を使用する場合、ピリオドは使用できません"
         s3_bucket_name_invalid_directory: "有効な S3 ディレクトリバケット名ではありません（3～63 文字、小文字の英字・数字・ハイフン、末尾に --<zone-id>--x-s3 必須、予約済みの接頭/接尾辞不可）"
         s3_bucket_name_invalid_table: "有効な S3 Tables バケット名ではありません（3～63 文字、小文字の英字・数字・ハイフン、ピリオドおよびアンダースコア不可、予約済みの接頭/接尾辞不可）"
+        s3_bucket_name_invalid_vector: "有効な S3 Vectors バケット名ではありません（3～63 文字、小文字の英字・数字・ハイフン、ピリオドおよびアンダースコア不可、先頭/末尾は英数字）"
         s3_bucket_name_invalid: "有効な S3 バケット名ではありません"

data/config/locales/ko.yml

@@ -6,4 +6,5 @@ ko:
         s3_bucket_name_invalid_transfer_acceleration: "S3 Transfer Acceleration 사용 시 점(.)을 포함할 수 없습니다"
         s3_bucket_name_invalid_directory: "유효한 S3 디렉터리 버킷 이름이 아닙니다(3–63자; 소문자, 숫자 또는 하이픈; '--<zone-id>--x-s3'로 끝나야 함; 예약된 접두사/접미사 금지)"
         s3_bucket_name_invalid_table: "유효한 S3 Tables 버킷 이름이 아닙니다(3–63자; 소문자, 숫자 또는 하이픈; 점/밑줄 금지; 예약된 접두사/접미사 금지)"
+        s3_bucket_name_invalid_vector: "유효한 S3 Vectors 버킷 이름이 아닙니다(3–63자; 소문자, 숫자 또는 하이픈; 점/밑줄 금지; 시작/끝은 영숫자)"
         s3_bucket_name_invalid: "유효한 S3 버킷 이름이 아닙니다"

data/config/locales/nl.yml

@@ -6,4 +6,5 @@ nl:
         s3_bucket_name_invalid_transfer_acceleration: "mag geen punten bevatten wanneer S3 Transfer Acceleration wordt gebruikt"
         s3_bucket_name_invalid_directory: "is geen geldige S3-directorybucketnaam (3–63 tekens; kleine letters, cijfers of koppeltekens; moet eindigen op --<zone-id>--x-s3; gereserveerde voor-/achtervoegsels niet toegestaan)"
         s3_bucket_name_invalid_table: "is geen geldige S3 Tables-bucketnaam (3–63 tekens; kleine letters, cijfers of koppeltekens; geen punten of underscores; geen gereserveerde voor-/achtervoegsels)"
+        s3_bucket_name_invalid_vector: "is geen geldige S3 Vectors-bucketnaam (3–63 tekens; kleine letters, cijfers of koppeltekens; geen punten of underscores; begint/eindigt alfanumerisch)"
         s3_bucket_name_invalid: "is geen geldige S3-bucketnaam"

data/config/locales/pt-BR.yml

@@ -6,4 +6,5 @@ pt-BR:
         s3_bucket_name_invalid_transfer_acceleration: "não pode conter pontos ao usar S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "não é um nome de bucket de diretório S3 válido (3–63 caracteres; letras minúsculas, números ou hífens; deve terminar com --<zone-id>--x-s3; prefixos/sufixos reservados não permitidos)"
         s3_bucket_name_invalid_table: "não é um nome de bucket S3 Tables válido (3–63 caracteres; letras minúsculas, números ou hífens; sem pontos ou underscores; sem prefixos/sufixos reservados)"
+        s3_bucket_name_invalid_vector: "não é um nome de bucket S3 Vectors válido (3–63 caracteres; letras minúsculas, números ou hífens; sem pontos ou underscores; começa/termina alfanumérico)"
         s3_bucket_name_invalid: "não é um nome de bucket S3 válido"

data/config/locales/ru.yml

@@ -6,4 +6,5 @@ ru:
         s3_bucket_name_invalid_transfer_acceleration: "нельзя использовать точки при S3 Transfer Acceleration"
         s3_bucket_name_invalid_directory: "недопустимое имя каталожного S3 бакета (3–63 символа; строчные буквы, цифры или дефисы; должно заканчиваться на --<zone-id>--x-s3; зарезервированные префиксы/суффиксы запрещены)"
         s3_bucket_name_invalid_table: "недопустимое имя бакета S3 Tables (3–63 символа; строчные буквы, цифры или дефисы; без точек и нижних подчёркиваний; зарезервированные префиксы/суффиксы запрещены)"
+        s3_bucket_name_invalid_vector: "недопустимое имя бакета S3 Vectors (3–63 символа; строчные буквы, цифры или дефисы; без точек и нижних подчёркиваний; начинается/заканчивается буквенно-цифровым символом)"
         s3_bucket_name_invalid: "недопустимое имя S3 бакета"

data/config/locales/zh-CN.yml

@@ -6,4 +6,5 @@ zh-CN:
         s3_bucket_name_invalid_transfer_acceleration: "使用 S3 Transfer Acceleration 时，名称中不能包含点（.）"
         s3_bucket_name_invalid_directory: "不是有效的 S3 目录存储桶名称（3–63 个字符；小写字母、数字或连字符；必须以 --<zone-id>--x-s3 结尾；不得使用保留的前缀/后缀）"
         s3_bucket_name_invalid_table: "不是有效的 S3 Tables 存储桶名称（3–63 个字符；小写字母、数字或连字符；不允许点或下划线；不得使用保留的前缀/后缀）"
+        s3_bucket_name_invalid_vector: "不是有效的 S3 Vectors 存储桶名称（3–63 个字符；小写字母、数字或连字符；不允许点或下划线；首尾必须为字母或数字）"
         s3_bucket_name_invalid: "不是有效的 S3 存储桶名称"

data/config/locales/zh-TW.yml

@@ -6,4 +6,5 @@ zh-TW:
         s3_bucket_name_invalid_transfer_acceleration: "使用 S3 Transfer Acceleration 時，名稱中不可包含點（.）"
         s3_bucket_name_invalid_directory: "不是有效的 S3 目錄儲存貯體名稱（3–63 個字元；小寫字母、數字或連字號；必須以 --<zone-id>--x-s3 結尾；不得使用保留的前/後綴）"
         s3_bucket_name_invalid_table: "不是有效的 S3 Tables 儲存貯體名稱（3–63 個字元；小寫字母、數字或連字號；不可有點或底線；不得使用保留的前/後綴）"
+        s3_bucket_name_invalid_vector: "不是有效的 S3 Vectors 儲存貯體名稱（3–63 個字元；小寫字母、數字或連字號；不可有點或底線；開頭與結尾必須為英數字）"
         s3_bucket_name_invalid: "不是有效的 S3 儲存貯體名稱"

data/lib/activerecord/s3/bucket/name/validator/version.rb

@@ -3,7 +3,7 @@ module Activerecord
     module Bucket
       module Name
         module Validator
-          VERSION = "0.1.3"
+          VERSION = "0.2.0"
         end
       end
     end

data/lib/activerecord/s3/bucket/name/validator.rb

@@ -30,7 +30,8 @@ end
 # Usage in a model:
 #   validates :bucket_name, s3_bucket_name: { type: :general_purpose }
 # Options:
-#   :type => :general_purpose (default), :directory, or :table
+#   :type => :general_purpose (default), :directory, :table, or :vector
+#   :namespace => :account_regional for general-purpose account regional bucket names
 #   :transfer_acceleration => true to forbid periods for TA buckets
 class S3BucketNameValidator < ActiveModel::EachValidator
   RESERVED_PREFIXES_GENERAL = %w[xn-- sthree- amzn-s3-demo-].freeze
@@ -44,9 +45,15 @@ class S3BucketNameValidator < ActiveModel::EachValidator
     return if blank_ok?(value)
 
     valid = case type
-    when :general_purpose then validate_general_purpose(value, transfer_acceleration: !!options[:transfer_acceleration])
+    when :general_purpose
+      validate_general_purpose(
+        value,
+        transfer_acceleration: !!options[:transfer_acceleration],
+        namespace: options[:namespace]
+      )
     when :directory then validate_directory_bucket(value)
     when :table then validate_table_bucket(value)
+    when :vector then validate_vector_bucket(value)
     else
       record.errors.add(attribute, :invalid, message: "unknown bucket type: #{type}")
       false
@@ -60,6 +67,7 @@ class S3BucketNameValidator < ActiveModel::EachValidator
         when :general_purpose then :s3_bucket_name_invalid_general
         when :directory then :s3_bucket_name_invalid_directory
         when :table then :s3_bucket_name_invalid_table
+        when :vector then :s3_bucket_name_invalid_vector
         else :s3_bucket_name_invalid
         end
       end
@@ -76,7 +84,7 @@ class S3BucketNameValidator < ActiveModel::EachValidator
   end
 
   # Based on AWS docs: General purpose bucket naming rules
-  def validate_general_purpose(name, transfer_acceleration: false)
+  def validate_general_purpose(name, transfer_acceleration: false, namespace: nil)
     return false unless length_between?(name, 3, 63)
     return false unless /\A[a-z0-9.-]+\z/.match?(name)
     return false unless begins_and_ends_with_alnum?(name)
@@ -85,6 +93,8 @@ class S3BucketNameValidator < ActiveModel::EachValidator
     return false unless RESERVED_PREFIXES_GENERAL.none? { |p| name.start_with?(p) }
     return false unless RESERVED_SUFFIXES_GENERAL.none? { |s| name.end_with?(s) }
     return false if transfer_acceleration && name.include?(".")
+    return false if name.end_with?("-an") && namespace != :account_regional
+    return false if namespace == :account_regional && !account_regional_name?(name)
     true
   end
 
@@ -111,6 +121,14 @@ class S3BucketNameValidator < ActiveModel::EachValidator
     true
   end
 
+  # Based on AWS docs: S3 vector bucket naming rules
+  def validate_vector_bucket(name)
+    return false unless length_between?(name, 3, 63)
+    return false unless /\A[a-z0-9-]+\z/.match?(name)
+    return false unless begins_and_ends_with_alnum?(name)
+    true
+  end
+
   def length_between?(str, min, max)
     str.length.between?(min, max)
   end
@@ -122,4 +140,8 @@ class S3BucketNameValidator < ActiveModel::EachValidator
   def ip_like?(str)
     str =~ /\A(?:\d{1,3}\.){3}\d{1,3}\z/
   end
+
+  def account_regional_name?(str)
+    /\A.+-\d{12}-[a-z0-9-]+-\d-an\z/.match?(str)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-s3-bucket-name-validator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Claudio Poli
@@ -85,8 +85,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: Validate S3 bucket names on your models against the official AWS rules
-  (general purpose, directory buckets, and S3 Tables).
+  (general purpose, directory buckets, S3 Tables, and S3 Vectors).
 email:
 - masterkain@gmail.com
 executables: []