cognito_rails 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d8bc1e0dc872a16d7406a72e5028da49b62c80c5297d6c4428ea45efd5293a1
-  data.tar.gz: 71d87358a0e584eba16ada273a582caa7e560b84ba58b06d6b5752b7d1769f9e
+  metadata.gz: 8d013a998e0deb672975845d617ee6e7bd98985e9776005574edddc60efea303
+  data.tar.gz: ddf9787f8bb69aff3ffcff50464fda787b9097875d9d8da165ef9074138ac4b6
 SHA512:
-  metadata.gz: c22e85bfa4b48b5f5614314ae5cf2f696342fdf3ca204ca92a9d23107a1097da897dcd23a67d7635f1a2cd83b8ecaacbf4bdf20bfeba785fb0c9a1328fb671e9
-  data.tar.gz: def01df4152f2fa0e0fc3991e1438d5898af2d3485be0824f0d59e83987d65d27268897e90308e353fdc04e7b8658ff88f0e54fd92dad41d263292fed80756d9
+  metadata.gz: b943c7b79fc60f473b99bd93b52319a4f7abe01f78266ed587f94ca9daf0c74d13ed0c8d72cb44d77c14813a7509b805adb96e929d43d7f22c5ba2b127a3a55b
+  data.tar.gz: 7a65fadd47485c198d6a70696c9e79d52da01130b35d2fd9479e86de64784f15786b4956d4329a873335bec7db794673f86f5971c938e3a234f7f72ad06d7969

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
@@ -142,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.2.0'
+  VERSION = '1.4.0'
 end

data/lib/cognito_rails.rb

@@ -4,6 +4,7 @@ require 'active_support/concern'
 require 'active_support/dependencies/autoload'
 require 'active_record'
 require 'action_controller/metal'
+require 'ostruct'
 
 # Provides a set of tools to integrate AWS Cognito in your Rails app
 module CognitoRails

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
@@ -184,8 +193,8 @@ RSpec.describe CognitoRails::User, type: :model do
         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'])
+        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
 

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'cognito_rails'
 require 'factory_bot_rails'
 require 'rspec/collection_matchers'
 require 'factories/user'
+require 'ostruct'
 
 I18n.enforce_available_locales = false
 RSpec::Expectations.configuration.warn_about_potential_false_positives = false

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

data/spec/support/schema.rb

@@ -42,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
@@ -68,6 +82,13 @@ module Schema
         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.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Mònade
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cognitoidentityprovider
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +127,7 @@ homepage: https://rubygems.org/gems/cognito_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Add Cognito authentication to your Rails API
 test_files: