Class: Alpaca::News::Api::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/alpaca/news/api/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Configuration

Create new configuration

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :key_id (String) —

    Alpaca Key ID

  • :secret_key (String) —

    Alpaca Secret Key

  • :host (String) —

    Alpaca host

  • :stream (String) —

    Alpaca stream

  • :client_options (Hash) —

    Websocket client options



40
41
42
43
44
45
46
47
 
# File 'lib/alpaca/news/api/configuration.rb', line 40

def initialize(options = {})
  options = ActiveSupport::HashWithIndifferentAccess.new(options)
  self.key_id = options[:key_id]
  self.secret_key = options[:secret_key]
  self.host = options[:host]
  self.stream = options[:stream]
  self.client_options = options[:client_options]
end

Instance Attribute Details

#client_options ⇒ String

Alpaca News API client options

Returns:

  • (String) 


29
30
31
 
# File 'lib/alpaca/news/api/configuration.rb', line 29

def client_options
  @client_options
end

#host ⇒ String

Alpaca API host

Returns:

  • (String) 


21
22
23
 
# File 'lib/alpaca/news/api/configuration.rb', line 21

def host
  @host
end

#key_id ⇒ String

Alpaca API Key ID

Returns:

  • (String) 


11
12
13
 
# File 'lib/alpaca/news/api/configuration.rb', line 11

def key_id
  @key_id
end

#secret_key ⇒ String

Alpaca API Secret Key

Returns:

  • (String) 


17
18
19
 
# File 'lib/alpaca/news/api/configuration.rb', line 17

def secret_key
  @secret_key
end

#stream ⇒ String

Alpaca API stream host

Returns:

  • (String) 


25
26
27
 
# File 'lib/alpaca/news/api/configuration.rb', line 25

def stream
  @stream
end

Instance Method Details

#user_agent ⇒ String

User agent base on the alpaca-news-api version and ruby version

Returns:

  • (String) 


53
54
55
 
# File 'lib/alpaca/news/api/configuration.rb', line 53

def user_agent
  "alpaca-news-api-#{Alpaca::News::Api::VERSION}/ruby-#{RUBY_VERSION}"
end