Module: Bearcat::Client::Users

Extended by:
ClientModule
Defined in:
lib/bearcat/client/users.rb

Constant Summary

Constants included from ClientModule

ClientModule::ARG_REGEX

Instance Attribute Summary

Attributes included from ClientModule

#_registered_endpoints

Instance Method Summary collapse

Methods included from ClientModule

context_types, endpoint, prefix

Instance Method Details

#delete_custom_data(user, params, scope = '') ⇒ Object

scope: food params: ‘com.account-domain.canvas-app’ deletes all custom user data for the food scope. If no scope deletes all custom user data



44
45
46
 
# File 'lib/bearcat/client/users.rb', line 44

def delete_custom_data(user, params, scope = '')
  delete("/api/v1/users/#{user}/custom_data/#{scope}", params)
end

#favorite_courses(user, params = {}) ⇒ Object 



48
49
50
51
 
# File 'lib/bearcat/client/users.rb', line 48

def favorite_courses(user, params = {})
  params.merge!({as_user_id: user})
  get("/api/v1/users/self/favorites/courses", params)
end

#load_custom_data(user, params, scope = '') ⇒ Object

scope: food params: ‘com.account-domain.canvas-app’ returns all custom user food scope data. If no scope returns all custom user data



29
30
31
 
# File 'lib/bearcat/client/users.rb', line 29

def load_custom_data(user, params, scope = '')
  get("/api/v1/users/#{user}/custom_data/#{scope}", params)
end

#store_custom_data(user, params, scope = '') ⇒ Object

scope: food params: ‘com.account-domain.canvas-app’,

data: {'favorite' => 'steak', 'least favorite' => 'water mellon'}

stores custom data in the food scope



37
38
39
 
# File 'lib/bearcat/client/users.rb', line 37

def store_custom_data(user, params, scope = '')
  put("/api/v1/users/#{user}/custom_data/#{scope}", params)
end

#unfavorite_course(user, course, params = {}) ⇒ Object 



53
54
55
56
 
# File 'lib/bearcat/client/users.rb', line 53

def unfavorite_course(user, course, params = {})
  params.merge!({as_user_id: user})
  delete("/api/v1/users/self/favorites/courses/#{course}", params)
end