module FirebaseAdmin::Configuration
Defines constants and methods related to configuration
Constants
- DEFAULT_ACCESS_TOKEN
By default, don't set a user access token
- DEFAULT_ADAPTER
The adapter that will be used to connect if none is set
@note The default faraday adapter is Net::HTTP.
- DEFAULT_CONNECTION_OPTIONS
By default, don't set any connection options
- DEFAULT_ENDPOINT
The endpoint that will be used to connect if none is set
@note There is no reason to use any other endpoint at this time
- DEFAULT_FORMAT
The response format appended to the path and sent in the 'Accept' header if none is set
@note JSON is the only available format at this time
- DEFAULT_LOUD_LOGGER
By default, don't turn on loud logging
- DEFAULT_PROJECT_ID
- DEFAULT_USER_AGENT
The user agent that will be sent to the
API
endpoint if none is set- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a {FirebaseAdmin::API}
Public Class Methods
When this module is extended, set all configuration options to their default values
# File lib/firebase-admin/configuration.rb, line 51 def self.extended(base) base.reset end
Public Instance Methods
Convenience method to allow configuration options to be set in a block
# File lib/firebase-admin/configuration.rb, line 56 def configure yield self end
Create a hash of options and their values
# File lib/firebase-admin/configuration.rb, line 61 def options VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end
Reset all configuration options to defaults
# File lib/firebase-admin/configuration.rb, line 68 def reset self.access_token = DEFAULT_ACCESS_TOKEN self.adapter = DEFAULT_ADAPTER self.connection_options = DEFAULT_CONNECTION_OPTIONS self.endpoint = DEFAULT_ENDPOINT self.user_agent = DEFAULT_USER_AGENT self.project_id = DEFAULT_PROJECT_ID self.loud_logger = DEFAULT_LOUD_LOGGER end