Module: StrixRuby

Defined in:
lib/strix_ruby.rb,
lib/strix_ruby/client.rb,
lib/strix_ruby/errors.rb,
lib/strix_ruby/version.rb,
lib/strix_ruby/connection.rb,
lib/strix_ruby/configuration.rb,
lib/strix_ruby/token_manager.rb

Overview

StrixRuby is a Ruby client for the Strix Integration API

Examples:

Global configuration

StrixRuby.configure do |config|
  config.base_url = "https://api.example.com"
  config.username = "your_username"
  config.password = "your_password"
end

client = StrixRuby::Client.new
things = client.list_things(account_id: 123)

Instance configuration

client = StrixRuby::Client.new(
  base_url: "https://api.example.com",
  username: "your_username",
  password: "your_password"
)
things = client.list_things(account_id: 123)

Defined Under Namespace

Classes: APIError, AuthenticationError, Client, Configuration, ConfigurationError, Connection, Error, TokenExpiredError, TokenManager

Constant Summary collapse

VERSION = 
"0.1.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



32
33
34
 
# File 'lib/strix_ruby.rb', line 32

def configuration
  @configuration
end

Class Method Details

.configure {|Configuration| ... } ⇒ Object

Configure StrixRuby globally

Examples:

StrixRuby.configure do |config|
  config.base_url = "https://api.example.com"
  config.username = "your_username"
  config.password = "your_password"
end

Yields:



42
43
44
45
 
# File 'lib/strix_ruby.rb', line 42

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

.reset_configuration! ⇒ Object

Reset the configuration to defaults



48
49
50
 
# File 'lib/strix_ruby.rb', line 48

def reset_configuration!
  self.configuration = Configuration.new
end