sidekiq_web_google_auth 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a95d3b7b58d3d19c6d13f84edea91a443ea09c944098d8fc274909dc5b0d6f5f
-  data.tar.gz: e4a9320a379a21d000c7c51cb779aba75574016c65bb60e7e0edd8841c6dfac4
+  metadata.gz: 79195452b22b2f2e07fbbfef93dfc106c9f114c1de3489e0b2beee25856b4c48
+  data.tar.gz: b734f8d1722d615af0ff8ce538e7b50478caf6c213edd63242b95fac48a8693f
 SHA512:
-  metadata.gz: e6c1ee2d889c7c825ae1215f52a883304a0814aa1a7a56ce88044140bc8440adf47702fdc694c9b0c0dd3cfe6e4ac69c79ca05d9f1f89ffbba59f3a42edd6c98
-  data.tar.gz: 04b5baedba8a58f10159bdbdb4653586ef0a4298f63e3f76848cfe9fba23a930ea5325c83a57f1c7a3ac6de4dc35669ee88ac206bfd974aeb603d068d9db2cd9
+  metadata.gz: 02ace301d166e323e49c075a83aaada1b2c992135aa5e76023def053bf1306e6d02b29497e71c3e1e985393c18f47819d676a9f7476dccac77998d4d83d2cb7e
+  data.tar.gz: a380197c4f3d2be19fda0701495360463c5081844009df1473637871d4958eaab6010f573d7d3e855b4249868b6c56fb38e710d91e4db3301d333386cac9204e

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0"]
+        ruby: ["3.3", "3.4"]
 
     name: ${{ matrix.ruby }}
 

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.3.2
 
 Naming/FileName:
   Exclude:

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+3.4.4

data/Gemfile

@@ -6,3 +6,15 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake"
+
+group :development do
+  gem "rubocop-config-umbrellio"
+end
+
+group :test do
+  gem "rack-session"
+  gem "rack-test"
+  gem "rspec"
+  gem "simplecov"
+  gem "simplecov-lcov"
+end

data/Gemfile.lock

@@ -1,141 +1,192 @@
 PATH
   remote: .
   specs:
-    sidekiq_web_google_auth (0.1.1)
+    sidekiq_web_google_auth (0.2.3)
       omniauth
       omniauth-google-oauth2
+      sidekiq
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    concurrent-ruby (1.1.9)
-    connection_pool (2.2.5)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     hashie (5.0.0)
-    i18n (1.8.10)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    jwt (2.4.1)
-    minitest (5.14.4)
-    multi_json (1.15.0)
-    multi_xml (0.6.0)
-    oauth2 (1.4.9)
-      faraday (>= 0.17.3, < 3.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
+    json (2.12.2)
+    jwt (2.10.1)
+      base64
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    multi_xml (0.7.2)
+      bigdecimal (~> 3.1)
+    net-http (0.6.0)
+      uri
+    oauth2 (2.0.12)
+      faraday (>= 0.17.3, < 4.0)
+      jwt (>= 1.0, < 4.0)
+      logger (~> 1.2)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (2.1.0)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0, >= 2.0.3)
+      version_gem (>= 1.1.8, < 3)
+    omniauth (2.1.3)
       hashie (>= 3.4.6)
       rack (>= 2.2.3)
       rack-protection
-    omniauth-google-oauth2 (1.0.1)
-      jwt (>= 2.0)
-      oauth2 (~> 1.1)
+    omniauth-google-oauth2 (1.2.1)
+      jwt (>= 2.9.2)
+      oauth2 (~> 2.0)
       omniauth (~> 2.0)
-      omniauth-oauth2 (~> 1.7.1)
-    omniauth-oauth2 (1.7.3)
+      omniauth-oauth2 (~> 1.8)
+    omniauth-oauth2 (1.8.0)
       oauth2 (>= 1.4, < 3)
-      omniauth (>= 1.9, < 3)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+      omniauth (~> 2.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
-    rack (2.2.3.1)
-    rack-protection (2.2.0)
-      rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    redis (4.6.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rack (3.1.16)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    redis-client (0.24.0)
+      connection_pool
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.75.8)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.11.0.51)
-      rubocop (= 1.11.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-config-umbrellio (1.75.0.104)
+      rubocop (~> 1.75.0)
+      rubocop-factory_bot (~> 2.27.0)
+      rubocop-performance (~> 1.25.0)
+      rubocop-rails (~> 2.32.0)
+      rubocop-rake (~> 0.7.0)
+      rubocop-rspec (~> 3.6.0)
+      rubocop-sequel (~> 0.4.0)
+    rubocop-factory_bot (2.27.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rails (2.32.0)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
-      rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    sidekiq (6.5.1)
-      connection_pool (>= 2.2.2)
-      rack (~> 2.0)
-      redis (>= 4.2.0)
-    simplecov (0.21.2)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-sequel (0.4.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sidekiq (8.0.4)
+      connection_pool (>= 2.5.0)
+      json (>= 2.9.0)
+      logger (>= 1.6.2)
+      rack (>= 3.1.0)
+      redis-client (>= 0.23.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.3)
-    tzinfo (2.0.4)
+    simplecov_json_formatter (0.1.4)
+    snaky_hash (2.0.3)
+      hashie (>= 0.1.0, < 6)
+      version_gem (>= 1.1.8, < 3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    version_gem (1.1.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rack-session
   rack-test
   rake
   rspec
   rubocop-config-umbrellio
-  sidekiq
   sidekiq_web_google_auth!
   simplecov
   simplecov-lcov
 
 BUNDLED WITH
-   2.1.4
+   2.6.9

data/README.md

@@ -26,13 +26,21 @@ Or install it yourself as:
 Initialize builder:
 
 ```ruby
-    Sidekiq::Web.use(SidekiqWebGoogleAuth::Builder) do
-      provider(
-        "example_client_id", # Google OAuth client ID
-        "example_client_secret", # Google OAuth client secret
-        authorized_emails: %w[test@mail.com], # List of authorized emails
-      )
-   end
+Sidekiq::Web.configure do |sidekiq_config|
+  sidekiq_config.use(OmniAuth::Builder) do
+    # Google OAuth client ID and secret
+    provider(:google_oauth2, "example_client_id", "example_client_secret", name: "oauth")
+  end
+
+  # You must provide at least one of: authorized_emails, authorized_email_domains
+  SidekiqWebGoogleAuth::Extension.authorized_emails = %w[test@mail.com], # List of authorized emails
+  SidekiqWebGoogleAuth::Extension.authorized_emails_domains = %w[mail.com], # List of authorized emails domains
+  sidekiq_config.register(
+    SidekiqWebGoogleAuth::Extension, name: "google-auth", tab: ["Logout"], index: ["logout"]
+  )
+
+  sidekiq_config.use(SidekiqWebGoogleAuth::Builder)
+end
 ```
 
 ## Contributing

data/lib/sidekiq_web_google_auth/builder.rb

@@ -3,10 +3,33 @@
 require_relative "extension"
 
 module SidekiqWebGoogleAuth
-  class Builder < OmniAuth::Builder
-    def provider(*args, authorized_emails:, **options, &block)
-      super("google_oauth2", *args, options.merge(name: "oauth"), &block)
-      Sidekiq::Web.register(SidekiqWebGoogleAuth::Extension.new(authorized_emails))
+  class Builder < Rack::Builder
+    def initialize(app, **, &)
+      @app = app
+      super
+    end
+
+    def call(env)
+      accept?(env) ? admit(env) : deny(env)
+    end
+
+    private
+
+    def accept?(env)
+      return true if env["PATH_INFO"].start_with?("/auth")
+      session(env)[:authenticated]
+    end
+
+    def admit(env)
+      @app.call(env)
+    end
+
+    def deny(env)
+      [302, { "location" => "#{env["SCRIPT_NAME"]}/auth/page" }, ["Found"]]
+    end
+
+    def session(env)
+      env["rack.session"]
     end
   end
 end

data/lib/sidekiq_web_google_auth/extension.rb

@@ -3,43 +3,42 @@
 # Idea taken from https://github.com/mperham/sidekiq/issues/2460#issuecomment-125694743
 module SidekiqWebGoogleAuth
   class Extension
-    def initialize(authorized_emails)
-      @authorized_emails = authorized_emails
-    end
-
-    def registered(app) # rubocop:disable Metrics/MethodLength
-      authorized_emails = @authorized_emails
+    class << self
+      attr_accessor :authorized_emails, :authorized_emails_domains
 
-      app.before do
-        if !session[:authenticated] && !request.path_info.start_with?("/auth")
-          redirect("#{root_path}auth/page")
-        end
+      def valid_email?(email)
+        authorized_emails.empty? || authorized_emails.include?(email)
       end
 
-      app.get "/auth/page" do
-        "Please <a href='#{root_path}auth/oauth'>authenticate via Google</a>."
+      def valid_email_domain?(email)
+        authorized_emails_domains.empty? || authorized_emails_domains.include?(email[/(?<=@).+/])
       end
 
-      app.get "/auth/oauth/callback" do
-        auth = request.env["omniauth.auth"]
+      def registered(app)
+        app.get "/auth/page" do
+          "Please <a href='#{root_path}auth/oauth'>authenticate via Google</a>."
+        end
 
-        if auth && authorized_emails.include?(auth.info.email)
-          session[:authenticated] = true
-          redirect(root_path)
-        else
-          OmniAuth.logger.warn(
-            "Someone unauthorized is trying to gain access to Sidekiq: #{auth.info}",
-          )
-          redirect("#{root_path}auth/page")
+        app.get "/auth/oauth/callback" do
+          auth = request.env["omniauth.auth"]
+          ext = SidekiqWebGoogleAuth::Extension
+
+          if auth && ext.valid_email?(auth.info.email) && ext.valid_email_domain?(auth.info.email)
+            session[:authenticated] = true
+            redirect(root_path)
+          else
+            OmniAuth.logger.warn(
+              "Someone unauthorized is trying to gain access to Sidekiq: #{auth.info}",
+            )
+            redirect("#{root_path}auth/page")
+          end
         end
-      end
 
-      app.get "/logout" do
-        session.clear
-        redirect(root_path)
+        app.get "/logout" do
+          session.clear
+          redirect(root_path)
+        end
       end
-
-      app.tabs["Logout"] = "logout"
     end
   end
 end

data/sidekiq_web_google_auth.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sidekiq_web_google_auth"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.3"
   spec.authors       = ["Igor Kir"]
   spec.email         = ["igor.kir@cadolabs.io"]
 
   spec.summary       = "Google OAuth for Sidekiq::Web"
   spec.homepage      = "https://github.com/umbrellio/sidekiq_web_google_auth"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.2")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/umbrellio/sidekiq_web_google_auth"
@@ -23,13 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "omniauth"
-  spec.add_runtime_dependency "omniauth-google-oauth2"
-
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-config-umbrellio"
-  spec.add_development_dependency "sidekiq"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "simplecov-lcov"
+  spec.add_dependency "omniauth"
+  spec.add_dependency "omniauth-google-oauth2"
+  spec.add_dependency "sidekiq"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_web_google_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Igor Kir
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -38,48 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-config-umbrellio
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -87,42 +44,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - igor.kir@cadolabs.io
 executables: []
@@ -151,7 +79,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/umbrellio/sidekiq_web_google_auth
   source_code_uri: https://github.com/umbrellio/sidekiq_web_google_auth
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Google OAuth for Sidekiq::Web
 test_files: []