Class: Readiness::Zendesk::Configuration

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

Overview

Defines the class Configuration within the module Readiness::Zendesk.

Author:

  • Jason Colyer

Since:

  • 1.0.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Creates a new Readiness::Zendesk::Configuration instance

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
pp config
# => #<Readiness::Zendesk::Configuration:0x00007f352fdd1420
       @retry_backoff=2,
       @retry_exceptions=
        [Errno::ETIMEDOUT, "Timeout::Error", Faraday::TimeoutError, Faraday::RetriableResponse, Faraday::ConnectionFailed],
       @retry_interval=1,
       @retry_max=5,
       @retry_randomness=0.5,
       @token="test123abc",
       @url="https://example.zendesk.com/api/v2",
       @username="alice@example.com">

Author:

  • Jason Colyer

Since:

  • 1.0.0



37
38
39
40
41
42
43
44
45
46
# File 'lib/support_readiness/zendesk/configuration.rb', line 37

def initialize
  @url = ''
  @username = ''
  @token = ''
  @retry_max = 5
  @retry_interval = 1
  @retry_randomness = 0.5
  @retry_backoff  = 2
  @retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
end

Instance Attribute Details

#retry_backoffObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_backoff
  @retry_backoff
end

#retry_exceptionsObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_exceptions
  @retry_exceptions
end

#retry_intervalObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_interval
  @retry_interval
end

#retry_maxObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_max
  @retry_max
end

#retry_optionsObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_options
  @retry_options
end

#retry_randomnessObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def retry_randomness
  @retry_randomness
end

#tokenObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def token
  @token
end

#urlObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def url
  @url
end

#usernameObject

Since:

  • 1.0.0



13
14
15
# File 'lib/support_readiness/zendesk/configuration.rb', line 13

def username
  @username
end