Échange de données 1

Échange de données 1


Laboratoire 3

Laboratoire 4

Vous devez développer un service de transformation de données utilisant une application terminal tierce. Le serveur doit recevoir un fichier et générer un fichier transformé via l'outil choisi. Analysez les requêtes-réponses pour élaborer les fonctionnalités du serveur.

Démontrez ensuite le fonctionnement du serveur en implémentant des requêtes brutes et affichage pertinent des réponse dans un client Ruby: 1 requête positive, 1 requête alternative significative et différente.

BONUS

Pour compléter votre exploration des concepts du cours, vous pouvez étoffer votre projet d'un élément qui n'a pas été vu en classe, par exemple :

Vous devez faire approuver votre choix d'outil(et de bonus)!

Persistence des données

Vous devez implémenter un mécanisme d'authentification HTTP Basic multi-usagers persistente. Vous pouvez créer manuellement les utilisateurs sur le serveur.

Le résultat de chaque transformation effectuée par les utilisateurs doit être enregistré dans un fichier et une base de données permet d'associer chaque fichier à son propriétaire, en plus des informations suivantes

Vous devez également effectuer les validations nécessaires pour assurer l'intégrité des données.


Les routes suivantes sont accessibles sans authentification obligatoire.

Gallerie

Affiche ce fichier HTML

http
GET /

===

... Fichier gallery.html ...

Liste

Retourne les informations des fichiers

http
GET /files

===

200
Content-Type: application/json

[
{ uuid: _string_, name: _string_, timestamp: _string_, private: _boolean_, mine: _boolean_ },
...
]

Récupérer un fichier

http
GET /files/...uuid...?pass=...

===

... Fichier correspondant au uuid ...

~~~ Si uuid invalide

404
File not found

~~~ Si pass incorrecte OU pas propriétaire

403
Access denied

Authentification

http
GET /login

===

303
Location: /

~~~ Si authentification invalide

401
Content-Type: text/plain
WWW-Authenticate: Basic

Invalid credentials


Les routes qui suivent requiert l'authentification de l'usager, et n'affectent que les données qui lui appartiennent

Transformation

Pour créer un nouveau fichier et ses informations.

http
POST /files
Authorization: Basic ...
Content-Type: multipart/form-data

-----------------------------
Content-Disposition: form-data; name="password"

shawi123
-----------------------------
Content-Disposition: form-data; name="original_file"; filename="demo.txt"
Content-Type: text/plain

Content of demo.txt
-----------------------------
Content-Disposition: form-data; name="options"

{ some: ..., option: ... }
-----------------------------

===

201
Content-Location: /files/...uuid...

... Fichier traité ...

~~~ Si erreur

400

...Message...

~~~ Si pas authentifié

401
Content-Type: text/plain
WWW-Authenticate: Basic

Authentication required

Modification

Permet d'ajouter/retirer le mot de passe d'un fichier

http
PATCH /files/...uuid...

... password ...

===

204

~~~ Si uuid invalide, ou pas propriétaire

404
File not found

~~~ Si erreur

400
...Message...

~~~ Si pas authentifié

401
Content-Type: text/plain
WWW-Authenticate: Basic

Authentication required

Suppression

Efface le fichier et ses informations de la base de données

http
DELETE /files/...uuid...
===

204

~~~ Si uuid invalide, ou pas propriétaire

404
File not found

~~~ Si erreur

400
...Message...

~~~ Si pas authentifié

401
Content-Type: text/plain
WWW-Authenticate: Basic

Authentication required

Outils

Suggestions tokei
bash
copier
wget https://github.com/XAMPPRocky/tokei/releases/download/v12.1.2/tokei-x86_64-unknown-linux-gnu.tar.gz
su root -c "tar -xf tokei-x86_64-unknown-linux-gnu.tar.gz --directory=/usr/bin"
bash
Usage
copier
tokei
tesseract ocr
bash
copier
su root -c "apt install tesseract-ocr -y"
bash
Usage
copier
tesseract
freeze
bash
copier
su root -l -c "wget -O /tmp/freeze.deb https://github.com/charmbracelet/freeze/releases/download/v0.2.2/freeze_0.2.2_amd64.deb; dpkg -i /tmp/freeze.deb"
bash
Usage
copier
freeze
boxes
bash
copier
su root -c "apt install boxes -y"
bash
Usage
copier
boxes
figlet
bash
copier
su root -c "apt install figlet -y"
bash
Usage
copier
figlet
toilet
bash
copier
su root -c "apt install toilet -y"
bash
Usage
copier
toilet
markmap
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g markmap-cli"
bash
Usage
copier
markmap
triangle
bash
copier
wget https://github.com/esimov/triangle/releases/download/v2.0.0/triangle-2.0.0-linux-amd64.tar.gz
su root -c "tar -xvf triangle-2.0.0-linux-amd64.tar.gz triangle-2.0.0-linux-amd64/triangle -O > /usr/bin/triangle; chmod 755 /usr/bin/triangle"
bash
Usage
copier
triangle
blazediff
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g @blazediff/bin"
bash
Usage
copier
blazediff
wkhtmltopdf / wkhtmltoimage
bash
copier
su root -c "apt install wkhtmltopdf -y"
bash
Usage
copier
wkhtmltopdf
bash
Usage
copier
wkhtmltoimage
pdftk
bash
copier
su root -c "apt install pdftk -y"
bash
Usage
copier
pdftk
cowsay
bash
copier
su root -c "apt install cowsay -y"
bash
Usage
copier
cowsay
diff2html
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g diff2html-cli"
bash
Usage
copier
diff -u file1.txt file2.txt | diff2html -i stdin
jq
bash
copier
su root -c "apt install jq -y"
bash
Usage
copier
jq
jc
bash
copier
su root -c "apt install jc -y"
bash
Usage
copier
jc
hget
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g hget"
bash
Usage
copier
hget
qrencode
bash
copier
su root -c "apt install qrencode -y"
bash
Usage
copier
qrencode
ffmpeg
bash
copier
su root -c "apt install ffmpeg -y"
bash
Usage
copier
ffmpeg
markdown
bash
copier
su root -c "apt install markdown -y"
bash
Usage
copier
markdown
graphicsmagick
bash
copier
su root -c "apt install graphicsmagick -y"
bash
Usage
copier
magick
ASCII Image Converter
bash
copier
su root -c "echo 'deb [trusted=yes] https://apt.fury.io/ascii-image-converter/ /' | sudo tee /etc/apt/sources.list.d/ascii-image-converter.list"
su root -c "apt update && apt install ascii-image-converter -y"
bash
Usage
copier
ascii-image-converter
odiff
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g odiff-bin"
bash
Usage
copier
odiff
markmap cli
bash
copier
su root -c "apt install nodejs npm -y"
su root -c "npm install -g markmap-cli"
bash
Usage
copier
markmap-cli
mermaid cli
bash
copier
su root -c "apt install ca-certificates fonts-liberation libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils"
su root -c "apt install nodejs npm -y"
su root -c "npm install -g @mermaid-js/mermaid-cli"
bash
Usage
copier
mmdc

Compléments techniques

Téléversement de fichiers
rb
server.txt
copier
require "bundler/inline"

gemfile do
source "http://rubygems.org"

gem "sinatra-contrib"

gem "rackup"
gem "puma"
end

require "sinatra/base"

class SinatraFileUpload < Sinatra::Base

post "/" do
return [
params.to_s,
"title = " + params["title"],
params["demo_file"]["filename"] + " = " + params["demo_file"]["tempfile"].read
].join("\n\n")
end

run! if app_file == $0
end
txt
file.txt
Hello world!!!
rb
client.rb
copier
require "bundler/inline"

gemfile do
source "http://rubygems.org"
gem "faraday"

# https://github.com/lostisland/faraday-multipart
gem "faraday-multipart"
end

require "faraday"
require "faraday/multipart"

server = Faraday.new("http://localhost:4567") do |f|
f.request :multipart
end

data = {
title: "demo file upload",
demo_file: Faraday::Multipart::FilePart.new("file.txt", "text/plain")
}

response = server.post("/", data)

puts(response.body)
Réponse
{
"title"=>"demo file upload",
"demo_file"=>{
"filename"=>"file.txt",
"type"=>"text/plain",
"name"=>"demo_file",
"tempfile"=> Tempfile:/tmp/RackMultipart20221119-13201-151pi1f.txt,
"head"=>"
Content-Disposition: form-data;
name="demo_file";
Content-Length: 16\r\n
Content-Type: text/plain\r\n
Content-Transfer-Encoding: binary\r\n
"
}
}

title = demo file upload

file.txt = Hello world!!!

Exécution d'un programme externe
txt
original.txt
3
4
2
6
7
3
4
5
7
3
6
rb
code.rb
copier
# Demonstration de l'utilisation d'un programme externe via Ruby

# https://docs.ruby-lang.org/en/3.1/Kernel.html#method-i-system

# avec les utilitaires standards uniq et sort

filename = "original.txt"
output = "result.txt"

# sort original.txt | uniq > result.txt
system("sort #{filename} | uniq > #{output}")
txt
result.txt
2
3
4
5
6
7

Remise

Dépôt via LÉA

Échange de données 1

Nom:


Outil __________________________

Suivi 1, avant le 5 décembre
GET /login 1     0.5     0
GET /files, public vs auth, données brutes 1     0.5     0
GET /, affichage de la liste, différents cas 1     0.5     0
Suivi 2, avant le 12 décembre
POST /files, transformation et persistence 2     1.5     1     0
GET /files, données réelles 2     1.5     1     0
GET /, affichage de la liste, différents cas 1     0.5     0
Livraison
Zip, Fichiers requis 0     -0.5     -1     -2
Qualité de rédaction, Nomenclature, Formatage 0     -0.5     -1     -2
Qualité de l'implémentation, syntaxe, mécanismes, réutilisation 0     -0.5     -1     -2
Gallerie
GET / = Fichier gallery.html 1     0.5     0
Liste
GET /files = 200, tableau JSON 2     1.5     1     0
Tri propriétaire en premier, si authentifié 1     0.5     0
Tri date descendant ET nom ascendant 1     0.5     0
Représentation des données uuid, name, timestamp, private, mine 2     1.5     1     0
Récupération
GET /files/...uuid... = 200, fichier correspondant 2     1.5     1     0
Sinon 404, not found 1     0.5     0
?pass=... doit correspondre sauf si propriétaire authentifié 1     0.5     0
Sinon 403, access denied 1     0.5     0
Authentification
GET /login = 303, redirection / 2     1.5     1     0
Sinon 401, invalid 1     0.5     0
Plusieurs utilisateurs, Gestion sécuritaire du mot de passe 0     -1     -2
Transformation
POST /files 1     0.5     0
password, original file, options JSON 2     1.5     1     0
= 201, content-location, fichier résultat 2     1.5     1     0
Sinon 401, auth required 1     0.5     0
Validations pertinentes = 400, erreur... 2     1.5     1     0
Persistence des informations de la transformation 1     0.5     0
Génération du fichier résultat de la transformation via l'outil, avec les options supplémentaires 2     1.5     1     0
Modification
PATCH /files/...uuid... , password = 204, persistence 2     1.5     1     0
404, not found OU pas propriétaire 1     0.5     0
401, auth required 1     0.5     0
400, message... 1     0.5     0
Suppression
DELETE /files/...uuid... = 204, persistence, suppression du fichier 2     1.5     1     0
404, not found OU pas propriétaire 1     0.5     0
401, auth required 1     0.5     0
400, message... 1     0.5     0
Client
GET /files positive, alternative, affichage 2     1.5     1     0
GET /files/...uuid..?pass positive, alternative, affichage 2     1.5     1     0
POST /files positive, alternative, affichage 2     1.5     1     0
PATCH /files/...uuid... positive, alternative, affichage 2     1.5     1     0
DELETE /files/...uuid... positive, alternative, affichage 2     1.5     1     0
BONUS

__________________________
+5     0