Class: Rocksky::Resources::Feed

Inherits:
Base
  • Object
show all
Defined in:
lib/rocksky/resources/feed.rb

Overview

‘app.rocksky.feed.*` endpoints.

Instance Attribute Summary

Attributes inherited from Base

#http

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Rocksky::Resources::Base

Instance Method Details

#get_album_recommendations(did:, limit: nil) ⇒ Object

Album recommendations for an actor.



46
47
48
 
# File 'lib/rocksky/resources/feed.rb', line 46

def get_album_recommendations(did:, limit: nil)
  query("app.rocksky.feed.getAlbumRecommendations", did: did, limit: limit)
end

#get_artist_recommendations(did:, limit: nil) ⇒ Object

Artist recommendations for an actor.



41
42
43
 
# File 'lib/rocksky/resources/feed.rb', line 41

def get_artist_recommendations(did:, limit: nil)
  query("app.rocksky.feed.getArtistRecommendations", did: did, limit: limit)
end

#get_feed(feed:, limit: nil, cursor: nil) ⇒ Object

Fetch feed contents.



26
27
28
 
# File 'lib/rocksky/resources/feed.rb', line 26

def get_feed(feed:, limit: nil, cursor: nil)
  query("app.rocksky.feed.getFeed", feed: feed, limit: limit, cursor: cursor)
end

#get_feed_generator(feed:) ⇒ Object

Fetch a feed generator by URI.



21
22
23
 
# File 'lib/rocksky/resources/feed.rb', line 21

def get_feed_generator(feed:)
  query("app.rocksky.feed.getFeedGenerator", feed: feed)
end

#get_feed_generators(size: nil) ⇒ Object

List feed generators.



16
17
18
 
# File 'lib/rocksky/resources/feed.rb', line 16

def get_feed_generators(size: nil)
  query("app.rocksky.feed.getFeedGenerators", size: size)
end

#get_recommendations(did:, limit: nil) ⇒ Object

Track recommendations for an actor.



36
37
38
 
# File 'lib/rocksky/resources/feed.rb', line 36

def get_recommendations(did:, limit: nil)
  query("app.rocksky.feed.getRecommendations", did: did, limit: limit)
end

#get_stories(size: nil) ⇒ Object

Stories (recent highlights).



31
32
33
 
# File 'lib/rocksky/resources/feed.rb', line 31

def get_stories(size: nil)
  query("app.rocksky.feed.getStories", size: size)
end

#search(q = nil, query: nil) ⇒ Object

Free-text search across the catalogue. ‘q` accepts a positional or `query:` keyword; both map to the lexicon’s ‘query` parameter.

Raises:

  • (ArgumentError) 


8
9
10
11
12
13
 
# File 'lib/rocksky/resources/feed.rb', line 8

def search(q = nil, query: nil)
  term = q || query
  raise ArgumentError, "search needs a query string" if term.nil? || term.empty?

  @http.query("app.rocksky.feed.search", query: term)
end