061035d2af
Merge telegram branch |
||
---|---|---|
bin | ||
scripts | ||
test | ||
.editorconfig | ||
.gitignore | ||
asjon-testing.coffee | ||
external-scripts.json | ||
hubot-scripts.json | ||
package.json | ||
Procfile | ||
README.md |
Asjon ROBOT
Asjon è un chat bot creato usando l'Hubot framework.
Asjon può:
- cercare immagini e video su internet
- cercare testi musicali su internet
- collegarsi al registro elettronico e al sito web dell'IIS Galilei di Crema (se munito di credenziali), visualizzando l'agenda scolastica, i compiti e le circolari
- riportare il meteo per Crema
- ricordare nozioni o date arbitrarie
- visitare 9gag
- e tante altre cose!
Asjon è sviluppato in collaborazione con gli studenti della 5IA (2014/2015) dell'IIS Galileo Galilei di Crema.
Usare Asjon
Asjon è sempre online su Telegram con l'username Asjon ROBOT
Sviluppare Asjon
Puoi testare asjon seguendo queste istruzioni, però alcuni componenti necessitano di variabili d'ambiente particolari per essere configurati correttamente (ad esempio i dati di accesso al registro elettronico per l'agenda)
Dipendenze
Asjon necessita di:
node
enpm
redis
se si vuole salvare la sua memoria in maniera persistentephantomjs
per utilizzare il modulo agenda/compiti
Installazione
- installare le dipendenze. Su arch linux:
pacman -S python2 nodejs phantomjs redis
- clonare questa repo
- lanciare
npm install
(Attenzione: usarePYTHON=python2 npm install
su arch linux!) per installare tutte le dipendenze npm - se vuoi che Asjon conservi i ricordi tra una sessione e l'altra, avvia redis (su arch linux:
systemctl start redis
) - lanciare
bin/hubot
per testare il bot. Per usare le variabili d'ambiente usare la sintassi di bashVARIABILE=valore VAR2=valore2 bin/hubot
.
Utilizzo
Puoi avviare asjon eseguendo
$ bin/hubot
Se tutto va bene dovrebbe comparire una cosa del genere:
[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
asjon>
Puoi interagire con asjon scrivendo asjon help
o qualsiasi altro suo comando.
Test
Asjon dispone di alcuni test d'integrità nella cartella test/
.
Per eseguirli, occorre:
- installare mocha tramite
npm install -g mocha
(potrebbe essere necessario sudo) - lanciare i test tramite
npm test
dalla cartella della repo - opzionalmente è possibile generare i report di copertura dei test usando
npm run coverage-html
onpm run coverage-json
in base al formato desiderato.
Nota Bene: è opportuno eseguire sempre i test d'integrità prima di contribuire una modifica. Ancora meglio sarebbe allegare dei test di integrità insieme alle nuove funzioni aggiunte
Scripting
Gli script di Asjon sono nella cartella scripts
.
La Scripting Guide di hubot è molto utile per imparare come funzionano
Hosting
Asjon può essere hostato come un qualsiasi Hubot, ma richiede phantomjs per alcune funzioni.
Il ramo master
di Asjon è sempre hostato online ed è accessibile tramite telegram all'username
Asjon ROBOT.
Licenza
Hubot e Asjon sono distribuiti sotto la MIT License