studio-engine 0.118.0 → 0.119.0

data/lib/studio.rb

@@ -42,10 +42,12 @@ require "studio/navbar_account_sidebar"
 require "studio/navbar_identity"
 require "studio/navbar_wordmark"
 require "studio/navbar_brand"
+require "studio/loader"
 require "studio/auth_labels"
 require "studio/profile_sections"
 require "studio/profile_image"
 require "studio/oauth_identity"
+require "studio/google_sign_in"
 require "studio/newsletter"
 require "studio/health_report"
 require "studio/agent_chat"
@@ -185,6 +187,26 @@ module Studio
   #   config.features     = %i[web3]
   mattr_accessor :auth_methods, default: %i[magic_link google]
 
+  # ---- Google sign-in, ready out of the box (Studio::GoogleSignIn) ----------
+  # :google in auth_methods draws the button; the engine registers the strategy
+  # and a default User.from_omniauth. What is left is the OAuth client, and
+  # google_ready? says whether the app has one: GOOGLE_CLIENT_ID and
+  # GOOGLE_CLIENT_SECRET both set. While it is false the button opens a modal
+  # whose "Request Google setup" mails google_setup_request_to, once per app
+  # per day, with the redirect URI to register. docs/GOOGLE_AUTH_SETUP.md.
+  def self.google_ready?(env: ENV)
+    GoogleSignIn.ready?(env: env)
+  end
+
+  mattr_accessor :google_setup_request_to, default: "team@mcritchie.studio"
+
+  # The host Google's callback lives on, e.g. "voicebox.mcritchie.studio". It
+  # names the redirect URI the setup-request email asks ops to register, and in
+  # production it pins OmniAuth's callback host. nil, the default, falls back to
+  # ENV["APP_HOST"], then the first plain hostname in config.hosts
+  # (Studio::GoogleSignIn.canonical_host). Never read from the request.
+  mattr_accessor :google_canonical_host, default: nil
+
   # ---- Capability features --------------------------------------------------
   # Coarse app-level capability switches an app opts into. Distinct from
   # auth_methods (which sign-in methods the login views render) — these gate
@@ -283,6 +305,27 @@ module Studio
     @@navbar_wordmark = NavbarWordmark.normalize(config)
   end
 
+  # ---- Branded loader ----
+  # The loader every page load, long wait and pending button draws: the app's
+  # own icon in its own theme colours, no per-app code. A style name, or a Hash
+  # with the icon (default: the navbar brand logo, else theme_logos' "Navbar
+  # Logo") and, for a signature style, the art file of marked layers. The
+  # default is :breathe. Rules: lib/studio/loader.rb; docs/LOADER.md.
+  #
+  #   config.loader = :orbit
+  #   config.loader = { style: :sparkle, icon: "/brand/icon-dark.svg",
+  #                     art: "/brand/loader-sparkle.svg" }
+  mattr_reader :loader, default: Loader.normalize(nil)
+
+  def self.loader=(config)
+    @@loader = Loader.normalize(config)
+  end
+
+  # The icon the loader draws: the configured one, else Loader.default_icon.
+  def self.loader_icon
+    loader[:icon] || Loader.default_icon
+  end
+
   def self.sign_in_label=(label)
     NavbarIdentity.validate_label!(label)
     @@sign_in_label = label
@@ -1736,6 +1779,16 @@ module Studio
       get  "auth/:provider/callback", to: "omniauth_callbacks#create"
       get  "auth/failure", to: "omniauth_callbacks#failure"
 
+      # "Request Google setup", the button in the Google modal an app shows
+      # while its OAuth client is unset (Studio::GoogleSignIn). Mails the team
+      # once per app per day, and answers 404 once the
+      # button posts; unauthenticated, since the person asking cannot
+      # sign in yet. Drawn whenever the Google button can be.
+      if Studio.auth_method?(:google)
+        post "_studio/google_setup_request", to: "studio/google_setup_requests#create",
+             as: :studio_google_setup_request
+      end
+
       # The daily health report as JSON, for the hub's central 07:00 pull
       # (Studio::HealthReportsController). Drawn in EVERY environment, production
       # included: the controller is the gate, answering 404 until the app names

data/studio-engine.gemspec

@@ -63,6 +63,14 @@ Gem::Specification.new do |spec|
   # allows accepts redis 6. test/lib/gemspec_redis_bound_test.rb pins it.
   spec.add_dependency "redis", ">= 4.0.1", "< 6"
   spec.add_dependency "turbo-rails", ">= 1.0"
+  # Google sign-in ships ready (Studio::GoogleSignIn). Every app draws the
+  # "Sign in with Google" button, so every app carries the strategy: the engine
+  # registers google_oauth2 itself unless the host's own initializer already did.
+  # Bounds match the consumers' locks (omniauth 2.1, google-oauth2 1.2,
+  # rails_csrf_protection 1.0 and 2.0).
+  spec.add_dependency "omniauth", ">= 2.1", "< 3"
+  spec.add_dependency "omniauth-google-oauth2", ">= 1.1", "< 2"
+  spec.add_dependency "omniauth-rails_csrf_protection", ">= 1.0", "< 3"
   # IP -> location for Studio::Geo. A dependency rather than a host concern
   # because the point of the geo primitive is that EVERY app has the capacity:
   # an app that has to add a gem before it can place a visitor does not.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.118.0
+  version: 0.119.0
 platform: ruby
 authors:
 - Alex McRitchie
@@ -174,6 +174,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-google-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-rails_csrf_protection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: geocoder
   requirement: !ruby/object:Gem::Requirement
@@ -400,6 +460,7 @@ files:
 - app/controllers/studio/component_previews_controller.rb
 - app/controllers/studio/emails_controller.rb
 - app/controllers/studio/geo_settings_controller.rb
+- app/controllers/studio/google_setup_requests_controller.rb
 - app/controllers/studio/health_reports_controller.rb
 - app/controllers/studio/knowledge_docs_controller.rb
 - app/controllers/studio/links_controller.rb
@@ -419,6 +480,7 @@ files:
 - app/helpers/studio/fizz_helper.rb
 - app/helpers/studio/geo_helper.rb
 - app/helpers/studio/link_preview_helper.rb
+- app/helpers/studio/loader_helper.rb
 - app/helpers/studio/public_user_helper.rb
 - app/helpers/studio/site_footer_helper.rb
 - app/helpers/studio_email_delivery_helper.rb
@@ -466,6 +528,7 @@ files:
 - app/javascript/studio/leveling_activity.js
 - app/javascript/studio/link_preview_card.js
 - app/javascript/studio/link_sidebar.js
+- app/javascript/studio/loader.js
 - app/javascript/studio/local_path.js
 - app/javascript/studio/modal_countdown.js
 - app/javascript/studio/modal_host.js
@@ -486,12 +549,14 @@ files:
 - app/jobs/studio/email_delivery_job.rb
 - app/jobs/studio/health_report_job.rb
 - app/mailers/application_mailer.rb
+- app/mailers/studio/google_setup_mailer.rb
 - app/mailers/studio/health_report_mailer.rb
 - app/mailers/studio/newsletter_mailer.rb
 - app/mailers/studio/profile_mailer.rb
 - app/mailers/user_mailer.rb
 - app/models/concerns/sluggable.rb
 - app/models/concerns/studio/board/rankable.rb
+- app/models/concerns/studio/omniauth_user.rb
 - app/models/current.rb
 - app/models/error_log.rb
 - app/models/image_cache.rb
@@ -591,6 +656,10 @@ files:
 - app/views/studio/emails/show.html.erb
 - app/views/studio/fields/_date_of_birth.html.erb
 - app/views/studio/geo_settings/edit.html.erb
+- app/views/studio/google_setup_mailer/setup_requested.html.erb
+- app/views/studio/google_setup_mailer/setup_requested.text.erb
+- app/views/studio/google_sign_in/_button.html.erb
+- app/views/studio/google_sign_in/_setup_modal.html.erb
 - app/views/studio/health_report_mailer/daily.html.erb
 - app/views/studio/health_report_mailer/daily.text.erb
 - app/views/studio/knowledge_docs/_access_chips.html.erb
@@ -610,6 +679,8 @@ files:
 - app/views/studio/knowledge_docs/preview.html.erb
 - app/views/studio/knowledge_docs/show.html.erb
 - app/views/studio/links/confirm.html.erb
+- app/views/studio/loader/_loader.html.erb
+- app/views/studio/loader/_overlay.html.erb
 - app/views/studio/local_emails/index.html.erb
 - app/views/studio/mailers/_layered_banner.html.erb
 - app/views/studio/modals/_crop_photo.html.erb
@@ -755,6 +826,7 @@ files:
 - lib/studio/geo.rb
 - lib/studio/geo/countries.rb
 - lib/studio/geo/lookup.rb
+- lib/studio/google_sign_in.rb
 - lib/studio/health_report.rb
 - lib/studio/hold_button.rb
 - lib/studio/host_schema.rb
@@ -772,6 +844,7 @@ files:
 - lib/studio/link_preview.rb
 - lib/studio/link_resolution.rb
 - lib/studio/link_token.rb
+- lib/studio/loader.rb
 - lib/studio/local_path.rb
 - lib/studio/log_rotation.rb
 - lib/studio/mail_sender.rb