{"id":86,"date":"2015-05-09T22:20:51","date_gmt":"2015-05-09T22:20:51","guid":{"rendered":"https:\/\/www.aya.io\/ayablog\/?p=86"},"modified":"2022-02-07T02:01:09","modified_gmt":"2022-02-07T02:01:09","slug":"un-mini-serveur-api-en-ruby","status":"publish","type":"post","link":"https:\/\/www.aya.io\/blog\/un-mini-serveur-api-en-ruby\/","title":{"rendered":"Un mini serveur d’API en Ruby"},"content":{"rendered":"

On a souvent besoin de tester des requ\u00eates Internet quand on d\u00e9veloppe une application, par exemple pour v\u00e9rifier dans une app iOS que la connexion se fait bien en arri\u00e8re-plan, que le JSON re\u00e7u est bien d\u00e9cod\u00e9, etc.<\/p>\n

On serait tent\u00e9 de s'adresser \u00e0 son serveur de prod, ou m\u00eame d'utiliser Dropbox... mais il y a plus cool : se faire son propre mini serveur de tests.<\/p>\n

Et avec Ruby, c'est tr\u00e8s simple, et \u00e7a prend \u00e0 peine vingt lignes de code.<\/p>\n

Let's go!<\/p>\n

<\/p>\n

Pr\u00e9sentation<\/h2>\n

Ces temps-ci j'ai souvent besoin de tester la validit\u00e9 d'un payload JSON, ou la solidit\u00e9 d'un upload d'image vers le Web, ou la qualit\u00e9 d'une connexion et de son timeout, etc.<\/p>\n

Au lieu d'utiliser plusieurs services pour \u00e7a, et m\u00eame de laisser tra\u00eener des fichiers dans des dossiers prot\u00e9g\u00e9s de mon serveur de prod, comme on est souvent tent\u00e9 de le faire, ou de s'adresser \u00e0 des outils qui ne sont pas faits pour \u00e7a comme Dropbox, il est plus efficace - et m\u00eame plus simple - de se faire son propre serveur en local.<\/p>\n

Avec Ruby et Sinatra \u00e7a prend quelques lignes \u00e0 peine et \u00e7a rend un service incroyable.<\/p>\n

Le serveur<\/h2>\n

On va avoir besoin de Sinatra, donc on l'installe avec ses d\u00e9pendances :<\/p>\n

gem install sinatra thin webrick<\/code><\/pre>\n
On cr\u00e9e ensuite un simple fichier Ruby app.rb<\/code> avec cet en-t\u00eate :<\/p>\n
#!\/usr\/bin\/env ruby\n# encoding: utf-8\n\nrequire "sinatra"\nrequire "json"<\/code><\/pre>\n
On peut obtenir une version fonctionnelle pour tester l'install avec juste trois lignes \u00e0 ajouter :<\/p>\n
get '\/' do\n    "Hello World"\nend<\/code><\/pre>\n
Ca veut dire que Sinatra va surveiller l'URL racine, dans notre cas localhost sur le port 4567, et r\u00e9pondre par le contenu de do ... end<\/code>.<\/p>\n
On le lance puis on teste :<\/p>\n
ruby app.rb\ncurl localhost:4567<\/code><\/pre>\n
R\u00e9sultat : "Hello World" s'affiche dans le terminal.<\/p>\n
Stoppez le serveur en faisant CTRL+C.<\/em><\/p>\n
On vient de voir que cr\u00e9er un serveur minimal \u00e9tait simplissime. On va maintenant cr\u00e9er des routes et fonctions plus utiles.<\/p>\n
JSON<\/h3>\n
Par exemple, on veut une URL "localhost:4567\/api" qui retourne du JSON.<\/p>\n
On cr\u00e9e donc une route pour l'URL :<\/p>\n
get '\/api' do\nend<\/code><\/pre>\n
et dans cette methode on va cr\u00e9er le contenu qui sera retourn\u00e9.<\/p>\n
Comme on veut du JSON, on va faire un hash (un dictionnaire) et le convertir en JSON.<\/p>\n
get '\/api' do\n    # On pr\u00e9cise le format pour Sinatra\n    content_type :json\n    # On cr\u00e9er un hash avec nos contenus\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer API.'\n        }\n    }\n    # On transforme le hash en joli JSON\n    # Comme on est en Ruby, la derni\u00e8re d\u00e9claration est retourn\u00e9e, donc par convention on n'indique pas explicitement `return`\n    JSON.pretty_generate(jj)\nend<\/code><\/pre>\n
R\u00e9sultat :<\/p>\n
ruby app.rb\ncurl localhost:4567\/api<\/code><\/pre>\n
{\n  "meta": {\n    "code": 200,\n    "message": "Welcome to MiniServer API."\n  }\n}<\/code><\/pre>\n
Fichier JSON<\/h3>\n
Et si on veut que notre serveur retourne du JSON plus complexe ? On peut lui demander, au lieu de cr\u00e9er un hash et de le convertir, de lire un fichier JSON existant.<\/p>\n
Dans notre exemple tr\u00e8s simple sans configuration, le fichier devra \u00eatre pr\u00e9sent au m\u00eame niveau que app.rb<\/code>.<\/p>\n
get '\/file\/*.*' do\n    # `params` est le nom de la variable globale de Sinatra qui contient les param\u00e8tres pass\u00e9s dans l'URL, et `splat` repr\u00e9sente un format contenant `*`\n    name = params["splat"].join(".")\n    File.read(name)\nend<\/code><\/pre>\n
Disons que j'aie un fichier test.json<\/code>, je fais :<\/p>\n
curl localhost:4567\/file\/test.json<\/code><\/pre>\n
et j'obtiens le JSON.<\/p>\n
Sinatra autorise \u00e0 forcer une URL sous forme de nom de fichier avec les deux ast\u00e9risques et le point, qui retourne un array qu'il faut donc rejoindre avec un point. <\/p>\n
On lit ensuite le contenu du fichier, qui est automatiquement retourn\u00e9.<\/p>\n
Donc par exemple au lieu de taper sans cesse une vraie API en ligne qui distribue du JSON, vous pouvez enregistrer le r\u00e9sultat d'une requ\u00eate puis la rejouer autant que vous voulez dans votre propre mini serveur :<\/p>\n
curl www.big-api.com\/api\/bigdatachunk > test.json\nruby app.rb\ncurl localhost:4567\/file\/test.json<\/code><\/pre>\n
Fichier \u00e0 downloader<\/h3>\n
Ici j'utilise une image en exemple. Sinatra permet de faire \u00e7a tr\u00e8s simplement gr\u00e2ce \u00e0 un de ses helpers :<\/p>\n
get '\/picture' do\n    send_file '\/Users\/you\/Images\/bird.jpg'\nend<\/code><\/pre>\n
Collez http:\/\/localhost:4567\/picture<\/code> dans un browser, et votre image s'affiche.<\/p>\n
D\u00e9tails d'une requ\u00eate<\/h3>\n
On peut vouloir inspecter l'URL form\u00e9e \u00e0 partir de param\u00e8tres, on va donc partir de notre pr\u00e9c\u00e9dente m\u00e9thode associ\u00e9e \u00e0 l'URL \/api<\/code> et lui ajouter ces fonctions :<\/p>\n
get '\/api\/*' do\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer. Request accepted.'\n        }\n    }\n    if params['splat'].first != ""\n        jj['data'] = {}\n        jj['data']['components'] = params['splat'].first.split('\/')\n        if !params["q"].nil?\n            jj['data']['query'] = params["q"]\n        end\n    end\n    content_type :json\n    JSON.pretty_generate(jj)\nend<\/code><\/pre>\n
Ce n'est qu'un exemple pour d\u00e9montrer le principe.<\/p>\n
Requ\u00eate :<\/p>\n
curl localhost:4567\/api\/test\/server\/whatever\/\\?q=yo<\/code><\/pre>\n
R\u00e9sultat :<\/p>\n
{\n  "meta": {\n    "code": 200,\n    "message": "Welcome to MiniServer. Request accepted."\n  },\n  "data": {\n    "components": [\n      "test",\n      "server",\n      "whatever"\n    ],\n    "query": "yo"\n  }\n}<\/code><\/pre>\n
404<\/h3>\n
Il faut bien se pr\u00e9parer aussi un petit 404, encore une fois Sinatra nous aide avec un helper pour, cette-fois, la route :<\/p>\n
not_found do\n    {\n        'meta' => {\n            'code' => 404,\n            'message' => 'Welcome to MiniServer. Request not found.'\n        }\n    }.to_json\nend<\/code><\/pre>\n
Ici j'ai volontairement choisi de retourner du JSON brut, non pretty-print, pour montrer que c'est encore plus simple \u00e0 faire.<\/em><\/p>\n
Upload<\/h3>\n
Bien s\u00fbr, on peut aussi tester autre chose que GET<\/code>. Par exemple, pour l'upload d'un fichier :<\/p>\n
post '\/upload' do\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer API. File received.'\n        }, \n        'data' => {\n            'env' => request.env\n        }\n    }\n    content_type :json\n    JSON.pretty_generate(jj)\nend<\/code><\/pre>\n
On fait par exemple avec notre pr\u00e9c\u00e9dent fichier de test (mais \u00e7a pourrait \u00eatre une image ou tout autre fichier) :<\/p>\n
curl -X POST -d @"test.json" localhost:4567\/upload<\/code><\/pre>\n
R\u00e9sultat :<\/p>\n
{\n  "meta": {\n    "code": 200,\n    "message": "Welcome to MiniServer API. File received."\n  },\n  "data": {\n    "env": {\n      "SERVER_SOFTWARE": "thin 1.6.3 codename Protein Powder",\n      "SERVER_NAME": "localhost",\n      "rack.input": "#<StringIO:0x007ff1e298b2b0>",\n      "rack.version": [\n        1,\n        0\n      ],\n      "rack.errors": "#<IO:0x007ff1e20ca4f0>",\n      "rack.multithread": true,\n      "rack.multiprocess": false,\n      "rack.run_once": false,\n      "REQUEST_METHOD": "POST",\n      "REQUEST_PATH": "\/upload",\n      "PATH_INFO": "\/upload",\n      "REQUEST_URI": "\/upload",\n      "HTTP_VERSION": "HTTP\/1.1",\n      "HTTP_USER_AGENT": "curl\/7.35.0",\n      "HTTP_HOST": "localhost:4567",\n      "HTTP_ACCEPT": "*\/*",\n      "CONTENT_LENGTH": "49",\n      "CONTENT_TYPE": "application\/x-www-form-urlencoded",\n      "GATEWAY_INTERFACE": "CGI\/1.2",\n      "SERVER_PORT": "4567",\n      "QUERY_STRING": "",\n      "SERVER_PROTOCOL": "HTTP\/1.1",\n      "rack.url_scheme": "http",\n      "SCRIPT_NAME": "",\n      "REMOTE_ADDR": "127.0.0.1",\n      "async.callback": "#<Method: Thin::Connection#post_process>",\n      "async.close": "#<EventMachine::DefaultDeferrable:0x007ff1e21e3558>",\n      "rack.request.form_input": "#<StringIO:0x007ff1e298b2b0>",\n      "rack.request.form_hash": {\n        "{\\"meta\\":{\\"code\\":200,\\"message\\":\\"Test from file.\\"}}": null\n      },\n      "rack.request.form_vars": "{\\"meta\\":{\\"code\\":200,\\"message\\":\\"Test from file.\\"}}",\n      "sinatra.commonlogger": true,\n      "rack.logger": "#<Logger:0x007ff1e2872680>",\n      "rack.request.query_string": "",\n      "rack.request.query_hash": {\n      },\n      "sinatra.route": "POST \/upload"\n    }\n  }\n}<\/code><\/pre>\n
Yeah, c'est plut\u00f4t complet ce que nous donne Sinatra comme infos, pas mal du tout !<\/p>\n
Exemple complet<\/h2>\n
#!\/usr\/bin\/env ruby\n# encoding: utf-8\n\nrequire "sinatra"\nrequire "json"\n\n# C'est pratique aussi d'avoir un log\nconfigure do\n  file = File.new("#{Dir.home}\/temp\/server.log", 'a+')\n  file.sync = true\n  use Rack::CommonLogger, file\nend\n\n# On peut choisir une liste de serveurs compatibles, choisir le port, et choisir le dossier racine\nset :server, %w[thin webrick]\nset :port, 4567\nset :root, File.dirname(__FILE__)\n\n# Routes\n\nget '\/' do\n    "yo"\nend\n\nget '\/api' do\n    content_type :json\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer API.'\n        }\n    }\n    JSON.pretty_generate(jj)\nend\n\nget '\/file\/*.*' do\n    name = params["splat"].join(".")\n    File.read(name)\nend\n\nget '\/api\/*' do\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer. Request accepted.'\n        }\n    }\n    if params['splat'].first != ""\n        jj['data'] = {}\n        jj['data']['components'] = params['splat'].first.split('\/')\n        if !params["q"].nil?\n            jj['data']['query'] = params["q"]\n        end\n    end\n    content_type :json\n    JSON.pretty_generate(jj)\nend\n\nget '\/picture' do\n    send_file '\/Users\/me\/images\/bird.jpg'\nend\n\npost '\/upload' do\n    jj = {\n        'meta' => {\n            'code' => 200,\n            'message' => 'Welcome to MiniServer API. File received.'\n        }, \n        'data' => {\n            'env' => request.env\n        }\n    }\n    content_type :json\n    JSON.pretty_generate(jj)\nend\n\nnot_found do\n    jj = {\n        'meta' => {\n            'code' => 404,\n            'message' => 'Welcome to MiniServer. Request not found.'\n        }\n    }\n    content_type :json\n    JSON.pretty_generate(jj)\nend<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
On a souvent besoin de tester des requ\u00eates Internet quand on d\u00e9veloppe une application, par exemple pour v\u00e9rifier dans une app iOS que la connexion se fait bien en arri\u00e8re-plan, que le JSON re\u00e7u est bien d\u00e9cod\u00e9, etc. On serait tent\u00e9 de s’adresser \u00e0 son serveur de prod, ou m\u00eame d’utiliser Dropbox… mais il y… Poursuivre la lecture Un mini serveur d’API en Ruby<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":87,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,24,10],"tags":[],"class_list":["post-86","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-dev","category-ruby","category-tuto","entry"],"_links":{"self":[{"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/posts\/86","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/comments?post=86"}],"version-history":[{"count":3,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/posts\/86\/revisions"}],"predecessor-version":[{"id":148,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/posts\/86\/revisions\/148"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/media\/87"}],"wp:attachment":[{"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/media?parent=86"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/categories?post=86"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.aya.io\/blog\/wp-json\/wp\/v2\/tags?post=86"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}