simple_auth 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f49f3b991fd189a65c444c7fe0bbf4b6312ad268d15d09718554b17abede88de
-  data.tar.gz: 4b89cc2082720e7b13c778393cbd353737855e913417a55f520443cbcbbafd25
+  metadata.gz: 767e5c4765e914fc1e310fe57f9ad0491ccfc7f3eff8b22c0002877bb4ddb262
+  data.tar.gz: f2ffea82bbf55a41c705bddb67b638f7df1cfb1f4abc1918c4d89d7b46bde019
 SHA512:
-  metadata.gz: 3bc6961ef9d45a04f41988e5f1abaa47784edec75d74f49655fdc214285c16c63c2d0aca6d80aa669e7d21fad74434c5f0a570ba1a557a9c14e1d0822063154e
-  data.tar.gz: a23600ef945fb6675390133b84b6219edafa10a11ab524856a6535162ee8726ad007b5d0613af48706b461d8e4318a632170425533ebb8c2b6cd56af46145792
+  metadata.gz: b1489bc14e6f5b787902ad3540e7236e1112a71939f192cdf2e100af5ce0ca302794200e307c517334ef8fe42ec87ade787cfb609f96c6cee91093431741a103
+  data.tar.gz: fe1ee4d957ac0a892cedd74efbc7a0f671f1d9adeb6a11f268fc9d4cba7e8a45aac9d8b9a1c68798dde41dd17fb7c3f6ba71062c63320a12635816855016fa1d

data/.github/workflows/ruby-tests.yml

@@ -19,31 +19,26 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
+        ruby: ["3.3", "3.4", "4.0"]
         gemfile:
           - Gemfile
-          - gemfiles/rails_7_0.gemfile
-          - gemfiles/rails_6_1.gemfile
-          - gemfiles/rails_6_0.gemfile
+          - gemfiles/rails_8_0.gemfile
+          - gemfiles/rails_8_1.gemfile
 
     services:
       postgres:
         image: postgres:11.5
         ports: ["5432:5432"]
-        options:
-          --health-cmd pg_isready --health-interval 10s --health-timeout 5s
-          --health-retries 5
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
-            hashFiles(matrix.gemfile) }}
-
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }} #magic___^_^___line
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -3,7 +3,11 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.3
+  NewCops: enable
   Exclude:
     - gemfiles/**/*
     - vendor/**/*
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v3.2.0
+
+- Bump up ruby requirement to 3.3.
+- Add support for ActionController::API
+
 ## v3.1.4
 
 - Add `authenticate(scope, condition, &block)`, so you can restrict routes

data/README.md

@@ -150,6 +150,54 @@ end
 In this case, `:admin` is the scope and the lambda will only be called whenever
 there's a valid record associated with that record.
 
+### API Controllers
+
+simple_auth supports `ActionController::API`-based controllers. Include the
+`SimpleAuth::ActionController::API` module in your API controller:
+
+```ruby
+class ApiController < ActionController::API
+  include SimpleAuth::ActionController::API
+
+  before_action :authenticate_via_token
+  before_action :require_logged_user
+
+  def index
+    render json: {message: "hello there"}
+  end
+
+  private def authenticate_via_token
+    user = User.find_by_api_token(id: request.headers["Authorization"])
+
+    return render(plain: "401 Unauthorized", status: :unauthorized) unless user
+
+    SimpleAuth::Session.create(scope: "user", session:, record: user)
+  end
+end
+```
+
+By default, unauthorized requests receive a `401 Unauthorized` plain text
+response. You can override `render_unauthorized_access(authorization)` to
+customize this behavior. The `authorization` object gives you access to
+`authorization.error_message`, which contains the translated error message for
+the failed authorization:
+
+```ruby
+class ApiController < ActionController::API
+  include SimpleAuth::ActionController::API
+
+  private def render_unauthorized_access(authorization)
+    render json: {error: authorization.error_message}, status: :unauthorized
+  end
+end
+```
+
+> [!NOTE]
+>
+> `SimpleAuth::ActionController::API` defines a stub session object that's just
+> a hash, so the user record can be resolved across multiple calls within the
+> same request.
+
 ### Translations
 
 These are the translations you'll need:
@@ -159,8 +207,8 @@ These are the translations you'll need:
 en:
   simple_auth:
     user:
-      need_to_be_logged_in: "You need to be logged in"
-      not_authorized: "You don't have permission to access this page"
+      unlogged_in: "You need to be logged in"
+      unauthorized: "You don't have permission to access this page"
 ```
 
 If you don't set these translations, a default message will be used.

data/gemfiles/rails_8_0.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "rails", "~> 8.0.0"

data/gemfiles/rails_8_1.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "rails", "~> 8.1.0"

data/lib/simple_auth/action_controller/api.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module ActionController
+    module API
+      extend ActiveSupport::Concern
+      include SimpleAuth::ActionController
+
+      included do
+        undef_method :simple_auth_redirect_logged_scope
+        undef_method :return_to
+
+        SimpleAuth.config.scopes.each do |scope|
+          undef_method :"redirect_logged_#{scope}"
+        end
+      end
+
+      # A stub session so we can persist the record id between different calls
+      # to fetch the record.
+      private def session
+        @session ||= {}
+      end
+
+      private def render_unauthorized_access(*)
+        render plain: "401 Unauthorized", status: :unauthorized
+      end
+    end
+  end
+end

data/lib/simple_auth/action_controller/require_login_action.rb

@@ -18,7 +18,7 @@ module SimpleAuth
         valid_session? && authorized?
       end
 
-      def message
+      def error_message
         return if valid?
         return unauthorized_message unless authorized?
 
@@ -26,11 +26,11 @@ module SimpleAuth
       end
 
       private def valid_session?
-        controller.send("#{scope}_session").valid?
+        controller.send(:"#{scope}_session").valid?
       end
 
       private def authorized?
-        controller.send("authorized_#{scope}?")
+        controller.send(:"authorized_#{scope}?")
       end
 
       private def unauthorized_message

data/lib/simple_auth/action_controller.rb

@@ -12,7 +12,10 @@ module SimpleAuth
       def install_simple_auth_scopes
         SimpleAuth.config.scopes.each do |scope|
           install_simple_auth_scope(scope)
-          helper_method "current_#{scope}", "#{scope}_logged_in?"
+
+          if respond_to?(:helper_method)
+            helper_method("current_#{scope}", "#{scope}_logged_in?")
+          end
         end
       end
 
@@ -40,15 +43,15 @@ module SimpleAuth
           end
         RUBY
 
-        define_method "authorized_#{scope}?" do
+        define_method :"authorized_#{scope}?" do
           true
         end
 
-        define_method "require_logged_#{scope}" do
+        define_method :"require_logged_#{scope}" do
           simple_auth_require_logged_scope(scope)
         end
 
-        define_method "redirect_logged_#{scope}" do
+        define_method :"redirect_logged_#{scope}" do
           simple_auth_redirect_logged_scope(scope)
         end
       end
@@ -63,21 +66,25 @@ module SimpleAuth
     end
 
     private def simple_auth_require_logged_scope(scope)
-      action = RequireLoginAction.new(self, scope)
+      authorization = RequireLoginAction.new(self, scope)
 
-      return if action.valid?
+      return if authorization.valid?
 
-      reset_session
-      flash[simple_auth.flash_message_key] = action.message
-      session[:return_to] = request.fullpath if request.get?
-      redirect_to instance_eval(&simple_auth.login_url)
+      render_unauthorized_access(authorization)
     end
 
     private def simple_auth_redirect_logged_scope(scope)
-      scope_session = send("#{scope}_session")
+      scope_session = send(:"#{scope}_session")
       return unless scope_session.valid?
 
       redirect_to instance_eval(&simple_auth.logged_url)
     end
+
+    private def render_unauthorized_access(authorization)
+      reset_session
+      flash[simple_auth.flash_message_key] = authorization.error_message
+      session[:return_to] = request.fullpath if request.get?
+      redirect_to instance_eval(&simple_auth.login_url)
+    end
   end
 end

data/lib/simple_auth/config.rb

@@ -22,6 +22,7 @@ module SimpleAuth
 
     def install_helpers!
       ::ActionController::Base.include SimpleAuth::ActionController
+      ::ActionController::API.include SimpleAuth::ActionController::API
     end
   end
 end

data/lib/simple_auth/session.rb

@@ -6,8 +6,8 @@ module SimpleAuth
       @record_not_found_exceptions ||= []
     end
 
-    def self.create(**kwargs)
-      new(**kwargs)
+    def self.create(**)
+      new(**)
     end
 
     def initialize(scope:, session:, record: nil)

data/lib/simple_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleAuth
-  VERSION = "3.1.4"
+  VERSION = "3.2.0"
 end

data/lib/simple_auth.rb

@@ -10,6 +10,7 @@ module SimpleAuth
   require "simple_auth/config"
   require "simple_auth/railtie"
   require "simple_auth/action_controller"
+  require "simple_auth/action_controller/api"
   require "simple_auth/routing_mapper"
   require "simple_auth/action_controller/require_login_action"
   require "simple_auth/session"

data/simple_auth.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://rubygems.org/gems/simple_auth"
   s.summary     = "A simple authentication system for Rails apps"
   s.description = s.summary
-  s.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   github_url = "https://github.com/fnando/simple_auth"
   github_tree_url = "#{github_url}/tree/v#{s.version}"
@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
   s.metadata["rubygems_mfa_required"] = "true"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`
                     .split("\n")
                     .map {|f| File.basename(f) }
@@ -34,7 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency "globalid"
   s.add_dependency "rails"
   s.add_development_dependency "activerecord"
-  s.add_development_dependency "bcrypt", "~> 3.1.7"
+  s.add_development_dependency "bcrypt"
   s.add_development_dependency "minitest"
   s.add_development_dependency "minitest-utils"
   s.add_development_dependency "pry-meta"

data/test/controllers/api_controller_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ApiControllerTest < ActionController::TestCase
+  setup do
+    @routes = Rails.application.routes
+    User.delete_all
+  end
+
+  def create_records
+    admin = User.create!(
+      password: "test",
+      email: "admin@example.com",
+      admin: true
+    )
+    user = User.create!(
+      password: "test",
+      email: "john@example.com",
+      admin: false
+    )
+
+    [admin, user]
+  end
+
+  test "renders unauthorized for invalid api keys" do
+    get :index
+
+    assert_equal 401, response.status
+    assert_equal "401 Unauthorized", response.body
+  end
+
+  test "renders unauthorized for unauthorized users" do
+    _, user = *create_records
+    @request.headers["Authorization"] = user.id.to_s
+    get :index
+
+    assert_equal 401, response.status
+    assert_equal "401 Unauthorized", response.body
+  end
+
+  test "renders page for authorized users" do
+    admin, _ = *create_records
+    @request.headers["Authorization"] = admin.id.to_s
+    get :index
+
+    assert_equal 200, response.status
+    assert_equal %[{"message":"hello there"}], response.body
+  end
+end

data/test/support/dummy/app/controllers/api_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class ApiController < ActionController::API
+  include SimpleAuth::ActionController::API
+
+  before_action :validate_api_key
+  before_action :require_logged_user
+
+  def index
+    render json: {message: "hello there"}
+  end
+
+  private def authorized_user?
+    current_user&.admin?
+  end
+
+  private def validate_api_key
+    id = request.headers["Authorization"]
+    user = User.find_by(id:)
+
+    return render(plain: "401 Unauthorized", status: :unauthorized) unless user
+
+    SimpleAuth::Session.create(
+      scope: "user",
+      session:,
+      record: User.find_by(id:)
+    )
+  end
+end

data/test/support/dummy/config/routes.rb

@@ -8,7 +8,7 @@ Rails.application.routes.draw do
   post "/start-session", to: "sessions#create_session"
   post "/terminate-session", to: "sessions#terminate_session"
 
-  authenticate :admin, ->(u) { u.admin? } do
+  authenticate :admin, lambda(&:admin?) do
     get "/only/admins", to: ->(_env) { [200, {}, ["OK"]] }
   end
 
@@ -35,4 +35,6 @@ Rails.application.routes.draw do
       get :log_in_with_admin_flag
     end
   end
+
+  get "api", to: "api#index"
 end

data/test/test_helper.rb

@@ -18,4 +18,4 @@ require "active_record"
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 require "./test/support/schema"
 
-Dir["./test/support/**/*.rb"].sort.each {|file| require file }
+Dir["./test/support/**/*.rb"].each {|file| require file }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simple_auth
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: globalid
@@ -56,16 +55,16 @@ dependencies:
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -194,8 +193,11 @@ files:
 - gemfiles/rails_6_0.gemfile
 - gemfiles/rails_6_1.gemfile
 - gemfiles/rails_7_0.gemfile
+- gemfiles/rails_8_0.gemfile
+- gemfiles/rails_8_1.gemfile
 - lib/simple_auth.rb
 - lib/simple_auth/action_controller.rb
+- lib/simple_auth/action_controller/api.rb
 - lib/simple_auth/action_controller/require_login_action.rb
 - lib/simple_auth/config.rb
 - lib/simple_auth/generator.rb
@@ -206,11 +208,13 @@ files:
 - lib/simple_auth/version.rb
 - simple_auth.gemspec
 - test/controllers/admin/dashboard_controller_test.rb
+- test/controllers/api_controller_test.rb
 - test/controllers/dashboard_controller_test.rb
 - test/controllers/pages_controller_test.rb
 - test/generators/install_test.rb
 - test/requests/admin_test.rb
 - test/support/dummy/app/controllers/admin/dashboard_controller.rb
+- test/support/dummy/app/controllers/api_controller.rb
 - test/support/dummy/app/controllers/application_controller.rb
 - test/support/dummy/app/controllers/dashboard_controller.rb
 - test/support/dummy/app/controllers/pages_controller.rb
@@ -227,12 +231,11 @@ licenses: []
 metadata:
   homepage_uri: http://rubygems.org/gems/simple_auth
   bug_tracker_uri: https://github.com/fnando/simple_auth/issues
-  source_code_uri: https://github.com/fnando/simple_auth/tree/v3.1.4
-  changelog_uri: https://github.com/fnando/simple_auth/tree/v3.1.4/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/simple_auth/tree/v3.1.4/README.md
-  license_uri: https://github.com/fnando/simple_auth/tree/v3.1.4/LICENSE.md
+  source_code_uri: https://github.com/fnando/simple_auth/tree/v3.2.0
+  changelog_uri: https://github.com/fnando/simple_auth/tree/v3.2.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/simple_auth/tree/v3.2.0/README.md
+  license_uri: https://github.com/fnando/simple_auth/tree/v3.2.0/LICENSE.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,32 +243,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A simple authentication system for Rails apps
-test_files:
-- test/controllers/admin/dashboard_controller_test.rb
-- test/controllers/dashboard_controller_test.rb
-- test/controllers/pages_controller_test.rb
-- test/generators/install_test.rb
-- test/requests/admin_test.rb
-- test/support/dummy/app/controllers/admin/dashboard_controller.rb
-- test/support/dummy/app/controllers/application_controller.rb
-- test/support/dummy/app/controllers/dashboard_controller.rb
-- test/support/dummy/app/controllers/pages_controller.rb
-- test/support/dummy/app/controllers/sessions_controller.rb
-- test/support/dummy/app/models/user.rb
-- test/support/dummy/config/application.rb
-- test/support/dummy/config/initializers/simple_auth.rb
-- test/support/dummy/config/routes.rb
-- test/support/schema.rb
-- test/test_helper.rb
-- test/unit/session_test.rb
+test_files: []