Module: Voog::API::Comments

Included in:

Client

Defined in:

lib/voog_api/api/comments.rb

Overview

Voog article Comments API methods.

See Also:

• http://www.voog.com/developers/api/resources/comments

Instance Method Summary

• #comment(article_id, id, params = {}) ⇒ Object

  Get a single comment for article.

• #comments(article_id, params = {}) ⇒ Object

  List article comments.

• #create_comment(article_id, data) ⇒ Object

  Create a comment.

• #delete_comment(article_id, id) ⇒ Object

  Delete an article comment.

• #delete_spam_comments(article_id) ⇒ Object

  Delete all spam comment for article.

• #toggle_spam_comment(article_id, id) ⇒ Object

  Toggle comment spam flag.

Instance Method Details

#comment(article_id, id, params = {}) ⇒ Object

Get a single comment for article

See Also:

• http://www.voog.com/developers/api/resources/comments#get_comment

# File 'lib/voog_api/api/comments.rb', line 19

def comment(article_id, id, params = {})
  get "articles/#{article_id}/comments/#{id}", {query: params}
end

#comments(article_id, params = {}) ⇒ Object

List article comments

See Also:

• http://www.voog.com/developers/api/resources/comments#get_comments

# File 'lib/voog_api/api/comments.rb', line 12

def comments(article_id, params = {})
  paginate "articles/#{article_id}/comments", {query: params}
end

#create_comment(article_id, data) ⇒ Object

Create a comment

See Also:

• http://www.voog.com/developers/api/resources/comments#create_comment

# File 'lib/voog_api/api/comments.rb', line 26

def create_comment(article_id, data)
  post "articles/#{article_id}/comments", data
end

#delete_comment(article_id, id) ⇒ Object

Delete an article comment

See Also:

• http://www.voog.com/developers/api/resources/comments#remove_comment

# File 'lib/voog_api/api/comments.rb', line 40

def delete_comment(article_id, id)
  delete "articles/#{article_id}/comments/#{id}"
end

#delete_spam_comments(article_id) ⇒ Object

Delete all spam comment for article

See Also:

• http://www.voog.com/developers/api/resources/comments#delete_spam_comments

# File 'lib/voog_api/api/comments.rb', line 47

def delete_spam_comments(article_id)
  delete "articles/#{article_id}/comments/delete_spam"
end

#toggle_spam_comment(article_id, id) ⇒ Object

Toggle comment spam flag

See Also:

• http://www.voog.com/developers/api/resources/comments#toggle_spam_comment

# File 'lib/voog_api/api/comments.rb', line 33

def toggle_spam_comment(article_id, id)
  put "articles/#{article_id}/comments/#{id}/toggle_spam", nil
end