omniauth-zeuswpi 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85d928de8aa7f50169f211a5e0d7274b953fd52f2659968028346ce41339d46
-  data.tar.gz: df0ac1cb065f9be81d7f097c1bbb64075adbb2b7d8ec939e77e2ff2f532eab67
+  metadata.gz: f5eb66f8bc8167c32055a23ab48ef1cd21265373b5b56b92e3adafb5157fc722
+  data.tar.gz: a3412cc3633f7dc193ad2d35b1b67c28e56e9a3bb04c6aebf3bbd3483cd17f4b
 SHA512:
-  metadata.gz: 2c1606e92208e7529748e6f4f804e8dae9ad1a7fad8d1b147fd9467ef6e6b4ea1feb1b9face4022cacb29c71c92cbd000df5332b22e3225a4d05eb0a19b57479
-  data.tar.gz: 37ed560d4ec48400fd9502c7dc3b3e4a9ab63935871dbc52567b2cbdcd85db8db1a5d4258fc1c80a7468ab2e84c775593472ae2ee15c7920fac9fc8b7ddbfe1c
+  metadata.gz: 11c71863ed4aac88099157671fae11f2362dd41557a763e97f8a402f01ee6dc107da62390cb5850b5279d95037e442a9a9b6788d091b68359ec81f7f49ce76a9
+  data.tar.gz: dc8d0bb46269b878377c499ba70f96a660e5e575575c794da9350b7b9a4158aa8f6c6c180744788009fc3731c4745fab751cd545839cc92cfb8445a832a451e3

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    omniauth-zeuswpi (1.0.0)
+      omniauth-oauth2 (~> 1.7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    hashie (5.0.0)
+    jwt (2.3.0)
+    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)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (2.1.0)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.2.0)
+      rack
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  omniauth-zeuswpi!
+
+BUNDLED WITH
+   2.3.13

data/README.md

@@ -0,0 +1,76 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-zeuswpi.svg)](https://badge.fury.io/rb/omniauth-zeuswpi)
+
+# OmniAuth ZeusWPI Zauth Strategy
+
+Strategy to authenticate with [Zeus WPI](https://zeus.gent) via OAuth2 in OmniAuth, powered by [Zauth](https://github.com/ZeusWPI/zauth).
+
+## Installation
+
+Add to your `Gemfile`
+```ruby
+gem 'omniauth-oauth2'
+gem 'omniauth-zeuswpi'
+gem 'omniauth-rails_csrf_protection'
+```
+
+And run `bundle install`
+
+## Usage
+
+_Note: Change `User` to your specific User model_
+
+1. Add the strategy to the omniauth config:
+
+```ruby
+config.omniauth :zeuswpi,
+  Rails.application.credentials.omniauth_client_id,
+  Rails.application.credentials.omniauth_client_secret,
+  token_params: { parse: :json }
+```
+
+2. Add a callbacks controller:
+```ruby
+class CallbacksController < Devise::OmniauthCallbacksController
+  # See https://github.com/omniauth/omniauth/wiki/FAQ#rails-session-is-clobbered-after-callback-on-developer-strategy
+  skip_before_action :verify_authenticity_token, only: :zeuswpi
+
+  def zeuswpi
+    @user = User.from_omniauth(request.env["omniauth.auth"])
+    sign_in_and_redirect @user, event: :authentication
+  end
+
+  def after_omniauth_failure_path_for(scope)
+    root_path
+  end
+end
+```
+
+3. Add the Devise Omniauth routes:
+```ruby
+devise_for :users, controllers: {
+  omniauth_callbacks: 'callbacks'
+}
+```
+
+4. Make your User model omniauthable:
+```ruby
+devise :omniauthable, omniauth_providers: %i[zeuswpi]
+```
+
+5. Add the `from_omniauth` helper to your `User` model:
+```ruby
+def self.from_omniauth(auth)
+  where(name: auth.uid).first_or_create do |user|
+    user.name = auth.uid
+    user.generate_key!
+  end
+end
+
+```
+6. Add a button to your website:
+```
+<%= button_to "Log in with Zeus WPI",
+              user_zeuswpi_omniauth_authorize_path %>
+```
+
+

data/lib/omniauth/zeuswpi/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module ZeusWPI
-    VERSION = '0.0.1'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-zeuswpi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Naessens, Zeus WPI
@@ -34,7 +34,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
+- README.md
 - lib/omniauth-zeuswpi.rb
 - lib/omniauth/strategies/zeuswpi.rb
 - lib/omniauth/zeuswpi.rb