Module: Untappd::Client::User

Included in:
Untappd::Client
Defined in:
lib/untappd-api/client/user.rb

Instance Method Summary collapse

Instance Method Details

#badges(options = {}) ⇒ Hashie::Mash

Returns the badge info for the requested user.

Examples:

Retrieve the badge info for the user with username “gambrinus”.

Untappd.badges(:user => "gambrinus')

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The username of the user you wish to request info for. Returns info for authenticated user if omitted.

Returns:

  • (Hashie::Mash) —

    The badge info for the requested user.



52
53
54
 
# File 'lib/untappd-api/client/user.rb', line 52

def badges(options={})
  get('/user_badge', options)
end

#distinct_beers(options = {}) ⇒ Hashie::Mash

Returns the distinct beers of the requested user.

Examples:

Retrieve the distinct beers of the user with username “gambrinus”.

Untappd.distinct_beers(:user => "gambrinus')

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The username of the user you wish to request info for. Returns info for authenticated user if omitted.

  • :offset (String, Integer) —

    The offset you would like the dataset to begin with.

Returns:

  • (Hashie::Mash) —

    The distinct beers of the requested user.



90
91
92
 
# File 'lib/untappd-api/client/user.rb', line 90

def distinct_beers(options={})
  get('/user_distinct', options)
end

#friend_feed(options = {}) ⇒ Hashie::Mash

Returns the friend feed for the authenticated user.

Examples:

Retrieve the friend feed for the authenticated user.

Untappd.friend_feed

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :since (String, Integer) —

    The ID of the last recent check-in.

  • :offset (String, Integer) —

    The offset you would like the dataset to begin with.

Returns:

  • (Hashie::Mash) —

    The requested friend feed of the authenticated user.



28
29
30
 
# File 'lib/untappd-api/client/user.rb', line 28

def friend_feed(options={})
  get('/feed', options)
end

#friends(options = {}) ⇒ Hashie::Mash

Returns the friends for the requested user.

Examples:

Retrieve the friends of the user with username “gambrinus”.

Untappd.friends(:user => "gambrinus')

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The username of the user you wish to request info for. Returns info for authenticated user if omitted.

Returns:

  • (Hashie::Mash) —

    The friends of the requested user.



64
65
66
 
# File 'lib/untappd-api/client/user.rb', line 64

def friends(options={})
  get('/friends', options)
end

#user(options = {}) ⇒ Hashie::Mash

Returns the info for the requested user.

Examples:

Retrieve the info for the user with username “gambrinus”.

Untappd.user(:user => "gambrinus')

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The username of the user you wish to request info for. Returns info for authenticated user if omitted.

Returns:

  • (Hashie::Mash) —

    The requested user info.



40
41
42
 
# File 'lib/untappd-api/client/user.rb', line 40

def user(options={})
  get('/user', options)
end

#user_feed(options = {}) ⇒ Hashie::Mash

Returns the feed for the specified user.

Examples:

Retrieve the feed for user with username “gambrinus”.

Untappd.user_feed(:user => "gambrinus")

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The user whose feed you wish to request. If not provided, the feed of the authenticated user will be returned.

  • :since (String, Integer) —

    The ID of the last recent check-in.

  • :offset (String, Integer) —

    The offset you would like the dataset to begin with.

Returns:

  • (Hashie::Mash) —

    The requested user feed.



15
16
17
 
# File 'lib/untappd-api/client/user.rb', line 15

def user_feed(options={})
  get('/user_feed', options)
end

#wish_list(options = {}) ⇒ Hashie::Mash

Returns the wish list of the requested user.

Examples:

Retrieve the wish list of the user with username “gambrinus”.

Untappd.wish_list(:user => "gambrinus')

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The username of the user you wish to request info for. Returns info for authenticated user if omitted.

  • :offset (String, Integer) —

    The offset you would like the dataset to begin with.

Returns:

  • (Hashie::Mash) —

    The wish list of the requested user.



77
78
79
 
# File 'lib/untappd-api/client/user.rb', line 77

def wish_list(options={})
  get('/wish_list', options)
end