Module: Inforouter

Defined in:
lib/inforouter/user.rb,
lib/inforouter.rb,
lib/inforouter/rules.rb,
lib/inforouter/users.rb,
lib/inforouter/client.rb,
lib/inforouter/folder.rb,
lib/inforouter/record.rb,
lib/inforouter/rights.rb,
lib/inforouter/version.rb,
lib/inforouter/document.rb,
lib/inforouter/rule_item.rb,
lib/inforouter/access_list.rb,
lib/inforouter/property_row.rb,
lib/inforouter/property_set.rb,
lib/inforouter/configuration.rb,
lib/inforouter/responses/base.rb,
lib/inforouter/responses/users.rb,
lib/inforouter/errors/api_error.rb,
lib/inforouter/responses/folder.rb,
lib/inforouter/errors/soap_error.rb,
lib/inforouter/responses/folders.rb,
lib/inforouter/responses/generic.rb,
lib/inforouter/responses/document.rb,
lib/inforouter/responses/documents.rb,
lib/inforouter/access_list_user_item.rb,
lib/inforouter/responses/access_list.rb,
lib/inforouter/errors/inforouter_error.rb,
lib/inforouter/responses/create_folder.rb,
lib/inforouter/responses/delete_folder.rb,
lib/inforouter/responses/folder_exists.rb,
lib/inforouter/responses/document_exists.rb,
lib/inforouter/responses/set_access_list.rb,
lib/inforouter/responses/set_folder_rules.rb,
lib/inforouter/access_list_user_group_item.rb,
lib/inforouter/errors/missing_config_error.rb,
lib/inforouter/responses/add_property_set_row.rb,
lib/inforouter/access_list_domain_members_item.rb,
lib/inforouter/responses/update_property_set_row.rb,
lib/inforouter/errors/missing_config_option_error.rb,
lib/inforouter/responses/update_folder_properties.rb,
lib/inforouter/errors/unexpected_soap_response_error.rb,
lib/inforouter/responses/update_property_set_definition.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Errors, Responses Classes: AccessList, AccessListDomainMembersItem, AccessListUserGroupItem, AccessListUserItem, Client, Configuration, Document, Folder, PropertyRow, PropertySet, Record, Rights, RuleItem, Rules, User, Users, Version

Constant Summary collapse

API_VERSION =

infoRouter API version.

'8.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



30
31
32
 
# File 'lib/inforouter.rb', line 30

def configuration
  @configuration
end

Class Method Details

.client(options = {}) ⇒ Object 



51
52
53
54
 
# File 'lib/inforouter.rb', line 51

def client(options = {})
  check_configuration!
  @client ||= Inforouter::Client.new(options)
end

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

Configure the gem

Yields:



41
42
43
44
 
# File 'lib/inforouter.rb', line 41

def configure
  self.configuration ||= Configuration.new
  yield configuration
end

.configured? ⇒ Boolean

Returns true if the gem has been configured.

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/inforouter.rb', line 36

def configured?
  !configured.nil?
end

.reset! ⇒ Object 



46
47
48
49
 
# File 'lib/inforouter.rb', line 46

def reset!
  self.configuration = nil
  @client = nil
end