Module: Renshuu

Defined in:

lib/renshuu.rb,
lib/renshuu/client.rb,
lib/renshuu/models.rb,
lib/renshuu/version.rb,
lib/renshuu/models/kanji.rb,
lib/renshuu/models/model.rb,
lib/renshuu/configuration.rb,
lib/renshuu/models/profile.rb

Overview

rubocop:disable Style/Documentation

Defined Under Namespace

Classes: Client, Configuration, Kanji, Model, Profile

Constant Summary

VERSION =

Semantic version number of the library.

'0.1.0'

Class Method Summary

• .client ⇒ Client
• .configuration ⇒ Configuration
• .configure {|configuration| ... } ⇒ Object
• .configure_from_env ⇒ Void

  Updates the configuration according to environment variables.

Class Method Details

.client ⇒ Client

Returns:

• (Client)

# File 'lib/renshuu.rb', line 30

def client
  @client ||= Client.new
end

.configuration ⇒ Configuration

Returns:

• (Configuration)

# File 'lib/renshuu.rb', line 18

def configuration
  @configuration ||= Configuration.new
end

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

Yield Parameters:

• configuration (Configuration)

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

def configure
  yield configuration
end

.configure_from_env ⇒ Void

Updates the configuration according to environment variables.

• RENSHUU_API_URL;

• RENSHUU_API_KEY.

Returns:

• (Void)

# File 'lib/renshuu.rb', line 41

def configure_from_env
  configuration.api_url = ENV.fetch('RENSHUU_API_URL', nil)
  configuration.api_key = ENV.fetch('RENSHUU_API_KEY', nil)
end