cognito_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b69f6c8db91a764df6878e0de53feb9879f7509e79bf0d406e6fe9522f96e61
-  data.tar.gz: f44a4f4dfce641e54493730c9f183c9bd2f6a2e73fe4cd0c7a60d084b6d0d09a
+  metadata.gz: 2d8bc1e0dc872a16d7406a72e5028da49b62c80c5297d6c4428ea45efd5293a1
+  data.tar.gz: 71d87358a0e584eba16ada273a582caa7e560b84ba58b06d6b5752b7d1769f9e
 SHA512:
-  metadata.gz: 17551dd1de906fd5813214f4fdd98bd49f7d4503138cfa5cd9beedc235707dc00b000d356e090a154b7de0c08e692553154b273d50236b31f455903044c97594
-  data.tar.gz: ee07b9c1b821bc601ac2c62d4268392783e5f687da1d9b810d6160f64c5b7f3546ffd7e5998f05a5a03fc2326bd162e338e0be2ceda461d2cae1152072e44ec8
+  metadata.gz: c22e85bfa4b48b5f5614314ae5cf2f696342fdf3ca204ca92a9d23107a1097da897dcd23a67d7635f1a2cd83b8ecaacbf4bdf20bfeba785fb0c9a1328fb671e9
+  data.tar.gz: def01df4152f2fa0e0fc3991e1438d5898af2d3485be0824f0d59e83987d65d27268897e90308e353fdc04e7b8658ff88f0e54fd92dad41d263292fed80756d9

data/lib/cognito_rails/model.rb

@@ -28,10 +28,13 @@ module CognitoRails
       # @return [Array<ActiveRecord::Base>] all users
       # @raise [CognitoRails::Error] if failed to fetch users
       # @raise [ActiveRecord::RecordInvalid] if failed to save user
+      # @yield [user, user_data] yields user and user_data just before saving
       def sync_from_cognito!
         response = User.all
         response.users.map do |user_data|
-          sync_user!(user_data)
+          sync_user!(user_data) do |user|
+            yield user, user_data if block_given?
+          end
         end
       end
 
@@ -56,6 +59,8 @@ module CognitoRails
         user.phone = User.extract_cognito_attribute(user_data.attributes, :phone_number) if user.respond_to?(:phone)
         _cognito_resolve_custom_attribute(user, user_data)
 
+        yield user if block_given?
+
         user.save!
         user
       end

data/lib/cognito_rails/version.rb

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

data/spec/cognito_rails/user_spec.rb

@@ -143,27 +143,50 @@ RSpec.describe CognitoRails::User, type: :model do
       expect(CognitoRails::User).to receive(:cognito_client).at_least(:once).and_return(fake_cognito_client)
     end
 
-    it '#sync_from_cognito!' do
-      expect(fake_cognito_client).to receive(:list_users).and_return(
-        OpenStruct.new(
-          users: [
-            build_cognito_user_data('some@example.com'),
-            build_cognito_user_data('some2@example.com')
-          ],
-          pagination_token: nil
+    context '#sync_from_cognito!' do
+      before do
+        expect(fake_cognito_client).to receive(:list_users).and_return(
+          OpenStruct.new(
+            users: [
+              build_cognito_user_data('some@example.com'),
+              build_cognito_user_data('some2@example.com')
+            ],
+            pagination_token: nil
+          )
         )
-      )
-
-      expect do
-        users = User.sync_from_cognito!
-
-        expect(users).to be_a(Array)
-        expect(users.size).to eq(2)
-        expect(users.first).to be_a(User)
-      end.to change { User.count }.by(2)
-
-      expect(User.pluck(:email)).to match_array(['some@example.com', 'some2@example.com'])
-      expect(User.pluck(:name)).to match_array(['Giovanni', 'Giovanni'])
+      end
+      it 'imports all users correctly' do
+        expect do
+          users = User.sync_from_cognito!
+
+          expect(users).to be_a(Array)
+          expect(users.size).to eq(2)
+          expect(users.first).to be_a(User)
+        end.to change { User.count }.by(2)
+
+        expect(User.pluck(:email)).to match_array(['some@example.com', 'some2@example.com'])
+        expect(User.pluck(:name)).to match_array(['John Doe', 'John Doe'])
+      end
+
+      it 'allows to specify a block with extra changes applied pre-save' do
+        expect do
+          i = 0
+          users = EnrichedUser.sync_from_cognito! do |user, cognito_user|
+            i += 1
+            name = cognito_user.attributes.find { |a| a.name == 'custom:name' }
+            user.first_name = name.value.split(' ').first + i.to_s
+            user.last_name = name.value.split(' ').last
+          end
+
+          expect(users).to be_a(Array)
+          expect(users.size).to eq(2)
+          expect(users.first).to be_a(EnrichedUser)
+        end.to change { EnrichedUser.count }.by(2)
+
+        expect(EnrichedUser.pluck(:email)).to match_array(['some@example.com', 'some2@example.com'])
+        expect(EnrichedUser.order(:id).pluck(:first_name)).to match_array(['John1', 'John2'])
+        expect(EnrichedUser.order(:id).pluck(:last_name)).to match_array(['Doe', 'Doe'])
+      end
     end
 
     it '#sync_to_cognito!' do

data/spec/support/cognito_helpers.rb

@@ -54,7 +54,7 @@ module CognitoRails::Helpers
         ),
         OpenStruct.new(
           name: 'custom:name',
-          value: 'Giovanni'
+          value: 'John Doe'
         )
       ],
       mfa_options: []

data/spec/support/schema.rb

@@ -17,6 +17,19 @@ class User < ActiveRecord::Base
   attr_accessor :password
 end
 
+class EnrichedUser < ActiveRecord::Base
+  validates :email, presence: true
+  validates :email, uniqueness: true
+  validates :first_name, :last_name, presence: true
+
+  as_cognito_user
+  cognito_verify_email
+  define_cognito_attribute 'role', 'user'
+
+  attr_accessor :password
+end
+
+
 class Admin < ActiveRecord::Base
   validates :email, presence: true
   validates :email, uniqueness: true
@@ -41,6 +54,14 @@ module Schema
         t.timestamps null: false
       end
 
+      create_table :enriched_users, force: true do |t|
+        t.string "email", null: false
+        t.string "first_name", null: false
+        t.string "last_name", null: false
+        t.string "external_id", null: false
+        t.timestamps null: false
+      end
+
       create_table :admins, force: true do |t|
         t.string "email", null: false
         t.string "phone", null: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognito_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mònade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport