Module: Desk

Extended by:

Configuration

Defined in:

lib/desk.rb,
lib/desk/api.rb,
lib/desk/error.rb,
lib/desk/client.rb,
lib/desk/request.rb,
lib/desk/version.rb,
lib/desk/client/job.rb,
lib/desk/connection.rb,
lib/desk/client/case.rb,
lib/desk/client/rule.rb,
lib/desk/client/user.rb,
lib/desk/client/brand.rb,
lib/desk/client/group.rb,
lib/desk/client/label.rb,
lib/desk/client/macro.rb,
lib/desk/client/topic.rb,
lib/desk/client/filter.rb,
lib/desk/configuration.rb,
lib/desk/authentication.rb,
lib/desk/client/article.rb,
lib/desk/client/company.rb,
lib/desk/client/insight.rb,
lib/desk/client/mailbox.rb,
lib/desk/client/customer.rb,
lib/desk/client/custom_field.rb,
lib/desk/client/site_setting.rb,
lib/desk/client/twitter_user.rb,
lib/desk/client/facebook_user.rb,
lib/desk/client/system_message.rb,
lib/desk/client/integration_url.rb,
lib/desk/client/twitter_account.rb

Defined Under Namespace

Modules: Configuration, Request Classes: BadGateway, BadRequest, Client, Conflict, DeskError, EnhanceYourCalm, Error, Forbidden, InternalServerError, NotAcceptable, NotFound, NotImplemented, ServiceUnavailable, SupportEmailNotSet, TooManyRequests, Unauthorized, Unprocessable

Constant Summary

VERSION =

The version of the gem

'1.2.0'.freeze

Constants included from Configuration

Configuration::DEFAULT_ADAPTER, Configuration::DEFAULT_AUTH_METHOD, Configuration::DEFAULT_BASIC_AUTH_PASSWORD, Configuration::DEFAULT_BASIC_AUTH_USERNAME, Configuration::DEFAULT_CONSUMER_KEY, Configuration::DEFAULT_CONSUMER_SECRET, Configuration::DEFAULT_DOMAIN, Configuration::DEFAULT_FORMAT, Configuration::DEFAULT_LOGGER, Configuration::DEFAULT_MAX_REQUESTS, Configuration::DEFAULT_OAUTH_TOKEN, Configuration::DEFAULT_OAUTH_TOKEN_SECRET, Configuration::DEFAULT_PROXY, Configuration::DEFAULT_SUBDOMAIN, Configuration::DEFAULT_SUPPORT_EMAIL, Configuration::DEFAULT_TIMEOUT, Configuration::DEFAULT_USER_AGENT, Configuration::DEFAULT_USE_MAX_REQUESTS, Configuration::DEFAULT_VERSION, Configuration::VALID_FORMATS, Configuration::VALID_OPTIONS_KEYS

Class Attribute Summary

• .counter ⇒ Object

  Returns the value of attribute counter.

• .minute ⇒ Object

  Returns the value of attribute minute.

Attributes included from Configuration

#DEFAULT_ADAPTER

Class Method Summary

• .client(options = {}) ⇒ Desk::Client

  Alias for Desk::Client.new.

• .method_missing(method, *args, &block) ⇒ Object

  Delegate to Desk::Client.

• .respond_to?(method, include_private = false) ⇒ Boolean

Methods included from Configuration

adapter, adapter=, auth_method, auth_method=, configure, consumer_key, consumer_key=, consumer_secret, consumer_secret=, domain, domain=, extended, format, format=, logger, logger=, max_requests, max_requests=, oauth_token, oauth_token=, oauth_token_secret, oauth_token_secret=, options, proxy, proxy=, reset, subdomain, subdomain=, support_email, support_email=, timeout, timeout=, use_max_requests, use_max_requests=, user_agent, user_agent=, version, version=

Class Attribute Details

.counter ⇒ Object

Returns the value of attribute counter.

# File 'lib/desk.rb', line 13

def counter
  @counter
end

.minute ⇒ Object

Returns the value of attribute minute.

# File 'lib/desk.rb', line 13

def minute
  @minute
end

Class Method Details

.client(options = {}) ⇒ Desk::Client

Alias for Desk::Client.new

Returns:

• (Desk::Client)

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

def client(options={})
  Desk::Client.new(options)
end

.method_missing(method, *args, &block) ⇒ Object

Delegate to Desk::Client

# File 'lib/desk.rb', line 23

def method_missing(method, *args, &block)
  return super unless client.respond_to?(method)
  client.send(method, *args, &block)
end

.respond_to?(method, include_private = false) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/desk.rb', line 28

def respond_to?(method, include_private=false)
  client.respond_to?(method, include_private) || super
end