doorkeeper-device_authorization_grant 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c9de51f80c701da39179d542265e15fc426cefdff8b7b70827305d27c89a16
-  data.tar.gz: '028cb5145903789550175cb6acdec567a214d4b84186d9e08fb9274b4016a4f3'
+  metadata.gz: 32ee06252abdee845d51559423b8acb6c52e95d6114a77829281fbfbe3b92cb2
+  data.tar.gz: 7808d08e1884a3e8755477a66527218fcde0a939d7c9c0aa896ff995255b1f9a
 SHA512:
-  metadata.gz: 667775d114f8a4559eaf84e84e8806acbdae0555bacb57db2c13a73d07dc447a60a2e135b837ffb42382e403f43774ce02f9933e619a0a6a28b291f771898f33
-  data.tar.gz: d8e6b3a77372b2dfe23e4a5f65d669878403b3ed803e1b66861d9c8c1279d3b7ecad1c97313a74475bd0a2ecc107e81410f74f9bf5de259a94a1292d48b1701c
+  metadata.gz: 0774bd3547873749fc1f5e0f6e76ccbe600809e085b290d776e53ebc88f4269e4199e6bc309ecd773952f93c73dadb4011d3b9cf69e4690b34034ce96e3afc06
+  data.tar.gz: be2761dd89889be684363b1f33ca69774f059baff4fddf4056e9b83d8037d06f6b0fd64c36ee2d95c51e2536121f613b5a982f7fc6da909196b82c8ed2be7bef

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 EXOP Group
+Copyright 2020-2021 EXOP Group
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -7,17 +7,6 @@ This library implements the OAuth 2.0 device authorization grant
 [Ruby on Rails](https://rubyonrails.org/) applications on top of the
 [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) OAuth 2.0 framework.
 
-## Status
-
-This extension currently works with Doorkeeper version `>= 5.4.0`.
-
-As of June 25 2020, due to some limitations of Doorkeeper, it is currently
-inconvenient for this Gem to use the official OAuth grant type
-`urn:ietf:params:oauth:grant-type:device_code`. Instead, it has been renamed
-to simply `device_code`, which is non-standard. This is going to be corrected
-soon: the next Doorkeeper release will include the ability to cleanly
-register custom Grant Flows - see [Doorkeeper Pull Request #1418](https://github.com/doorkeeper-gem/doorkeeper/pull/1418).
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -55,7 +44,7 @@ $ rails doorkeeper_device_authorization_grant_engine:install:migrations
 ### Doorkeeper configuration
 
 In your Doorkeeper initializer (usually `config/initializers/doorkeeper.rb`), enable
-the device flow extension grant type, adding to the `grant_flows` option the `device_code`
+the new grant flow extension, adding to the `grant_flows` option the `device_code`
 string. For example:
 
 ```ruby
@@ -65,9 +54,6 @@ string. For example:
     # ... 
   
     grant_flows [
-      # Note: this is a non-standard grant flow, used instead of the
-      # official `urn:ietf:params:oauth:grant-type:device_code` due to
-      # current Doorkeeper limitations.
       'device_code',
  
       # together with all the other grant flows you already enabled, for example:
@@ -80,11 +66,6 @@ string. For example:
   end
 ```
 
-Please note that **this is not the official grant flow**. The real one should be
-the IANA URN `urn:ietf:params:oauth:grant-type:device_code`, however this is hard
-to support with the current version of Doorkeeper, due to how strategy classes are
-looked up by grant type value.
-
 ### Device Authorization Grant configuration
 
 The gem's installation scripts automatically creates a new initializer file:
@@ -237,15 +218,11 @@ by Dorkeeper), for example:
 POST /oauth/token HTTP/1.1
 Content-Type: application/x-www-form-urlencoded
 
-grant_type=device_code
+grant_type=urn:ietf:params:oauth:grant-type:device_code
 &device_code=GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS
 &client_id=1406020730
 ```
 
-**Note:** this is a non-standard `grant_type`, used instead of the official 
-`urn:ietf:params:oauth:grant-type:device_code` due to current limitations of
-the Doorkeeper gem.
-
 The response to this request is defined in the next section. It is expected for
 the *Device Client* to try the access token request repeatedly in a polling
 fashion, based on the error code in the response. The polling time interval

data/Rakefile

@@ -1,20 +1,6 @@
 # frozen_string_literal: true
 
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Doorkeeper::DeviceAuthorizationGrant'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/setup'
 
 APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'

data/lib/doorkeeper/device_authorization_grant.rb

@@ -5,12 +5,14 @@ require 'active_model'
 require 'doorkeeper/device_authorization_grant/config'
 require 'doorkeeper/device_authorization_grant/engine'
 
+# Doorkeeper namespace
 module Doorkeeper
   # OAuth 2.0 Device Authorization Grant extension for Doorkeeper.
   module DeviceAuthorizationGrant
     autoload :DeviceGrant, 'doorkeeper/device_authorization_grant/orm/active_record/device_grant'
     autoload :DeviceGrantMixin, 'doorkeeper/device_authorization_grant/orm/active_record/device_grant_mixin'
     autoload :Errors, 'doorkeeper/device_authorization_grant/errors'
+    autoload :OAuth, 'doorkeeper/device_authorization_grant/oauth'
     autoload :VERSION, 'doorkeeper/device_authorization_grant/version'
 
     # Namespace for device authorization request strategies
@@ -45,4 +47,10 @@ module Doorkeeper
   module Request
     autoload :DeviceCode, 'doorkeeper/request/device_code'
   end
+
+  Doorkeeper::GrantFlow.register(
+    :device_code,
+    grant_type_matches: Doorkeeper::DeviceAuthorizationGrant::OAuth::DEVICE_CODE,
+    grant_type_strategy: Doorkeeper::Request::DeviceCode
+  )
 end

data/lib/doorkeeper/device_authorization_grant/oauth.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module DeviceAuthorizationGrant
+    module OAuth
+      # IANA URN of the Device Authorization Grant Type.
+      # @see https://tools.ietf.org/html/rfc8628#section-7.2 RFC 8628 - 7.2. OAuth URI Registration
+      DEVICE_CODE = 'urn:ietf:params:oauth:grant-type:device_code'
+      public_constant :DEVICE_CODE
+    end
+  end
+end

data/lib/doorkeeper/device_authorization_grant/oauth/device_code_request.rb

@@ -27,8 +27,7 @@ module Doorkeeper
           @client = client
           @device_grant = device_grant
 
-          # this should be `urn:ietf:params:oauth:grant-type:device_code`
-          @grant_type = 'device_code'
+          @grant_type = Doorkeeper::DeviceAuthorizationGrant::OAuth::DEVICE_CODE
         end
 
         def before_successful_response

data/lib/doorkeeper/device_authorization_grant/version.rb

@@ -2,7 +2,7 @@
 
 module Doorkeeper
   module DeviceAuthorizationGrant
-    VERSION = '0.2.1'
+    VERSION = '1.0.0'
     public_constant :VERSION
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doorkeeper-device_authorization_grant
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - EXOP Group
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: doorkeeper
@@ -16,56 +16,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +119,7 @@ files:
 - lib/doorkeeper/device_authorization_grant/config.rb
 - lib/doorkeeper/device_authorization_grant/engine.rb
 - lib/doorkeeper/device_authorization_grant/errors.rb
+- lib/doorkeeper/device_authorization_grant/oauth.rb
 - lib/doorkeeper/device_authorization_grant/oauth/device_authorization_request.rb
 - lib/doorkeeper/device_authorization_grant/oauth/device_authorization_response.rb
 - lib/doorkeeper/device_authorization_grant/oauth/device_code_request.rb
@@ -131,7 +138,10 @@ files:
 homepage: https://github.com/exop-group/doorkeeper-device_authorization_grant
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/exop-group/doorkeeper-device_authorization_grant
+  source_code_uri: https://github.com/exop-group/doorkeeper-device_authorization_grant
+  changelog_uri: https://github.com/exop-group/doorkeeper-device_authorization_grant/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -147,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: OAuth 2.0 Device Authorization Grant extension for Doorkeeper.