Module: Doorkeeper

Defined in:
lib/doorkeeper.rb,
lib/doorkeeper/config.rb,
lib/doorkeeper/engine.rb,
lib/doorkeeper/errors.rb,
lib/doorkeeper/server.rb,
lib/doorkeeper/request.rb,
lib/doorkeeper/version.rb,
lib/doorkeeper/oauth/error.rb,
lib/doorkeeper/oauth/token.rb,
lib/doorkeeper/validations.rb,
lib/doorkeeper/oauth/client.rb,
lib/doorkeeper/oauth/scopes.rb,
lib/doorkeeper/rails/routes.rb,
lib/doorkeeper/request/code.rb,
lib/doorkeeper/models/scopes.rb,
lib/doorkeeper/request/token.rb,
lib/doorkeeper/doorkeeper_for.rb,
lib/doorkeeper/helpers/filter.rb,
lib/doorkeeper/models/expirable.rb,
lib/doorkeeper/models/ownership.rb,
lib/doorkeeper/models/revocable.rb,
lib/doorkeeper/request/password.rb,
lib/doorkeeper/models/accessible.rb,
lib/doorkeeper/helpers/controller.rb,
lib/doorkeeper/models/application.rb,
lib/doorkeeper/oauth/code_request.rb,
lib/doorkeeper/models/access_grant.rb,
lib/doorkeeper/models/access_token.rb,
lib/doorkeeper/oauth/code_response.rb,
lib/doorkeeper/oauth/token_request.rb,
lib/doorkeeper/rails/routes/mapper.rb,
lib/doorkeeper/oauth/client/methods.rb,
lib/doorkeeper/oauth/error_response.rb,
lib/doorkeeper/oauth/token_response.rb,
lib/doorkeeper/rails/routes/mapping.rb,
lib/doorkeeper/models/mongoid/scopes.rb,
lib/doorkeeper/oauth/request_concern.rb,
lib/doorkeeper/request/refresh_token.rb,
lib/doorkeeper/models/mongoid/version.rb,
lib/doorkeeper/oauth/pre_authorization.rb,
lib/doorkeeper/oauth/authorization/code.rb,
lib/doorkeeper/oauth/client/credentials.rb,
lib/doorkeeper/oauth/authorization/token.rb,
lib/doorkeeper/oauth/helpers/uri_checker.rb,
lib/doorkeeper/oauth/helpers/unique_token.rb,
lib/doorkeeper/request/authorization_code.rb,
lib/doorkeeper/request/client_credentials.rb,
lib/generators/doorkeeper/views_generator.rb,
lib/doorkeeper/models/mongoid2/application.rb,
lib/doorkeeper/oauth/helpers/scope_checker.rb,
lib/doorkeeper/oauth/refresh_token_request.rb,
lib/doorkeeper/models/mongoid2/access_grant.rb,
lib/doorkeeper/models/mongoid2/access_token.rb,
lib/doorkeeper/oauth/invalid_token_response.rb,
app/controllers/doorkeeper/tokens_controller.rb,
lib/doorkeeper/models/mongoid3_4/application.rb,
lib/doorkeeper/models/mongoid3_4/access_grant.rb,
lib/doorkeeper/models/mongoid3_4/access_token.rb,
lib/doorkeeper/oauth/forbidden_token_response.rb,
lib/doorkeeper/models/mongo_mapper/application.rb,
lib/doorkeeper/oauth/authorization/uri_builder.rb,
lib/doorkeeper/oauth/client_credentials/issuer.rb,
lib/doorkeeper/models/active_record/application.rb,
lib/doorkeeper/models/mongo_mapper/access_grant.rb,
lib/doorkeeper/models/mongo_mapper/access_token.rb,
lib/doorkeeper/oauth/authorization_code_request.rb,
lib/doorkeeper/oauth/client_credentials/creator.rb,
lib/doorkeeper/oauth/client_credentials_request.rb,
app/controllers/doorkeeper/token_info_controller.rb,
lib/doorkeeper/models/active_record/access_grant.rb,
lib/doorkeeper/models/active_record/access_token.rb,
app/controllers/doorkeeper/application_controller.rb,
app/controllers/doorkeeper/applications_controller.rb,
lib/doorkeeper/oauth/client_credentials/validation.rb,
lib/doorkeeper/oauth/password_access_token_request.rb,
app/controllers/doorkeeper/authorizations_controller.rb,
app/controllers/doorkeeper/application_metal_controller.rb,
lib/generators/doorkeeper/mongo_mapper/indexes_generator.rb,
app/controllers/doorkeeper/authorized_applications_controller.rb

Defined Under Namespace

Modules: Errors, FormErrorsHelper, Generators, Helpers, Models, MongoMapper, OAuth, Rails, Request, Validations Classes: AccessGrant, AccessToken, AllDoorkeeperFor, Application, ApplicationController, ApplicationMetalController, ApplicationOwnerGenerator, ApplicationsController, AuthorizationsController, AuthorizedApplicationsController, Config, DoorkeeperFor, DoorkeeperForBuilder, Engine, InstallGenerator, InvalidSyntax, MigrationGenerator, MissingConfiguration, SelectedDoorkeeperFor, Server, TokenInfoController, TokensController

Constant Summary collapse

VERSION = 
'1.4.0'

Class Method Summary collapse

Class Method Details

.authenticate(request, methods = Doorkeeper.configuration.access_token_methods) ⇒ Object 



59
60
61
 
# File 'lib/doorkeeper.rb', line 59

def self.authenticate(request, methods = Doorkeeper.configuration.access_token_methods)
  OAuth::Token.authenticate(request, *methods)
end

.configuration ⇒ Object 



14
15
16
 
# File 'lib/doorkeeper/config.rb', line 14

def self.configuration
  @config || (fail MissingConfiguration.new)
end

.configure(&block) ⇒ Object 



8
9
10
11
12
 
# File 'lib/doorkeeper/config.rb', line 8

def self.configure(&block)
  @config = Config::Builder.new(&block).build
  enable_orm
  setup_application_owner if @config.enable_application_owner?
end

.configured? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/doorkeeper.rb', line 47

def self.configured?
  @config.present?
end

.database_installed? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/doorkeeper.rb', line 51

def self.database_installed?
  [AccessToken, AccessGrant, Application].all? { |model| model.table_exists? }
end

.enable_orm ⇒ Object 



27
28
29
30
31
32
33
34
 
# File 'lib/doorkeeper/config.rb', line 27

def self.enable_orm
  require "doorkeeper/models/#{orm_model_dir}/access_grant"
  require "doorkeeper/models/#{orm_model_dir}/access_token"
  require "doorkeeper/models/#{orm_model_dir}/application"
  require 'doorkeeper/models/access_grant'
  require 'doorkeeper/models/access_token'
  require 'doorkeeper/models/application'
end

.installed? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/doorkeeper.rb', line 55

def self.installed?
  configured? && database_installed?
end

.orm_model_dir ⇒ Object 



18
19
20
21
22
23
24
25
 
# File 'lib/doorkeeper/config.rb', line 18

def self.orm_model_dir
  case configuration.orm
  when :mongoid3, :mongoid4
    'mongoid3_4'
  else
    configuration.orm
  end
end

.setup_application_owner ⇒ Object 



36
37
38
39
 
# File 'lib/doorkeeper/config.rb', line 36

def self.setup_application_owner
  require File.join(File.dirname(__FILE__), 'models', 'ownership')
  Application.send :include, Models::Ownership
end