strongmind-auth 1.0.3 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3b415850df2aa96fc700cdd6f9062a2b08bd45013b3cf0eed7daface29b249
-  data.tar.gz: f5b2460f7b9647a5ca78a077cb15fdd4ada4deec9283f4b13c25baee8cf4d1a1
+  metadata.gz: 29554b31cde55064956270ba9bd557e8390a49ec9a847ff417cd13e0983d0460
+  data.tar.gz: 534b35f4fcfa0273ec3364b1bceca1b4e0bf9f1f99c681c21d2d489b97b861b5
 SHA512:
-  metadata.gz: a1e37eb6d57253077830cf3d34364708b3ea823272ed095ae54e348e51ecc3c1b868977c1e3e53afc2670cd98f526d8faa835e69c8f2ae25c864bf32239b0ac0
-  data.tar.gz: 65f17555dd2cad8787ab9855f424495311a9b289a87732a508f4e2b3d3a5a4384d05a9d6f03cb371a527e9087c55f80ae94f7370fcaaa284d8e4f2146e8ea700
+  metadata.gz: c00798ee297949194cb98ff045e46b222bcd3a5d60d244f9f78cf5ee336299c1ba19d9c1414cd2a9f14345cd8fd6372f09769bdcc928599bf610c325552ee342
+  data.tar.gz: caeb996433c23a339c251f4617a525ead271377fa97d0d027ae87ae9a694cce1e07c596ebdd21f3fd3a2aab2e10ccbcc210cb0c8c9885a5c826d82e02ba80df8

data/README.md

@@ -2,12 +2,11 @@
 
 Ruby gem for authentication in a rails app
 
-## Usage
+## Creating a new Rails app
 
-1. `rails new app --css tailwind`
-1. `cd app`
-1. `bundle add strongmind-auth`
-1. `rails g strongmind:install`
+1. Use [Repository Dashboard](https://repository-dashboard.strongmind.com/repositories/new) to create a new repository
+   with the rails-template.
+1. Navigate to the repo folder in a terminal and execute `rails g strongmind:install`
 1. Move app root to authenticated root in routes. Should look like this:
     ```ruby
     authenticated :user do
@@ -15,5 +14,5 @@ Ruby gem for authentication in a rails app
     end
     ```
 1. Create a new client in identity server and `IDENTITY_CLIENT_ID` and `IDENTITY_CLIENT_SECRET` values to .env file.
-1. `rails dev:cache`
-1. `bin/dev`
+1. Execute `rails dev:cache` to turn on caching in development.
+1. Execute `bin/dev`

data/app/controllers/concerns/strong_mind_nav.rb

@@ -0,0 +1,26 @@
+require "strongmind/common_nav_fetcher"
+
+module StrongMindNav
+  extend ActiveSupport::Concern
+
+  def fetch_common_nav
+    begin
+      navbar = Strongmind::CommonNavFetcher.new(current_user, request).retrieve(menu_items)
+
+      @top_navbar_html = navbar[:top_navbar_html]
+      @bottom_navbar_html = navbar[:bottom_navbar_html]
+      @theme_css = navbar[:theme_css]
+    rescue Strongmind::CommonNavFetcher::TokenNotFoundError, Strongmind::CommonNavFetcher::UserNotFoundError
+      render 'logins/index'
+    rescue Faraday::TimeoutError
+      @top_navbar_html = render_to_string(partial: 'layouts/loading_navbar').html_safe
+    end
+  end
+
+  def menu_items
+    [
+      { name: 'Home', icon: 'fa-solid fa-house', path_method: :root_path }
+    ]
+  end
+
+end

data/app/controllers/logins_controller.rb

@@ -1,5 +1,6 @@
 class LoginsController < ApplicationController
   skip_before_action :authenticate_user!
+  skip_before_action :fetch_common_nav
 
   def index
     flash[:alert] = nil

data/app/controllers/users/omniauth_callbacks_controller.rb

@@ -3,6 +3,7 @@
 module Users
 
   class OmniauthCallbacksController < Devise::OmniauthCallbacksController
+    skip_before_action :fetch_common_nav
 
     def strongmind
       auth = request.env['omniauth.auth']

data/app/views/layouts/_loading_navbar.html.erb

@@ -0,0 +1,30 @@
+<a href="/" data-turbo="false">
+  <nav class="flex sm-top-nav">
+    <div class="flex-1 branding-container">
+      <img class="branding-logo-lg" src="https://prod-backpack-ui.strongmind.com/assets/images/sm-logo-2c-white.png"/>
+      <img class="branding-logo-sm" src="https://prod-backpack-ui.strongmind.com/assets/images/SMbulb.svg"/>
+    </div>
+
+    <div id="loading">
+      <canvas id="canvas" width="64" height="64"></canvas>
+
+      <script src="https://unpkg.com/@rive-app/canvas@2.9.3"></script>
+      <script>
+          const r = new rive.Rive({
+              src: "https://backpack.strongmind.com/assets/images/loader_dark_mode.riv",
+              canvas: document.getElementById("canvas"),
+              autoplay: true,
+              stateMachines: null,
+              onLoad: () => {
+              },
+          });
+      </script>
+    </div>
+
+    <div class="flex-1 justify-end sm-top-nav-controls">
+      <div class="profile-container">
+        <i class="fa-light fa-circle-user text-white fa-2xl"></i>
+      </div>
+    </div>
+  </nav>
+</a>

data/lib/generators/strongmind/install_generator.rb

@@ -11,9 +11,16 @@ module Strongmind
       copy_file "user.rb", "app/models/user.rb", force: true
     end
 
-    def protect_app_files
+    def protect_app_files_and_add_nav
       inject_into_file "app/controllers/application_controller.rb", after: "class ApplicationController < ActionController::Base\n" do
-        "  before_action :authenticate_user!\n"
+        "  include StrongMindNav\n  before_action :authenticate_user!\n  before_action :fetch_common_nav\n
+  # Implement the list of menu items for the application
+  # def menu_items
+  #   [
+  #     { name: 'Home', icon: 'fa-solid fa-house', path_method: :root_path }
+  #   ]
+  # end"
+
       end
     end
 
@@ -51,6 +58,7 @@ devise_scope :user do
     def add_dotenv_file
       copy_file "env", ".env"
     end
+
   end
 
 end

data/lib/strongmind/auth/version.rb

@@ -1,5 +1,5 @@
 module Strongmind
   module Auth
-    VERSION = "1.0.3"
+    VERSION = "1.0.6"
   end
 end

data/lib/strongmind/common_nav_fetcher.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'platform_sdk'
+
+module Strongmind
+  # This class is responsible for fetching the common navbar data from SM Central
+  class CommonNavFetcher
+    attr_reader :user, :request, :auth_client
+
+    include Rails.application.routes.url_helpers
+
+    class TokenNotFoundError < StandardError; end
+
+    class UserNotFoundError < StandardError; end
+
+    def initialize(user, request)
+      raise UserNotFoundError, 'User not found' unless user.present?
+      raise ArgumentError, 'Request not found' unless request.present?
+
+      @user = user
+      @request = request
+      @auth_client = PlatformSdk::Identity::AuthClient.new(
+        ENV.fetch('IDENTITY_BASE_URL'), ENV.fetch('IDENTITY_CLIENT_ID'), ENV.fetch('IDENTITY_CLIENT_SECRET')
+      )
+    end
+
+    def retrieve(menu_items)
+      response = fetch_navbar_data(build_nav_items(menu_items))
+      parse_navbar(response)
+    end
+
+    private
+
+    def current_page?(url)
+      request.fullpath == URI.parse(url).path
+    end
+
+    def fetch_navbar_data(nav_items)
+      refresh_session if auth_client.token_expired?(token)
+
+      connection.post(navbar_endpoint, nav_items.to_json, 'Authorization' => "Bearer #{token}")
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: ENV.fetch('SM_CENTRAL_BASE_URL')) do |conn|
+        conn.options.timeout = 3
+        conn.response :raise_error
+        conn.adapter Faraday.default_adapter
+        conn.headers['Content-Type'] = 'application/json'
+      end
+    end
+
+    def token
+      cache_data = Rails.cache.fetch(user.uid)
+      raise TokenNotFoundError, "Token not found for user #{user.id}" unless cache_data&.key?(:access_token)
+
+      cache_data[:access_token]
+    end
+
+    def refresh_session
+      begin
+        session = Rails.cache.fetch(user.uid)
+        auth_client.refresh_session(session:)
+        Rails.cache.write(user.uid, session)
+      rescue Faraday::BadRequestError => e
+        Sentry.capture_exception(e, extra: { session:, request_body: request.body })
+      end
+    end
+
+    def navbar_endpoint
+      '/navbar'
+    end
+
+    def parse_navbar(response)
+      JSON.parse(response.body, symbolize_names: true) if response
+    end
+
+    def build_nav_items(menu_items)
+      { nav_items: menu_items.map { |item| nav_item_data(item) } }
+    end
+
+    def nav_item_data(item)
+      url = send(item[:path_method])
+      {
+        name: item[:name],
+        icon: item[:icon],
+        url:,
+        is_disabled: item[:feature_flag] ? !user.feature_flag_enabled?(item[:feature_flag]) : false,
+        is_active: current_page?(url),
+        is_external: false
+      }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-auth
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.6
 platform: ruby
 authors:
 - Team Belding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -105,13 +105,14 @@ files:
 - Rakefile
 - app/assets/config/strongmind_auth_manifest.js
 - app/assets/stylesheets/strongmind/auth/application.css
+- app/controllers/concerns/strong_mind_nav.rb
 - app/controllers/logins_controller.rb
 - app/controllers/users/omniauth_callbacks_controller.rb
 - app/helpers/strongmind/auth/application_helper.rb
 - app/jobs/rails/auth/application_job.rb
 - app/mailers/rails/auth/application_mailer.rb
 - app/models/user_base.rb
-- app/views/layouts/strongmind/auth/application.html.erb
+- app/views/layouts/_loading_navbar.html.erb
 - app/views/logins/index.html.erb
 - config/initializers/devise.rb
 - config/routes.rb
@@ -123,6 +124,7 @@ files:
 - lib/strongmind/auth.rb
 - lib/strongmind/auth/engine.rb
 - lib/strongmind/auth/version.rb
+- lib/strongmind/common_nav_fetcher.rb
 - lib/tasks/rails/auth_tasks.rake
 - lib/tasks/strongmind/auth_tasks.rake
 homepage: https://www.strongmind.com

data/app/views/layouts/strongmind/auth/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Rails auth</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%#= stylesheet_link_tag    "strongmind/auth/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>