cognito_rails 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a632d6d69bb5fe154466be5a348d85be21fbdc4724d8d36e8f6277d3c25272a
-  data.tar.gz: 80cfe3e7dff4e66bbddb1216490661fc057777248e25be73b142d9e727263888
+  metadata.gz: 3c56a423a7d1738a9b7a521d4a9856c6abf1f66abbe8ae743963a115cc9b4cf8
+  data.tar.gz: eb6a06e28793e1306a77c68c26884625eca2005ac4017895be317a8571db30af
 SHA512:
-  metadata.gz: 20f84101146cfbe29e6f447e7b7eae1d08526383d8d33ea4ce98c93ea7d25b50da29464064ea023b2425e484afc874f67fb775c189df631d9b0e802047e62df7
-  data.tar.gz: 88ffa88de959b6e6f335723ef8d423842a9bdd18b3e1ccff16791d98575e77f30ef7070eb588f7556913f4c3f7c2f600bf38c7274a70b73957b835893a52e33c
+  metadata.gz: dec481affcb3985407c1908297df5dccf1a2c3681f545b9c8a0c9c9ad1303ece7bb101ae0c916173fa53a8ddbc209e53fcd5fe524ad45d2fd7f8336c7b116eb6
+  data.tar.gz: 9a880a87e8a1247eaf4132d860aaed216ac4aa246f51cb515cfef8b865bfbe54eb9831a57f1fc06c2fd94d93e814a0770e61c1be24e899786d8ec1a3c33b6fc0

data/lib/cognito_rails/model.rb

@@ -12,6 +12,7 @@ module CognitoRails
       class_attribute :_cognito_verify_phone
       class_attribute :_cognito_custom_attributes
       class_attribute :_cognito_attribute_name
+      class_attribute :_cognito_attribute_type
       class_attribute :_cognito_password_policy
       class_attribute :_cognito_aws_user_pool_id
       class_attribute :_cognito_aws_client_credentials
@@ -60,11 +61,12 @@ module CognitoRails
       private
 
       def sync_user!(user_data)
-        external_id = user_data.username
+        attributes = user_data.respond_to?(:attributes) ? user_data.attributes : user_data.user_attributes
+
+        external_id = _cognito_resolve_attribute_type(user_data)
         return if external_id.blank?
 
         user = find_or_initialize_by(_cognito_attribute_name => external_id)
-        attributes = user_data.respond_to?(:attributes) ? user_data.attributes : user_data.user_attributes
         user.email = User.extract_cognito_attribute(attributes, :email)
         user.phone = User.extract_cognito_attribute(attributes, :phone_number) if user.respond_to?(:phone)
         _cognito_resolve_custom_attribute(user, user_data)
@@ -75,6 +77,19 @@ module CognitoRails
         user
       end
 
+      def _cognito_resolve_attribute_type(user_data)
+        attributes = user_data.respond_to?(:attributes) ? user_data.attributes : user_data.user_attributes
+
+        case _cognito_attribute_type
+        when :username
+          user_data.username
+        when :sub
+          User.extract_cognito_attribute(attributes, :sub)
+        else
+          raise "Unsupported attribute type: #{_cognito_attribute_type}"
+        end
+      end
+
       def _cognito_resolve_custom_attribute(user, user_data)
         _cognito_custom_attributes.each do |attribute|
           next if attribute[:value].is_a?(String)

data/lib/cognito_rails/version.rb

@@ -2,5 +2,5 @@
 
 module CognitoRails
   # @return [String] gem version
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

data/lib/cognito_rails.rb

@@ -25,9 +25,10 @@ module CognitoRails
     # @param user_pool_id [String]
     # @param aws_credentials [Hash,nil]
     # @return [void]
-    def as_cognito_user(attribute_name: 'external_id', user_pool_id: nil, aws_credentials: nil)
+    def as_cognito_user(attribute_name: 'external_id', attribute_type: :username, user_pool_id: nil, aws_credentials: nil)
       send :include, CognitoRails::Model
       self._cognito_attribute_name = attribute_name
+      self._cognito_attribute_type = attribute_type
       self._cognito_aws_user_pool_id = user_pool_id
       self._cognito_aws_client_credentials = aws_credentials
 

data/spec/cognito_rails/user_spec.rb

@@ -156,7 +156,7 @@ RSpec.describe CognitoRails::User, type: :model do
 
     context '#sync_from_cognito!' do
       before do
-        expect(fake_cognito_client).to receive(:list_users).and_return(
+        allow(fake_cognito_client).to receive(:list_users).and_return(
           OpenStruct.new(
             users: [
               build_cognito_user_data('some@example.com'),
@@ -179,6 +179,40 @@ RSpec.describe CognitoRails::User, type: :model do
         expect(User.pluck(:name)).to match_array(['John Doe', 'John Doe'])
       end
 
+      it 'resolves external_id from username when attribute_type is :username' do
+        allow(fake_cognito_client).to receive(:list_users).and_return(
+          OpenStruct.new(
+            users: [
+              build_cognito_user_data('u1@example.com', username: 'username-1'),
+              build_cognito_user_data('u2@example.com', username: 'username-2')
+            ],
+            pagination_token: nil
+          )
+        )
+
+        expect do
+          users = User.sync_from_cognito!
+          expect(users.map(&:external_id)).to match_array(%w[username-1 username-2])
+        end.to change { User.count }.by(2)
+      end
+
+      it 'resolves external_id from sub when attribute_type is :sub' do
+        allow(fake_cognito_client).to receive(:list_users).and_return(
+          OpenStruct.new(
+            users: [
+              build_cognito_user_data('s1@example.com', sub: 'sub-1'),
+              build_cognito_user_data('s2@example.com', sub: 'sub-2')
+            ],
+            pagination_token: nil
+          )
+        )
+
+        expect do
+          users = SubAttributeUser.sync_from_cognito!
+          expect(users.map(&:external_id)).to match_array(%w[sub-1 sub-2])
+        end.to change { SubAttributeUser.count }.by(2)
+      end
+
       it 'allows to specify a block with extra changes applied pre-save' do
         expect do
           i = 0

data/spec/support/cognito_helpers.rb

@@ -40,9 +40,9 @@ module CognitoRails::Helpers
     end
   end
 
-  def build_cognito_user_data(email)
+  def build_cognito_user_data(email, username: SecureRandom.uuid, sub: nil)
     OpenStruct.new(
-      username: SecureRandom.uuid,
+      username: username,
       user_status: 'CONFIRMED',
       enabled: true,
       user_last_modified_date: Time.now,
@@ -51,11 +51,12 @@ module CognitoRails::Helpers
           name: 'email',
           value: email
         ),
+        (sub ? OpenStruct.new(name: 'sub', value: sub) : nil),
         OpenStruct.new(
           name: 'custom:name',
           value: 'John Doe'
         )
-      ],
+      ].compact,
       mfa_options: []
     )
   end

data/spec/support/schema.rb

@@ -63,6 +63,16 @@ class PasswordProvidedUser < ActiveRecord::Base
   attr_accessor :password
 end
 
+class SubAttributeUser < ActiveRecord::Base
+  validates :email, presence: true
+  validates :email, uniqueness: true
+
+  as_cognito_user(attribute_type: :sub)
+  cognito_verify_email
+
+  attr_accessor :password
+end
+
 module Schema
   def self.create
     ActiveRecord::Migration.verbose = false
@@ -96,6 +106,12 @@ module Schema
         t.string "external_id", null: false
         t.timestamps null: false
       end
+
+      create_table :sub_attribute_users, force: true do |t|
+        t.string "email", null: false
+        t.string "external_id", null: false
+        t.timestamps null: false
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognito_rails
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Mònade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-13 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport