Class: Johac::Client

Inherits:

Object

• Object
• Johac::Client

Includes:

Connection

Defined in:

lib/johac/client.rb

Overview

Base class for Johac API Client.

Extend this class and provide API specific calls

Instance Attribute Summary

• #config ⇒ Object readonly

  Returns the value of attribute config.

Instance Method Summary

• #env ⇒ String

  Reference to the current environment.

• #initialize(config = nil) ⇒ Client constructor

  A new instance of Client.

• #uri ⇒ String

  Reference to base_uri set on config in configure or in the constructor.

Constructor Details

#initialize(config = nil) ⇒ Client

Returns a new instance of Client.

Parameters:

• config (Johac::Config) (defaults to: nil)

# File 'lib/johac/client.rb', line 18

def initialize(config=nil)
  @config = Johac.merged_config(config)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.

# File 'lib/johac/client.rb', line 8

def config
  @config
end

Instance Method Details

#env ⇒ String

Reference to the current environment. Set explicitly in Johac.configure or via environment variables JOHAC_ENV or RAILS_ENV.

Returns:

• (String) —

  One of “testing”, “development”, or “production”

# File 'lib/johac/client.rb', line 33

def env
  config.env
end

#uri ⇒ String

Reference to base_uri set on Johac.config in Johac.configure or in the constructor.

Returns:

• (String)

# File 'lib/johac/client.rb', line 25

def uri
  config.base_uri
end