Project

soames

0.0
No release in over a year
Gem to detect academic fraud and plagiarism. It can compare a text or a file with some multiple resources and return the level of plagiarism and much more.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.1.4
~> 10
~> 3.0

Runtime

~> 1.3
~> 0.2.4
 Project Readme

Soames Project

Project to detect academic fraud and plagiarism

Installation

Add this line to your application's Gemfile:

gem 'soames'

And then execute:

$ bundle

Or install it yourself as:

$ gem install soames

Usage

First of all, add the following line to you ruby code.

require 'soames'

In order to use Soames gem you need to configure the detectors you want to use (right now, only FilesDetector is available).

Soames.configure do |config|
  config.detectors = [
    Soames::Detectors::FilesDetector.new(folder: '~/folder-with-student-homeworks')
  ]
end

After configuring it, you can perform the following method to comparte a provided text against all the files inside the provided folder.

result = Soames.check_fraud('A suspicious sentence that looks really similar to another from other student.')

The result of the previous operation will return the result of the check as a Soames::Model::Result model. This model can be displayed as a hash using to_h method.

{
  original_text: "A suspicious sentence that looks really similar to another from other student.",
  fraud?: false,
  fraud_level: 0.0,
  detectors_results: [
    {
      detector_name: "files_detector",
      fraud?: false,
      fraud_level: 0.0,
      sources: []
    }
  ]
}

Development

After checking out the repo, run make build to install dependencies. Then, run make test to run the tests. You can also run make sh to open the Docker container and execute the ./bin/console for an interactive prompt that will allow you to experiment.

$ make sh
/opt # ./bin/console
irb(main):001:0> Soames.check_fraud("wadus")

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on github at https://github.com/jcagarcia/soames. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Soames project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.