File: Authentication.rb

package info (click to toggle)
ruby-em-mongo 0.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 340 kB
  • sloc: ruby: 2,960; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,064 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
require 'eventmachine'

# interface for all possible authentications
module EM::Mongo
  class Authentication
    include EM::Deferrable

    SYSTEM_COMMAND_COLLECTION = '$cmd'

    # supported AuthMethods (TODO make instantiation (in database.authenticate) dynamic)
      module AuthMethod
        SCRAM_SHA1 = :scram_sha1
        MONGODB_CR = :mongodb_cr
      end

    def initialize(database)
      @db = database
    end

      # Authenticate with the given username and password. Note that mongod
      # must be started with the --auth option for authentication to be enabled.
      #
      # @param [String] username
      # @param [String] password
      #
      # @return [EM::Mongo::RequestResponse] Calls back with +true+ or +false+, indicating success or failure
      #
      # @raise [AuthenticationError]
      #
      # @core authenticate authenticate-instance_method
    def authenticate(username, password)
      r=DefaultDeferrable.new #stub implementation
      r.fail "not implemented, use a subclass instead"
      return r
    end
  end
end