module Genba

Genba API module

Constants

LEVEL_DEBUG: map to the same values as the standard library's logger
LEVEL_ERROR
LEVEL_INFO
VERSION

Public Class Methods

client(credentials = {}) click to toggle source

# File lib/genba.rb, line 38
def self.client(credentials = {})
  Client.new(credentials)
end

log_level() click to toggle source

When set prompts the library to log some extra information to $stdout and $stderr about what it's doing. For example, it'll produce information about requests, responses, and errors that are received. Valid log levels are `debug` and `info`, with `debug` being a little more verbose in places.

Use of this configuration is only useful when `.logger` is not set. When it is, the decision what levels to print is entirely deferred to the logger.

# File lib/genba.rb, line 49
def self.log_level
  @log_level
end

log_level=(val) click to toggle source

# File lib/genba.rb, line 53
def self.log_level=(val)
  # Backwards compatibility for values that we briefly allowed
  if val == 'debug'
    val = LEVEL_DEBUG
  elsif val == 'info'
    val = LEVEL_INFO
  end

  if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
    raise ArgumentError, "log_level should only be set to `nil`, `debug` or `info`"
  end
  @log_level = val
end

logger() click to toggle source

Sets a logger to which logging output will be sent. The logger should support the same interface as the `Logger` class that's part of Ruby's standard library (hint, anything in `Rails.logger` will likely be suitable).

If `.logger` is set, the value of `.log_level` is ignored. The decision on what levels to print is entirely deferred to the logger.

# File lib/genba.rb, line 74
def self.logger
  @logger
end

logger=(val) click to toggle source

# File lib/genba.rb, line 78
def self.logger=(val)
  @logger = val
end