rest_framework 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64cf1d1a710b4ee12f57fb30cb23d3ba000a2e9072ff991cb40aaa20c3cdf81b
-  data.tar.gz: 212edeefb3ffecaf05658cfa301cb161e09201e09fe7dd4deb490c152bebe211
+  metadata.gz: c26bdb290be334d911d6270e010568d3674f12a3e63dfa0f51337b242907317c
+  data.tar.gz: '07897cd01fe0f3df22af8d8466b49835d8e1db623b8e6066b407675989e0b9b2'
 SHA512:
-  metadata.gz: 907aef47db6388a52f017d3f6a02f8ca07f4d67c59e68ff0a3004cff559ca7fcf4fe88937a1943b6a8afe81802df18d3b31249cc808dd512689bd5f0c62b2b01
-  data.tar.gz: 871befe2e9b01875d57171188db84a6eca226d2d37cd170c6c3de9b05f8bd75466447276f22a16f64af030d0f5dfb786790ace1edd59fdc4375f7ede7545a175
+  metadata.gz: 71952c62c0f9165d837afbec82168ce11361c6e9655d4c73beabfe0e7de40f18c6cb059a7b76b5bf5fe38a5f6c3b545f8df7c5b60724900cf1d1d32a5b3cb8e8
+  data.tar.gz: 74ed89e118d69516d0bdd6a5cdcfa99e125fa80c45a48af2c99b8c79744041519c3e316a4f82c2737cdb41949a3bf9243c93b90090ab426880778d0b81fb1c61

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Gregory N. Schmit
+Copyright (c) 2023 Gregory N. Schmit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,130 @@
+# Rails REST Framework
+
+[![Gem Version](https://badge.fury.io/rb/rest_framework.svg)](https://badge.fury.io/rb/rest_framework)
+[![Pipeline](https://github.com/gregschmit/rails-rest-framework/actions/workflows/pipeline.yml/badge.svg)](https://github.com/gregschmit/rails-rest-framework/actions/workflows/pipeline.yml)
+[![Coverage](https://coveralls.io/repos/github/gregschmit/rails-rest-framework/badge.svg?branch=master)](https://coveralls.io/github/gregschmit/rails-rest-framework?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ba5df7706cb544d78555/maintainability)](https://codeclimate.com/github/gregschmit/rails-rest-framework/maintainability)
+
+A framework for DRY RESTful APIs in Ruby on Rails.
+
+**The Problem**: Building controllers for APIs usually involves writing a lot of redundant CRUD
+logic, and routing them can be obnoxious. Building and maintaining features like ordering,
+filtering, and pagination can be tedious.
+
+**The Solution**: This framework implements browsable API responses, CRUD actions for your models,
+and features like ordering/filtering/pagination, so you can focus on building awesome APIs.
+
+Website/Guide: [rails-rest-framework.com](https://rails-rest-framework.com)
+
+Demo API: [rails-rest-framework.com/api/demo](https://rails-rest-framework.com/api/demo)
+
+Source: [github.com/gregschmit/rails-rest-framework](https://github.com/gregschmit/rails-rest-framework)
+
+YARD Docs: [rubydoc.info/gems/rest_framework](https://rubydoc.info/gems/rest_framework)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest_framework'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself with:
+
+```shell
+$ gem install rest_framework
+```
+
+## Quick Usage Tutorial
+
+### Controller Mixins
+
+To transform a controller into a RESTful controller, you can either include `BaseControllerMixin`,
+`ReadOnlyModelControllerMixin`, or `ModelControllerMixin`. `BaseControllerMixin` provides a `root`
+action and a simple interface for routing arbitrary additional actions:
+
+```ruby
+class ApiController < ApplicationController
+  include RESTFramework::BaseControllerMixin
+  self.extra_actions = {test: :get}
+
+  def test
+    render api_response({message: "Test successful!"})
+  end
+end
+```
+
+`ModelControllerMixin` assists with providing the standard model CRUD for your controller.
+
+```ruby
+class Api::MoviesController < ApiController
+  include RESTFramework::ModelControllerMixin
+
+  self.recordset = Movie.where(enabled: true)
+end
+```
+
+`ReadOnlyModelControllerMixin` only enables list/show actions, but since we're naming this
+controller in a way that doesn't make the model obvious, we can set that explicitly:
+
+```ruby
+class Api::ReadOnlyMoviesController < ApiController
+  include RESTFramework::ReadOnlyModelControllerMixin
+
+  self.model = Movie
+end
+```
+
+Note that you can also override the `get_recordset` instance method to override the API behavior
+dynamically per-request.
+
+### Routing
+
+You can use Rails' `resource`/`resources` routers to route your API, however if you want
+`extra_actions` / `extra_member_actions` to be routed automatically, then you can use `rest_route`
+for non-resourceful controllers, or `rest_resource` / `rest_resources` resourceful routers. You can
+also use `rest_root` to route the root of your API:
+
+```ruby
+Rails.application.routes.draw do
+  rest_root :api  # will find `api_controller` and route the `root` action to '/api'
+  namespace :api do
+    rest_resources :movies
+    rest_resources :users
+  end
+end
+```
+
+Or if you want the API root to be routed to `Api::RootController#root`:
+
+```ruby
+Rails.application.routes.draw do
+  namespace :api do
+    rest_root  # will route `Api::RootController#root` to '/' in this namespace ('/api')
+    rest_resources :movies
+    rest_resources :users
+  end
+end
+```
+
+## Development/Testing
+
+After you clone the repository, cd'ing into the directory should create a new gemset if you are
+using RVM. Then run `bundle install` to install the appropriate gems.
+
+To run the test suite:
+
+```shell
+$ rails test
+```
+
+The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via
+the usual commands. Ensure you run `rails db:setup` before running `rails server` or
+`rails console`.

data/VERSION

@@ -1 +1 @@
-0.9.4
+0.9.6

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

@@ -8,195 +8,21 @@
     <%= csp_meta_tag rescue nil %>
 
     <%= render partial: "rest_framework/head", cached: true %>
+
+    <%= yield :head %>
   </head>
 
   <body>
     <header>
-      <div class="w-100 m-0 p-0" id="rrfAccentBar"></div>
-      <nav class="navbar py-0" data-bs-theme="dark">
-        <div class="container">
-          <span class="navbar-brand p-0">
-            <h1 title="RRF v<%= RESTFramework::VERSION %>" class="text-light font-weight-light m-0 p-0" style="font-size: 1em">
-              <%= @template_logo_text || "Rails REST Framework" %>
-            </h1>
-          </span>
-          <div class="dropdown ms-auto" id="rrfModeComponent">
-            <button class="btn btn-dark dropdown-toggle rounded-0 bg-black" style="border-color: black" data-bs-toggle="dropdown"></button>
-            <div class="rrf-mode dropdown-menu dropdown-menu-end py-0 rounded-0" style="font-size: .8em; min-width: 0">
-              <button class="dropdown-item text-end" data-rrf-mode-value="system">
-                System<i class="bi bi-circle-half ms-2"></i>
-              </button>
-              <button class="dropdown-item text-end" data-rrf-mode-value="light">
-                Light<i class="bi bi-sun-fill ms-2"></i>
-              </button>
-              <button class="dropdown-item text-end" data-rrf-mode-value="dark">
-                Dark<i class="bi bi-moon-stars-fill ms-2"></i>
-              </button>
-            </div>
-          </div>
-        </div>
-      </nav>
+      <%= render partial: "rest_framework/header" %>
     </header>
     <div class="container py-3">
-      <div class="row">
-        <nav>
-          <ol class="breadcrumb">
-            <%
-              breadcrumbs = request.path.split("/").inject([]) { |breadcrumbs, part|
-                # Ignore blank parts of the path (leading slash or double-slashes).
-                next breadcrumbs if part.blank?
-
-                last_path = breadcrumbs.last&.first || "/"
-                breadcrumbs << [
-                  [last_path, part].join(last_path[-1] == "/" ? "" : "/"),
-                  part,
-                ]
-
-                next breadcrumbs
-              }
-            %>
-            <% breadcrumbs.each_with_index do |(path, label), i| %>
-              <% if i != breadcrumbs.size - 1 %>
-                <li class="breadcrumb-item"><a href="<%= path %>"><%= label %></a></li>
-              <% else %>
-                <li class="breadcrumb-item active"><%= label %></li>
-              <% end %>
-            <% end %>
-          </ol>
-        </nav>
-      </div>
-      <div class="row">
-        <div>
-          <h1 class="m-0"><%= (@header_text if defined? @header_text) || @title %></h1>
-          <div style="float: right">
-            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "DELETE" && r[:action] == "destroy" } %>
-              <button type="button" class="btn btn-danger" onclick="rrfDelete(this)">DELETE</button>
-            <% end %>
-            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "OPTIONS" } %>
-              <button type="button" class="btn btn-primary" onclick="rrfOptions(this)">OPTIONS</button>
-            <% end %>
-            <button type="button" class="btn btn-primary" onclick="rrfGet(this)">GET</button>
-          </div>
-          <% if @description.present? %>
-            <br><br><p style="display: inline-block; margin-bottom: 0"><%= @description %></p>
-          <% end %>
-        </div>
-      </div>
-      <hr/>
-      <div class="row">
-        <div>
-          <pre style="white-space: normal">
-            <code>
-              <strong>
-                <%= request.request_method %>
-                <% if request.method != request.request_method %>
-                  (via <%= request.method %>)
-                <% end %>
-              </strong> <%= request.path %><br>
-            </code>
-          </pre>
-          <pre style="white-space: normal">
-            <code>
-              <strong>HTTP <%= response.status %> <%= response.message %></strong><br>
-              <strong>Content-Type:</strong> <%= response.content_type %>
-            </code>
-          </pre>
-        </div>
-      </div>
-      <% if @json_payload.present? || @xml_payload.present? %>
-        <div class="row">
-          <div>
-            <ul class="nav nav-tabs">
-              <% if @json_payload.present? %>
-                <li class="nav-item">
-                  <a class="nav-link active" href="#tab-json" data-bs-toggle="tab" role="tab">
-                    .json
-                  </a>
-                </li>
-              <% end %>
-              <% if @xml_payload.present? %>
-                <li class="nav-item">
-                  <a class="nav-link" href="#tab-xml" data-bs-toggle="tab" role="tab">
-                    .xml
-                  </a>
-                </li>
-              <% end %>
-            </ul>
-          </div>
-          <div class="tab-content pt-2">
-            <div class="tab-pane fade show active" id="tab-json" role="tabpanel">
-              <% if @json_payload.present? %>
-                <div><pre class="rrf-copy"><code class="auto-hljs language-json"><%=
-                  JSON.pretty_generate(
-                    JSON.parse(@json_payload)
-                  ) unless @json_payload == ''
-                %></code></pre></div>
-              <% end %>
-            </div>
-            <div class="tab-pane fade" id="tab-xml" role="tabpanel">
-              <% if @xml_payload.present? %>
-                <div><pre class="rrf-copy"><code class="auto-hljs language-xml"><%=
-                  CGI.unescapeHTML(@xml_payload)
-                %></code></pre></div>
-              <% end %>
-            </div>
-          </div>
-        </div>
-      <% end %>
-      <% if @route_groups.present? %>
-        <%
-          @is_model_controller = controller.class.included_modules.include?(RESTFramework::ModelControllerMixin)
-        %>
-        <div class="row">
-          <div>
-            <ul class="nav nav-tabs">
-              <li class="nav-item">
-                <a class="nav-link active" href="#tab-routes" data-bs-toggle="tab" role="tab">
-                  Routes
-                </a>
-              </li>
-              <% @_rrf_form_routes_raw = @route_groups.values[0].select { |r|
-                r[:matches_params] && (
-                  r[:verb].in?(["POST", "PUT", "PATCH"]) ||
-                  (r[:verb] == "DELETE" && r[:action] == "destroy_all")
-                )
-              } %>
-              <% @_rrf_form_routes_html = @route_groups.values[0].select { |r|
-                r[:matches_params] && r[:verb].in?(["POST", "PUT", "PATCH"])
-              } %>
-              <% if @_rrf_form_routes_raw.present? %>
-                <li class="nav-item">
-                  <a class="nav-link" href="#tabRawForm" data-bs-toggle="tab" role="tab">
-                    Raw Form
-                  </a>
-                </li>
-              <% end %>
-              <% if @_rrf_form_routes_html.present? && @is_model_controller %>
-                <li class="nav-item">
-                  <a class="nav-link" href="#tabHtmlForm" data-bs-toggle="tab" role="tab">
-                    HTML Form
-                  </a>
-                </li>
-              <% end %>
-            </ul>
-          </div>
-          <div class="tab-content pt-2">
-            <div class="tab-pane fade show active" id="tab-routes" role="tabpanel">
-              <%= render partial: "rest_framework/routes" %>
-            </div>
-            <% if @_rrf_form_routes_raw.present? %>
-              <div class="tab-pane fade" id="tabRawForm" role="tabpanel">
-                <%= render partial: "rest_framework/raw_form" %>
-              </div>
-            <% end %>
-            <% if @_rrf_form_routes_html.present? && @is_model_controller %>
-              <div class="tab-pane fade" id="tabHtmlForm" role="tabpanel">
-                <%= render partial: "rest_framework/html_form" %>
-              </div>
-            <% end %>
-          </div>
-        </div>
-      <% end %>
+      <%= render partial: "rest_framework/breadcrumbs" unless @hide_breadcrumbs %>
+      <%= render partial: "rest_framework/heading" unless @hide_heading %>
+      <%= render partial: "rest_framework/request_metadata" unless @hide_request_metadata %>
+      <%= yield %>
+      <%= render partial: "rest_framework/payloads" if @json_payload.present? || @xml_payload.present? %>
+      <%= render partial: "rest_framework/routes_and_forms" if @route_groups.present? %>
     </div>
   </body>
 </html>

data/app/views/rest_framework/_breadcrumbs.html.erb

@@ -0,0 +1,27 @@
+<div class="row">
+  <nav>
+    <ol class="breadcrumb">
+      <%
+        breadcrumbs = request.path.split("/").inject([]) { |breadcrumbs, part|
+          # Ignore blank parts of the path (leading slash or double-slashes).
+          next breadcrumbs if part.blank?
+
+          last_path = breadcrumbs.last&.first || "/"
+          breadcrumbs << [
+            [last_path, part].join(last_path[-1] == "/" ? "" : "/"),
+            part,
+          ]
+
+          next breadcrumbs
+        }
+      %>
+      <% breadcrumbs.each_with_index do |(path, label), i| %>
+        <% if i != breadcrumbs.size - 1 %>
+          <li class="breadcrumb-item"><a href="<%= path %>"><%= label %></a></li>
+        <% else %>
+          <li class="breadcrumb-item active"><%= label %></li>
+        <% end %>
+      <% end %>
+    </ol>
+  </nav>
+</div>