@jimpick/akismet-api
    Overview
    Versions
    Jobs
    Chat
    Dependencies
    Contributors
    Documentation
    Alternatives
    Discussions

@jimpick/akismet-api

Nodejs bindings to the Akismet (http://akismet.com) spam detection service

2.0.0  •  Updated 4 years ago  •  by Chris Foster  •  MIT License

Akismet-api

Build Status Dependency Status

Full Nodejs bindings to the Akismet (http://akismet.com) spam detection service.

Features:

  • Promise and callback support
  • Supports node/iojs from 0.8 to 4.1
  • Supports all Akismet API features
  • Uses a modern HTTP client
  • Complete test suite
  • No coffeescript

Upgrading to 2.0? You likely don’t need to change anything, but check out the changelog.

Installing

npm install akismet-api

Creating the Client

The blog and key values are required by Akismet. There are a set of other avaliable default options visible in the source, but you likely will not need to change those.

var akismet = require('akismet-api');
var client = akismet.client({
  key  : 'myKey',                   // Required!
  blog : 'http://myblog.com'        // Required!
});

Promises and Callbacks

All of the function methods below support both promises and callbacks! The returned promises use the Bluebird promise library. The following documentation primarily uses the callback version, but to return a promise simply don’t provide a callback. Here is an example of the promise version of the verifyKey() function:

client.verifyKey()
.then(function(valid) {
  if (valid) console.log('Valid key!');
  else console.log('Invalid key!');
})
.catch(function(err) {
  console.log('Check failed: ' + err.message);
}):

Verifying your Key

It’s a good idea to verify your key before use. If your key returns as invalid, the error field will contain the debug help message returned by Akismet.

client.verifyKey(function(err, valid) {
  if (err) console.log('Error:', err.message);
  if (valid) console.log('Valid key!');
  else console.log('Invalid key!');
});

Checking for Spam

The user_ip, user_agent, and referrer are required options. All other options are optional, but will provide you with better spam detection accuracy.

client.checkSpam({
  user_ip : '123.123.123.123',              // Required!
  user_agent : 'MyUserAgent 1.0 Webkit',    // Required!
  referrer : 'http://google.com',           // Required!
  permalink : 'http://myblog.com/myPost',
  comment_type : 'comment',
  comment_author : 'John Smith',
  comment_author_email : 'john.smith@gmail.com',
  comment_author_url : 'http://johnsblog.com',
  comment_content : 'Very nice blog! Check out mine!'
}, function(err, spam) {
  if (err) console.log ('Error!');
  if (spam) {
    console.log('OMG Spam!');
  } else {
    console.log('Totally not spam');
  }
});

Submitting False Negatives

If Akismet reports something as not-spam, but it turns out to be spam anyways, we can report this to Akismet via this API call.

client.submitSpam({
  user_ip : '123.123.123.123',              // Required!
  user_agent : 'MyUserAgent 1.0 Webkit',    // Required!
  referrer : 'http://google.com',           // Required!
  permalink : 'http://myblog.com/myPost',
  comment_type : 'comment',
  comment_author : 'John Smith',
  comment_author_email : 'john.smith@gmail.com',
  comment_author_url : 'http://johnsblog.com',
  comment_content : 'Very nice blog! Check out mine!'
}, function(err) {
  if (!err) {
    console.log('Spam reported!');
  }
});

Submitting False Positives

If Akismet reports something as spam, but it turns out to not be spam anyways, we can report this to Akismet via this API call.

client.submitHam({
  user_ip : '123.123.123.123',              // Required!
  user_agent : 'MyUserAgent 1.0 Webkit',    // Required!
  referrer : 'http://google.com',           // Required!
  permalink : 'http://myblog.com/myPost',
  comment_type : 'comment',
  comment_author : 'John Smith',
  comment_author_email : 'john.smith@gmail.com',
  comment_author_url : 'http://johnsblog.com',
  comment_content : 'Very nice blog! Check out mine!'
}, function(err) {
  if (!err) {
    console.log('Non-spam reported!');
  }
});

Testing

cd node_modules/akismet-api
npm test

Credits

Author and maintainer is Chris Foster. Development was sponsored by MemoryLeaf Media.

License

Released under the MIT license.

See LICENSE.txt for more information.

Popularity

Stars
33

Maintenance

Development

Last ver 4 years ago
Created 4 years ago
Last commit 2 months ago
12 days between commits

Technology

Node version: 5.10.1
0 unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

9 contributors
Chris Foster
Maintainer, 184 commits, 60 merges, 44 PRs
Works at TwoStoryRobot
greenkeeper[bot]
7 commits
dependabot-preview[bot]
6 commits
Mo Gusbi
3 commits
greenkeeperio-bot
2 commits, 16 PRs
Works at greenkeeperio
Nat Welch
2 commits, 1 PRs
Works at Google

Tags

akismet
spam
detection
Ready for the next level?
Join Openbase's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookLinkedIn
© 2020 Devstore, Inc.