Module: Behance::Client::User

Included in:
Behance::Client
Defined in:
lib/behance/user.rb

Instance Method Summary collapse

Instance Method Details

#user(user) ⇒ Object

Public: Get basic information about a user.

user - can be an ID (Integer) or username (String).

Examples

@client.user(1)
@client.user("foo")

Returns a single user object.



45
46
47
 
# File 'lib/behance/user.rb', line 45

def user(user)
  request("users/#{user}")["user"]
end

#user_appreciations(user) ⇒ Object

Public: Get a list of user’s recently appreciated projects.

user - can be an ID (Integer) or username (String).

Examples

@client.user_appreciations(1)
@client.user_appreciations("foo")

Returns an array of user’s recently appreciated projects in JSON format.



106
107
108
 
# File 'lib/behance/user.rb', line 106

def user_appreciations(user)
  request("users/#{user}/appreciations")["appreciations"]
end

#user_collections(user) ⇒ Object

Public: Get a list of user’s public collections.

user - can be an ID (Integer) or username (String).

Examples

@client.user_collections(1)
@client.user_collections("foo")

Returns an array of user’s public collections in JSON format.



121
122
123
 
# File 'lib/behance/user.rb', line 121

def user_collections(user)
  request("users/#{user}/collections")["collections"]
end

#user_projects(user, options = {}) ⇒ Object

Public: Get the projects published by an user.

user - Can be an ID (Integer) or username (String) options - The Hash of options that the API would expect:

:sort - The order the results are returned in. 
        Possible values: featured_date (default), apprecia-
        tions, views, comments, published_date.
:time - Limits the search by time. 
        Possible values: all (default), today, week, month.
:page - The page number of the results, always starting 
        with 1.

Examples

@client.user_projects(1)
@client.user_projects("foo")
@client.user_projects("foo", page: 2, sort: "views")

Returns an array of projects published an user in JSON format.



68
69
70
 
# File 'lib/behance/user.rb', line 68

def user_projects(user, options={})
  request("users/#{user}/projects", options)["projects"]
end

#user_wips(user, options = {}) ⇒ Object

Public: Get the works-in-progress published by a user.

user - can be an ID (Integer) or username (String). options - The Hash of options that the API would expect:

:sort - The order the results are returned in.
        Possible values: featured_date (default), apprecia-
        tions, views, comments, published_date.
:time - Limits the search by time. Possible values: all 
        (default), today, week, month.
:page - The page number of the results, always starting 
        with 1.

Examples

@client.user_wips(1)
@client.user_wips(1, page: 2)
@client.user_wips("foo", sort: "comments", page: 3)

Returns an array of work-in-progress of an user in JSON format.



91
92
93
 
# File 'lib/behance/user.rb', line 91

def user_wips(user, options={})
  request("users/#{user}/wips", options)["wips"]
end

#users(options = {}) ⇒ Object

Public: Search for users.

options - The Hash of options that the API would expect:

:q       - Free text query string.
:field   - Limits the search by creative field. 
           Accepts a URL-encoded field name from the list of 
           defined creative fields.
:country - Limits the search by a 2-letter FIPS country code.
:state   - Limits the search by state or province name.
:city    - Limits the search by city name.
:page    - The page number of the results, always starting 
           with 1.
:sort    - The order the results are returned in. 
           Possible values: featured_date (default), apprecia-
           tions, views, comments, 
           published_date, followed.
:tags    - Limits the search by tags. 
           Accepts one tag name or a pipe-separated list of 
           tag names.

Examples

@client.users
@client.users(q: "Juan", state: "California", :tags "freelance")

Returns an array of users in JSON format.



31
32
33
 
# File 'lib/behance/user.rb', line 31

def users(options={})
  request("users", options)["users"]
end