doorkeeper-device_authorization_grant 0.1.0

data/lib/doorkeeper/device_authorization_grant/request/device_authorization.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module DeviceAuthorizationGrant
+    module Request
+      # Doorkeeper strategy for OAuth 2.0 Device Authorization Requests.
+      #
+      # @see https://tools.ietf.org/html/rfc8628#section-3.1 RFC 8628, sect. 3.1
+      class DeviceAuthorization < ::Doorkeeper::Request::Strategy
+        delegate :client, to: :server
+
+        # @return [OAuth::DeviceAuthorizationRequest]
+        def request
+          @request ||= OAuth::DeviceAuthorizationRequest.new(
+            Doorkeeper.configuration,
+            client,
+            host_name
+          )
+        end
+
+        private
+
+        # @return [String]
+        def host_name
+          req = server.context.request
+          "#{req.scheme}://#{req.host}#{port}"
+        end
+
+        # @return [String, nil]
+        def port
+          return nil if [80, 443].include?(server.context.request.port)
+
+          ":#{server.context.request.port}"
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/device_authorization_grant/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module DeviceAuthorizationGrant
+    VERSION = '0.1.0'
+    public_constant :VERSION
+  end
+end

data/lib/doorkeeper/request/device_code.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module Request
+    # Doorkeeper strategy for OAuth 2.0 Device Access Token Requests.
+    #
+    # @see https://tools.ietf.org/html/rfc8628#section-3.4 RFC 8628, sect. 3.4
+    class DeviceCode < ::Doorkeeper::Request::Strategy
+      delegate :parameters, :client, to: :server
+
+      # @return [::Doorkeeper::DeviceAuthorizationGrant::OAuth::DeviceCodeRequest]
+      def request
+        @request ||=
+          ::Doorkeeper::DeviceAuthorizationGrant::OAuth::DeviceCodeRequest
+          .new(Doorkeeper.configuration, client, device_grant)
+      end
+
+      private
+
+      delegate :device_grant_model, to: :configuration
+
+      # @return [::Doorkeeper::DeviceAuthorizationGrant::DeviceGrant, nil]
+      def device_grant
+        @device_grant ||= device_grant_model.by_device_code(parameters[:device_code])
+      end
+
+      # @return [::Doorkeeper::DeviceAuthorizationGrant::Config]
+      def configuration
+        @configuration ||= DeviceAuthorizationGrant.configuration
+      end
+    end
+  end
+end

data/lib/generators/doorkeeper/device_authorization_grant/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module DeviceAuthorizationGrant
+    # Rails generator to install DeviceAuthorizationGrant initializer and routes.
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('./templates', __dir__)
+      desc 'Installs Doorkeeper DeviceAuthorizationGrant.'
+
+      def install
+        template('initializer.rb', 'config/initializers/doorkeeper_device_authorization_grant.rb')
+        route('use_doorkeeper_device_authorization_grant')
+      end
+    end
+  end
+end

data/lib/generators/doorkeeper/device_authorization_grant/templates/initializer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Doorkeeper::DeviceAuthorizationGrant.configure do
+  # Minimum device code polling interval expected from the client, expressed in seconds.
+  # device_code_polling_interval 5
+
+  # Device code expiration time, in seconds.
+  # device_code_expires_in 300
+
+  # Customizable reference to the DeviceGrant model.
+  # device_grant_class 'Doorkeeper::DeviceAuthorizationGrant::DeviceGrant'
+
+  # Reference to a model (or class) for user code generation.
+  #
+  # It must implement a `.generate` method, which can be invoked without
+  # arguments, to obtain a String user code value.
+  #
+  # user_code_generator 'Doorkeeper::DeviceAuthorizationGrant::OAuth::Helpers::UserCode'
+
+  # A Proc returning the end-user verification URI on the authorization server.
+  # verification_uri ->(host_name) do
+  #   "#{host_name}/oauth/device"
+  # end
+
+  # A Proc returning the verification URI that includes the "user_code"
+  # (or other information with the same function as the "user_code"), which is
+  # designed for non-textual transmission. This is optional, so the Proc can
+  # also return `nil`.
+  #
+  # verification_uri_complete ->(verification_uri, host_name, device_grant) do
+  #   "#{verification_uri}?user_code=#{CGI.escape(device_grant.user_code)}"
+  # end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: doorkeeper-device_authorization_grant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- EXOP Group
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: doorkeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: OAuth 2.0 Device Authorization Grant extension for Doorkeeper.
+email:
+- opensource@exop-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/doorkeeper/device_authorization_grant/device_authorizations_controller.rb
+- app/controllers/doorkeeper/device_authorization_grant/device_codes_controller.rb
+- app/views/doorkeeper/device_authorization_grant/device_authorizations/index.html.erb
+- config/locales/en.yml
+- db/migrate/20200629094624_create_doorkeeper_device_grants.rb
+- lib/doorkeeper/device_authorization_grant.rb
+- 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/device_authorization_request.rb
+- lib/doorkeeper/device_authorization_grant/oauth/device_authorization_response.rb
+- lib/doorkeeper/device_authorization_grant/oauth/device_code_request.rb
+- lib/doorkeeper/device_authorization_grant/oauth/helpers/user_code.rb
+- lib/doorkeeper/device_authorization_grant/orm/active_record.rb
+- lib/doorkeeper/device_authorization_grant/orm/active_record/device_grant.rb
+- lib/doorkeeper/device_authorization_grant/rails/routes.rb
+- lib/doorkeeper/device_authorization_grant/rails/routes/mapper.rb
+- lib/doorkeeper/device_authorization_grant/rails/routes/mapping.rb
+- lib/doorkeeper/device_authorization_grant/request/device_authorization.rb
+- lib/doorkeeper/device_authorization_grant/version.rb
+- lib/doorkeeper/request/device_code.rb
+- lib/generators/doorkeeper/device_authorization_grant/install_generator.rb
+- lib/generators/doorkeeper/device_authorization_grant/templates/initializer.rb
+homepage: https://github.com/exop-group/doorkeeper-device_authorization_grant
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: OAuth 2.0 Device Authorization Grant extension for Doorkeeper.
+test_files: []