cognito_rails 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b69f6c8db91a764df6878e0de53feb9879f7509e79bf0d406e6fe9522f96e61
-  data.tar.gz: f44a4f4dfce641e54493730c9f183c9bd2f6a2e73fe4cd0c7a60d084b6d0d09a
+  metadata.gz: bf2686f37e8a52be09eb2a043f21055fca0823015460b964e448ccc27e7a5637
+  data.tar.gz: d5d983d923769b5ff58325e05d5a5f942b69efe80b9e0adbcc9ca384fe3b8960
 SHA512:
-  metadata.gz: 17551dd1de906fd5813214f4fdd98bd49f7d4503138cfa5cd9beedc235707dc00b000d356e090a154b7de0c08e692553154b273d50236b31f455903044c97594
-  data.tar.gz: ee07b9c1b821bc601ac2c62d4268392783e5f687da1d9b810d6160f64c5b7f3546ffd7e5998f05a5a03fc2326bd162e338e0be2ceda461d2cae1152072e44ec8
+  metadata.gz: bf8e6743abb4d4a7968598b84c08a92c04b1838fdab5754e75d6157626b7f1b8106397a917799872693e0da51e0f310b3e353759b36e2c77bc6fbb0d85d321c0
+  data.tar.gz: bc2b2a108801f6d108d13db71b1ac7c86ab3c9bf16fbf0cb93d0bd1e59f488b16eb7009df04088eaec9ac6c68706dfb651a30db7b856e36f8a2b7ef03835bdbb

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_password_policy
       self._cognito_custom_attributes = []
 
       before_create do
@@ -28,10 +29,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 +60,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
@@ -137,6 +143,10 @@ module CognitoRails
         self._cognito_verify_phone = true
       end
 
+      def cognito_password_policy(type)
+        self._cognito_password_policy = type
+      end
+
       # @param name [String] attribute name
       # @param value [String] attribute name
       def define_cognito_attribute(name, value)

data/lib/cognito_rails/user.rb

@@ -171,6 +171,11 @@ module CognitoRails
       user_class._cognito_verify_phone
     end
 
+    # @return [Symbol] :temporary | :user_provided
+    def cognito_password_policy
+      user_class._cognito_password_policy || :temporary
+    end
+
     # @return [Array<Hash>]
     def general_user_attributes
       [
@@ -188,18 +193,41 @@ module CognitoRails
       ]
     end
 
+    # @return [Array<Hash>]
+    def password_attributes
+      if cognito_password_policy == :user_provided
+        { message_action: 'SUPPRESS' }
+      else
+        { temporary_password: password }
+      end
+    end
+
+    def set_user_provided_password
+      cognito_client.admin_set_user_password(
+        {
+          user_pool_id: CognitoRails::Config.aws_user_pool_id,
+          username: email,
+          password: password,
+          permanent: true
+        }
+      )
+    end
+
     def save_for_create
       resp = cognito_client.admin_create_user(
         {
           user_pool_id: CognitoRails::Config.aws_user_pool_id,
           username: email,
-          temporary_password: password,
           user_attributes: [
             *general_user_attributes,
             *verify_user_attributes
-          ]
+          ],
+          **password_attributes
         }
       )
+
+      set_user_provided_password if cognito_password_policy == :user_provided
+
       self.id = resp.user.attributes.find { |a| a[:name] == 'sub' }[:value]
     end
 

data/lib/cognito_rails/version.rb

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

data/spec/cognito_rails/user_spec.rb

@@ -7,6 +7,7 @@ RSpec.describe CognitoRails::User, type: :model do
 
   let(:sample_cognito_email) { 'some@mail.com' }
   let(:sample_cognito_phone) { '123456789' }
+  let(:sample_cognito_password) { '123qweASD!@#' }
 
   it 'validates email presence' do
     expect(subject).to have(1).error_on(:email)
@@ -136,6 +137,14 @@ RSpec.describe CognitoRails::User, type: :model do
 
       User.create!(email: sample_cognito_email, name: 'TestName')
     end
+
+    it 'creates a cognito user with user_provided' do
+      expect(fake_cognito_client).to receive(:admin_set_user_password).exactly(1).time.and_return(OpenStruct.new)
+
+      allow_any_instance_of(CognitoRails::User).to receive(:cognito_client).and_return(fake_cognito_client)
+      PasswordProvidedUser.create!(email: sample_cognito_email, password: sample_cognito_password)
+      User.create!(email: sample_cognito_email)
+    end
   end
 
   context 'class methods' do
@@ -143,27 +152,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(%w[John1 John2])
+        expect(EnrichedUser.order(:id).pluck(:last_name)).to match_array(%w[Doe Doe])
+      end
     end
 
     it '#sync_to_cognito!' do

data/spec/support/cognito_helpers.rb

@@ -11,8 +11,7 @@ module CognitoRails::Helpers
         expect(params).to match_structure(
           user_pool_id: one_of(String, nil),
           username: String,
-          temporary_password: String,
-          user_attributes: a_list_of(name: String, value: one_of(String, nil))
+          user_attributes: a_list_of(name: String, value: one_of(String, nil)),
         )
         OpenStruct.new(user: OpenStruct.new(attributes: [{ name: 'sub', value: sample_cognito_id }]))
       end
@@ -54,7 +53,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
@@ -29,6 +42,20 @@ class Admin < ActiveRecord::Base
   define_cognito_attribute 'role', 'admin'
 end
 
+
+class PasswordProvidedUser < ActiveRecord::Base
+  validates :email, presence: true
+  validates :email, uniqueness: true
+
+  as_cognito_user
+  cognito_verify_email
+  cognito_password_policy :user_provided
+  define_cognito_attribute 'role', 'user'
+  define_cognito_attribute 'name', :name
+
+  attr_accessor :password
+end
+
 module Schema
   def self.create
     ActiveRecord::Migration.verbose = false
@@ -41,12 +68,27 @@ 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
         t.string "cognito_id", null: false
         t.timestamps null: false
       end
+
+      create_table :password_provided_users, force: true do |t|
+        t.string "email", null: false
+        t.string "name"
+        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.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mònade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport