Module: BridgeAPI

Defined in:
lib/bridge_api.rb,
lib/bridge_api/client.rb,
lib/bridge_api/version.rb,
lib/bridge_api/api_array.rb,
lib/bridge_api/client/role.rb,
lib/bridge_api/client/user.rb,
lib/bridge_api/client/group.rb,
lib/bridge_api/client/account.rb,
lib/bridge_api/client/manager.rb,
lib/bridge_api/client/program.rb,
lib/bridge_api/client/data_dump.rb,
lib/bridge_api/client/enrollment.rb,
lib/bridge_api/client/affiliation.rb,
lib/bridge_api/client/live_course.rb,
lib/bridge_api/client/sub_account.rb,
lib/bridge_api/client/clone_object.rb,
lib/bridge_api/client/custom_field.rb,
lib/bridge_api/client/learner_item.rb,
lib/bridge_api/client/course_template.rb,
lib/bridge_api/client/program_enrollment.rb,
lib/bridge_api/client/live_course_session.rb,
lib/bridge_api/client/live_course_enrollment.rb

Defined Under Namespace

Classes: ApiArray, Client

Constant Summary collapse

VERSION = 
'0.3.4'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.beginning_rate_limit ⇒ Object 



20
21
22
 
# File 'lib/bridge_api.rb', line 20

def beginning_rate_limit
  @beginning_rate_limit ||= 30
end

.enforce_rate_limits ⇒ Object 



16
17
18
 
# File 'lib/bridge_api.rb', line 16

def enforce_rate_limits
  @enforce_rate_limits ||= false
end

.logger ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/bridge_api.rb', line 44

def logger
  return @logger if defined? @logger
  @logger = Logger.new(STDOUT)
  @logger.level = :debug
  @logger
end

.master_mutex ⇒ Object 



36
37
38
 
# File 'lib/bridge_api.rb', line 36

def master_mutex
  @master_mutex ||= Mutex.new
end

.master_rate_limit ⇒ Object 



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

def master_rate_limit
  @master_rate_limit ||= false
end

.max_sleep_seconds ⇒ Object 



28
29
30
 
# File 'lib/bridge_api.rb', line 28

def max_sleep_seconds
  @max_sleep_seconds ||= 30
end

.min_sleep_seconds ⇒ Object 



51
52
53
 
# File 'lib/bridge_api.rb', line 51

def min_sleep_seconds
  @min_sleep_seconds ||= 5
end

.rate_limit_threshold ⇒ Object 



40
41
42
 
# File 'lib/bridge_api.rb', line 40

def rate_limit_threshold
  @rate_limit_threshold ||= 10
end

.rate_limits ⇒ Object 



24
25
26
 
# File 'lib/bridge_api.rb', line 24

def rate_limits
  @rate_limits ||= {}
end

Class Method Details

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (BridgeAPI) —

    the object that the method was called on



12
13
14
 
# File 'lib/bridge_api.rb', line 12

def configure
  yield self if block_given?
end