rest_framework 0.8.16 → 0.8.17

data/docs/index.md

@@ -0,0 +1,133 @@
+---
+---
+
+# 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: [demo.rails-rest-framework.com](https://demo.rails-rest-framework.com)
+
+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/lib/rest_framework/serializers.rb

@@ -281,7 +281,7 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
           end
         else
           self.define_singleton_method(f) do |record|
-            next record.send(f).map { |x| x.attachment&.url }
+            next record.send(f).map(&:url)
           end
         end
       elsif @model.method_defined?(f)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.8.16
+  version: 0.8.17
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,6 +40,23 @@ files:
 - app/views/rest_framework/_raw_form.html.erb
 - app/views/rest_framework/_route.html.erb
 - app/views/rest_framework/_routes.html.erb
+- docs/CNAME
+- docs/Gemfile
+- docs/Gemfile.lock
+- docs/_config.yml
+- docs/_guide/1_routers.md
+- docs/_guide/2_controller_mixins.md
+- docs/_guide/3_serializers.md
+- docs/_guide/4_filtering_and_ordering.md
+- docs/_guide/5_pagination.md
+- docs/_includes/anchor_headings.html
+- docs/_includes/head.html
+- docs/_includes/header.html
+- docs/_layouts/default.html
+- docs/assets/css/rest_framework.css
+- docs/assets/images/favicon.ico
+- docs/assets/js/rest_framework.js
+- docs/index.md
 - lib/rest_framework.rb
 - lib/rest_framework/controller_mixins.rb
 - lib/rest_framework/controller_mixins/base.rb