cognito_rails 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48fe70f5578d90db88e1a7546f12a16a3b24941bf20a2e8bb4a37b24b3678adc
-  data.tar.gz: 5463df9f063b8b986ca1ef49d0f9a8efce22862854e7e74cb4aee77a8f101fea
+  metadata.gz: f8bbd85c82670198044b07ac6bd693920201e3911166f1432365bd834e54fafd
+  data.tar.gz: 1c435514395d116f142fb22121bb0bdb7cdb91b46897b48566453e3748ae184d
 SHA512:
-  metadata.gz: '058bb0a9820ee032ca2d56f7c3954c5acb434543d599ddf3aedb029e2c8b6e06b9d93445a9989248c0a9223cc5038a91cd680313d7d1735837c18826a3008999'
-  data.tar.gz: 5fa75f4e6109b4144a33759340672eee19253d33ba8e9c167b0c4187b85f7b736d8129cfd22221188119c793f8250d550b36ba49b55742d47133ec9fd7d4ec14
+  metadata.gz: 11bea4faacf98021ee61a6ae2280e4da743fd1e62e68c4dc88681c98f735973ccabc5806261df3e1d22243da42eef7fb3ddc2fc02f5c06677e6291f1e3d9f780
+  data.tar.gz: 26ba725b881ab2333e8ea5823ac199fc4fd430426b85f1f50832d2e9b1985db692615d2543ef7cea6d6a21aa8cddfdc9358194bf0ce30655acb35b0a971a1d90

data/lib/cognito_rails/config.rb

@@ -5,26 +5,21 @@ require 'logger'
 module CognitoRails
   class Config
     class << self
-      # @raise [RuntimeError] if not set
       # @return [String] AWS access key id
-      def aws_access_key_id
-        # @type [String,nil]
-        @aws_access_key_id || (raise 'Missing config aws_access_key_id')
+      def aws_client_credentials
+        @aws_client_credentials || {}
       end
 
-      # @!attribute aws_access_key_id [w]
-      #   @return [String]
+      # @!attribute aws_client_credentials [w]
+      #   @return [Hash]
       # @!attribute aws_region [w]
       #   @return [String]
-      # @!attribute aws_secret_access_key [w]
-      #   @return [String]
       # @!attribute aws_user_pool_id [w]
       #   @return [String]
       # @!attribute default_user_class [w]
       #   @return [String,nil]
-      attr_writer :aws_access_key_id, :skip_model_hooks, :aws_region,
-                  :aws_secret_access_key, :aws_user_pool_id,
-                  :default_user_class
+      attr_writer :aws_client_credentials, :skip_model_hooks, :aws_region,
+                  :aws_user_pool_id, :default_user_class
 
       # @return [Boolean] skip model hooks
       def skip_model_hooks
@@ -43,12 +38,6 @@ module CognitoRails
         @aws_region || (raise 'Missing config aws_region')
       end
 
-      # @return [String] AWS secret access key
-      # @raise [RuntimeError] if not set
-      def aws_secret_access_key
-        @aws_secret_access_key || (raise 'Missing config aws_secret_access_key')
-      end
-
       # @return [String] AWS user pool id
       # @raise [RuntimeError] if not set
       def aws_user_pool_id

data/lib/cognito_rails/model.rb

@@ -23,6 +23,55 @@ module CognitoRails
       end
     end
 
+    # rubocop:disable Metrics/BlockLength
+    class_methods do
+      # @return [Array<ActiveRecord::Base>] all users
+      # @raise [CognitoRails::Error] if failed to fetch users
+      # @raise [ActiveRecord::RecordInvalid] if failed to save user
+      def sync_from_cognito!
+        response = User.all
+        response.users.map do |user_data|
+          sync_user!(user_data)
+        end
+      end
+
+      # @return [Array<ActiveRecord::Base>] all users
+      # @raise [CognitoRails::Error] if failed to fetch users
+      # @raise [ActiveRecord::RecordInvalid] if failed to save user
+      def sync_to_cognito!
+        find_each.map do |user|
+          user.init_cognito_user
+          user.save!
+        end
+      end
+
+      private
+
+      def sync_user!(user_data)
+        external_id = user_data.username
+        return if external_id.blank?
+
+        user = find_or_initialize_by(_cognito_attribute_name => external_id)
+        user.email = User.extract_cognito_attribute(user_data.attributes, :email)
+        user.phone = User.extract_cognito_attribute(user_data.attributes, :phone_number) if user.respond_to?(:phone)
+        _cognito_resolve_custom_attribute(user, user_data)
+
+        user.save!
+        user
+      end
+
+      def _cognito_resolve_custom_attribute(user, user_data)
+        _cognito_custom_attributes.each do |attribute|
+          next if attribute[:value].is_a?(String)
+
+          value = User.extract_cognito_attribute(user_data.attributes, attribute[:name])
+          next unless value
+
+          user[attribute[:name].gsub('custom:', '')] = value
+        end
+      end
+    end
+
     # @return [String]
     def cognito_external_id
       self[self.class._cognito_attribute_name]

data/lib/cognito_rails/user.rb

@@ -57,11 +57,15 @@ module CognitoRails
       )
       user = new(user_class: user_class)
       user.id = result.username
-      user.email = result.user_attributes.find { |attribute| attribute[:name] == 'email' }[:value]
-      user.phone = result.user_attributes.find { |attribute| attribute[:name] == 'phone_number' }&.dig(:value)
+      user.email = extract_cognito_attribute(result.user_attributes, :email)
+      user.phone = extract_cognito_attribute(result.user_attributes, :phone_number)
       user
     end
 
+    def self.all
+      cognito_client.list_users(user_pool_id: CognitoRails::Config.aws_user_pool_id)
+    end
+
     # @param attributes [Hash]
     # @option attributes [String] :email
     # @option attributes [String] :password
@@ -138,6 +142,18 @@ module CognitoRails
       destroy || (raise ActiveRecord::RecordInvalid, self)
     end
 
+    # @return [Aws::CognitoIdentityProvider::Client]
+    # @raise [RuntimeError]
+    def self.cognito_client
+      @cognito_client ||= Aws::CognitoIdentityProvider::Client.new(
+        { region: CognitoRails::Config.aws_region }.merge(CognitoRails::Config.aws_client_credentials)
+      )
+    end
+
+    def self.extract_cognito_attribute(attributes, column)
+      attributes.find { |attribute| attribute[:name] == column.to_s }&.dig(:value)
+    end
+
     private
 
     # @return [Aws::CognitoIdentityProvider::Client]
@@ -155,18 +171,6 @@ module CognitoRails
       user_class._cognito_verify_phone
     end
 
-    # @return [Aws::CognitoIdentityProvider::Client]
-    # @raise [RuntimeError]
-    def self.cognito_client
-      raise 'Can\'t create user in test mode' if Rails.env.test?
-
-      @cognito_client ||= Aws::CognitoIdentityProvider::Client.new(
-        access_key_id: CognitoRails::Config.aws_access_key_id,
-        secret_access_key: CognitoRails::Config.aws_secret_access_key,
-        region: CognitoRails::Config.aws_region
-      )
-    end
-
     # @return [Array<Hash>]
     def general_user_attributes
       [

data/lib/cognito_rails/version.rb

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

data/spec/cognito_rails/user_spec.rb

@@ -111,6 +111,42 @@ RSpec.describe CognitoRails::User, type: :model do
     end
   end
 
+  context 'class methods' do
+    before 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
+        )
+      )
+
+      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 '#sync_to_cognito!' do
+      User.create!(email: sample_cognito_email)
+
+      expect_any_instance_of(User).to receive(:init_cognito_user).exactly(1).times
+      User.sync_to_cognito!
+    end
+  end
+
   context 'admin' do
     before do
       expect(CognitoRails::User).to receive(:cognito_client).at_least(:once).and_return(fake_cognito_client)

data/spec/spec_helper.rb

@@ -11,16 +11,17 @@ require 'factories/user'
 I18n.enforce_available_locales = false
 RSpec::Expectations.configuration.warn_about_potential_false_positives = false
 
-Dir[File.expand_path('../support/*.rb', __FILE__)].each { |f| require f }
+Dir[File.expand_path('../support/*.rb', __FILE__)].sort.each { |f| require f }
 
-CognitoRails::Config.aws_access_key_id = 'access_key_id'
+CognitoRails::Config.aws_client_credentials = {
+  access_key_id: 'access_key_id',
+  secret_access_key: 'secret_access_key'
+}
 CognitoRails::Config.aws_region = 'region'
-CognitoRails::Config.aws_secret_access_key = 'secret_access_key'
 CognitoRails::Config.aws_user_pool_id = 'user_pool_id'
 CognitoRails::Config.default_user_class = 'User'
 
 RSpec.configure do |config|
-
   config.include FactoryBot::Syntax::Methods
 
   config.before(:suite) do

data/spec/support/cognito_helpers.rb

@@ -40,4 +40,24 @@ module CognitoRails::Helpers
       client
     end
   end
+
+  def build_cognito_user_data(email)
+    OpenStruct.new(
+      username: SecureRandom.uuid,
+      user_status: 'CONFIRMED',
+      enabled: true,
+      user_last_modified_date: Time.now,
+      attributes: [
+        OpenStruct.new(
+          name: 'email',
+          value: email
+        ),
+        OpenStruct.new(
+          name: 'custom:name',
+          value: 'Giovanni'
+        )
+      ],
+      mfa_options: []
+    )
+  end
 end

metadata

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