Module: Metric

Defined in:

lib/metric.rb,
lib/metric/track.rb,
lib/metric/receive.rb,
lib/metric/version.rb,
lib/metric/configuration.rb

Defined Under Namespace

Classes: Configuration, Receive, Track

Constant Summary

VERSION =

"0.1.0"

Class Attribute Summary

• .configuration ⇒ Object

  Holds the configuration for easy access to settings.

Class Method Summary

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

  Configures gem options.

• .receive(metric, range) ⇒ Hash

  Fetches data from the API.

• .track(metric, options = {}) ⇒ Hash

  Tracks metrics.

Class Attribute Details

.configuration ⇒ Object

Holds the configuration for easy access to settings

# File 'lib/metric.rb', line 9

def configuration
  @configuration
end

Class Method Details

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

Configures gem options

Parameters:

• (Block)

Yields:

• (configuration)

# File 'lib/metric.rb', line 14

def configure
  self.configuration ||= Metric::Configuration.new
  yield(configuration)
end

.receive(metric, range) ⇒ Hash

Fetches data from the API

Parameters:

• metric (String) —

  Metric identifier

• range (String) —

  Range identifier, either total, today, week or month

Returns:

• (Hash) —

  API Response

# File 'lib/metric.rb', line 33

def receive(metric, range)
  Metric::Receive.receive(metric, range)
end

.track(metric, options = {}) ⇒ Hash

Tracks metrics

Parameters:

• metric (String) —

  Metric identifier

• options (Hash) (defaults to: {}) —

  Options

Returns:

• (Hash) —

  API Response

# File 'lib/metric.rb', line 24

def track(metric, options = {})
  Metric::Track.track(metric, options)
end