Module: RubyPtv

Defined in:
lib/ruby_ptv.rb,
lib/ruby_ptv/client.rb,
lib/ruby_ptv/request.rb,
lib/ruby_ptv/version.rb,
lib/ruby_ptv/client/runs.rb,
lib/ruby_ptv/client/stops.rb,
lib/ruby_ptv/client/routes.rb,
lib/ruby_ptv/client/search.rb,
lib/ruby_ptv/client/patterns.rb,
lib/ruby_ptv/client/departures.rb,
lib/ruby_ptv/client/directions.rb,
lib/ruby_ptv/client/disruptions.rb,
lib/ruby_ptv/client/route_types.rb

Defined Under Namespace

Modules: Departures, Directions, Disruptions, Patterns, Request, RouteTypes, Routes, Runs, Search, Stops Classes: Client

Constant Summary collapse

VERSION = 
"0.1.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.options ⇒ Object

Returns the value of attribute options.



6
7
8
 
# File 'lib/ruby_ptv.rb', line 6

def options
  @options
end

Class Method Details

.configuration ⇒ Object

Returns global configuration hash



26
27
28
 
# File 'lib/ruby_ptv.rb', line 26

def self.configuration
  options
end

.configure(params = {}) ⇒ Object

Define global configuration, if desired

Required params:

options[:dev_id]     - PTV developer ID
options[:secret_key] - PTV developer key

Raises:

  • (ArgumentError) 


16
17
18
19
20
21
22
 
# File 'lib/ruby_ptv.rb', line 16

def self.configure(params = {})
  raise(ArgumentError, "Options hash required.") unless params.is_a?(Hash)

  options[:dev_id]     = params[:dev_id]
  options[:secret_key] = params[:secret_key]
  options
end

.reset_configuration ⇒ Object

Resets the global configuration



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

def self.reset_configuration
  self.options = {}
end