Project

filter8

0.0
No commit activity in last 3 years
No release in over 3 years
An unofficial ruby wrapper for Filter8 (http://filter8.com). An API to filter lots of stuff from texts, e.g. bad words.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

filter8

A unofficial ruby wrapper for Filter8 (http://filter8.com). An API to filter lots of stuff from texts, e.g. bad words.

Code Climate Test Coverage

Installation

As you'd expect. Nothing special here:

gem install filter8

How to use

Configuration

Before you use Filter8 you need to configure it:

Filter8.configure do |config|
  config.api_key = "your filter8-api-key"
  config.api_secret = "your filter8-api-secret"
end

Usage

Simply send the content, you wish to filter with the filter-method:

Filter8.filter("your content")

If you want to change the default-options of filter8 (https://filter8.com/documentation), you can pass an optional options-hash with the filter-configuration:

Filter8.filter("your content", blacklist: {enabled: true, locales: [:en, :de, :fr], tags: ["AsciiArt"]})

The email and urls filters are not yet supported.

Feedback

Feedback and pull-request are always welcome. You can find the author via http://toadle.me

License

The filter8-gem is released under the MIT License.