Module: Typeform::Configuration

Included in:

Typeform

Defined in:

lib/typeform/configuration.rb

Overview

Defines constants and methods related to configuration.

Constant Summary

OPTION_KEYS =

An array of valid keys in the options hash when configuring a Typeform::Client.

[:typeform_token, :timeout, :debug]

DEFAULT_USER_AGENT =

The user agent that will be sent to the API endpoint if none is set.

"Typeform Ruby Client Gem #{Typeform::VERSION}"

DEFAULT_API_BASE_URI =

Base URI for the Typeform API.

"https://api.typeform.com/"

Instance Method Summary

• #configure {|_self| ... } ⇒ Object

  Convenience method to allow configuration options to be set in a block.

• #options ⇒ Object

  Creates a hash of options and their values.

Instance Method Details

#configure {|_self| ... } ⇒ Object

Convenience method to allow configuration options to be set in a block.

Yields:

• (_self)

Yield Parameters:

• _self (Typeform::Configuration) —

  the object that the method was called on

# File 'lib/typeform/configuration.rb', line 18

def configure
  yield(self)
end

#options ⇒ Object

Creates a hash of options and their values.

# File 'lib/typeform/configuration.rb', line 23

def options
  options = {}
  OPTION_KEYS.each { |key| options[key] = send(key) }
  options
end