Module: Github::ClassMethods

Included in:

Github, API

Defined in:

lib/github_api.rb

Instance Method Summary

• #configuration ⇒ Configuration (also: #config)

  The client configuration.

• #configure {|configuration| ... } ⇒ nil

  Configure options.

• #require_all(prefix, *libs) ⇒ self

  Requires internal libraries.

Instance Method Details

#configuration ⇒ Configuration Also known as: config

The client configuration

Returns:

• (Configuration)

# File 'lib/github_api.rb', line 87

def configuration
  @configuration ||= Configuration.new
end

#configure {|configuration| ... } ⇒ nil

Configure options

Examples:

Github.configure do |c|
  c.some_option = true
end

Yields:

• the configuration block

Yield Parameters:

• configuration (Github::Configuration) —

  the configuration instance

Returns:

• (nil)

# File 'lib/github_api.rb', line 106

def configure
  yield configuration
end

#require_all(prefix, *libs) ⇒ self

Requires internal libraries

Parameters:

• prefix (String) —

  the relative path prefix

• libs (Array[String]) —

  the array of libraries to require

Returns:

• (self)

# File 'lib/github_api.rb', line 76

def require_all(prefix, *libs)
  libs.each do |lib|
    require "#{File.join(prefix, lib)}"
  end
end