httpstatus-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 651e156cb21cf97aa967d53d2b8837afed7bd33b699111b7f1df2046b02b13db
+  data.tar.gz: fe69ab42c90b162ecd30f331faca64820df043fdbc3786e94664b386c9bc7ec7
+SHA512:
+  metadata.gz: 3c88c51b1fa2d2e24c8c7da40f209bce89797158b2ee0b5bceb8d092fdb5a1087dba683761fee6f19f07ce5821a6d19c87fe2cfc2fdbea7ec13e385d43c3e802
+  data.tar.gz: b8306f03fe7b5d9474e1ec3bc6d0e83c014278bfcbfa2e32e55e0ddab717124a06aeceb91be4379a4460870a83f0043e8b70c02590b6369326e9d71a78939f0c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Julien Dargelos
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,195 @@
+# Http Status Rails
+This gem makes http status rendering cool. It provides a minimal rendering content for every status and format included in Ruby On Rails.
+
+## Usage
+
+### Basic
+
+To render a status in a controller, you can just call the `render_status` method:
+
+```ruby
+def show
+ @user = User.find_by id: params[:id]
+ render_status :not_found if @user.nil?
+end
+```
+
+Depending on the request format, it will respond with a basic message:
+
+#### HTML
+
+```html
+<!-- Wrapped into layouts/application by default -->
+<h1>404 Not Found</h1>
+<p>The page you are looking for does not exist.</p>
+```
+
+#### JSON
+
+```json
+{
+  "status": 404,
+  "title": "Not Found",
+  "message": "The page you are looking for does not exist."
+}
+```
+
+#### Formats supported by default
+- text
+- json
+- yaml
+- xml
+- svg
+- js
+- html
+- rss
+- atom
+- ics
+- csv
+
+If the request format isn't in this list and you haven't created any template to handle it, the server will respond with a **html** format (The *Restrict render format* section explain how to customize this behavior).
+
+You can also explicitly set the rendering format or the layout:
+
+```ruby
+render_status :bad_request, format: :js, layout: 'layouts/status'
+# Set layout to false if you doesn't want any layout
+# If the layout isn't found for the given format, it's assumed to be false
+```
+
+The response could be:
+
+```javascript
+// Asuming that layouts/status.js.erb wraps JavaScript into a jQuery callback
+$(function() {
+  window.http = { "code": 400, "title": "Bad Request", "message": "The server cannot or will not process the request due to something that is perceived to be a client error." }
+});
+```
+
+### Templating
+
+You can override these responses or create new ones by adding `status` named templates in the `app/views/http` folder. (eg: `app/views/http/status.html.erb`, `app/views/http/status.csv.erb`)
+
+You'll have access to a `@status` variable which contains the following methods:
+- `key`: The symbol you provided to the `render_status` method. (If this symbol isn't registered by Rails within valid http status, it'll be replaced by `:internal_error`)
+- `code`: The code corresponding to the status. (eg: for `:not_found` it'll be `404`)
+- `title`: The title of the status (eg: for `:not_found` it'll be «*Not Found*»)
+- `message`: The message of the status (eg: for `:not_found` it'll be «*The page you are looking for does not exist.*»)
+- `error?`: Indicates if the status is considered as an error (4xx and 5xx codes).
+
+### Layout
+
+You can configure the layout you want to use in your controller with the `status_layout` method:
+
+```
+class ApplicationController < ActionController::Base
+    status_layout 'status' # By default: 'application'
+    # If the layout isn't found for the current format, it's assumed to be false
+end
+```
+
+### Localizing
+
+This gem uses `I18n` to provide localized contents. You can override or translate these contents by adding new yaml keys under the `config/locales` folder:
+
+```yaml
+fr:
+  http_status:
+    not_found:
+      code: 404
+      title: Page introuvable
+      message: La page que vous recherchez n'existe pas
+```
+
+Every key which lives directly under `http_status` exactly matches the corresponding status symbol provided by Rails.
+
+### Helpers
+
+#### Handle *Not Found*
+
+You can easily handle *Not Found* status by calling the `handles_not_found_status` method in a controller **and** in the `config/routes.rb` file:
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+  handles_not_found_status
+end
+```
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  handles_not_found_status
+end
+```
+
+This method will respond with a *Not Found* page (in html, json, ...) when a record isn't found (eg: `User.find params[:id]`), or when there is any routing problem (controller not found, action not found).
+
+#### Handle generic errors (as error 500)
+
+You can easily handle generic exceptions within your controller by calling the `handles_error_status` method.
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+  handles_error_status
+end
+```
+
+This method will respond with a *Internal Server Error* page (in html, json, ...) when any error occurs while handling the request.
+
+#### Restrict render formats
+
+Http status will all be rendered in json, whatever the request format is:
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  status_formats only: :json
+end
+```
+
+Http status will all be rendered in json or html, but will fallback on html because it's the first one:
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  status_formats only: [:html, :json]
+end
+```
+
+Http status will be rendered in html for csv, yaml and rss formats:
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  status_formats except: [:csv, :yaml, :rss]
+end
+```
+
+Http status will be rendered in json for csv, yaml and rss formats, or when the format is unknown, or when json is the original request format. The status will be rendered in html when it's the original request format:
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  status_formats except: [:csv, :yaml, :rss], only: [:json, :html]
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'httpstatus-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install httpstatus-rails
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Httpstatus::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/views/http/status.atom.erb

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <title><%= @status.code %> <%= @status.title %></title>
+  <subtitle><%= @status.message %></subtitle>
+</feed>

data/app/views/http/status.csv.erb

@@ -0,0 +1 @@
+<%= @status %>

data/app/views/http/status.html.erb

@@ -0,0 +1,2 @@
+<h1><%= @status.code %> <%= @status.title %></h1>
+<p><%= @status.message %></p>

data/app/views/http/status.ics.erb

@@ -0,0 +1,17 @@
+BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+VERSION:2.0
+X-WR-CALNAME:<%= @status.code %> <%= @status.title %>
+METHOD:PUBLISH
+PRODID:-//Apple Inc.//Mac OS X 10.12.5//EN
+BEGIN:VEVENT
+CREATED:19971210T000000Z
+UID:56A7A602-B272-48BB-B9CB-BB5FC227C721
+DTEND;VALUE=DATE:19971210
+SUMMARY:<%= @status.code %> <%= @status.title %>
+DTSTART;VALUE=DATE:19971210
+DTSTAMP:19971210T000000Z
+SEQUENCE:0
+DESCRIPTION:<%= @status.message %>
+END:VEVENT
+END:VCALENDAR

data/app/views/http/status.js.erb

@@ -0,0 +1 @@
+window.http = <%= @status.to_json %>;

data/app/views/http/status.json.erb

@@ -0,0 +1 @@
+<%= @status.to_json %>

data/app/views/http/status.rss.erb

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title><%= @status.code %> <%= @status.title %></title>
+        <description><%= @status.message %></description>
+    </channel>
+</rss>

data/app/views/http/status.svg.erb

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg">
+  <style>text { font-family: sans-serif }</style>
+  <text x="10" y="30" font-size="20"><%= @status.code %> <%= @status.title %></text>
+  <text x="10" y="50" font-size="14"><%= @status.message %></text>
+</svg>

data/app/views/http/status.txt.erb

@@ -0,0 +1 @@
+<%= @status %>

data/app/views/http/status.xml.erb

@@ -0,0 +1 @@
+<%= @status.to_xml %>

data/app/views/http/status.yaml.erb

@@ -0,0 +1 @@
+<%= @status.to_yaml %>

data/config/locales/en.yml

@@ -0,0 +1,212 @@
+en:
+  http_status:
+
+    # 1xx Informational
+    continue:
+      code: 100
+      title: Continue
+      message: The initial part of a request has been received and has not yet been rejected by the server. The server intends to send a final response after the request has been fully received and acted upon.
+    switching_protocols:
+      code: 101
+      title: Switching Protocols
+      message: The server understands and is willing to comply with the client's request, via the Upgrade header field, for a change in the application protocol being used on this connection.
+    processing:
+      code: 102
+      title: Processing
+      message: An interim response used to inform the client that the server has accepted the complete request, but has not yet completed it.
+
+    # 2xx Success
+    ok:
+      code: 200
+      title: OK
+      message: The request has succeeded.
+    created:
+      code: 201
+      title: Created
+      message: The request has been fulfilled and has resulted in one or more new resources being created.
+    accepted:
+      code: 202
+      title: Accepted
+      message: The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.
+    non_authoritative_information:
+      code: 203
+      title: Non-authoritative Information
+      message: The request was successful but the enclosed payload has been modified from that of the origin server's 200 OK response by a transforming proxy.
+    no_content:
+      code: 204
+      title: No Content
+      message: The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
+    reset_content:
+      code: 205
+      title: Reset Content
+      message: The server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server.
+    partial_content:
+      code: 206
+      title: Partial Content
+      message: The server is successfully fulfilling a range request for the target resource by transferring one or more parts of the selected representation that correspond to the satisfiable ranges found in the request's Range header field.
+    multi_status:
+      code: 207
+      title: Multi-Status
+      message: A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.
+    im_used:
+      code: 226
+      title: IM Used
+      message: The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
+
+    # 3xx Redirection
+    multiple_choices:
+      code: 300
+      title: Multiple Choices
+      message: The target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.
+    moved_permanently:
+      code: 301
+      title: Moved Permanently
+      message: The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.
+    found:
+      code: 302
+      title: Found
+      message: The target resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client ought to continue to use the effective request URI for future requests.
+    see_other:
+      code: 303
+      title: See Other
+      message: The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request.
+    not_modified:
+      code: 304
+      title: Not Modified
+      message: A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to false.
+    use_proxy:
+      code: 305
+      title: Use Proxy
+      message: The requested resource must be accessed through the proxy given by the Location field.
+    temporary_redirect:
+      code: 307
+      title: Temporary Redirect
+      message: The target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
+
+    # 4xx Client Error
+    bad_request:
+      code: 400
+      title: Bad Request
+      message: The server cannot or will not process the request due to something that is perceived to be a client error.
+    unauthorized:
+      code: 401
+      title: Unauthorized
+      message: The request has not been applied because it lacks valid authentication credentials for the target resource.
+    payment_required:
+      code: 402
+      title: Payment Required
+      message: This code is reserved for future use.
+    forbidden:
+      code: 403
+      title: Forbidden
+      message: The server understood the request but refuses to authorize it.
+    not_found:
+      code: 404
+      title: Not Found
+      message: The page you are looking for does not exist.
+    method_not_allowed:
+      code: 405
+      title: Method Not Allowed
+      message: The method received in the request-line is known by the origin server but not supported by the target resource.
+    not_acceptable:
+      code: 406
+      title: Not Acceptable
+      message: The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation.
+    proxy_authentication_required:
+      code: 407
+      title: Proxy Authentication Required
+      message: The request has not been applied because it lacks valid authentication credentials for the target resource. The client needs to authenticate itself in order to use a proxy.
+    request_timeout:
+      code: 408
+      title: Request Timeout
+      message: The server did not receive a complete request message within the time that it was prepared to wait.
+    conflict:
+      code: 409
+      title: Conflict
+      message: The request could not be completed due to a conflict with the current state of the target resource.
+    gone:
+      code: 410
+      title: Gone
+      message: The target resource is no longer available at the origin server and that this condition is likely to be permanent.
+    length_required:
+      code: 411
+      title: Length Required
+      message: The server refuses to accept the request without a defined Content-Length.
+    precondition_failed:
+      code: 412
+      title: Precondition Failed
+      message: One or more conditions given in the request header fields evaluated to false when tested on the server.
+    payload_too_large:
+      code: 413
+      title: Payload Too Large
+      message: The server is refusing to process a request because the request payload is larger than the server is willing or able to process.
+    request_uri_too_long:
+      code: 414
+      title: Request-URI Too Long
+      message: The server is refusing to service the request because the request-target is longer than the server is willing to interpret.
+    unsupported_media_type:
+      code: 415
+      title: Unsupported Media Type
+      message: The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.
+    requested_range_not_satisfiable:
+      code: 416
+      title: Requested Range Not Satisfiable
+      message: None of the ranges in the request's Range header field overlap the current extent of the selected resource or that the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges.
+    expectation_failed:
+      code: 417
+      title: Expectation Failed
+      message: The expectation given in the request's Expect header field could not be met by at least one of the inbound servers.
+    unprocessable_entity:
+      code: 422
+      title: Unprocessable Entity
+      message: The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
+    locked:
+      code: 423
+      title: Locked
+      message: The source or destination resource of a method is locked.
+    failed_dependency:
+      code: 424
+      title: Failed Dependency
+      message: The method could not be performed on the resource because the requested action depended on another action and that action failed.
+    upgrade_required:
+      code: 426
+      title: Upgrade Required
+      message: The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
+
+    # 5xx Server Error
+    internal_server_error:
+      code: 500
+      title: Internal Server Error
+      message: We're sorry but something went wrong.
+    not_implemented:
+      code: 501
+      title: Not Implemented
+      message: The server does not support the functionality required to fulfill the request.
+    bad_gateway:
+      code: 502
+      title: Bad Gateway
+      message: The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
+    service_unavailable:
+      code: 503
+      title: Service Unavailable
+      message: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
+    gateway_timeout:
+      code: 504
+      title: Gateway Timeout
+      message: The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
+    http_version_not_supported:
+      code: 505
+      title: HTTP Version Not Supported
+      message: The server does not support, or refuses to support, the major version of HTTP that was used in the request message.
+    insufficient_storage:
+      code: 507
+      title: Insufficient Storage
+      message: The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
+    loop_detected:
+      code: 508
+      title: Loop Detected
+      message: The server terminated an operation because it encountered an infinite loop while processing a request with infinite depth.
+    not_extended:
+      code: 510
+      title: Not Extended
+      message: The policy for accessing the resource has not been met in the request.

data/config/locales/fr.yml

@@ -0,0 +1,212 @@
+fr:
+  http_status:
+
+    # 1xx Informational
+    continue:
+      code: 100
+      title: Continuer
+      message: La partie initiale de la requête a bien été reçue et le client peut continuer avec la fin de sa requête.
+    switching_protocols:
+      code: 101
+      title: Changement de protocole
+      message: Le client a demandé au serveur d'utiliser un autre protocole que celui actuellement utilisé, et le serveur accepte cette requête.
+    processing:
+      code: 102
+      title: Traîtement
+      message: Traitement en cours.
+
+    # 2xx Success
+    ok:
+      code: 200
+      title: OK
+      message: Requête traitée avec succès.
+    created:
+      code: 201
+      title: Créé
+      message: La requête a été traitée avec succès et une ou plusieurs resources ont été créées.
+    accepted:
+      code: 202
+      title: Accepté
+      message: La requête a éré traitée, mais le serveur ne garantit pas un résultat.
+    non_authoritative_information:
+      code: 203
+      title: Information non certifiée
+      message: L'information retournée n'a pas été générée par le serveur HTTP mais par une autre source non authentifiée.
+    no_content:
+      code: 204
+      title: Pas de contenu
+      message: Le serveur HTTP a correctement traité la requête mais il n'y a pas d'information à envoyer en retour.
+    reset_content:
+      code: 205
+      title: Contenu réinitialisé
+      message: Le client doit remettre à zéro le formulaire utilisé dans cette transaction.
+    partial_content:
+      code: 206
+      title: Contenu partiel
+      message: Le serveur retourne une partie seulement de la taille demandée.
+    multi_status:
+      code: 207
+      title: Statuts multiples
+      message: Réponse multiple.
+    im_used:
+      code: 226
+      title: IM utilisé
+      message: Le serveur a accompli la requête pour la ressource, et la réponse est une représentation du résultat d'une ou plusieurs manipulations d'instances appliquées à l'instance actuelle.
+
+    # 3xx Redirection
+    multiple_choices:
+      code: 300
+      title: Choix multiples
+      message: L'url demandée concerne plus d'une ressource.
+    moved_permanently:
+      code: 301
+      title: Changement d'adresse définitif
+      message: La ressource demandée possède une nouvelle adresse.
+    found:
+      code: 302
+      title: Changement d'adresse temporaire
+      message: La ressource demandée réside temporairement à une adresse différente.
+    see_other:
+      code: 303
+      title: Voir ailleurs
+      message: L'url spécifiée est disponible à une autre adresse.
+    not_modified:
+      code: 304
+      title: Non modifié
+      message: Le navigateur web a effectué une requête GET conditionnelle et l'accès est autorisé, mais le document n'a pas été modifié.
+    use_proxy:
+      code: 305
+      title: Utiliser le proxy
+      message: L'adresse spécifiée ne peut être atteinte qu'à travers le proxy.
+    temporary_redirect:
+      code: 307
+      title: Redirection temporaire
+      message: La resource spécifiée réside temporairement à une autre adresse.
+
+    # 4xx Client Error
+    bad_request:
+      code: 400
+      title: Mauvaise requête
+      message: La requête HTTP n'a pas pu être comprise par le serveur en raison d'une syntaxe erronée.
+    unauthorized:
+      code: 401
+      title: Non autorisé
+      message: La requête nécessite une identification de l'utilisateur.
+    payment_required:
+      code: 402
+      title: Paiement exigé
+      message: Ce code est réservé pour un usage futur.
+    forbidden:
+      code: 403
+      title: Interdit
+      message: Le serveur HTTP a compris la requête, mais refuse de la traiter.
+    not_found:
+      code: 404
+      title: Page introuvable
+      message: La page que vous recherchez n'existe pas.
+    method_not_allowed:
+      code: 405
+      title: Méthode non autorisée
+      message: La méthode utilisée par le client n'est pas supportée pour cette url.
+    not_acceptable:
+      code: 406
+      title: Aucun disponible
+      message: L'adresse spécifiée existe, mais pas dans le format préféré du client.
+    proxy_authentication_required:
+      code: 407
+      title: Authentification proxy exigée
+      message: Le serveur proxy exige une authentification du client avant de transmettre la requête.
+    request_timeout:
+      code: 408
+      title: La requête a expiré
+      message: Le client n'a pas présenté une requête complète pendant le délai maximal qui lui était imparti, et le serveur a abandonné la connexion.
+    conflict:
+      code: 409
+      title: Conflit
+      message: La requête entre en conflit avec une autre requête ou avec la configuration du serveur.
+    gone:
+      code: 410
+      title: Parti
+      message: L'adresse demandée n'existe plus et a été définitivement supprimée du serveur.
+    length_required:
+      code: 411
+      title: Longueur exigée
+      message: Le serveur a besoin de connaître la taille de cette requête pour pouvoir y répondre.
+    precondition_failed:
+      code: 412
+      title: Précondition échouée
+      message: Les conditions spécifiées dans la requête ne sont pas remplies.
+    payload_too_large:
+      code: 413
+      title: Corps de requête trop grand
+      message: Le serveur ne peut traiter la requête car la taille de son contenu est trop importante.
+    request_uri_too_long:
+      code: 414
+      title: Url trop longue
+      message: Le serveur ne peut traiter la requête car la taille de l'url est trop importante.
+    unsupported_media_type:
+      code: 415
+      title: Format non supporté
+      message: Le serveur ne peut traiter la requête car son contenu est écrit dans un format non supporté.
+    requested_range_not_satisfiable:
+      code: 416
+      title: Plage demandée invalide
+      message: Le sous-ensemble de recherche spécifié est invalide.
+    expectation_failed:
+      code: 417
+      title: Comportement erroné
+      message: Le comportement prévu pour le serveur n'est pas supporté.
+    unprocessable_entity:
+      code: 422
+      title: Impossiblde traîter l'entité
+      message: L’entité fournie avec la requête est incompréhensible ou incomplète.
+    locked:
+      code: 423
+      title: Verouillé
+      message: L’opération ne peut avoir lieu car la ressource est verrouillée.
+    failed_dependency:
+      code: 424
+      title: Échec de la méthode
+      message: Une méthode de la transaction a échoué.
+    upgrade_required:
+      code: 426
+      title: Mise à niveau requise
+      message: Le client devrait changer de protocole.
+
+    # 5xx Server Error
+    internal_server_error:
+      code: 500
+      title: Erreur interne du serveur
+      message: Nous sommes désolé mais quelque chose n'a pas fonctionné...
+    not_implemented:
+      code: 501
+      title: Non implémenté
+      message: Fonctionnalité réclamée non supportée par le serveur.
+    bad_gateway:
+      code: 502
+      title: Mauvaise passerelle
+      message: La passerelle a fourni une réponse invalide.
+    service_unavailable:
+      code: 503
+      title: Service indisponible
+      message: Le serveur HTTP est actuellement incapable de traiter la requête en raison d'une surcharge temporaire ou d'une opération de maintenance.
+    gateway_timeout:
+      code: 504
+      title: Passerelle hors-délai
+      message: La passerrelle n'a pas présenté une réponse complète pendant le délai maximal qui lui était imparti, et le serveur a abandonné la connexion.
+    http_version_not_supported:
+      code: 505
+      title: Version de HTTP non supportée
+      message: La version du protocole HTTP utilisée dans cette requête n'est pas supportée par le serveur.
+    insufficient_storage:
+      code: 507
+      title: Espace insuffisant
+      message: Espace insuffisant pour modifier les propriétés ou construire la collection.
+    loop_detected:
+      code: 508
+      title: Boucle détectée
+      message: Boucle dans une mise en relation de ressources.
+    not_extended:
+      code: 510
+      title: Non étendu
+      message: La requête ne respecte pas la politique d'accès aux ressources HTTP étendues.

data/lib/httpstatus/core_ext.rb

@@ -0,0 +1,2 @@
+require __dir__ + '/core_ext/action_controller'
+require __dir__ + '/core_ext/mapper'

data/lib/httpstatus/core_ext/action_controller.rb

@@ -0,0 +1,82 @@
+ActionController::Base.class_eval do
+  DEFAULT_STATUS_LAYOUT = 'application'
+
+  class << self
+    def status_format?(format)
+      (status_formats[:only].include?(format) || status_formats[:only].empty?) && !status_formats[:except].include?(format)
+    end
+
+    def status_formats(only: nil, except: nil)
+      @status_formats = { only: [], except: [] } unless @status_formats.is_a? Hash
+
+      only = only.to_sym if only.is_a? String
+      only = [only] if only.is_a? Symbol
+
+      except = only.to_sym if only.is_a? String
+      except = [only] if only.is_a? Symbol
+
+      if only.is_a? Array
+        @status_formats[:only] = (@status_formats[:only] + only).uniq
+      end
+
+      if except.is_a? Array
+        @status_formats[:except] = (@status_formats[:except] + except).uniq
+        @status_formats[:only] -= except
+      end
+
+      @status_formats
+    end
+    alias_method :status_format, :status_formats
+
+    def status_layout(*name)
+      @status_layout = name.first if name.any?
+      @status_layout == false ? nil : (@status_layout || DEFAULT_STATUS_LAYOUT)
+    end
+  end
+
+  protected
+
+  def status_format?(format)
+    lookup_context.exists?('http/status', [], false, [], formats: [format]) && self.class.status_format?(format)
+  end
+
+  def render_status(status, format: nil, layout: nil)
+    format = (format.present? ? format : request.format).to_sym
+    format = self.class.status_formats[:only].first || :html unless status_format? format
+    layout = layout.nil? ? self.class.status_layout : layout
+    layout = false unless lookup_context.exists? layout, [], false, formats: [format]
+    layout = "layouts/#{layout}" unless layout == false
+
+    @status = Httpstatus::Status.new status
+    render 'http/status', formats: [format], layout: layout, status: @status.key
+  end
+
+  class << self
+    def status_action(*status)
+      status.each do |_status|
+        unless instance_methods.include? _status
+          define_method _status do |*_, format: nil, layout: nil|
+            render_status _status, format: format, layout: layout
+          end
+        end
+      end
+    end
+
+    def handles_error_status
+      status_action :internal_server_error
+      skip_before_action :verify_authenticity_token, only: :internal_server_error, if: -> { request.format.js? }
+      rescue_from Exception, with: :internal_server_error
+    end
+
+    def handles_not_found_status
+      status_action :not_found
+      skip_before_action :verify_authenticity_token, only: :not_found, if: -> { request.format.js? }
+      rescue_from *[
+        ActiveRecord::RecordNotFound,
+        ActionController::RoutingError,
+        ActionController::UnknownFormat,
+        ::AbstractController::ActionNotFound
+      ], with: :not_found
+    end
+  end
+end

data/lib/httpstatus/core_ext/mapper.rb

@@ -0,0 +1,5 @@
+ActionDispatch::Routing::Mapper.class_eval do
+  def handles_not_found_status
+    match '*path' => 'application#not_found', via: :all
+  end
+end

data/lib/httpstatus/engine.rb

@@ -0,0 +1,4 @@
+module Httpstatus
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/httpstatus/rails.rb

@@ -0,0 +1,9 @@
+require "httpstatus/rails/railtie"
+
+module Httpstatus
+  module Rails
+    require __dir__ + '/engine'
+    require __dir__ + '/core_ext'
+    require __dir__ + '/status'
+  end
+end

data/lib/httpstatus/rails/railtie.rb

@@ -0,0 +1,6 @@
+module Httpstatus
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/httpstatus/rails/version.rb

@@ -0,0 +1,5 @@
+module Httpstatus
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/lib/httpstatus/status.rb

@@ -0,0 +1,74 @@
+module Httpstatus
+  class Status
+    DEFAULT = :internal_server_error
+
+    def initialize key = nil
+      self.key = key
+    end
+
+    def key
+      @key || DEFAULT
+    end
+
+    def key= v
+      @key = v.is_a?(Symbol) ? v : (v.is_a?(String) ? v.to_sym : nil)
+      default! unless valid?
+    end
+
+    def code
+      i18n :code
+    end
+
+    def title
+      i18n :title
+    end
+
+    def message
+      i18n :message
+    end
+
+    def error?
+      (400..599) === code
+    end
+
+    def default!
+      @key = nil
+    end
+
+    def default?
+      status.key == DEFAULT
+    end
+
+    def to_hash *options
+      { status: code, title: title, message: message }
+    end
+    alias_method :to_h, :to_hash
+    alias_method :as_json, :to_hash
+
+    def to_s
+      "#{code} #{title}\n#{message}"
+    end
+
+    def to_json(*options)
+      to_h.to_json(*options).html_safe
+    end
+
+    def to_yaml(*options)
+      to_h.to_yaml(*options).html_safe
+    end
+
+    def to_xml(*options)
+      to_h.to_xml(*options).html_safe
+    end
+
+    protected
+
+    def valid?
+      code.is_a?(Fixnum) && title.is_a?(String) && message.is_a?(String)
+    end
+
+    def i18n(property)
+      I18n.t "http_status.#{key}.#{property}"
+    end
+  end
+end

data/lib/tasks/httpstatus/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :httpstatus_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: httpstatus-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Dargelos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0.rc2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a minimal and customizable rendering content for every
+  status and format included in Rails.
+email:
+- contact@juliendargelos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/http/status.atom.erb
+- app/views/http/status.csv.erb
+- app/views/http/status.html.erb
+- app/views/http/status.ics.erb
+- app/views/http/status.js.erb
+- app/views/http/status.json.erb
+- app/views/http/status.rss.erb
+- app/views/http/status.svg.erb
+- app/views/http/status.txt.erb
+- app/views/http/status.xml.erb
+- app/views/http/status.yaml.erb
+- config/locales/en.yml
+- config/locales/fr.yml
+- lib/httpstatus/core_ext.rb
+- lib/httpstatus/core_ext/action_controller.rb
+- lib/httpstatus/core_ext/mapper.rb
+- lib/httpstatus/engine.rb
+- lib/httpstatus/rails.rb
+- lib/httpstatus/rails/railtie.rb
+- lib/httpstatus/rails/version.rb
+- lib/httpstatus/status.rb
+- lib/tasks/httpstatus/rails_tasks.rake
+homepage: https://www.github.com/juliendargelos/httpstatus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Makes http status rendering cool.
+test_files: []