omniauth-slack-openid 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5fb3e5f96c832e24bbd7dc23c9e4ee0e1f8858a78beebdfdd7b0fe172c3a32e
-  data.tar.gz: ec3f3ae44d759f1a40f34fe5e5a953b1bc120e9c9fd93678834c54f4c4d202ba
+  metadata.gz: f29f8209a74236017c3e9c6a7119d26aa117da292f6bacf66c6a563f4ac8dd48
+  data.tar.gz: 296c5115987fa1c5bcf9ba75a4ef988ad8587cf7e3e8fad7567ccdc365d99c8d
 SHA512:
-  metadata.gz: 132b6519d589788e032f2994fb23663eb0765ec97efc11aa218ea98774aca4a1b6faa776ae4c492062876698ae3e6f3730d4bc3cfc8ecc6c2290719dc1defdbe
-  data.tar.gz: a58d54b112c70ae11395f19a1fca400bee3a5f3ad9a22b2fef67f0b48e50f2f930a77e97e2b4d49bdc9b55d3d374255a1536667b60989e43b4400b5a6cdb11ee
+  metadata.gz: 3250acb4a4279c4e0bb4119cbff7e47f30368dcb72c4b46e8015a47811d2aba6252faad76e751f6ea58d68aa781cd25ad33b59e622f206fb48f59f8f114fbf31
+  data.tar.gz: b420399ef6866402af8780211393f242a931b9729f766c841293d86a2eb531a9c706e467d17cc7b06673d4cb8117fa6903cf2d98bf3a42e712b9c7154ac16d20

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.0.2
+
+* Updated gem configuration
+
+# 1.0.1
+
+* Updated gem description
+
 # 1.0.0
 
 * Initial version

data/README.md

@@ -1,8 +1,10 @@
-# omniauth_slack_openid.rb
+# omniauth-slack-openid.rb
 
-[![Gem Version](https://badge.fury.io/rb/omniauth-slack-openid.svg)](https://badge.fury.io/rb/omniauth-slack-openid) [![Test Status](https://github.com/amkisko/omniauth_slack_openid.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/omniauth_slack_openid.rb/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/omniauth-slack-openid.svg)](https://badge.fury.io/rb/omniauth-slack-openid) [![Test Status](https://github.com/amkisko/omniauth-slack-openid.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/omniauth-slack-openid.rb/actions/workflows/test.yml)
 
-An OmniAuth strategy for Slack's OAuth2 API.
+An OmniAuth strategy for implementing Sign-in with Slack using OpenID Connect.
+
+Official documentation: https://api.slack.com/authentication/sign-in-with-slack
 
 Sponsored by [Kisko Labs](https://www.kiskolabs.com).
 
@@ -26,6 +28,15 @@ gem 'omniauth-slack-openid'
 
 ## Usage with Devise
 
+Create Slack app and configure OAuth & Permissions to have the following Redirect URLs:
+- https://localhost:3000/user/auth/slack_openid/callback
+
+Copy `Client ID` and `Client Secret` to your environment (e.g. `.env.local` file):
+```sh
+SLACK_CLIENT_ID=1234567890.1234567890
+SLACK_CLIENT_SECRET=1234567890abcdef1234567890abcdef
+```
+
 Add the following to your `config/initializers/devise.rb`:
 
 ```ruby
@@ -43,9 +54,20 @@ Add the following to your `config/initializers/devise.rb`:
 
 In order to test the callback in development, try logging in and then manually update URL to use http instead of https.
 
+## Generating uid
+
+Gem has own `generate_uid` method that concatenates `team_id` and `user_id`, you can use it with custom parameters:
+
+```ruby
+def resolve_user_session(team_id, user_id)
+  uid = OmniAuth::Strategies::SlackOpenid.generate_uid(team_id, user_id)
+  UserSession.find_by(uid: uid, provider: "slack-openid")
+end
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/omniauth_slack_openid.rb
+Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/omniauth-slack-openid.rb
 
 ## Publishing
 

data/lib/omniauth/slack_openid.rb

@@ -1,2 +1,7 @@
-require 'omniauth/slack_openid/version'
 require 'omniauth/strategies/slack_openid'
+
+module OmniAuth
+  module SlackOpenid
+    VERSION = '1.0.2'
+  end
+end

data/omniauth-slack-openid.gemspec

@@ -1,9 +1,8 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/omniauth/slack_openid/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name = "omniauth-slack-openid"
-  gem.version = OmniAuth::SlackOpenid::VERSION
+  gem.version = File.read(File.expand_path('../lib/omniauth/slack_openid.rb', __FILE__)).match(/VERSION\s*=\s*'(.*?)'/)[1]
 
   repository_url = "https://github.com/amkisko/omniauth-slack-openid.rb"
   root_files = %w(CHANGELOG.md LICENSE.md README.md)
@@ -16,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["Andrei Makarov"]
   gem.email = ["andrei@kiskolabs.com"]
   gem.homepage = repository_url
-  gem.summary = %q{Slack OAuth2 strategy for OmniAuth}
+  gem.summary = %q{An OmniAuth strategy for implementing Sign-in with Slack using OpenID Connect}
   gem.description = gem.summary
   gem.metadata = {
     "homepage" => repository_url,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-slack-openid
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: Slack OAuth2 strategy for OmniAuth
+description: An OmniAuth strategy for implementing Sign-in with Slack using OpenID
+  Connect
 email:
 - andrei@kiskolabs.com
 executables: []
@@ -106,7 +107,6 @@ files:
 - README.md
 - lib/omniauth-slack-openid.rb
 - lib/omniauth/slack_openid.rb
-- lib/omniauth/slack_openid/version.rb
 - lib/omniauth/strategies/slack_openid.rb
 - omniauth-slack-openid.gemspec
 - spec/omniauth/strategies/slack_openid_spec.rb
@@ -137,6 +137,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Slack OAuth2 strategy for OmniAuth
+summary: An OmniAuth strategy for implementing Sign-in with Slack using OpenID Connect
 test_files:
 - spec/omniauth/strategies/slack_openid_spec.rb

data/lib/omniauth/slack_openid/version.rb

@@ -1,5 +0,0 @@
-module OmniAuth
-  module SlackOpenid
-    VERSION = '1.0.0'
-  end
-end