omniauth-discord 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e8c36d444404a9248c61a4cbe2efc24ab9daedcc8d72b95371a64844c975eb
-  data.tar.gz: 96619b3fd3c018843e8be931f8520fda07b2b30bfae2e843e587b5259f11f236
+  metadata.gz: dd7659142ba5f22d8146f7844aa6d56b3c3c6a7201e623d00e0c6f0656875f4d
+  data.tar.gz: cd9dce4beb227213e08f3897b2e332fe89679d1edf0adb54e4144e22836415e4
 SHA512:
-  metadata.gz: a593ff764c850a8a4efb395e8bb8efe9cc56fe2e938aac169f782675dd89f80ff75882e0c5ac13fecf0870942371574df71da914cedf71608be80bbbcfc757cf
-  data.tar.gz: 061d325e89a4a29e24b8bcdaf32c6a276f5d7e96da1cef5cb2ba87478ea2b93543b873c692c1d6535c4a996eae6aa2aa6ce3c7ba793b9ae616984f0be758c001
+  metadata.gz: 611bda0c4d19ea05645a15413cb2ed035465a48c959b56fbaa618c8daf206d1deb9253423b4407cae247f935e4d96e8f20c9614bc9a0d1c46e920846f15c648a
+  data.tar.gz: d3a9c813cf4258adaa9bae74ecbd2c21cb11141dc88e8c68b193d4d489e78018f442ee4bd2f51d320d817a9b183339b1d1b3ad970b286e276f2eae69b3c733ce

data/README.md

@@ -1,24 +1,22 @@
 # OmniAuth Discord
 
-Discord OAuth2 Strategy for OmniAuth.
+OmniAuth Discord - OAuth2 Strategy for OmniAuth
 
-Read the Discord API documentation for more details: https://discordapp.com/developers/docs/topics/oauth2
+OmniAuth Discord is an OAuth2 strategy for OmniAuth that allows you to authenticate users using Discord. If you're not familiar with Discord's OAuth2, we recommend you check out the Discord API documentation for more details.
 
-## Installing
+## Installation
 
-Add to your `Gemfile`:
+To install OmniAuth Discord, simply add the following line to your Gemfile:
 
 ```ruby
 gem 'omniauth-discord'
 ```
 
-Then `bundle install`.
+Then run bundle install to install the gem.
 
 ## Usage
 
-`OmniAuth::Strategies::Discord` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
-
-Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+OmniAuth Discord is a Rack middleware. If you're not familiar with OmniAuth, we recommend reading the documentation for detailed instructions. Here's an example of how to add the middleware to a Rails app in config/initializers/omniauth.rb:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
@@ -26,10 +24,7 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-By default, Discord does not return a user's email address. Their API uses
-[scopes](https://discordapp.com/developers/docs/topics/oauth2#scopes) to provide
-access to certain resources of a user's account. For example, to get a user's
-email set the scope to `email`.
+By default, Discord does not return a user's email address. You can request access to additional resources by setting scopes. For example, to get a user's email, you would set the scope to 'email'.
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
@@ -37,8 +32,7 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-You can pass multiple scopes in the same string. For example to get a user's
-Discord account info set the scope to `email identify`
+You can pass multiple scopes in the same string. For example, to get a user's Discord account info, you would set the scope to 'email identify'.
 
 
 ```ruby
@@ -47,7 +41,7 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-You can set callback url
+You can also specify a callback URL by adding callback_url to the provider options.
 
 
 ```ruby
@@ -56,10 +50,9 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-## Specifying additional permissions
+## Additional Permissions
 
-You can also request additional permissions from the user. See the
-[permission help page](https://discordapp.com/developers/docs/topics/permissions#bitwise-permission-flags) for a list of all available options.
+You can request additional permissions from the user by setting the permissions option. For example, to request permission to the MANAGE_CHANNELS and MANAGE_ROLES permissions, you would set permissions to 0x00000010 + 0x10000000.
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
@@ -70,15 +63,15 @@ end
 This will request permission to the MANAGE_CHANNELS and the MANAGE_ROLES
 permissions.
 
-## Specifying the prompt options
+## Prompt Options
 
-Discord looks for the prompt option to indicate if the user should be prompted to reauthorize on sign in. Valid options are 'consent' and 'none'. Note that the use is always prompted to authorize on sign up.
+You can specify the prompt options by setting the prompt option. The prompt option indicates whether the user should be prompted to reauthorize on sign in. Valid options are 'consent' and 'none'. Note that the user is always prompted to authorize on sign up.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/adaoraul/omniauth-discord.
+If you find a bug or want to contribute to the project, we welcome bug reports and pull requests on GitHub.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+OmniAuth Discord is available as open-source software under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new
-
-desc 'Run specs'
-task default: :spec
+require "bundler/gem_tasks"

data/lib/omniauth/discord/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Discord
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.2.0'
   end
 end

data/lib/omniauth/strategies/discord.rb

@@ -12,7 +12,7 @@ module OmniAuth
              authorize_url: 'oauth2/authorize',
              token_url: 'oauth2/token'
 
-      option :authorize_options, %i[scope permissions prompt]
+      option :authorize_options, %i[scope guild_id permissions prompt]
 
       uid { raw_info['id'] }
 
@@ -20,14 +20,13 @@ module OmniAuth
         {
           name: raw_info['username'],
           email: raw_info['verified'] ? raw_info['email'] : nil,
-          # CDN is still cdn.discordapp.com
-          image: raw_info['avatar'].present? ? "https://cdn.discordapp.com/avatars/#{raw_info['id']}/#{raw_info['avatar']}" : nil,
+          image: raw_info['avatar'] ? "https://cdn.discordapp.com/avatars/#{raw_info['id']}/#{raw_info['avatar']}" : nil,
         }
       end
 
       extra do
         {
-          'raw_info' => raw_info
+          raw_info: raw_info
         }
       end
 
@@ -37,7 +36,7 @@ module OmniAuth
 
       def callback_url
         # Discord does not support query parameters
-        options[:callback_url] || (full_host + script_name + callback_path)
+        options[:redirect_uri] || (full_host + script_name + callback_path)
       end
 
       def authorize_params

data/omniauth-discord.gemspec

@@ -4,12 +4,12 @@ require 'omniauth/discord/version'
 Gem::Specification.new do |spec|
   spec.name          = 'omniauth-discord'
   spec.version       = Omniauth::Discord::VERSION
-  spec.authors       = ['Adão Raul']
-  spec.email         = ['adao.raul@gmail.com']
+  spec.authors       = ["Dean Perry", 'Adão Raul']
+  spec.email         = ["dean@deanpcmad.com", 'adao.raul@gmail.com']
 
   spec.summary       = 'Discord OAuth2 Strategy for OmniAuth'
   spec.description   = spec.summary
-  spec.homepage      = 'http://github.com/adaoraul/omniauth-discord'
+  spec.homepage      = 'https://github.com/deanpcmad/omniauth-discord'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
@@ -17,12 +17,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'omniauth', '~> 2.0.4'
-  spec.add_runtime_dependency 'omniauth-oauth2'
-
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'webmock'
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.6'
 end

metadata

@@ -1,139 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-discord
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
+- Dean Perry
 - Adão Raul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: omniauth
+  name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
-- !ruby/object:Gem::Dependency
-  name: omniauth-oauth2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 description: Discord OAuth2 Strategy for OmniAuth
 email:
+- dean@deanpcmad.com
 - adao.raul@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gem-push.yml"
-- ".github/workflows/rspec.yml"
 - ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- example/Gemfile
-- example/Gemfile.lock
-- example/app.rb
-- example/config.ru
 - lib/omniauth-discord.rb
 - lib/omniauth/discord.rb
 - lib/omniauth/discord/version.rb
 - lib/omniauth/strategies/discord.rb
 - omniauth-discord.gemspec
-homepage: http://github.com/adaoraul/omniauth-discord
+homepage: https://github.com/deanpcmad/omniauth-discord
 licenses:
 - MIT
 metadata: {}
@@ -152,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: Discord OAuth2 Strategy for OmniAuth

data/.github/workflows/gem-push.yml

@@ -1,33 +0,0 @@
-name: Ruby Gem
-
-on:
-  release:
-    types:
-      - created
-
-jobs:
-  build:
-
-    name: Build + Publish Gem
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: 2.7.2
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/rspec.yml

@@ -1,25 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.rubocop.yml

@@ -1,18 +0,0 @@
-Rails:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
-Metrics/BlockLength:
-  ExcludedMethods:
-    - describe

data/.travis.yml

@@ -1,28 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=ABC123
-
-language: ruby
-before_install: gem install bundler
-
-rvm:
-  - 2.6.1
-  - 2.3.0
-  - jruby-head
-
-gemfile:
-  - Gemfile
-
-notifications:
-  email: true
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bundle exec rspec
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/example/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'sinatra'
-gem 'sinatra-reloader'
-gem 'omniauth-discord', path: '../'

data/example/Gemfile.lock

@@ -1,60 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    omniauth-discord (1.0.0)
-      omniauth
-      omniauth-oauth2
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    backports (3.15.0)
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    hashie (3.6.0)
-    jwt (2.2.1)
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    mustermann (1.0.3)
-    oauth2 (1.4.1)
-      faraday (>= 0.8, < 0.16.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (1.9.0)
-      hashie (>= 3.4.6, < 3.7.0)
-      rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.6.0)
-      oauth2 (~> 1.1)
-      omniauth (~> 1.9)
-    rack (2.2.3)
-    rack-protection (2.0.5)
-      rack
-    sinatra (2.0.5)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.5)
-      tilt (~> 2.0)
-    sinatra-contrib (2.0.5)
-      backports (>= 2.8.2)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.0.5)
-      sinatra (= 2.0.5)
-      tilt (>= 1.3, < 3)
-    sinatra-reloader (1.0)
-      sinatra-contrib
-    tilt (2.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  omniauth-discord!
-  sinatra
-  sinatra-reloader
-
-BUNDLED WITH
-   2.0.2

data/example/app.rb

@@ -1,23 +0,0 @@
-require 'sinatra'
-require "sinatra/reloader"
-require 'yaml'
-
-# configure sinatra
-set :run, false
-set :raise_errors, true
-
-get '/' do
-  content_type 'text/html'
-  <<-HTML
-    <html>
-      <body>
-        <a href="/auth/discord">Connect to Discord!</a>
-      </body>
-    </html>
-  HTML
-end
-
-get '/auth/:provider/callback' do
-  content_type 'application/json'
-  MultiJson.encode(request.env)
-end

data/example/config.ru

@@ -1,11 +0,0 @@
-require 'bundler/setup'
-require 'omniauth-discord'
-require './app.rb'
-
-use Rack::Session::Cookie, secret: '123456789'
-
-use OmniAuth::Builder do
-  provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_ID'], scope: ENV['SCOPE']
-end
-
-run Sinatra::Application