Class: Hsquare::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/hsquare/configuration.rb

Overview

Public: Configuration object for Hsquare.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#http_proxyObject

Public: HTTP proxy URI.



5
6
7
# File 'lib/hsquare/configuration.rb', line 5

def http_proxy
  @http_proxy
end

Instance Method Details

#admin_key=(admin_key) ⇒ Object

Public: Sets admin key for default application.

admin_key - Admin key to set.

Returns newly set admin key.



12
13
14
# File 'lib/hsquare/configuration.rb', line 12

def admin_key=(admin_key)
  default_application.admin_key = admin_key
end

#application(label = nil) {|new_application| ... } ⇒ Object

Public: Adds a new application.

Returns nothing.

Yields:

  • (new_application)


48
49
50
51
52
53
54
55
# File 'lib/hsquare/configuration.rb', line 48

def application(label = nil, &block)
  new_application = Hsquare::Application.new(label: label)

  @default_application ||= new_application
  applications.push(new_application) unless applications.include?(new_application)

  yield new_application
end

#applicationsObject

Public: Retrieves list of registered applications.

Returns Array of registered applications.



41
42
43
# File 'lib/hsquare/configuration.rb', line 41

def applications
  @applications ||= [default_application]
end

#base_uri=(base_uri) ⇒ Object

Public: Sets API base URI for default application.

base_uri - Base URI to set.

Returns newly set base URI.



21
22
23
# File 'lib/hsquare/configuration.rb', line 21

def base_uri=(base_uri)
  default_application.base_uri = base_uri
end

#default_applicationObject

Public: Retrieves default application.

Returns Hsquare::Application object for default application.



28
29
30
31
32
33
34
35
36
# File 'lib/hsquare/configuration.rb', line 28

def default_application
  if @default_application
    @default_application
  elsif @applications && !@applications.empty?
    @default_application ||= @applications.first
  else
    @default_application ||= Hsquare::Application.new
  end
end