Module: Rescuetime

Defined in:
lib/rescuetime.rb,
lib/rescuetime/client.rb,
lib/rescuetime/errors.rb,
lib/rescuetime/version.rb,
lib/rescuetime/requester.rb,
lib/rescuetime/collection.rb,
lib/rescuetime/formatters.rb,
lib/rescuetime/date_parser.rb,
lib/rescuetime/configuration.rb,
lib/rescuetime/core_extensions.rb,
lib/rescuetime/query_buildable.rb,
lib/rescuetime/report_formatters.rb

Overview

Wrapper module for rescuetime gem

Since:

  • v0.1.0

Defined Under Namespace

Modules: CoreExtensions, Errors, Formatters, QueryBuildable Classes: Client, Collection, Configuration, DateParser, ReportFormatters, Requester

Constant Summary collapse

VERSION =

rescuetime gem version number

Since:

  • v0.1.0

'1.0.2'.freeze

Class Method Summary collapse

Class Method Details

.configuration ⇒ Rescuetime::Configuration

Returns either the current configuration (if set) or initializes a new default configuration.

Examples:

Rescuetime.configuration.formatter_paths
#=> []

Rescuetime.configure do |config|
  config.formatter_paths += ['formatters/*.rb']
end
Rescuetime.configuration.formatter_paths
#=> ["formatters/*.rb"]

Returns:

See Also:

Since:

  • v0.4.0



54
55
56
 
# File 'lib/rescuetime.rb', line 54

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Passes a block to the Rescuetime configuration, allowing configuration options to be set.

Examples:

# In an initializer or before any report formatters are called:
Rescuetime.configure do |config|
  config.formatter_paths += ['path/to/local/formatters/*_formatter.rb']
end

# Let's say that directory contains the valid formatters pdf_formatter.rb
# and json_formatter.rb
report_formatters = Rescuetime::ReportFormatters.new
puts report_formatters.all
#=> ["array", "csv", "pdf", "json"]

Yields:

See Also:

Since:

  • v0.4.0



34
35
36
 
# File 'lib/rescuetime.rb', line 34

def self.configure
  yield(configuration)
end

.reset ⇒ Object

Resets the configuration back to the initial state. Mainly useful for resetting the class after testing, making specs order-independent.

Examples:

before :each do
  Rescuetime.configure { |c| c.formatter_paths += ['formatters/*.rb'] }
end

after :each do
  Rescuetime.reset
end

See Also:

Since:

  • v0.4.0



72
73
74
 
# File 'lib/rescuetime.rb', line 72

def self.reset
  @configuration = Configuration.new
end