Copyleaks Ruby SDK
Copyleaks SDK is a simple framework that allows you to scan text for plagiarism and detect content distribution online, using the Copyleaks plagiarism checker cloud.
Using Copyleaks SDK you can check for plagiarism in:
- Online content and webpages
- Local and cloud files (see supported files)
- Free text
- OCR (Optical Character Recognition) - scanning pictures with textual content (see supported files)
Installation
Install using RubyGems
gem install plagiarism-checker
Register and Get Your API Key
To use the Copyleaks API you need to first be a registered user. The registration to Copyleaks takes a minute and is free of charge. Signup and make sure to confirm your account.
As a signed user you can generate your personal API key. Do so on your dashboard home under 'API Access Credentials'.
For more information check out our API guide.
Usage
require 'copyleaks'
copyleaks = Copyleaks::API.new
res = copyleaks.login(<your email>,<your api key>)
puts res.to_json
- (Option) To change the Identity server URI (default:"https://id.copyleaks.com"):
rb Copyleaks::Config.identity_server_uri = "<your identity server uri>" - (Option) To change the API server URI (default:"https://api.copyleaks.com"):
rb Copyleaks::Config.api_server_uri = "<your api server uri>"
Demo
See demo.rb under demo folder for an example.