https://github.com/guibrandt/antiplagio.rb

API para detecção de plágio em código
https://github.com/guibrandt/antiplagio.rb

plagiarism-detection rspec ruby sinatra

Last synced: 3 days ago
JSON representation

API para detecção de plágio em código

• Host: GitHub
• URL: https://github.com/guibrandt/antiplagio.rb
• Owner: GuiBrandt
• License: mit
• Created: 2019-06-30T20:49:27.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-16T05:58:21.000Z (over 1 year ago)
• Last Synced: 2023-06-15T07:45:20.660Z (over 1 year ago)
• Topics: plagiarism-detection, rspec, ruby, sinatra
• Language: Ruby
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Anti-plágio

===

API anti-plágio de código, feita para a prova inicial da Dextra.

Primeiros passos

---

Esta seção especifica primeiros passos para rodar a API.

### Pré-requisitos

Requer [Ruby](https://www.ruby-lang.org/pt/).

Recomenda-se usar a última versão 2.x disponível, mas teoricamente qualquer

versão acima da 2.2 funciona.

### Instalação

Instale as gems necessárias com `bundle`. Na pasta raíz do repositório:

    $ bundle install

### Testando

Este projeto usa [`rspec`](https://rspec.info/) como framework de testes

automatizados.

Para executar, execute na raíz do repositório:

    $ rspec -fd

### Executando localmente

Para executar a API, é necessário ter uma conexão com um servidor Firebase.

Uma vez providenciado o servidor, crie variáveis de ambiente `FIREBASE_URL` e

`FIREBASE_KEY_FILE` com a URL para o banco de dados do firebase e o arquivo

json com a chave privada de acesso, respectivamente.

Para formas de obter a URL e a chave privada, veja os links:

- [Where can I find my Firebase reference URL in Firebase account?][1]

- [Add the Firebase Admin SDK to Your Server][2]

    [1]: https://stackoverflow.com/questions/40168564/where-can-i-find-my-firebase-reference-url-in-firebase-account

    [2]: https://firebase.google.com/docs/admin/setup#initialize_the_sdk

Feito isso, basta executar:

    $ ruby api.rb

### Endpoints

#### `POST /submit/:user_id/:question_id`

Endpoint de envio de resposta.

##### Parâmetros

- `user_id`: Código do usuário enviando a resposta. Armazenado a fim de

  relacionar com outras bases.

- `question_id`: Código da questão, usado para fazer a comparação com as demais

  respostas armazenadas.

##### Corpo

O corpo da requisição deve conter a resposta dada pelo usuário para a questão,

em texto puro (a rever).

##### Resposta

A resposta é o código da entrada gerada no firebase para a submissão, em texto

puro (a rever).

---

Em construção...