Module: Datarank::Client::Topics

Included in:

Datarank::Client

Defined in:

lib/datarank/topics.rb

Overview

Module containing methods for interacting with topics

Instance Method Summary

• #all_topics(options = {}) ⇒ Object

  Return all topics.

• #find_topic(slug, options = {}) ⇒ Object

  Return single topic by slug.

Instance Method Details

#all_topics(options = {}) ⇒ Object

Return all topics

Parameters:

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

  a customizable set of options

Options Hash (options):

• :limit (1..1000) —

  The number of items to return.

# File 'lib/datarank/topics.rb', line 10

def all_topics options={}
  get '/topics', options
end

#find_topic(slug, options = {}) ⇒ Object

Return single topic by slug

Parameters:

• slug (String) —

  A topic’s unique identifier slug

# File 'lib/datarank/topics.rb', line 17

def find_topic(slug, options={})
  get "/topics/#{slug}", options
end