sync_attr_with_auth0 0.1.7 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cbd1d27afcb626e027d6b5d610d048e52611480e
-  data.tar.gz: 1c0ba300b82dc2a2cb1a8da61ed0b16805967d96
+SHA256:
+  metadata.gz: 0e0afb86d465d9c136f38d604c69f198a86a969b77301f6abf60da12aa98cf54
+  data.tar.gz: 237034211a5eaf258332933e8c10c3e2744b3033dd83f8f859dd578b42d06b63
 SHA512:
-  metadata.gz: 2f8a355e4b26d652563dc2812108c13019ea5a18f1def848efdc749149e39877c3d0722780f11ae8449b2233629e130bf0fe9810943fc7a6f3c26e576e161f9c
-  data.tar.gz: 0250be3d225041f815f7960f5fb59f25834799750b405168297bdecaea174611d8115ee5352c65d68eb58432f8a5c228585a83d3638d00c3d955259f03828b81
+  metadata.gz: 978bc082c1c60d5d13ba2a20a5f1d8faf5da73596e852c75d2d53aa6893a46fcfc1104029788ccc8b7320161597a3e352f365958b816b0f118bbde50e92e71d7
+  data.tar.gz: f87f7c4145859950ea7336adde22913c4ec1390893c57a097b77cf7147f2e18e068bf4fa3d3b4cd60f6d4e41feeae4183e3881fb471360fafce32aedab1d17ed

data/lib/sync_attr_with_auth0/adapters/active_record.rb

@@ -13,6 +13,7 @@ module SyncAttrWithAuth0
 
       module ClassMethods
 
+        # TODO: We should accept two arrays of fields: user_metadata (for user-managed settings) and app_metadata (for app-managed settings)
         def sync_attr_with_auth0(*fields)
           options = fields.extract_options!
 
@@ -33,9 +34,9 @@ module SyncAttrWithAuth0
 
           # Setup callbacks
           after_validation :validate_email_with_auth0
-          after_create :save_to_auth0_on_create
-          after_update :save_to_auth0_on_update
-          after_commit :update_uid_from_auth0
+          after_create :save_to_auth0_after_create
+          after_update :save_to_auth0_after_update
+          after_commit :update_uid_and_picture_from_auth0
         end # sync_attr_with_auth0
 
       end # ClassMethods
@@ -52,18 +53,27 @@ module SyncAttrWithAuth0
       end # auth0_user_email
 
 
-      def auth0_user_email_changed?
+      def auth0_user_saved_change_to_email?
         return false unless self.respond_to?(auth0_sync_configuration.email_attribute)
         # return false unless sync_email_with_auth0? # We don't care if it changed if we aren't syncing it.
 
-        return self.send("#{auth0_sync_configuration.email_attribute}_changed?")
-      end # auth0_email_changed?
+        if respond_to? :"saved_change_to_#{auth0_sync_configuration.email_attribute}?"
+          # Modern method
+          public_send :"saved_change_to_#{auth0_sync_configuration.email_attribute}?"
+        else
+          # Legacy method. Drop when no longer supporting <= Rails 5.1
+          public_send :"#{auth0_sync_configuration.email_attribute}_changed?"
+        end
+      end # auth0_user_saved_change_to_email?
 
 
       def auth0_user_uid
         self.send(auth0_sync_configuration.auth0_uid_attribute) if self.respond_to?(auth0_sync_configuration.auth0_uid_attribute)
       end # auth0_user_uid
 
+      def auth0_picture
+        public_send auth0_sync_configuration.picture_attribute if respond_to? auth0_sync_configuration.picture_attribute
+      end
 
       def auth0_user_name
         self.send(auth0_sync_configuration.name_attribute) if self.respond_to?(auth0_sync_configuration.name_attribute)
@@ -85,18 +95,21 @@ module SyncAttrWithAuth0
       end # auth0_user_password
 
 
-      def auth0_user_password_changed?
+      def auth0_user_saved_change_to_password?
         return false unless self.respond_to?(auth0_sync_configuration.password_attribute)
-        # return false unless sync_password_with_auth0? # We don't care if it changed if we aren't syncing it.
 
-        if self.respond_to?(:"#{auth0_sync_configuration.password_attribute.to_s}_changed?")
-          # We have a changed method, use it
-          return self.send(:"#{auth0_sync_configuration.password_attribute.to_s}_changed?")
-        else
-          # We don't have a changed method, check if the attribute was set.
-          return !self.send(auth0_sync_configuration.password_attribute).nil?
+        case
+          when respond_to?(:"saved_change_to_#{auth0_sync_configuration.password_attribute}?")
+            # Prefer modern method
+            public_send :"saved_change_to_#{auth0_sync_configuration.password_attribute}?"
+          when respond_to?(:"#{auth0_sync_configuration.password_attribute}_changed?")
+            # Legacy method. Drop when no longer supporting <= Rails 5.1
+            public_send :"#{auth0_sync_configuration.password_attribute}_changed?"
+          else
+            # Neither exists so must be in-memory accessor. Just check if set.
+            public_send(auth0_sync_configuration.password_attribute).present?
         end
-      end # auth0_user_password_changed?
+      end # auth0_user_saved_change_to_password?
 
 
       def auth0_default_password

data/lib/sync_attr_with_auth0/adapters/active_record/auth0_sync.rb

@@ -23,40 +23,50 @@ module SyncAttrWithAuth0
         end # sync_with_auth0_on_update?
 
 
-        def save_to_auth0_on_create
+        def save_to_auth0_after_create
           return true unless sync_with_auth0_on_create?
 
           save_to_auth0
 
           true # don't abort the callback chain
-        end # save_to_auth0_on_create
+        end # save_to_auth0_after_create
 
 
-        def save_to_auth0_on_update
+        def save_to_auth0_after_update
           return true unless sync_with_auth0_on_update?
-          return true unless auth0_dirty?
+          return true unless auth0_saved_change_dirty?
 
           save_to_auth0
 
           true # don't abort the callback chain
-        end # save_to_auth0_on_update
+        end # save_to_auth0_after_update
 
 
-        def auth0_dirty?
-          is_dirty = !!(
-            auth0_attributes_to_sync.inject(false) do |memo, attrib|
-              memo || self.try("#{attrib}_changed?")
+        def auth0_saved_change_dirty?
+          is_dirty = auth0_attributes_to_sync.any? do |attrib|
+            if respond_to? :"saved_change_to_#{attrib}?"
+              # Prefer modern method
+              public_send :"saved_change_to_#{attrib}?"
+            elsif respond_to? :"#{attrib}_changed?"
+              # Legacy method. Drop when no longer supporting <= Rails 5.1
+              public_send :"#{attrib}_changed?"
+            else
+              # Specs currently verify attributes specified as needing synced
+              # that are not defined not cause an error. I'm not sure why we
+              # need this. Seems like a misconfiguration and we should blow
+              # up. But to limit scope of change keeping with defined behavior.
+              false
             end
-          )
+          end
 
           # If the password was changed, force is_dirty to be true
-          is_dirty = true if auth0_user_password_changed?
+          is_dirty = true if auth0_user_saved_change_to_password?
 
           # If the email was changed, force is_dirty to be true
-          is_dirty = true if auth0_user_email_changed?
+          is_dirty = true if auth0_user_saved_change_to_email?
 
           return is_dirty
-        end # auth0_dirty?
+        end # auth0_saved_change_dirty?
 
 
         def save_to_auth0
@@ -86,8 +96,9 @@ module SyncAttrWithAuth0
 
           response = SyncAttrWithAuth0::Auth0.create_user(auth0_user_name, params, config: auth0_sync_configuration)
 
-          # Update the record with the uid after_commit
+          # Update the record with the uid and picture after_commit
           @auth0_uid = response['user_id']
+          @auth0_picture = response['picture']
         end # create_in_auth0
 
 
@@ -97,10 +108,11 @@ module SyncAttrWithAuth0
           params = auth0_update_params
 
           begin
-            SyncAttrWithAuth0::Auth0.patch_user(user_uid, params, config: auth0_sync_configuration)
+            response = SyncAttrWithAuth0::Auth0.patch_user(user_uid, params, config: auth0_sync_configuration)
 
             # Update the record with the uid after_commit (in case it doesn't match what's on file).
             @auth0_uid = user_uid
+            @auth0_picture = response['picture']
           rescue ::Auth0::NotFound => e
             # For whatever reason, the passed in uid was invalid,
             # determine how to proceed.
@@ -113,10 +125,11 @@ module SyncAttrWithAuth0
             else
               # The uid was incorrect, so re-attempt with the new uid
               # and update the one on file.
-              SyncAttrWithAuth0::Auth0.patch_user(found_user['user_id'], params, config: auth0_sync_configuration)
+              response = SyncAttrWithAuth0::Auth0.patch_user(found_user['user_id'], params, config: auth0_sync_configuration)
 
               # Update the record with the uid after_commit
               @auth0_uid = found_user['user_id']
+              @auth0_picture = response['picture']
             end
 
           rescue Exception => e
@@ -146,6 +159,10 @@ module SyncAttrWithAuth0
             'password' => password,
             'connection' => auth0_sync_configuration.connection_name,
             'email_verified' => email_verified,
+            'name' => auth0_user_name,
+            'nickname' => auth0_user_name,
+            'given_name' => auth0_user_given_name,
+            'family_name' => auth0_user_family_name,
             'user_metadata' => user_metadata,
             'app_metadata' => app_metadata
           }
@@ -159,40 +176,50 @@ module SyncAttrWithAuth0
           app_metadata = auth0_app_metadata
 
           params = {
+            'name' => auth0_user_name,
+            'nickname' => auth0_user_name,
+            'given_name' => auth0_user_given_name,
+            'family_name' => auth0_user_family_name,
             'app_metadata' => app_metadata,
             'user_metadata' => user_metadata
           }
 
-          if auth0_user_password_changed?
+          if auth0_user_saved_change_to_password?
             # The password needs to be updated.
             params['password'] = auth0_user_password
             params['verify_password'] = auth0_verify_password?
           end
 
-          if auth0_user_email_changed?
+          if auth0_user_saved_change_to_email?
             # The email needs to be updated.
             params['email'] = auth0_user_email
-            params['verify_email'] = auth0_email_verified?
+            params['verify_email'] = !auth0_email_verified?
           end
 
           return params
         end # auth0_update_params
 
 
-        def update_uid_from_auth0
-          if @auth0_uid
-            self.sync_with_auth0_on_update = false if self.respond_to?(:sync_with_auth0_on_update=)
-            self.send("#{auth0_sync_configuration.auth0_uid_attribute}=", @auth0_uid)
+        def update_uid_and_picture_from_auth0
+          data = {}
 
-            # Nil the instance variable to prevent an infinite loop
-            @auth0_uid = nil
+          if @auth0_uid
+            attr = auth0_sync_configuration.auth0_uid_attribute
+            data[attr] = @auth0_uid if respond_to?(attr) && @auth0_uid != public_send(attr)
+          end
 
-            # Save!
-            self.save
+          if @auth0_picture
+            attr = auth0_sync_configuration.picture_attribute
+            data[attr] = @auth0_picture if respond_to?(attr) && @auth0_picture != public_send(attr)
           end
 
+          update_columns data unless data.empty?
+
+          remove_instance_variable :@auth0_uid if defined? @auth0_uid
+          remove_instance_variable :@auth0_picture if defined? @auth0_picture
+
           true # don't abort the callback chain
-        end # update_uid_from_auth0
+        end # update_uid_and_picture_from_auth0
 
       end
     end

data/lib/sync_attr_with_auth0/auth0.rb

@@ -14,7 +14,7 @@ module SyncAttrWithAuth0
           }
         },
         'iat' => Time.now.to_i,
-        'jti' => UUIDTools::UUID.timestamp_create.to_s
+        'jti' => UUIDTools::UUID.random_create.to_s
       }
 
       jwt = JWT.encode(payload, JWT.base64url_decode(global_client_secret))
@@ -68,7 +68,15 @@ module SyncAttrWithAuth0
       auth0 = SyncAttrWithAuth0::Auth0.create_auth0_client(config: config)
 
       # Use the Lucene search because Find by Email is case sensitive
-      results = auth0.get('/api/v2/users', q: "email:#{email}")
+      query = "email:#{email}"
+      unless config.search_connections.empty?
+        conn_query = config.search_connections
+          .collect { |conn| %Q{identities.connection:"#{conn}"} }
+          .join ' OR '
+        query = "#{query} AND (#{conn_query})"
+      end
+
+      results = auth0.get('/api/v2/users', q: query, search_engine: 'v3')
 
       if exclude_user_id
         results = results.reject { |r| r['user_id'] == exclude_user_id }

data/lib/sync_attr_with_auth0/configuration.rb

@@ -31,8 +31,8 @@ module SyncAttrWithAuth0
       :auth0_client_id, :auth0_client_secret, :auth0_namespace,
       :auth0_uid_attribute, :name_attribute, :given_name_attribute,
       :family_name_attribute, :email_attribute, :password_attribute,
-      :email_verified_attribute, :verify_password_attribute,
-      :connection_name
+      :email_verified_attribute, :verify_password_attribute, :picture_attribute,
+      :connection_name, :search_connections
 
 
     def initialize
@@ -50,7 +50,9 @@ module SyncAttrWithAuth0
       @password_attribute = :password
       @email_verified_attribute = :email_verified
       @verify_password_attribute = :verify_password
+      @picture_attribute = :picture
       @connection_name = 'Username-Password-Authentication'
+      @search_connections = []
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sync_attr_with_auth0
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.2
 platform: ruby
 authors:
 - Patrick McGraw
@@ -29,16 +29,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +99,14 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
@@ -169,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Synchronize attributes on a local ActiveRecord user model with the user metadata