Module: BetterSqs

Defined in:
lib/better_sqs.rb,
lib/better_sqs/client.rb,
lib/better_sqs/message.rb,
lib/better_sqs/configuration.rb

Defined Under Namespace

Classes: Client, Configuration, Message

Class Method Summary collapse

Class Method Details

.configurationConfiguration

Returns the singleton class’s configuration object

Returns:



24
25
26
# File 'lib/better_sqs.rb', line 24

def configuration
  @configuration ||= Configuration.new
end

.configure(opts = {}) {|configuration| ... } ⇒ Configuration

Allows the user to set configuration options

by yielding the configuration block

Parameters:

  • opts (Hash) (defaults to: {})

    an optional hash of options, supported options are ‘reset: true`

  • block (Block)

    an optional configuration block

Yields:

Returns:



13
14
15
16
17
18
19
# File 'lib/better_sqs.rb', line 13

def configure(opts = {}, &_block)
  @configuration = nil if opts.key?(:reset) && opts[:reset]
  yield(configuration) if block_given?

  configuration.configure_aws
  configuration
end

.configured?Boolean

Returns:

  • (Boolean)


28
29
30
# File 'lib/better_sqs.rb', line 28

def configured?
  !@configuration.nil?
end

.loggerObject



32
33
34
# File 'lib/better_sqs.rb', line 32

def logger
  LincolnLogger.logger
end