Module: Bearcat::Client::Users

Defined in:
lib/bearcat/client/users.rb

Instance Method Summary collapse

Instance Method Details

#add_user(account, params = {}) ⇒ Object 



13
14
15
 
# File 'lib/bearcat/client/users.rb', line 13

def add_user(, params={})
  post("/api/v1/accounts/#{.to_s}/users", params)
end

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



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

def communication_channels(user, params={})
  get("/api/v1/users/#{user.to_s}/communication_channels", params)
end

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



67
68
69
 
# File 'lib/bearcat/client/users.rb', line 67

def dashboard_positions(user, params = {})
  get("/api/v1/users/#{user}/dashboard_positions", params)
end

#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



51
52
53
 
# File 'lib/bearcat/client/users.rb', line 51

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

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



75
76
77
78
 
# File 'lib/bearcat/client/users.rb', line 75

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

#list_users(account, params = {}) ⇒ Object 



5
6
7
 
# File 'lib/bearcat/client/users.rb', line 5

def list_users(, params={})
  get("/api/v1/accounts/#{.to_s}/users", 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



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

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

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



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

def page_views(user, params = {})
  get("/api/v1/users/#{user}/page_views", 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



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

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

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



80
81
82
83
 
# File 'lib/bearcat/client/users.rb', line 80

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

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



71
72
73
 
# File 'lib/bearcat/client/users.rb', line 71

def update_dashboard_positions(user, params = {})
  put("/api/v1/users/#{user}/dashboard_positions", params)
end

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



63
64
65
 
# File 'lib/bearcat/client/users.rb', line 63

def user_assignments(user, course, params = {})
  get("/api/v1/users/#{user}/courses/#{course}/assignments", params)
end

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



9
10
11
 
# File 'lib/bearcat/client/users.rb', line 9

def user_avatars(user, params={})
  get("/api/v1/users/#{user.to_s}/avatars", params)
end

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



17
18
19
 
# File 'lib/bearcat/client/users.rb', line 17

def user_detail(user, params={})
  get("/api/v1/users/#{user.to_s}", params)
end

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



25
26
27
 
# File 'lib/bearcat/client/users.rb', line 25

def user_logins(user, params={})
  get("/api/v1/users/#{user.to_s}/logins", params)
end

#user_merge(user, merge_into_user) ⇒ Object 



59
60
61
 
# File 'lib/bearcat/client/users.rb', line 59

def user_merge(user, merge_into_user)
  put("/api/v1/users/#{user}/merge_into/#{merge_into_user}")
end

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



21
22
23
 
# File 'lib/bearcat/client/users.rb', line 21

def (user, params={})
  get("/api/v1/users/#{user.to_s}/profile", params)
end