https://github.com/copyleaks/ruby-plagiarism-checker
Copyleaks Plagiarism Checker - Ruby SDK.
https://github.com/copyleaks/ruby-plagiarism-checker
copyleaks copyleaks-api plagiarism
Last synced: 6 months ago
JSON representation
Copyleaks Plagiarism Checker - Ruby SDK.
- Host: GitHub
- URL: https://github.com/copyleaks/ruby-plagiarism-checker
- Owner: Copyleaks
- License: mit
- Created: 2016-06-21T09:10:12.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T10:58:50.000Z (9 months ago)
- Last Synced: 2024-09-13T22:26:19.373Z (9 months ago)
- Topics: copyleaks, copyleaks-api, plagiarism
- Language: Ruby
- Homepage: https://api.copyleaks.com
- Size: 303 KB
- Stars: 8
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://api.copyleaks.com/documentation/specifications#2-supported-file-types))
* Free text
* OCR (Optical Character Recognition) - scanning pictures with textual content (see [supported files](https://api.copyleaks.com/documentation/specifications#6-supported-image-types-ocr))
## Installation
Install using [RubyGems](https://rubygems.org/gems/plagiarism-checker)
```bash
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](https://api.copyleaks.com/?register=true) and make sure to confirm your account.
As a signed user you can generate your personal API key. Do so on your [dashboard home](https://api.copyleaks.com/dashboard) under 'API Access Credentials'.
For more information check out our [API guide](https://api.copyleaks.com/documentation/v3).
## Usage
```rb
require 'copyleaks'
copyleaks = Copyleaks::API.new
res = copyleaks.login(,)
puts res.to_json
```
* (Option) To change the Identity server URI (default:"https://id.copyleaks.com"):
```rb
Copyleaks::Config.identity_server_uri = ""
```
* (Option) To change the API server URI (default:"https://api.copyleaks.com"):
```rb
Copyleaks::Config.api_server_uri = ""
```
## Demo
See [demo.rb](./demo/demo.rb) under demo folder for an example.
## Read More
* [API Homepage](https://api.copyleaks.com/)
* [API Documentation](https://api.copyleaks.com/documentation)
* [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)