gamora 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 563e700187ac79aef45f7d11aad774aee205f7917870f5431d3f1d6d63d7850b
-  data.tar.gz: 9817af7d6c4eb85abb6bdaa76d53efc0f1016f6516df95c674366b89ab920b49
+  metadata.gz: aa6a4fbbe3e75fdacdc78a5cf6635e0859cc459e4319446e65de3893b9c17959
+  data.tar.gz: 78182a8c53dd683fba71650fa5af83ec3637251903b1343722e27146aec5c042
 SHA512:
-  metadata.gz: 34de3119b475580ec5b65cab413d8f6ca7aed17fe433542ea81c6ef5ba314a67d9a29c384dd2aaafc9a9ff267510efbf6649a33f43fb7d41a15a0d3b7c308661
-  data.tar.gz: 2848933923aee39b310b107e77c6ec219b6642f0bda21c0e61677fbf056f3f80629f0d9bed0dbb81ea2637483d333de77292a871d86a358f19d98e1bade10b69
+  metadata.gz: c5d719440c65a62611fddbc9153a5d0f64585d1f67d45a3b29b9eba82d02940ce63f776092f829c0a1b3a55c292b4fe94a8515a38ef9126d150e705c44b7799d
+  data.tar.gz: d6de59c853d9fd0b8369ac583aa0235007c4576f7684431441620e3da2e2ee16d6a1def3b5718eaceef443a7e2a1fb2188b7bad4bbaf471f3bad6ee061ef59af

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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
@@ -80,8 +115,32 @@ Optionally, if you want to do something different when authentication
 fails, you just need to override the `user_authentication_failed!`
 method in you controller and customize it as you wish.
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and the created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amco/gamora-rb.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct](https://github.com/amco/gamora-rb/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gamora project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/amco/gamora-rb/blob/main/CODE_OF_CONDUCT.md).

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

@@ -47,6 +47,7 @@ module Gamora
 
       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/version.rb

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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: gamora
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
@@ -46,7 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - app/controllers/concerns/gamora/authorization_url.rb
@@ -68,13 +68,13 @@ files:
 - lib/generators/gamora/install_generator.rb
 - lib/generators/gamora/templates/gamora.rb
 - lib/tasks/gamora_tasks.rake
-homepage: https://github.com/amco/gamora_rb
+homepage: https://github.com/amco/gamora-rb
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/amco/gamora_rb
-  source_code_uri: https://github.com/amco/gamora_rb
-  changelog_uri: https://github.com/amco/gamora_rb/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/amco/gamora-rb
+  source_code_uri: https://github.com/amco/gamora-rb
+  changelog_uri: https://github.com/amco/gamora-rb/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -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.

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2022 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 in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.