omniauth-hub_az 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6b3cdd9d7d7fc5a1351f0ffce55b9e126b737bff47b32bcfe5b07581c04c77
-  data.tar.gz: e9746b012f98d8a4586a2d5f30133007b9e85bb8bdaf27a9ee5eaf25e1b54ff8
+  metadata.gz: 4ef928ff5884d9b4cb44fe222597feb798dc920b8eed2e29d942143866763259
+  data.tar.gz: c369b9406cff29c27531c91838b93e8fbf871a4eb7adcd593a7d6de2e18fc96c
 SHA512:
-  metadata.gz: f54080ded310eb5efbbcbe0f8ee21070aa152a63499c706528c2a39a945a30b6b177e831f6640b3275b2a9bf329829fb5c55021436e8aaf3ea44294d7b368ae6
-  data.tar.gz: 4705da313c9689ae2ac31093c773dc80b5ffcf1a11d1d1066ec76e897a70909d52b11f26e142eeb057917c0883083eedf398f610f0bbad6d14166b7e3b55ff64
+  metadata.gz: 7447ac12e6a050c05f10442144a7c910a237ad5fdba245cafdd1195f3865f0439376e9069ece0aa1c32bc8ae832dbbe6c2246b61c68d28d4345b2827f5f1b87b
+  data.tar.gz: 60d37bd4908b6bf012061fb04fc2bc6e714bed223bbcfb0591f437f80046cbf575b5622b6bd1e9b5996039112778572efbd850fecc432676c0b743d2fb2e0e11

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version

data/Gemfile.lock

@@ -1,48 +1,56 @@
 PATH
   remote: .
   specs:
-    omniauth-hub_az (0.1.0)
+    omniauth-hub_az (0.1.1)
       activesupport (>= 5.0)
-      omniauth-oauth2 (~> 1.6)
+      omniauth-oauth2 (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.1.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    concurrent-ruby (1.1.6)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    hashie (4.1.0)
-    i18n (1.8.5)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.2.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashie (5.0.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.2.1)
-    minitest (5.14.1)
-    multi_json (1.15.0)
+    jwt (2.6.0)
+    minitest (5.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    oauth2 (1.4.4)
-      faraday (>= 0.8, < 2.0)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (1.9.1)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.1)
       hashie (>= 3.4.6)
-      rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.6.0)
-      oauth2 (~> 1.1)
-      omniauth (~> 1.9)
-    rack (2.2.3)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    rack (3.0.4.1)
+    rack-protection (3.0.5)
+      rack
     rake (12.3.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    ruby2_keywords (0.0.5)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    version_gem (1.1.1)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,8 +1,6 @@
 # Omniauth::HubAz
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/hub_az`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An omniauth gem to authenticate with hub-az
 
 ## Installation
 
@@ -22,7 +20,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Configration
+
+Create an initializer file and configure the following parameters;
+
+```ruby
+Omniauth::HubAz.setup do |config|
+  config.public_key = OpenSSL::PKey::RSA.new(Rails.application.credentials.hub_az[:public_key])
+  config.algorithm = 'RS512'
+end
+```
+
+### Use with Devise
+
+Configure the `devise.rb` initializer;
+
+```ruby
+  config.omniauth :hub_az, Rails.application.credentials.hub_az[:client_id], Rails.application.credentials.hub_az[:client_secret]
+```
+
+Change your routes file to handle omniauth authentication;
+```ruby
+  #...
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+```
+
+and create that controller
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  def hub_az
+    authorization = request.env["omniauth.auth"]
+
+    # test that the info is valid? (verification with the public key was successfull)
+    if authorization.info.valid? && authorization.info.roles.include?('some-role')
+      @user = User.find_or_initialize_by(email: authorization.info.email) do |user|
+        user.password = Devise.friendly_token[0, 20]
+      end
+      # set additional attributes that should be updated after each authentication
+      @user.save!
+
+      sign_in_and_redirect @user, event: :authentication
+    else
+      redirect_to new_user_session_path, alert: 'Unable to login, make sure you have the correct roles assigned.'
+    end
+  end
+
+end
+```
+
+### Api Controller validation
+
+Include the mixin to your API controller to obtain additional methods to valid an incoming Bearer token;
+
+```ruby
+class Api::V1::ExampleController < ApplicationController
+
+  include Omniauth::HubAz::Mixins::ControllerHelper
+
+  before_action :valid_hub_az_token_required!
+  before_action do
+    hub_az_token_requires_role!('some-api-role')
+  end
+
+end
+```
 
 ## Development
 
@@ -32,7 +95,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-hub_az. 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/[USERNAME]/omniauth-hub_az/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/stijnster/omniauth-hub_az. 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/stijnster/omniauth-hub_az/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +104,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Omniauth::HubAz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/omniauth-hub_az/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Omniauth::HubAz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stijnster/omniauth-hub_az/blob/master/CODE_OF_CONDUCT.md).

data/lib/omniauth/hub_az/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module HubAz
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/omniauth/hub_az.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext'
 require 'omniauth-oauth2'
 

data/omniauth-hub_az.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'omniauth-oauth2', '~> 1.6'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.8'
   spec.add_dependency 'activesupport', '>= 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-hub_az
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Stijn Mathysen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement