Skip to content

README.md

Latest commit

 

History

History
74 lines (52 loc) · 2.25 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.25 KB

ruby-cleantalk

API to have CleanTalk anti-spam on Ruby

Install

Install via bundler

gem 'cleantalk'

Usage

Authentication

The easiest way to configure the authentication is to set the API key globally. You can also set it on each request.

require 'cleantalk'

Cleantalk.auth_key = 'ur_api_key'

Check user registration

See https://cleantalk.org/help/api-check-newuser

require 'cleantalk'

request = Cleantalk::CheckNewuser.new({
  auth_key: 'ur_api_key',            # Required if not defined via Cleantalk.auth_key. the API Key
  sender_email: 'test@example.org',  # Required: The email used by the user
  sender_ip: '127.0.0.1',            # Required: The IP used by the user
  js_on: 1,                          # Required: 1 if the user has javascript enabled, 0 otherwise
  submit_time: 11,                   # Required: Time spend you submit the request in seconds
  sender_nickname: 'test nickname',  # Optional: The nickname used by the user
})

request.allowed? # => true or false
request.result   # => <Object Cleantalk::CheckNewuserResult> with all response data

Depending of your use case, you can also mutate the request:

require 'cleantalk'

request = Cleantalk::CheckNewuser.new({ auth_key: 'ur_api_key', sender_email: 'test@example.org' })
request.sender_ip       = '127.0.0.1'
request.sender_nickname = 'test nickname'
request.js_on           = 1
request.submit_time     = 11

Check message

See https://cleantalk.org/help/api-check-message

require 'cleantalk'

request = Cleantalk::CheckMessage.new({
  auth_key: 'ur_api_key',           # Required if not defined via Cleantalk.auth_key. the API Key
  sender_email: 'test@example.org', # Required: The email used by the user
  sender_ip: '127.0.0.1',           # Required: The IP used by the user
  js_on: 1,                         # Required: 1 if the user has javascript enabled, 0 otherwise
  submit_time: 11,                  # Required: Time spend you submit the request in seconds
  message: '<p>Hello World!</p>'    # Required: The text of the message
  sender_nickname: 'test nickname', # Optional: The nickname used by the user
})

request.allowed? # => true or false
request.result   # => <Object Cleantalk::CheckMessageResult> with all response data