class Teamsupport::Client
Attributes
Provide api_key
and api_secret
methods for accessing Client
API values
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.api_key teamsupport_client.api_secret
@return [String]
@api public
Provide api_key
and api_secret
methods for accessing Client
API values
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.api_key teamsupport_client.api_secret
@return [String]
@api public
Provide api_url
and user_agent
methods for overriding default Client
values
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.api_url = 'https://app.teamsupport.com' teamsupport_client.user_agent = 'MyTeamsupportClient/1.0.0'
@return [String]
@api public
Provide api_url
and user_agent
methods for overriding default Client
values
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.api_url = 'https://app.teamsupport.com' teamsupport_client.user_agent = 'MyTeamsupportClient/1.0.0'
@return [String]
@api public
Public Class Methods
Initializes a new Client
object
@param options [Hash]
@return [Teamsupport::Client]
@api private
# File lib/teamsupport/client.rb, line 38 def initialize(options = {}) options.each do |key, value| instance_variable_set("@#{key}", value) end yield(self) if block_given? end
Public Instance Methods
Returns authentication hash for the Client
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.auth
@return [Hash]
@api public
# File lib/teamsupport/client.rb, line 80 def auth { user: api_key, password: api_secret, } end
Checks for the existence of an authentication hash on the Client
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.auth?
@return [Boolean]
@api public
# File lib/teamsupport/client.rb, line 96 def auth? auth.values.all? end
Returns user agent string for the Client
@example
teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS') teamsupport_client.user_agent
@return [String]
@api public
# File lib/teamsupport/client.rb, line 67 def user_agent @user_agent ||= "TeamsupportRubyGem/#{Teamsupport::Version}" end