Module: Trubl::API::Users

Included in:
Client
Defined in:
lib/trubl/api/users.rb

Instance Method Summary collapse

Instance Method Details

#follow_user(uid) ⇒ Object

implements http://developer.tout.com/api/users-api/apimethod/follow-user returns response object



67
68
69
 
# File 'lib/trubl/api/users.rb', line 67

def follow_user(uid)
  post("/api/v1/users/#{uid}/follows")
end

#retrieve_user(uid = nil) ⇒ Trubl::User

implements http://developer.tout.com/api/users-api/apimethod/retrieve-user

Parameters:

  • uid (String) (defaults to: nil) —

    a user uid

Returns:



14
15
16
17
18
19
 
# File 'lib/trubl/api/users.rb', line 14

def retrieve_user(uid=nil)
  return nil if uid.blank?

  response = get("/api/v1/users/#{uid}")
  Trubl::User.new.from_response(response)
end

#retrieve_user_followers(uid, order = nil, per_page = nil, page = nil) ⇒ Object

implements http://developer.tout.com/api/users-api/apimethod/retrieve-list-users-follow-user returns Array of Trubl::User instances or nil



54
55
56
57
 
# File 'lib/trubl/api/users.rb', line 54

def retrieve_user_followers(uid, order=nil, per_page=nil, page=nil)
  response = get("/api/v1/users/#{uid}/followers", query: {order: order, per_page: per_page, page: page})
  Trubl::Users.new.from_response(response)
end

#retrieve_user_likes(uid, order = nil, per_page = nil, page = nil) ⇒ Object

implements http://developer.tout.com/api/users-api/apimethod/retrieve-list-touts-liked-user returns Array of Trubl::Tout instances or nil



40
41
42
43
 
# File 'lib/trubl/api/users.rb', line 40

def retrieve_user_likes(uid, order=nil, per_page=nil, page=nil)
  response = get("/api/v1/users/#{uid}/likes", query: {order: order, per_page: per_page, page: page})
  Trubl::Touts.new.from_response(response)
end

#retrieve_user_touts(uid, order = nil, per_page = nil, page = nil) ⇒ Object

implements http://developer.tout.com/api/users-api/apimethod/retrieve-users-touts return Array of Trubl::Tout instances or nil



47
48
49
50
 
# File 'lib/trubl/api/users.rb', line 47

def retrieve_user_touts(uid, order=nil, per_page=nil, page=nil)
  response = get("/api/v1/users/#{uid}/touts", query: {order: order, per_page: per_page, page: page})
  Trubl::Touts.new.from_response(response)
end

#retrieve_user_widgets(uid, order = nil, per_page = nil, page = nil) ⇒ Object

order, per_page, page arent supported at the moment



60
61
62
63
 
# File 'lib/trubl/api/users.rb', line 60

def retrieve_user_widgets(uid, order=nil, per_page=nil, page=nil)
  response = get("/api/v1/users/#{uid}/widgets")
  Trubl::Widgets.new.from_response(response)
end

#retrieve_users(uids = []) ⇒ Array<Trubl::User>

implements http://developer.tout.com/api/users-api/apimethod/retrieve-users

Parameters:

  • uids (Array<String>) (defaults to: []) —

    of user uids

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/trubl/api/users.rb', line 24

def retrieve_users(uids=[])
  uids = (uids.is_a?(Array) ? uids : [uids]).compact.uniq.sort
  return [] if uids.blank?

  requests = uids.in_groups_of(100, false).collect do |uid_group|
    {path: "users", query: {uids: uid_group.join(',')} }
  end

  multi_request(:get, requests).
    collect { |response| Trubl::Users.new.from_response(response) }.
    flatten.
    compact
end

#unfollow_user(uid) ⇒ Object

implements http://developer.tout.com/api/users-api/apimethod/unfollow-user returns response object



73
74
75
 
# File 'lib/trubl/api/users.rb', line 73

def unfollow_user(uid)
  delete("/api/v1/users/#{uid}/follows")
end