Module: Totter::Client::Activities

Included in:
Totter::Client
Defined in:
lib/totter/client/activities.rb

Overview

Client methods for working with activities in the application.

Constant Summary collapse

DEFAULT_ACTIVITY_OPTIONS =

Default query parameters for retrieving activities

{
  :limit => 1000,
  :offset => 0
}

Instance Method Summary collapse

Instance Method Details

#activities(user_id, options = DEFAULT_ACTIVITY_OPTIONS) ⇒ Hashie::Mash

Returns a user’s activities

Examples:

Totter.activity(1)

Parameters:

  • user_id (Numeric) —

    The user’s id

  • options (Hash) (defaults to: DEFAULT_ACTIVITY_OPTIONS) —

    Parameters for returning selected activities

Returns:

  • (Hashie::Mash) 


18
19
20
 
# File 'lib/totter/client/activities.rb', line 18

def activities(user_id, options = DEFAULT_ACTIVITY_OPTIONS)
  get("users/#{user_id}/activities?limit=#{options[:limit]}&offset=#{options[:offset]}").body
end

#friends_activities(options = DEFAULT_ACTIVITY_OPTIONS) ⇒ Hashie::Mash

Returns activities performed by a user’s friends

Examples:

Totter.activity(1)

Parameters:

  • user_id (Numeric) —

    The user’s id

  • options (Hash) (defaults to: DEFAULT_ACTIVITY_OPTIONS) —

    Parameters for returning selected activities

Returns:

  • (Hashie::Mash) 


40
41
42
 
# File 'lib/totter/client/activities.rb', line 40

def friends_activities(options = DEFAULT_ACTIVITY_OPTIONS)
  get("me/activities/friends?limit=#{options[:limit]}&offset=#{options[:offset]}").body
end

#my_activities(options = DEFAULT_ACTIVITY_OPTIONS) ⇒ Hashie::Mash

Returns activities performed on a given user

Examples:

Totter.activity(1)

Parameters:

  • user_id (Numeric) —

    The user’s id

  • options (Hash) (defaults to: DEFAULT_ACTIVITY_OPTIONS) —

    Parameters for returning selected activities

Returns:

  • (Hashie::Mash) 


29
30
31
 
# File 'lib/totter/client/activities.rb', line 29

def my_activities(options = DEFAULT_ACTIVITY_OPTIONS)
  get("me/activities?limit=#{options[:limit]}&offset=#{options[:offset]}").body
end