Archives du tag: Sinatra

Développement Mac OS X NodeJS Ruby Ruby on Rails Web

Installer un environnement de développement moderne sous OS X 10.8

Beaucoup de développeurs utilisent de plus en plus Ruby, son framework Ruby on Rails et les autres outils de développement modernes.

Nous allons voir comment installer le tout de manière « propre ».

Vous aurez alors un environnement de développement complet et performant !

Mettre à jour OS X

La dernière version en date est OS X 10.8.3. Pensez à mettre à jour votre système.

Mettre à jour Java

Java peut être nécessaire pour obtenir un environnement de développement complet.

La dernière version en date est Java 7.

Le tout est disponible sur le site Oracle.

Installer XCode et les outils en ligne de commande

XCode est disponible sur le Mac App Store.

Une fois installé, ouvrez ses préférences afin d’installer les outils en ligne de commande.

La base : Homebrew

Homebrew vous permet de disposer des bibliothèques et outils open-source en environnement OS X.

Installez Homebrew via une ligne de commande du Terminal :

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Vous aurez peut-être à vous y reprendre à plusieurs fois.

Une fois installé, et à chaque fois que vous souhaitez installer quoi que ce soit via Homebrew, utilisez d’abord cette ligne de commande :

brew doctor

Cette ligne de commande vous demandera peut-être de supprimer, par exemple, iconv. Renommez vos fichiers, c’est plus prudent.

Si les fichiers de s’installent pas du premier coup, désinstallez puis ré-installez.

Au final, tout devrait fonctionner correctement.

Sur une installation « propre », tout se passe sans encombres.

RVM (Ruby & Ruby on Rails)

RVM vous permet d’installer plusieurs versions de Ruby sur votre Mac.

Vous pourrez également installer Ruby on Rails (RoR).

Les versions actuelles sont Ruby 2.0.0 et RoR 3.2.13.

RVM vous permet également d’installer, par exemple, la version 4.0 beta 1 de RoR. En cohabitation avec le reste : pratique !

Pour installer Ruby et Rails avec toutes les dépendances liées à Homebrew, une seule ligne de commande suffit :

\curl -L https://get.rvm.io | bash -s stable --rails --autolibs=enabled

Et voilà, votre système est complètement prêt pour le développement Ruby et RoR.

Pensez à mettre à jour, si nécessaire, votre fichier .profile. (et faire le lien via source pour les fichiers .bashrc et autres)

[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm" # Load RVM into a shell session *as a function* [[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm"

Sur une installation « propre », il n’y a rien d’autre à faire.

Sinatra

Sinatra vous permet de concevoir rapidement des prototypes d’applications web, voir des applications web complètes, dans le sens où cet outil est très léger.

Son installation en une ligne de commande :

gem install sinatra

Node.js

Node.js vous permet de faire la même chose de Sinatra, du moins sur le même principe, avec de meilleures performances (potentiellement) mais moins de maturité et en Javascript (moteur V8).

brew install nodejs

PHP

Les plus nostalgiques d’entre nous souhaiterons sûrement installer ce bon vieux PHP. Pour cela, installez d’abord XQuartz.

Ensuite, installez les dépendances nécessaires :

brew tap dupes brew tap josegonzalez/homebrew-php

Ensuite, installez PHP 5.4 en choisissant judicieusement vos options :

brew options php54 brew install php54

Installez également l’extension intl :

brew install php54-intl

Et configurez le fichier /usr/local/etc/php/5.4/php.ini :

date.timezone = Europe/Paris

 Avec Symfony 2

Symfony 2 est un framework PHP qui modernise la plateforme en la rapprochant de RoR et autres.

Pour utiliser le serveur intégré à PHP 5.4 avec Symfony 2, placez-vous dans le sous-répertoire web de votre projet. Puis exécutez :

php -S 127.0.0.1:8080

Vous pourrez alors accéder à Symfony 2 dans votre navigateur via http://127.0.0.1:8080/app_dev.php.

PostgreSQL / PostGIS

Passez tout simplement par Homebrew :

brew install postgis

Des composantes de Python auront peut-être besoin d’êtres installées. Suivez les instructions à l’écran.

Initialisez votre base de données :

initdb /usr/local/var/postgres -E utf8

Lancez automatique PostgreSQL à l’ouverture de session :

ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents

Lancez PostgreSQL dès maintenant :

launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist

Connectez-vous à votre base de données (nom d’utilisateur = nom d’utilisateur de session) :

psql postgres

Vous pouvez alors voir la liste des extensions installées :

SELECT * FROM pg_available_extensions;

« \q » pour quitter la console PostgreSQL.

MongoDB

Encore une fois, Homebrew est parfaitement adapté :

brew install mongodb

Lancez MongoDB à chaque ouverture de session :

ln -sfv /usr/local/opt/mongodb/*.plist ~/Library/LaunchAgents

Lancez MongoDB dès maintenant :

launchctl load ~/Library/LaunchAgents/homebrew.mxcl.mongodb.plist

Ou, ponctuellement, via le Terminal :

mongod

Connectons-nous au serveur :

mongo

Testons un peu mongo :

db.test.save({ age: 29, "fullname":"Florent Morin"}) db.test.find()

Qui devrait retourner quelque-chose comme :

{   "_id" : ObjectId("51a9bb4d6121d24a661f17a0"),   "age" : 29,   "fullname" : "Florent Morin" }

Memcached

Si on veut bien faire les choses, et pour bien tester les projets en mode « staging » avant de les envoyer en production, l’installation de « memcached » est indispensable.

brew install memcached

Pour le lancement automatique à l’ouverture de session :

ln -sfv /usr/local/opt/memcached/*.plist ~/Library/LaunchAgents

Pour le lancement immédiat :

launchctl load ~/Library/LaunchAgents/homebrew.mxcl.memcached.plist

Testons :

telnet localhost 11211

Puis, en telnet :

stats

Pour quitter :

quit
Share
Développement Web

Les services web RESTful

Les services web sont aujourd’hui au coeur du web et au coeur des applications connectées.

Pour cela, beaucoup de services et d’outils utilisent le modèle REST. Sur iOS, on peut notamment citer l’excellent framework AFNetworking permettant d’accéder aux services web et son prometteur petit frère AFIncrementalStore qui permet lui de synchroniser cache local et service distant.

Pour autant, comment un service web être réellement RESTful ?

Cette question est en suspend depuis quelques années. Au travers de cet article, amené à évoluer, je vais tâcher d’apporter quelques éléments de réponses.

REST : kézako ???

Déjà, qu’est-ce REST ?

C’est un modèle d’organisation de service web exploitant au maximum le protocole HTTP et les standards du web afin d’être aussi léger que performant.

Le principe est d’accéder à des ressources en suivant le modèle objet.

Définition du service web

Afin de définir les ressources du service web, il suffit d’accéder à la racine de l’API.

Par exemple :

{   "url": "https://api.monservice.com",   "resources": {     "cars": {       "url": "https://api.monservice.com/cars"     },     "accounts": {       "url": "https://api.monservice.com/accounts"     }   } }

 

URL des ressources

Les resources sont accessibles via des URL.

Par convention, on utilisera toujours le pluriel pour les collections. Et on utilisera toujours des noms pour identifier les ressources.

Par exemple :

/cars : ensemble de voitures

/cars/count : nombre total de voiture

/cars/12 : voiture « 12″

/cars/12/options : options disponibles pour la voiture « 12″

/cars_models : toutes les relations entre voiture et modèle (many to many)

Options d’affichage

Il est possible de passer des paramètres dans les URL.

Par convention, pour n’afficher que certains champs, on utilisera « fields » séparé par des virgules ».

/cars?fields=immatriculation,color : je veux seulement les champs « immatriculation » et « color »

Egalement, on peut filtrer les résultats sur certains champs en les passant en paramètres.

/cars?color=red : seulement les voitures rouges

/cars?model.name=volvo : seulement les voiture dont le nom du modèle est volvo (certains caractères n’ont volontairement pas été échappés)

Pagination

Certaines options peuvent être passées dans l’URL afin de gérer la pagination.

- offset : premier résultat affiché

- limit : nombre maximal de résultats par page

- until : date maximale de création

- since : date minimale de création

- since_id : identifiant le plus ancien

- max_id : identifiant le plus récent

Cela permet de gérer un chargement progressif de manière très fiable.

L’en-tête HTTP « Link », avec les liens et les options « rel » (« next », « previous ») permet également de paginer la réponse.

L’en-tête HTTP « X-Result-Count » permet d’avoir le nombre total de résultats.

Aussi, on peut utiliser « Content-Range ». Ex. « Content-Range: cars 0-20/2550″. Et l’en-tête en requête serait « Range: cars=0-20″.

Actions

Idéalement, une action est définie par un verbe. La méthode HTTP dépend d’une modification ou non du contenu de la ressource ciblée.

POST /cars/12/buy : acheter la voiture « 12″

GET /cars/search : rechercher une voiture

Les verbes HTTP

Pour les ressources, utilisez la méthodes CRUD (Create, Read, Update, Delete) .

POST /cars : ajouter une voiture (redirige vers la ressource créée)

GET /cars/12 : voir la voiture 12

HEAD /cars/12 : savoir si la voiture 12 existe (aucune ressource retournée)

PUT /cars/12 : mettre à jour intégralement la voiture 12 (redirige vers la ressource mise à jour)

PATCH /cars/12 : mettre à jour intégralement la voiture 12 (redirige vers la ressource mise à jour)

DELETE /cars/12 : supprimer la voiture 12

OPTIONS /cars : description des actions possibles sur les ressources de type « cars » (via l’en-tête Allow, access-control-allow-methods, access-control-allow-origin et une description explicite dans le corps)

Pour les actions, on utilise souvent GET.

Lorsque l’on utilise AJAX, sur les navigateurs web par exemple, on n’a pas accès à PUT ou DELETE.

Ce n’est pas un problème : passez le paramètre « _method » avec comme nom la méthode HTTP à utiliser. Si vous utilisez un framework comme par exemple Ruby on Rails, la méthode sera automatiquement gérée.

Format des données

Plusieurs formats peuvent être utilisés. Ils sont définis en priorité par l’extension de l’URL, mais également par le Content-Type ou le Accept de la réponse et/ou de la requête.

application/xml est le plus ancien.

application/json est le plus courant. Parfaitement adapté aux services web orientés REST.

application/x-www-form-urlencoded est utilisé lors d’envoi de données. Chaque clé correspondant à une propriété de l’objet.

multipart/form-data est lui particulièrement adapté pour l’envoi de données binaires. Chaque champs correspond à une propriété et chacune de ces propriétés peut adopter son propre format. (binaire, XML, JSON, texte)

Format des dates et heures

Les dates et heures ont leur propre standard : ISO-8601.

Utilisez le format court pour les dates et le format complet pour date et heure.

Les codes HTTP

200 : message de réponse bien interprétée

201 : une ressource a été crée

304 : rien n’a été modifié

400 : requête non comprise

401 : accès non autorisé à l’utilisateur

403 : accès purement et simplement interdit

404 : élément non trouvé

500 : erreur du serveur

DNS

Utilisez, dans la mesure du mesure, un nom de domaine spécifique pour vos API.

ex. http://api.monservice.com

Version

Utilisez un chemin spécifique pour chaque version de votre API.

ex. http://api.monservice.com/v1/

Faire référence à une autre ressource

Utilisez les suffixes « _url » ou « _href » qui sont particulièrement adaptées. Surtout si vous faites références à des objets binaires.

Pour une autre entité, vous pouvez utiliser « _id » ou « _identifier ».

Identifier une ressource

On identifie une ressource soit par « id », soit par « identifier ». Parfois aussi par « url » ou « href ».

Représentation binaire

Certains objets ont des propriétés binaires.

Selon le volume d’information, utilisez :

- soit « url » / « href » ou « maprioriete_url »  pour faire référence à une URL de téléchargement

- soit « data » ou « mapropriete_data » afin de proposer une représentation encodée en Base64 des données.

Envoyer / récupérer des données binaires

Pour envoyer par exemple une photo avec un commentaire, utilisez le multipart/form-data.

POST /photos

champs « comment » : contenu texte

champs « photo » : la photo, en binaire

champs « thumb » : la miniature de la photo, en binaire

En réponse, ou à la lecture :

GET /photos/12

{   "id": 12,   "comment": "mon texte",   "photo_url": "http://lien_vers_photo.jpg",   "thumb_url": "http://lien_vers_thumb.jpg" }

C’est finalement très simple. :-)

Vous pouvez également choisir d’avoir des objets spécifiques pour les fichiers à télécharger, ce qui peut être pratique pour avoir par exemple les dates de modification.

{   "id": 12,   "comment": "mon texte",   "photo": {     "url": "http://lien_vers_photo.jpg",     "updated_at": "2013-04-22T06:00:00Z"   },   "thumb": {     "url": "http://lien_vers_thumb.jpg",     "updated_at": "2013-04-22T07:00:00Z"   }, }

 Gestion des erreurs

Ne pas avoir de code erreur autres que 200 ou 500 peut parfois s’avérer utile.

Pour cela, utilisez le paramètre « suppress_error_codes » dans votre URL.

Egalement, pensez à renvoyer un message d’erreur explicite.

{   "errors": [     {       "message": "Password length is at least 8 characters.",       "code": 400     },     {       "message": "Email format is invalid.",       "code": 400     }   ] }

Gestion du cache

L’utilisation des en-têtes Etag/If-not-match permet une gestion plus efficace du cache.

Egalement, les en-têtes Last-Modified/If-modified-since sont très efficaces côté performances.

Authentification

Si vous souhaitez authentifier votre client et/ou votre utilisateur, je ne peux que vous recommander le protocole OAuth 2.0.

Il est simple, fiable et performant. Particulièrement adapté aux services web moderne.

L’authentification basique sur du HTTPS est également fiable et a l’avantage d’être la plus simple de toutes.

Limites

Les limites d’accès aux ressources peuvent être définies via les en-têtes HTTP X-RateLimit-Limit et X-RateLimit-Remaining. X-RateLimit-Reset permet de définir à quelle date/heure la limite va être réinitialisée.

Outils de développement

Les outils de développement les plus adaptés sont les suivants.

Si vous ne connaissez que le PHP, utilisez le framework Symfony 2 (Dailymotion) qui est bien conçu pour les services web.

Si vous êtes plus à l’aise avec Java/Scala, le framework Play est assez sympa, bien qu’un peu jeune.

Si vous êtes à l’aise avec Ruby, je ne peux que vous conseiller le framework Ruby on Rails (Twitter, Shopify, Groupon, GitHub, Linkedin) et/ou son petit cousin Sinatra (idéal pour le prototypage rapide).

Si vous êtes aventurier et que vous visez plus de performances, Node.js (Linkedin, eBay) peut être utilisé seul ou en parallèle de l’un des frameworks pré-cités.

Share