Class: Jammed::Following

Inherits:
API
  • Object
show all
Defined in:
lib/jammed/following.rb

Overview

Provides methods for calling API endpoint /following.json?

Class Method Summary collapse

Methods inherited from API

request

Class Method Details

.following(username, api_key, opts = {}) ⇒ Object

Calls API for user specific data concerning who the user is following

Attributes

  • username - The username of the user whose followings you want to retrieve

  • api_key - The key to use with the API call

  • opts - Options for ordering the data

Options

  • :order - A symbol determining how the data is orderd like :date, :affinity, or :alpha

Examples

Jammed::Following.following('IFTFOM', '08972935872035') #returns followings unorderd
Jammed::Following.following('IFTFOM', '08972935872035', :order => :date) # returns followings ordered by date


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/jammed/following.rb', line 22

def self.following(username, api_key, opts={})
  case(opts[:order])
  when nil
    response = request(:get, "/#{username}/following.json", {:https => opts[:https],
      :query => {:key => api_key}})
  when :date
    response = request(:get, "/#{username}/following.json", {:https => opts[:https],
      :query => {:order => 'followedDate', :key => api_key}})
  when :affinity
    response = request(:get, "/#{username}/following.json", {:https => opts[:https],
      :query => {:order => 'affinity', :key => api_key}})
  when :alpha
    response = request(:get, "/#{username}/following.json", {:https => opts[:https],
      :query => {:order => 'name', :key => api_key}})
  else
    return "Cannot order Followings by #{opts[:order]}"
  end
  JSON.parse(response.body)['people']
end