cognito_rails 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8bbd85c82670198044b07ac6bd693920201e3911166f1432365bd834e54fafd
-  data.tar.gz: 1c435514395d116f142fb22121bb0bdb7cdb91b46897b48566453e3748ae184d
+  metadata.gz: 2d8bc1e0dc872a16d7406a72e5028da49b62c80c5297d6c4428ea45efd5293a1
+  data.tar.gz: 71d87358a0e584eba16ada273a582caa7e560b84ba58b06d6b5752b7d1769f9e
 SHA512:
-  metadata.gz: 11bea4faacf98021ee61a6ae2280e4da743fd1e62e68c4dc88681c98f735973ccabc5806261df3e1d22243da42eef7fb3ddc2fc02f5c06677e6291f1e3d9f780
-  data.tar.gz: 26ba725b881ab2333e8ea5823ac199fc4fd430426b85f1f50832d2e9b1985db692615d2543ef7cea6d6a21aa8cddfdc9358194bf0ce30655acb35b0a971a1d90
+  metadata.gz: c22e85bfa4b48b5f5614314ae5cf2f696342fdf3ca204ca92a9d23107a1097da897dcd23a67d7635f1a2cd83b8ecaacbf4bdf20bfeba785fb0c9a1328fb671e9
+  data.tar.gz: def01df4152f2fa0e0fc3991e1438d5898af2d3485be0824f0d59e83987d65d27268897e90308e353fdc04e7b8658ff88f0e54fd92dad41d263292fed80756d9

data/lib/cognito_rails/config.rb

@@ -19,7 +19,7 @@ module CognitoRails
       # @!attribute default_user_class [w]
       #   @return [String,nil]
       attr_writer :aws_client_credentials, :skip_model_hooks, :aws_region,
-                  :aws_user_pool_id, :default_user_class
+                  :aws_user_pool_id, :default_user_class, :password_generator
 
       # @return [Boolean] skip model hooks
       def skip_model_hooks
@@ -49,6 +49,10 @@ module CognitoRails
       def default_user_class
         @default_user_class || (raise 'Missing config default_user_class')
       end
+
+      def password_generator
+        @password_generator || CognitoRails::PasswordGenerator.method(:generate)
+      end
     end
   end
 end

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
@@ -92,12 +97,17 @@ module CognitoRails
     def init_cognito_user
       return if cognito_external_id.present?
 
+      cognito_user = User.new(init_attributes)
+      cognito_user.save!
+      self.cognito_external_id = cognito_user.id
+    end
+
+    def init_attributes
       attrs = { email: email, user_class: self.class }
       attrs[:phone] = phone if respond_to?(:phone)
+      attrs[:password] = password if respond_to?(:password)
       attrs[:custom_attributes] = instance_custom_attributes
-      cognito_user = User.new(attrs)
-      cognito_user.save!
-      self.cognito_external_id = cognito_user.id
+      attrs
     end
 
     # @return [Array<Hash>]

data/lib/cognito_rails/password_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CognitoRails
+  class PasswordGenerator
+    NUMERIC = (0..9).to_a.freeze
+    LOWER_CASE = ('a'..'z').to_a.freeze
+    UPPER_CASE = ('A'..'Z').to_a.freeze
+    SPECIAL = [
+      '^', '$', '*', '.', '[', ']', '{', '}',
+      '(', ')', '?', '"', '!', '@', '#', '%',
+      '&', '/', '\\', ',', '>', '<', "'", ':',
+      ';', '|', '_', '~', '`', '=', '+', '-'
+    ].freeze
+
+    # Generates a random password given a length range
+    #
+    # @param range [Range]
+    # @return [String]
+    def self.generate(range = 8..16)
+      password_length = rand(range)
+      numeric_count = rand(1..(password_length-3))
+
+      lower_case_count = rand(1..(password_length-(numeric_count+2)))
+      upper_case_count = rand(1..(password_length-(numeric_count + lower_case_count + 1)))
+      special_count = password_length-(numeric_count + lower_case_count + upper_case_count)
+
+      numeric_characters = numeric_count.times.map { NUMERIC.sample }
+      lower_case_characters = lower_case_count.times.map { LOWER_CASE.sample }
+      upper_case_characters = upper_case_count.times.map { UPPER_CASE.sample }
+      special_characters = special_count.times.map { SPECIAL.sample }
+
+      (numeric_characters + lower_case_characters + upper_case_characters + special_characters).shuffle.join
+    end
+  end
+end

data/lib/cognito_rails/user.rb

@@ -39,7 +39,7 @@ module CognitoRails
     def initialize(attributes = {})
       attributes = attributes.with_indifferent_access
       self.email = attributes[:email]
-      self.password = SecureRandom.urlsafe_base64 || attributes[:password]
+      self.password = attributes[:password] || Config.password_generator.call
       self.phone = attributes[:phone]
       self.user_class = attributes[:user_class] || Config.default_user_class.constantize
       self.custom_attributes = attributes[:custom_attributes]

data/lib/cognito_rails/version.rb

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

data/lib/cognito_rails.rb

@@ -15,6 +15,7 @@ module CognitoRails
   autoload :Model
   autoload :User
   autoload :JWT
+  autoload :PasswordGenerator
 
   # @private
   module ModelInitializer

data/spec/cognito_rails/controller_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
-# rubocop:disable Metrics/BlockLength
 RSpec.describe CognitoRails::Controller, type: :model do
-  # rubocop:enable Metrics/BlockLength
   include CognitoRails::Helpers
 
   context 'with an API controller' do

data/spec/cognito_rails/jwt_spec.rb

@@ -2,9 +2,7 @@
 
 require 'spec_helper'
 
-# rubocop:disable Metrics/BlockLength
 RSpec.describe CognitoRails::JWT, type: :model do
-  # rubocop:enable Metrics/BlockLength
   before do
     allow(URI).to receive(:open).and_return(double(read: jwks))
   end

data/spec/cognito_rails/password_generator_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CognitoRails::PasswordGenerator do
+  it 'generates a password' do
+    expect(described_class.generate).to be_a(String)
+  end
+
+  it 'generates a password with the correct length' do
+    1000.times do
+      expect(described_class.generate(8..8).length).to eq(8)
+    end
+  end
+
+  it 'contains at least one letter, one number, one upper case letter, one symbol' do
+    1000.times do
+      password = described_class.generate
+      expect(password).to match(/[a-z]/)
+      expect(password).to match(/[A-Z]/)
+      expect(password).to match(/[0-9]/)
+      include_symbol = CognitoRails::PasswordGenerator::SPECIAL.any? do |symbol|
+        password.include?(symbol)
+      end
+      expect(include_symbol).to be_truthy
+    end
+  end
+end

data/spec/cognito_rails/user_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 
-# rubocop:disable Metrics/BlockLength
 RSpec.describe CognitoRails::User, type: :model do
   include CognitoRails::Helpers
 
@@ -83,6 +82,34 @@ RSpec.describe CognitoRails::User, type: :model do
       user.destroy!
     end
 
+    it 'uses the password generator defined in config' do
+      CognitoRails::Config.password_generator = -> { 'ciao' }
+      expect(CognitoRails::User).to receive(:cognito_client).at_least(:once).and_return(fake_cognito_client)
+
+      expect(fake_cognito_client).to receive(:admin_create_user).with(
+        hash_including(
+          temporary_password: 'ciao'
+        )
+      )
+      user = User.new(email: sample_cognito_email)
+      user.save!
+    ensure
+      CognitoRails::Config.password_generator = nil
+    end
+
+    it 'uses the custom password passed as parameter' do
+      expect(CognitoRails::User).to receive(:cognito_client).at_least(:once).and_return(fake_cognito_client)
+
+      expect(fake_cognito_client).to receive(:admin_create_user).with(
+        hash_including(
+          temporary_password: '12345678'
+        )
+      )
+      user = User.new(email: sample_cognito_email)
+      user.password = '12345678'
+      user.save!
+    end
+
     it 'saves custom attributes in cognito' do
       expect(CognitoRails::User).to receive(:cognito_client).at_least(:once).and_return(fake_cognito_client)
 
@@ -116,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

@@ -13,8 +13,23 @@ class User < ActiveRecord::Base
   cognito_verify_email
   define_cognito_attribute 'role', 'user'
   define_cognito_attribute 'name', :name
+
+  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
@@ -39,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.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mònade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -97,10 +97,12 @@ files:
 - lib/cognito_rails/controller.rb
 - lib/cognito_rails/jwt.rb
 - lib/cognito_rails/model.rb
+- lib/cognito_rails/password_generator.rb
 - lib/cognito_rails/user.rb
 - lib/cognito_rails/version.rb
 - spec/cognito_rails/controller_spec.rb
 - spec/cognito_rails/jwt_spec.rb
+- spec/cognito_rails/password_generator_spec.rb
 - spec/cognito_rails/user_spec.rb
 - spec/factories/user.rb
 - spec/spec_helper.rb
@@ -133,6 +135,7 @@ summary: Add Cognito authentication to your Rails API
 test_files:
 - spec/cognito_rails/controller_spec.rb
 - spec/cognito_rails/jwt_spec.rb
+- spec/cognito_rails/password_generator_spec.rb
 - spec/cognito_rails/user_spec.rb
 - spec/factories/user.rb
 - spec/spec_helper.rb