rest_framework 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71a3fea7904490cd834aff65231d4a18804e8cd487a07314e475a73d9a6500e
-  data.tar.gz: bde5421c92b4c960bc9b09b369a36b2d4df463b0722490c35cbaf00cdb6b6a66
+  metadata.gz: 0ae8173bd8209fe5250ec9fe3a749d41d46307f7948d1c7597921ab5b4d2cae2
+  data.tar.gz: 3ca1aa88dbde70ad327a65778bfa7e2a90499111dbf6e16a9d084aba2df42328
 SHA512:
-  metadata.gz: 21db95368e8223a1b086e63b9724eb7cb35cb5eb42db9eedb5eca557662be24363f225ab69fb98d2996152c69d58218a5156fdaba1345330660c974313b3f912
-  data.tar.gz: 2f32d14d77eb8f60b29019afd81f6b926e2bd97268b2cd6d4828698adf4b66debea2959f00403913a6e74a970f858d960a4d3c9268a1f6fcccd9549c1aca992e
+  metadata.gz: bd56096773684dc55324b6a8d3fed2a7d214201fd9ac516862a24a111ecedcf70cebf20b61ff264f11a921d67e9a057da4a8b1c2d4c498d07bb042401993e5e3
+  data.tar.gz: 2f9f5b01fa4a956f0047307ed0f9b7523607ad6487fa5f8fa15d9895b7ff814703c048e5a7a0261fad35f11b96f3078641e8b9dd9e897bdbbc15b36c775c084e

data/README.md

@@ -24,6 +24,78 @@ Or install it yourself with:
 
     $ gem install rest_framework
 
+## Usage
+
+### 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:
+
+```
+class ApiController < ApplicationController
+  include RESTFramework::BaseControllerMixin
+  @extra_actions = {test: [:get]}
+
+  def test
+    render inline: "Test successful!"
+  end
+end
+```
+
+`ModelControllerMixin` assists with providing the standard CRUD for your controller.
+
+```
+class Api::MoviesController < ApiController
+  include RESTFramework::ModelControllerMixin
+
+  @recordset = Movie.where(enabled: true)  # by default, @recordset would include all movies
+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:
+
+```
+class Api::ReadOnlyMoviesController < ApiController
+  include RESTFramework::ReadOnlyModelControllerMixin
+
+  @model = Movie
+end
+```
+
+Note that you can also override `get_model` and `get_recordset` instance methods to override the API
+behavior based on each 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 the
+`rest_resource`/`rest_resources` routers provided by this gem. You can also use `rest_root` to route
+the root of your API:
+
+```
+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 :read_only_movies
+  end
+end
+```
+
+Or if you want the API root to be routed to `Api::RootController#root`:
+
+```
+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 :read_only_movies
+  end
+end
+```
+
 ## Development/Testing
 
 After you clone the repository, cd'ing into the directory should create a new gemset if you are
@@ -37,10 +109,10 @@ To run unit tests:
 
     $ rake test:unit
 
-To run integration tests on a sample app:
-
-    $ rake test:app
+To run integration tests:
 
-To run that sample app live:
+    $ rake test:integration
 
-    $ rake test:app:run
+To interact with the integration app, you can `cd test/integration` and operate it via the normal
+Rails interfaces. Ensure you run `rake db:schema:load` before running `rails server` or
+`rails console`.

data/lib/rest_framework/VERSION_STAMP

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/rest_framework/controllers/base.rb

@@ -1,6 +1,9 @@
 module RESTFramework
 
+  # This module provides helpers for mixin `ClassMethods` submodules.
   module ClassMethodHelpers
+
+    # This helper assists in providing reader interfaces for mixin properties.
     def _restframework_attr_reader(property, default: nil)
       method = <<~RUBY
         def #{property}
@@ -14,6 +17,9 @@ module RESTFramework
     end
   end
 
+  # This module provides the common functionality for any controller mixins, a `root` action, and
+  # the ability to route arbitrary actions with `@extra_actions`. This is also where `api_response`
+  # is defined.
   module BaseControllerMixin
     # Default action for API root.
     # TODO: use api_response and show sub-routes.
@@ -47,7 +53,20 @@ module RESTFramework
       # end
 
       _restframework_attr_reader(:extra_actions, default: {})
-      _restframework_attr_reader(:skip_actions, default: [])
+
+      def skip_actions(skip_undefined: true)
+        # first, skip explicitly skipped actions
+        skip = _restframework_try_class_level_variable_get(:skip_actions, default: [])
+
+        # now add methods which don't exist, since we don't want to route those
+        if skip_undefined
+          [:index, :new, :create, :show, :edit, :update, :destroy].each do |a|
+            skip << a unless self.method_defined?(a)
+          end
+        end
+
+        return skip
+      end
     end
 
     def self.included(base)

data/lib/rest_framework/controllers/models.rb

@@ -32,11 +32,14 @@ module RESTFramework
       _restframework_attr_reader(:extra_member_actions, default: {})
 
       # For model-based mixins, `@extra_collection_actions` is synonymous with `@extra_actions`.
-      def extra_actions
-        return (
+      # @param skip_undefined [Boolean] whether we should skip routing undefined actions
+      def extra_actions(skip_undefined: true)
+        actions = (
           _restframework_try_class_level_variable_get(:extra_collection_actions) ||
           _restframework_try_class_level_variable_get(:extra_actions, default: {})
         )
+        actions = actions.select { |a| self.method_defined?(a) } if skip_undefined
+        return actions
       end
     end
 
@@ -109,10 +112,10 @@ module RESTFramework
     end
 
     # Internal interface for get_model, protecting against infinite recursion with get_recordset.
-    private def _get_model(from_internal_get_recordset: false)
+    def _get_model(from_internal_get_recordset: false)
       return @model if @model
       return self.class.model if self.class.model
-      unless from_get_recordset  # prevent infinite recursion
+      unless from_internal_get_recordset  # prevent infinite recursion
         recordset = self._get_recordset(from_internal_get_model: true)
         return (@model = recordset.klass) if recordset
       end
@@ -124,10 +127,10 @@ module RESTFramework
     end
 
     # Internal interface for get_recordset, protecting against infinite recursion with get_model.
-    private def _get_recordset(from_internal_get_model: false)
+    def _get_recordset(from_internal_get_model: false)
       return @recordset if @recordset
       return self.class.recordset if self.class.recordset
-      unless from_get_model  # prevent infinite recursion
+      unless from_internal_get_model  # prevent infinite recursion
         model = self._get_model(from_internal_get_recordset: true)
         return (@recordset = model.all) if model
       end

data/lib/rest_framework/routers.rb

@@ -41,7 +41,8 @@ module ActionDispatch::Routing
     # @param default_singular [Boolean] the default plurality of the resource if the plurality is
     #   not otherwise defined by the controller
     # @param name [Symbol] the resource name, from which path and controller are deduced by default
-    protected def _rest_resources(default_singular, name, **kwargs, &block)
+    # @param skip_undefined [Boolean] whether we should skip routing undefined actions
+    protected def _rest_resources(default_singular, name, skip_undefined: true, **kwargs, &block)
       controller = kwargs[:controller] || name
       if controller.is_a?(Class)
         controller_class = controller
@@ -50,9 +51,7 @@ module ActionDispatch::Routing
       end
 
       # set controller if it's not explicitly set
-      unless kwargs[:controller]
-        kwargs[:controller] = name
-      end
+      kwargs[:controller] = name unless kwargs[:controller]
 
       # determine plural/singular resource
       if kwargs.delete(:force_singular)
@@ -67,10 +66,14 @@ module ActionDispatch::Routing
       resource_method = singular ? :resource : :resources
 
       # call either `resource` or `resources`, passing appropriate modifiers
-      public_send(resource_method, name, except: controller_class.skip_actions, **kwargs) do
+      skip_undefined = kwargs.delete(:skip_undefined) || true
+      skip = controller_class.skip_actions(skip_undefined: skip_undefined)
+      public_send(resource_method, name, except: skip, **kwargs) do
         if controller_class.respond_to?(:extra_member_actions)
           member do
-            controller_class.extra_member_actions.each do |action, methods|
+            actions = controller_class.extra_member_actions
+            actions = actions.select { |k,v| controller_class.method_defined?(k) } if skip_undefined
+            actions.each do |action, methods|
               methods = [methods] if methods.is_a?(Symbol) || methods.is_a?(String)
               methods.each do |m|
                 public_send(m, action)
@@ -80,7 +83,9 @@ module ActionDispatch::Routing
         end
 
         collection do
-          controller_class.extra_actions.each do |action, methods|
+          actions = controller_class.extra_actions
+          actions = actions.select { |k,v| controller_class.method_defined?(k) } if skip_undefined
+          actions.each do |action, methods|
             methods = [methods] if methods.is_a?(Symbol) || methods.is_a?(String)
             methods.each do |m|
               public_send(m, action)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails