http-cat-rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54497b9383f6690bc586dad711065d9bb6bb589583e34e86a44499af4bb2ec49
-  data.tar.gz: a8ba1f1381eab9dfc6bc1754320fc79da60f49965b00152e112d2f5e7d4e46a8
+  metadata.gz: '0791742ed1e6ca6929799b1d0baa8fc0e3954cd8df323b2c3b50d6999ff16e49'
+  data.tar.gz: a14448d8a91b93d91d5302b795168d9f3eb8b0fb75c34289fc933a394c86dd69
 SHA512:
-  metadata.gz: 282abceebfe10600ba97fc57c9ae30c300c9c0b5960f6c00ce3b10d2541f1e9a8e4a86d62f4d288ea82f417e0bcd45776b654c3e02f78c6b18a2b2bd5af32652
-  data.tar.gz: 03eaa0d98b99bf46ced75a362024a2a7ae4c99f273c5cfa5a2d7d2cc5271b852b6ac4ebf0c5463ba98f52840cdb2f92791745c05aaa3b3024b0b8e522bf3459e
+  metadata.gz: da4f093e927466f231cbc337bff2e3860a2e1d51238dcdb9e1e25163d28acbdb00944f1244fe76558fccaa53f57c5690c3f86200f3634faafe87444863c71116
+  data.tar.gz: c4c388cda49bc6a0a871a71ff10b05fbc30b2a981c84d469d87fa1577b2bb45c7d4d46435e1c476534817e1ccca560d31a27591efb9b33b8b19e261c8df85347

data/README.md

@@ -1,10 +1,62 @@
 # Http::Cat::Rails
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+http-cat-rails is a configurable gem that changes every http-error page in your rails application with an image of a cute
+little cat, that describes _purrfectly_ the error code (credits for the default images to https://http.cat)
+
+![Example](images/example.png)
+
+## Configuration
+
+This gem is highly customizable: you could even decide to self host your own error images, and use them.  
+To change this gem's behaviour, you can create a http_cat_rails.rb inside /config/initializers, and structure it as
+follows:
+
+```ruby
+Http::Cat::Rails.configure do |c|
+  c.base_url = "https://www.myurl.com/"
+  c.status_codes = { "404": "code_name", "500": "code_name_2" }
+  c.layout = "application"
+  c.extension = :jpg
+end
+```
+
+In this example, if an error 404 is raised, your page will load an image inside your application.html.erb from the following
+url: "https://www.myurl.com/404.jpg"
+
+### Base Url (default: "https://http.cat/")
+
+This option is used to set the base url to retrieve images
+
+### Status Codes (default: _a very long hash_)
+
+This option is used to pass an Hash of status codes, to limit them, or change the url visited. The value of each
+element must be **unique**, since it's used to define a function.
+
+### Layout (default: "layout_default")
+
+- "application" to embed http error page inside your application.html.erb
+- false to don't have a layout
+- "layout_default" (default option: just a black background)
+- "custom_error_layout" to embed http error page inside "/views/layouts/custom_error_layout.html.erb"
+
+### Extension (default: :jpg)
+
+Extension to insert in the url. Can also be false or nil, to dont include an extension
+
+### CSS
+
+The img tag that contains the image has the following class: "http_error_image"  
+You can customize its style using that
+
+## Summary
+
+url_to_visit:
+```ruby
+"#{base_url}#{code_of_this_error}#{".#{extension}" if extension}"
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +64,34 @@ gem "http-cat-rails"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install http-cat-rails
 ```
 
+Then, you'll need to add this line to your application.rb:
+
+```ruby
+config.exceptions_app = self.routes
+```
+
+## Troubleshooting
+
+This gem won't work if your application.rb or <your_environment>.rb contains the following line
+
+```ruby
+config.consider_all_requests_local = true
+```
+
 ## Contributing
-Contribution directions go here.
+
+It's a small project, but if you want to contribute feel free to send a Pull Request, or open an Issue
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/errors_controller.rb

@@ -2,7 +2,7 @@ class ErrorsController < ApplicationController
   Http::Cat::Rails.status_codes.each do |code, desc|
     define_method(desc.downcase.gsub(' ', '_')) do
       @code = code
-      render 'error', layout: false
+      render 'error', layout: Http::Cat::Rails.layout
     end
   end
 end

data/app/views/errors/error.html.erb

@@ -1,5 +1 @@
-<body style="margin: 0">
-  <div style="width: 100vw; height: 100vh; background: black; display: flex; align-items: center; justify-content: center">
-    <%= image_tag "#{Http::Cat::Rails.base_url}#{@code}.jpg", width: "50%" %>
-  </div>
-</body>
+<%= image_tag "#{Http::Cat::Rails.base_url}#{@code}#{".#{Http::Cat::Rails.extension}" if Http::Cat::Rails.extension}", width: "50%", class: "http_error_image" %>

data/app/views/layouts/layout_default.html.erb

@@ -0,0 +1,5 @@
+<body style="margin: 0">
+  <div style="width: 100vw; height: 100vh; background: black; display: flex; align-items: center; justify-content: center">
+    <%= yield %>
+  </div>
+</body>

data/lib/http/cat/configuration.rb

@@ -28,10 +28,12 @@ module Http
                           '509': 'Bandwidth Limit Exceeded', '510': 'Not Extended', '511': 'Network Authentication Required',
                           '521': 'Web Server Is Down', '522': 'Connection Timed Out', '523': 'Origin Is Unreachable',
                           '525': 'SSL Handshake Failed', '530': 'Site Frozen', '599': 'Network Connect Timeout Error' },
-          base_url: "https://http.cat/"
+          base_url: "https://http.cat/",
+          extension: :jpg,
+          layout: "layout_default"
         }.freeze
 
-        attr_writer :status_codes, :base_url
+        attr_writer :status_codes, :base_url, :extension, :layout
 
         def configure
           yield self
@@ -45,6 +47,13 @@ module Http
           @base_url || DEFAULTS[:base_url]
         end
 
+        def extension
+          @extension || DEFAULTS[:extension]
+        end
+
+        def layout
+          @layout || DEFAULTS[:layout]
+        end
       end
     end
   end

data/lib/http/cat/rails/version.rb

@@ -1,7 +1,7 @@
 module Http
   module Cat
     module Rails
-      VERSION = "1.0.0"
+      VERSION = "1.1.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-cat-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gamberi Elia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,6 +36,7 @@ files:
 - Rakefile
 - app/controllers/errors_controller.rb
 - app/views/errors/error.html.erb
+- app/views/layouts/layout_default.html.erb
 - config/routes.rb
 - lib/http/cat/configuration.rb
 - lib/http/cat/rails.rb