gamora 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac3585239f26c73703bedba78b8fb157fcae96e795606833510820dcc541635
-  data.tar.gz: b12bd007f45d5b97861254c0e7418faa14554eadc31fc0b7fa196932abb8915d
+  metadata.gz: e164eceeb7c3a744ed43be46877cb904fff4add871d4a7b4fac25e4837f2f731
+  data.tar.gz: cff5f7b7f3ffd07b13d6e6cc0e476ae86c87788bdf47a4e9c9ff4703dfe54d64
 SHA512:
-  metadata.gz: 4b824e97d834065f0beb2d0a6d30d343f02edb70d1cecbc7bcd598166474a32e71849b45e46289745ce2d279166a810ed9572cfe6688e48c0e6a9f496cb7e6dd
-  data.tar.gz: 6fd882d104aa35374d94e40f1b98b9dc708e26689da28ec9a0736ad4f7b7cba6bf177ecc18ddc8e0c8c5303a087404ec95ead3a20cf8cc2405be0eb49128594b
+  metadata.gz: b5da9c118a7f13441147ded22bb7bc237e7b51cd583e7355fa65370ef4e71dfa5256150f6ff0b6aad0f0169a1113dc9a8af2514aecff33454bb571391dea74de
+  data.tar.gz: ad67d0b0be691f544bd2ffcc277b6a70f036bd20ddbabfd9a48b1f92023f84023e8eaa715b6ccc82a9f8a90f4be975b0ac54a657bc18a14e6fd6e40f4bff6f23

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Alejandro Gutiérrez
+Copyright (c) 2023 Alejandro Gutiérrez
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -38,6 +38,41 @@ end
 To see the full list of configuration options please check your gamora
 initializer.
 
+## Mount Gamora Engine
+
+In order to have the authorization and callback endpoints mount the
+engine in the `config/routes.rb` file:
+
+```ruby
+Rails.application.routes.draw do
+  ...
+  mount Gamora::Engine => "/auth"
+
+  ...
+end
+```
+
+This will enable the following routes in the parent application:
+
+#### `gamora.authorization_path`
+
+This endpoint will redirect users to the IDP generating url and query
+params based on the configuration. This endpoint is called automatically
+when the user is not logged in and the application requires users to be
+authenticated.
+
+#### `gamora.logout_path`
+
+This endpoint allows users to be logged out from the application and the
+IDP. It removes the access and refresh tokens and redirects to IDP in order
+to force users to authenticate again.
+
+#### `gamora.callback_path`
+
+This endpoint is the responsible to received the auth code provided by
+the IDP and generate and access token. This endpoint is called automatically
+once the user authenticates successfully in the IDP.
+
 ## User authentication
 
 ### Web-based applications

data/app/controllers/concerns/gamora/authorization_url.rb

@@ -1,7 +1,21 @@
+# frozen_string_literal: true
+
 module Gamora
   module AuthorizationUrl
     def authorization_url(params, extra_params = {})
-      default_params = {
+      data =
+        default_params
+        .merge(extra_params)
+        .merge(authorization_params(params))
+        .compact_blank
+
+      Client.from_config.auth_code.authorize_url(data)
+    end
+
+    private
+
+    def default_params
+      {
         scope: Configuration.default_scope,
         theme: Configuration.default_theme,
         prompt: Configuration.default_prompt,
@@ -9,18 +23,8 @@ module Gamora
         branding: Configuration.default_branding,
         ui_locales: Configuration.ui_locales.call
       }
-
-      data =
-        default_params.
-        merge(extra_params).
-        merge(authorization_params(params)).
-        compact_blank
-
-      Client.from_config.auth_code.authorize_url(data)
     end
 
-    private
-
     def authorization_params(params)
       params.permit(
         :scope,

data/app/controllers/gamora/authentication_controller.rb

@@ -6,8 +6,8 @@ module Gamora
 
     def show
       redirect_to authorization_url(params),
-        allow_other_host: true,
-        status: :see_other
+                  allow_other_host: true,
+                  status: :see_other
     end
   end
 end

data/app/controllers/gamora/callback_controller.rb

@@ -7,7 +7,6 @@ module Gamora
       session[:access_token] = access_token.token
       session[:refresh_token] = access_token.refresh_token
       redirect_to session.delete("gamora.origin") || main_app.root_path
-
     rescue OAuth2::Error
       render plain: "Invalid authorization code"
     end

data/app/controllers/gamora/unauthentication_controller.rb

@@ -9,8 +9,8 @@ module Gamora
       session[:refresh_token] = nil
 
       redirect_to authorization_url(params, { max_age: 0 }),
-        allow_other_host: true,
-        status: :see_other
+                  allow_other_host: true,
+                  status: :see_other
     end
   end
 end

data/lib/gamora/authentication/base.rb

@@ -3,6 +3,16 @@
 module Gamora
   module Authentication
     module Base
+      CLAIMS = {
+        sub: :id,
+        email: :email,
+        given_name: :first_name,
+        family_name: :last_name,
+        phone_number: :phone_number,
+        email_verified: :email_verified,
+        phone_number_verified: :phone_number_verified
+      }.freeze
+
       def authenticate_user!
         claims = resource_owner_claims(access_token)
         assign_current_user_from_claims(claims) if claims.present?
@@ -33,20 +43,12 @@ module Gamora
       end
 
       def user_attributes_from_claims(claims)
-        claims.transform_keys do |key|
-          case key
-          when :sub then :id
-          when :email then :email
-          when :given_name then :first_name
-          when :family_name then :last_name
-          when :phone_number then :phone_number
-          else key
-          end
-        end
+        claims.slice(*CLAIMS.keys).transform_keys(CLAIMS)
       end
 
       def resource_owner_claims(access_token)
         return {} if access_token.blank?
+
         resource_owner_claims!(access_token)
       end
 

data/lib/gamora/authentication/headers.rb

@@ -9,6 +9,7 @@ module Gamora
 
       def validate_authentication!
         return if current_user.present?
+
         user_authentication_failed!
       end
 
@@ -16,6 +17,7 @@ module Gamora
         pattern = /^Bearer /
         header = request.headers["Authorization"]
         return unless header&.match(pattern)
+
         header.gsub(pattern, "")
       end
 

data/lib/gamora/authentication/session.rb

@@ -13,6 +13,7 @@ module Gamora
 
       def validate_authentication!
         return if current_user.present?
+
         session["gamora.origin"] = request.original_url
         user_authentication_failed!
       end

data/lib/gamora/client.rb

@@ -2,10 +2,18 @@
 
 module Gamora
   class Client < OAuth2::Client
-    def self.from_config
-      new(
-        Configuration.client_id,
-        Configuration.client_secret,
+    class << self
+      def from_config
+        new(
+          Configuration.client_id,
+          Configuration.client_secret,
+          client_options
+        )
+      end
+
+      private
+
+      def client_options
         {
           site: Configuration.site,
           token_url: Configuration.token_url,
@@ -14,7 +22,7 @@ module Gamora
           userinfo_url: Configuration.userinfo_url,
           authorize_url: Configuration.authorize_url
         }
-      )
+      end
     end
 
     def userinfo(access_token)

data/lib/gamora/user.rb

@@ -8,6 +8,8 @@ module Gamora
                   :email,
                   :last_name,
                   :first_name,
-                  :phone_number
+                  :phone_number,
+                  :email_verified,
+                  :phone_number_verified
   end
 end

data/lib/gamora/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamora
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamora
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: OpenID Connect Relying Party for rails apps.