https://github.com/seanbehan/akismet

A Ruby client for the Akismet API
https://github.com/seanbehan/akismet

Last synced: 25 days ago
JSON representation

A Ruby client for the Akismet API

• Host: GitHub
• URL: https://github.com/seanbehan/akismet
• Owner: seanbehan
• License: mit
• Created: 2011-09-11T15:34:29.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-09-11T15:37:20.000Z (over 13 years ago)
• Last Synced: 2024-11-16T16:11:44.184Z (3 months ago)
• Language: Ruby
• Homepage:
• Size: 95.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Akismet

=======

A Ruby client for the Akismet API.

Usage

-----

Call `Akismet::verify_key` to verify an API key. Instantiate an

`Akismet::Client` with your API and site URL. Call the client's `check`,

`ham`, and `spam` methods, passing the commenter's IP and user agent and

parameters specified in the Akismet documentation:

http://akismet.com/development/api/#comment-check.

Example

-------

    Akismet.verify_key 'my_api_key', 'http://mysite.com'

    client = Akismet::Client.new 'my_api_key', 'http://mysite.com'

    client.check '173.194.35.104',

      'user_agent',

      :permalink => 'http://mysite.com/post/100',

      :comment_type => Akismet::CommentType::COMMENT,

      :comment_author => 'commenter_name',

      :comment_author_email => '[email protected]',

      :comment_author_url => 'http://commenter.com',

      :comment_content => 'The text of a comment'