infinum_azure 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22a078df24ccf923263fb54f5527288599b6525afc08be03a02e831045abb22e
-  data.tar.gz: 14122b63d4c84e3c4491f8d446092bcb8eb3712c6879df811cc814f311b74ebd
+  metadata.gz: 239fd243ff912422205387b16829115566d6cb14580b48bc229eddf4cbc6a9b0
+  data.tar.gz: 796c56fc53bfb09b5639fea39ec47fc1d7b8398df373bf77726690f3854a1d42
 SHA512:
-  metadata.gz: d164d91027e483295911adad35c322442cc950a78a8ccb927c8c445c519172c58fc7b3682383d3e8e20bdec4ffbae77ac79ee6b77f086ea697e2d65a802bee68
-  data.tar.gz: b6c10aa75e1f2395cb01527bf45cb3d7140db2125641b7ec7d21e8185e0af89abeabb9fa9d88bb909f6de56fde9bf13ae3ddc60d938e7e366478b876965a1ced
+  metadata.gz: '086ee18dff4f363beaa89c05d39a4a3330cf4cecbb8f8bcb63fe9de965372decd8cd545683b9afa7d798fc732af21094d5c45699ecefd8343f8a4ad6cc1b351a'
+  data.tar.gz: f8a7835a59f356ccd8b0ef1cfec8e658a73fb94316eb5c0bf0a7008971a770c74d138898c06509211a5d53f77fb734743644aca2f916f1b40bb5378eacb95c12

data/.rubocop.yml

@@ -14,6 +14,9 @@ Style/Documentation:
 Style/SymbolArray:
   Enabled: false
 
+Style/Lambda:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - '**/*.rake'

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2023-06-15
+
+- Slim down the gem (remove dependencies and transient dependencies):
+  - dry-configurable
+  - http
+  - responders
+- Add `avatar_url`, `deactivated_at`, `provider_groups` and `employee` as selectable *resource_attributes*
+- Add rake task `infinum_azure:migrate_users` for migrating users (updating `uid` values from Infinum ID to Infinum Azure)
+- Update Readme
+
 ## [0.3.0] - 2023-04-21
 
 - Fix upserting new resource memoization

data/Gemfile.lock

@@ -1,13 +1,10 @@
 PATH
   remote: .
   specs:
-    infinum_azure (0.3.0)
+    infinum_azure (0.4.0)
       bundler
       devise
-      dry-configurable
-      http
-      omniauth-infinum_azure (>= 0.1.6, < 2.0)
-      responders
+      omniauth-infinum_azure (>= 0.3.0, < 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -96,14 +93,6 @@ GEM
       warden (~> 1.2.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    dry-configurable (1.0.1)
-      dry-core (~> 1.0, < 2)
-      zeitwerk (~> 2.6)
-    dry-core (1.0.0)
-      concurrent-ruby (~> 1.0)
-      zeitwerk (~> 2.6)
     erubi (1.12.0)
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
@@ -116,24 +105,10 @@ GEM
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    ffi (1.15.5)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
     globalid (1.1.0)
       activesupport (>= 5.0)
     hashdiff (1.0.1)
     hashie (5.0.0)
-    http (4.4.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.2)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    http-form_data (2.3.0)
-    http-parser (1.2.3)
-      ffi-compiler (>= 1.0, < 2.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jwt (2.7.0)
@@ -173,7 +148,7 @@ GEM
       hashie (>= 3.4.6)
       rack (>= 2.2.3)
       rack-protection
-    omniauth-infinum_azure (0.1.6)
+    omniauth-infinum_azure (0.3.0)
       omniauth-oauth2
     omniauth-oauth2 (1.8.0)
       oauth2 (>= 1.4, < 3)
@@ -261,9 +236,6 @@ GEM
     timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
     version_gem (1.1.1)
     warden (1.2.9)
       rack (>= 2.0.9)

data/README.md

@@ -29,8 +29,6 @@ Or install it yourself as:
 ## Dependencies
 
 * [Devise](https://github.com/plataformatec/devise)
-* [Dry configurable](https://github.com/dry-rb/dry-configurable)
-* [Http](https://github.com/httprb/http)
 * [Omniauth::InfinumAzure](https://github.com/infinum/ruby-infinum-azure-omniauth)
 
 ## Configuration
@@ -43,18 +41,36 @@ Or install it yourself as:
 InfinumAzure.configure do |config|
   config.service_name = 'Revisor'
   config.resource_name = 'User'
-  config.resource_attributes = [:uid, :email, :first_name, :last_name]
+  config.resource_attributes = [:uid, :email, :first_name, :last_name, :avatar_url,
+                                :deactivated_at, :provider_groups, :employee]
+
+  config.user_migration_scope = -> { resource_class.where(provider: 'infinum_id') }
+  config.user_migration_operation = > (record, resource) {
+    record.update_attribute(:provider, 'infinum_azure')
+    record.update_attribute(:uid, resource['uid'])
+  }
 end
 ```
 
 Configuration options:
-* Service name - name of application
-* Resource name - name of resource on whom authentication is being done
-* Resource attributes - attributes sent from InfinumAzure when user is created/updated that will be permitted
+* service_name(mandatory) - name of application
+* resource_name(mandatory) - name of resource on whom authentication is being done
+* resource_attributes(optional) - attributes that will be permitted once the webhook controller receives the params from InfinumAzure
+* user_migration_scope(optional) - a block that will be used to get the initial collection of resources (if blank, default is written above)
+* user_migration_operation(optional) - a block that will be called for each resource from the above collection if a matching resource on InfinumAzure is found. The resource is a Hash containing the following properties:
+  * `uid` - string
+  * `first_name` - string || null
+  * `last_name` - string || null
+  * `email` - string
+  * `avatar_url` - string || null
+  * `groups` - string || null -> a comma separated list; if "employees" is present, the user is an employee
+  * `deactivated` - boolean
 
 ### Secrets
 
-Needed secrets:
+Secrets should be kept in `config/secrets.yml` file.
+
+Required ones are:
 
 ```ruby
 # config/secrets.yml
@@ -65,19 +81,44 @@ infinum_azure:
   tenant: 'InfinumAzure_tenant'
 ```
 
+Optional ones are:
+
+```ruby
+infinum_azure:
+  users_auth_url: 'InfinumAzure_users_auth_url_with_api_code' # required only if infinum_azure:migrate_users rake task is used
+```
+
 ## Usage
 
 1. Add columns to resource via migration.
 
-    <b>Required columns:</b> email, uid and provider <br />
-    <b>Optional columns:</b> name
+<b>Required columns:</b>
+* *email* _string_
+* *uid* _string_
+* *provider* _string_
+* *remember_created_at* _datetime_
+* *remember_token* _string_
+
+<b>Optional columns:</b>
+* *first_name* _string_
+* *last_name* _string_
+* *avatar_url* _string_
+* *deactivated_at* _datetime_
+* *provider_groups* _jsonb array_
+* *employee* _boolean_
 
 2. Add following rows to resource model:
 
 ```ruby
-devise :omniauthable, omniauth_providers: [:infinum_azure]
+devise :rememberable, :omniauthable, omniauth_providers: [:infinum_azure]
+
+def remember_me
+  true
+end
 ```
 
+_NOTE_: The `#remember_me` method needs to always return *true* in order for users to stay logged in after they shut down their browsers. In case your app has a checkbox for `Remember me` on the login page next to the login button, you can override the return value.
+
 3. Use devise's method `#authenticate_user!` to authenticate users on API endpoints
 
 ```ruby

data/app/controllers/infinum_azure/api/webhooks_controller.rb

@@ -12,7 +12,7 @@ module InfinumAzure
           action = 'created'
         end
 
-        InfinumAzure::AfterUpsertResource.call(resource, params[:user])
+        InfinumAzure::AfterUpsertResource.call(resource, normalized_azure_params)
 
         render json: { resource_name.underscore => action }
       end
@@ -26,9 +26,15 @@ module InfinumAzure
       end
 
       def user_params
-        params.require(:user)
-              .permit(InfinumAzure.resource_attributes)
-              .merge(provider: InfinumAzure.provider)
+        normalized_azure_params
+          .slice(*InfinumAzure.resource_attributes)
+          .merge(provider: InfinumAzure.provider)
+      end
+
+      def normalized_azure_params
+        InfinumAzure::Resources::Params.normalize(
+          params.require(:user).permit!.to_h.symbolize_keys
+        )
       end
     end
   end

data/app/services/infinum_azure/resources/params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module InfinumAzure
+  module Resources
+    class Params
+      NORMALIZATIONS = {
+        uid: :propagate,
+        email: :propagate,
+        first_name: :propagate,
+        last_name: :propagate,
+        avatar_url: :propagate,
+        deactivated_at: {
+          procedure: ->(value) { [false, nil].include?(value) ? nil : Time.zone.now },
+          target_name: :deactivated
+        },
+        employee: {
+          procedure: ->(value) { value&.include?('employees') },
+          target_name: :groups
+        }
+      }.freeze
+
+      def self.normalize(payload)
+        new(payload).as_json
+      end
+
+      def initialize(params = {})
+        NORMALIZATIONS.each do |attribute, operation|
+          value = if operation == :propagate
+                    params[attribute]
+                  elsif operation.is_a?(Hash)
+                    operation[:procedure].call(params[operation[:target_name]])
+                  else
+                    raise 'unsupported normalization'
+                  end
+
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+
+      def as_json
+        NORMALIZATIONS.keys.reduce({}) do |hash, key|
+          hash[key] = instance_variable_get("@#{key}")
+
+          hash
+        end
+      end
+
+      private
+
+      attr_reader(*NORMALIZATIONS.keys)
+    end
+  end
+end

data/infinum_azure.gemspec

@@ -46,8 +46,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'bundler'
   spec.add_dependency 'devise'
-  spec.add_dependency 'dry-configurable'
-  spec.add_dependency 'http'
-  spec.add_dependency 'omniauth-infinum_azure', '>= 0.1.6', '< 2.0'
-  spec.add_dependency 'responders'
+  spec.add_dependency 'omniauth-infinum_azure', '>= 0.3.0', '< 2.0'
 end

data/lib/infinum_azure/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module InfinumAzure
+  class Config
+    Defaults.all_attributes.each do |attr, value|
+      attr_writer attr
+
+      define_method(attr) do
+        instance_variable_set("@#{attr}", instance_variable_get("@#{attr}") || value)
+      end
+    end
+  end
+end

data/lib/infinum_azure/defaults.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module InfinumAzure
+  module Defaults
+    REQUIRED = {
+      service_name: nil,
+      resource_name: nil
+    }.freeze
+    OPTIONAL = {
+      resource_attributes: [
+        :uid, :email, :first_name, :last_name, :avatar_url, :deactivated_at, :provider_groups, :employee
+      ],
+      user_migration_scope: -> { InfinumAzure.resource_class.where(provider: 'infinum_id') },
+      user_migration_operation: ->(record, resource) {
+        record.update_attribute(:provider, provider)
+        record.update_attribute(:uid, resource['uid'])
+      }
+    }.freeze
+
+    def self.all_attribute_names
+      REQUIRED.keys + OPTIONAL.keys
+    end
+
+    def self.all_attributes
+      REQUIRED.merge(OPTIONAL)
+    end
+  end
+end

data/lib/infinum_azure/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InfinumAzure
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/infinum_azure.rb

@@ -3,38 +3,58 @@
 require 'omniauth/infinum_azure'
 require 'infinum_azure/version'
 require 'infinum_azure/engine'
-require 'dry-configurable'
+require 'infinum_azure/defaults'
+require 'infinum_azure/config'
 require 'devise'
-require 'http'
 
 module InfinumAzure
-  extend Dry::Configurable
+  Error = Class.new(StandardError)
 
-  setting :service_name, reader: true
-  setting :resource_name, default: 'User', reader: true
-  setting :resource_attributes, default: [:uid, :email, :first_name, :last_name], reader: true
+  class << self
+    def configure
+      yield config if block_given?
 
-  def self.provider
-    to_s.underscore
-  end
+      ensure_all_attributes_present!
+    end
 
-  def self.resource_class
-    resource_name.constantize
-  end
+    def config
+      @config ||= Config.new
+    end
 
-  def self.client_id
-    dig_secret(:client_id)
-  end
+    def ensure_all_attributes_present!
+      Defaults.all_attribute_names.each do |attribute|
+        raise Error, "InfinumAzure attribute '@#{attribute}' not set" if config.public_send(attribute).blank?
+      end
+    end
 
-  def self.client_secret
-    dig_secret(:client_secret)
-  end
+    delegate(*Defaults.all_attribute_names, to: :config)
 
-  def self.tenant
-    dig_secret(:tenant)
-  end
+    def provider
+      to_s.underscore
+    end
+
+    def resource_class
+      resource_name.constantize
+    end
+
+    def client_id
+      dig_secret(:client_id)
+    end
+
+    def client_secret
+      dig_secret(:client_secret)
+    end
+
+    def tenant
+      dig_secret(:tenant)
+    end
+
+    def users_auth_url
+      dig_secret(:users_auth_url)
+    end
 
-  def self.dig_secret(key)
-    Rails.application.secrets.dig(:infinum_azure, key)
+    def dig_secret(key)
+      Rails.application.secrets.dig(:infinum_azure, key)
+    end
   end
 end

data/lib/tasks/infinum_azure/user_migration.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'users/request'
+require_relative 'users/migration'
+
+namespace :infinum_azure do
+  desc 'Migrate users from InfinumID to InfinumAzure'
+  task migrate_users: :environment do
+    response = InfinumAzure::Users::Request.execute
+
+    if response.success?
+      process = InfinumAzure::Users::Migration.perform(response.body)
+
+      puts process.results
+    else
+      puts response.body
+      raise "couldn't connect to InfinumAzure AD B2C"
+    end
+  end
+end

data/lib/tasks/infinum_azure/users/migration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module InfinumAzure
+  module Users
+    class Migration
+      delegate :user_migration_scope, :user_migration_operation, to: InfinumAzure
+
+      def self.perform(response = {})
+        new(response).perform
+      end
+
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        @users_updated_count = 0
+        @emails_not_found = []
+      end
+
+      def perform
+        user_migration_scope.call.each do |record|
+          resource = response.find { |object| object['email'] == record.email }
+          emails_not_found.push(record.email) && next if resource.nil?
+
+          user_migration_operation.call(record, resource)
+          self.users_updated_count += 1
+        end
+
+        self
+      end
+
+      def results
+        <<~HEREDOC
+          Count of updated resources: #{users_updated_count}
+          Emails not found on Infinum Azure AD B2C: #{emails_not_found.size}
+          Emails:
+          #{emails_not_found.join("\n")}
+        HEREDOC
+      end
+
+      private
+
+      attr_accessor :users_updated_count, :emails_not_found
+    end
+  end
+end

data/lib/tasks/infinum_azure/users/request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+require_relative 'response'
+
+module InfinumAzure
+  module Users
+    class Request
+      URL = InfinumAzure.users_auth_url
+
+      def self.execute
+        raise 'infinum_azure_users_auth_url secret required for this rake task' if URL.blank?
+
+        uri = URI(URL)
+
+        Response.new(Net::HTTP.get_response(uri))
+      end
+    end
+  end
+end

data/lib/tasks/infinum_azure/users/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module InfinumAzure
+  module Users
+    class Response
+      attr_reader :raw_response
+
+      def initialize(raw_response)
+        @raw_response = raw_response
+      end
+
+      def success?
+        raw_response.is_a?(Net::HTTPSuccess)
+      end
+
+      def body
+        @body ||= success? ? success_json['Value'] : error_json
+      end
+
+      private
+
+      def success_json
+        JSON.parse(raw_response.body)
+      end
+
+      def error_json
+        {
+          error: {
+            status: raw_response.code.to_i,
+            details: raw_response.body
+          }
+        }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infinum_azure
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marko Ćilimković
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,41 +220,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  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: http
-  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: omniauth-infinum_azure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -264,24 +236,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: responders
-  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'
 description:
 email:
 - marko.cilimkovic@infinum.hr
@@ -306,12 +264,19 @@ files:
 - app/models/infinum_azure/application_record.rb
 - app/services/infinum_azure/after_upsert_resource.rb
 - app/services/infinum_azure/resources/finder.rb
+- app/services/infinum_azure/resources/params.rb
 - config/initializers/devise.rb
 - config/routes.rb
 - infinum_azure.gemspec
 - lib/infinum_azure.rb
+- lib/infinum_azure/config.rb
+- lib/infinum_azure/defaults.rb
 - lib/infinum_azure/engine.rb
 - lib/infinum_azure/version.rb
+- lib/tasks/infinum_azure/user_migration.rake
+- lib/tasks/infinum_azure/users/migration.rb
+- lib/tasks/infinum_azure/users/request.rb
+- lib/tasks/infinum_azure/users/response.rb
 homepage: https://github.com/infinum/rails-infinum-azure-engine
 licenses:
 - MIT