rest_framework 0.0.8 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a9ae17435876f34d868d88ea187ae8844593a498f6d2d560c3ab2cfe1fa37a
-  data.tar.gz: ea04580ad618ed1e15f28cb29ed079e64beead85d77479a52896c10aed226bc8
+  metadata.gz: ab8e500690ee54da42755e6243047dcc2cd78706c96dae29e18510aef2f9829a
+  data.tar.gz: 9e8c0990b2bf175effea734f306a806de6094984b6dca7cf2899c9c6e77bcc5a
 SHA512:
-  metadata.gz: 3b596fb77e6bf656ce0fd7613ed2498019670b8576b022f6bda349d4f945d1502a2704bffb3d82a8cf2910ee0779f8fbcf2abae69bbd90e7734d59af1f2a8323
-  data.tar.gz: 9c11d18a0805d17adb55b15d2e5b75e563c7e065bf0734e330c2584991ba0301a542466d9ee5d87387ecd97848451656c0740fa5488d77cd3f187b1f8988aacb
+  metadata.gz: 730b8dcf9e9febb6d6adee7672a3bb1d8458498b6c17b1ec483878a5b8d28638a11f15c71745d9ba06d2eb41e64834a7e591390da3d5d64e1daa30b5244046b3
+  data.tar.gz: 544814fbe3bc83bdd6661346bae020ce8f74a0ea8edab9180d88654e09d51b458f5eed5732916c58aff9961da6b6224776d9bc6aff9d01b6519ab0cfe5e2641c

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

@@ -19,7 +19,7 @@
     <div class="container py-3">
       <div class="container">
         <div class="row">
-          <h1><%= @title %></h1>
+          <h1><%= (@header_text if defined? @header_text) || @title %></h1>
         </div>
         <hr/>
         <% if @json_payload || @xml_payload %>
@@ -46,7 +46,7 @@
             <div class="tab-content w-100 pt-3">
               <div class="tab-pane fade show active" id="tab-json" role="tab">
                 <% if @json_payload %>
-                  <div><pre><code class="language-json"><%= JSON.pretty_generate(JSON.parse(@json_payload)) %></code></pre></div>
+                  <div><pre><code class="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="tab">

data/lib/rest_framework/VERSION_STAMP

@@ -1 +1 @@
-0.0.8
+0.0.14

data/lib/rest_framework/controller_mixins/base.rb

@@ -34,8 +34,15 @@ module RESTFramework
           :skip_actions,
           :paginator_class,
         ])
+
+        # skip csrf since this is an API
+        base.skip_before_action(:verify_authenticity_token) rescue nil
+
+        # handle some common exceptions
         base.rescue_from(ActiveRecord::RecordNotFound, with: :record_not_found)
         base.rescue_from(ActiveRecord::RecordInvalid, with: :record_invalid)
+        base.rescue_from(ActiveRecord::RecordNotSaved, with: :record_not_saved)
+        base.rescue_from(ActiveRecord::RecordNotDestroyed, with: :record_not_destroyed)
       end
     end
 
@@ -51,6 +58,14 @@ module RESTFramework
       return api_response({message: "Record not found.", exception: e}, status: 404)
     end
 
+    def record_not_saved(e)
+      return api_response({message: "Record not saved.", exception: e}, status: 406)
+    end
+
+    def record_not_destroyed(e)
+      return api_response({message: "Record not destroyed.", exception: e}, status: 406)
+    end
+
     def _get_routes
       begin
         formatter = ActionDispatch::Routing::ConsoleFormatter::Sheet
@@ -59,42 +74,55 @@ module RESTFramework
       end
       return ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes).format(
         formatter.new
-      ).lines[1..].map { |r| r.split.last(3) }.map { |r|
+      ).lines.drop(1).map { |r| r.split.last(3) }.map { |r|
         {verb: r[0], path: r[1], action: r[2]}
       }.select { |r| r[:path].start_with?(request.path) }
     end
 
-    # Helper alias for `respond_to`/`render`, and replace nil responses with blank ones. `payload`
-    # must be already serialized to Ruby primitives.
+    # Helper alias for `respond_to`/`render`. `payload` should be already serialized to Ruby
+    # primitives.
     def api_response(payload, html_kwargs: nil, json_kwargs: nil, xml_kwargs: nil, **kwargs)
       html_kwargs ||= {}
       json_kwargs ||= {}
       xml_kwargs ||= {}
 
+      # allow blank (no-content) responses
+      @blank = kwargs[:blank]
+
       respond_to do |format|
-        if payload.respond_to?(:to_json)
-          format.json {
-            kwargs = kwargs.merge(json_kwargs)
-            render(json: payload || '', **kwargs)
-          }
-        end
-        if payload.respond_to?(:to_xml)
-          format.xml {
-            kwargs = kwargs.merge(xml_kwargs)
-            render(xml: payload || '', **kwargs)
-          }
+        if @blank
+          format.json {head :no_content}
+          format.xml {head :no_content}
+        else
+          if payload.respond_to?(:to_json)
+            format.json {
+              kwargs = kwargs.merge(json_kwargs)
+              render(json: payload, layout: false, **kwargs)
+            }
+          end
+          if payload.respond_to?(:to_xml)
+            format.xml {
+              kwargs = kwargs.merge(xml_kwargs)
+              render(xml: payload, layout: false, **kwargs)
+            }
+          end
         end
         format.html {
           @payload = payload
-          @json_payload = payload.to_json
-          @xml_payload = payload.to_xml
+          @json_payload = ''
+          @xml_payload = ''
+          unless @blank
+            @json_payload = payload.to_json if payload.respond_to?(:to_json)
+            @xml_payload = payload.to_xml if payload.respond_to?(:to_xml)
+          end
           @template_logo_text ||= "Rails REST Framework"
           @title ||= self.controller_name.camelize
           @routes ||= self._get_routes
           kwargs = kwargs.merge(html_kwargs)
           begin
             render(**kwargs)
-          rescue ActionView::MissingTemplate  # fallback to rest_framework default view
+          rescue ActionView::MissingTemplate  # fallback to rest_framework layout/view
+            kwargs[:layout] = "rest_framework"
             kwargs[:template] = "rest_framework/default"
           end
           render(**kwargs)

data/lib/rest_framework/controller_mixins/models.rb

@@ -13,6 +13,8 @@ module RESTFramework
           :recordset,
           :fields,
           :action_fields,
+          :native_serializer_config,
+          :native_serializer_action_config,
           :filterset_fields,
           :allowed_parameters,
           :allowed_action_parameters,
@@ -29,36 +31,43 @@ module RESTFramework
       return self.class.serializer_class || NativeModelSerializer
     end
 
-    # Get a list of fields for an action (or the current action if none given).
-    def get_fields(action: nil)
+    # Get a list of fields for the current action.
+    def get_fields
       action_fields = self.class.action_fields || {}
-
-      # action will, by default, be the current action name
-      action = action_name.to_sym unless action
+      action = self.action_name.to_sym
 
       # index action should use :list fields if :index is not provided
       action = :list if action == :index && !action_fields.key?(:index)
 
-      return action_fields[action] || self.class.fields || []
+      return (action_fields[action] if action) || self.class.fields || []
     end
 
-    # Get a list of parameters allowed for an action (or the current action if none given).
-    def get_allowed_parameters(action: nil)
-      allowed_action_parameters = self.class.allowed_action_parameters || {}
+    # Get a native serializer config for the current action.
+    def get_native_serializer_config
+      action_serializer_config = self.class.native_serializer_action_config || {}
+      action = self.action_name.to_sym
 
-      # action will, by default, be the current action name
-      action = action_name.to_sym unless action
+      # index action should use :list serializer config if :index is not provided
+      action = :list if action == :index && !action_serializer_config.key?(:index)
+
+      return (action_serializer_config[action] if action) || self.class.native_serializer_config
+    end
+
+    # Get a list of parameters allowed for the current action.
+    def get_allowed_parameters
+      allowed_action_parameters = self.class.allowed_action_parameters || {}
+      action = self.action_name.to_sym
 
       # index action should use :list allowed parameters if :index is not provided
       action = :list if action == :index && !allowed_action_parameters.key?(:index)
 
-      return allowed_action_parameters[action] || self.class.allowed_parameters
+      return (allowed_action_parameters[action] if action) || self.class.allowed_parameters
     end
 
     # Filter the request body for keys in current action's allowed_parameters/fields config.
     def _get_parameter_values_from_request_body
       fields = self.get_allowed_parameters || self.get_fields
-      return @_get_field_values_from_request_body ||= (request.request_parameters.select { |p|
+      return @_get_parameter_values_from_request_body ||= (request.request_parameters.select { |p|
         fields.include?(p.to_sym) || fields.include?(p.to_s)
       })
     end
@@ -68,7 +77,7 @@ module RESTFramework
     # Filter params for keys allowed by the current action's filterset_fields/fields config.
     def _get_filterset_values_from_params
       fields = self.filterset_fields || self.get_fields
-      return @_get_field_values_from_params ||= request.query_parameters.select { |p|
+      return @_get_filterset_values_from_params ||= request.query_parameters.select { |p|
         fields.include?(p.to_sym) || fields.include?(p.to_s)
       }
     end
@@ -178,12 +187,8 @@ module RESTFramework
   module DestroyModelMixin
     def destroy
       @record = self.get_record
-      if @record
-        @record.destroy!
-        api_response('')
-      else
-        api_response({detail: "Method 'DELETE' not allowed."}, status: 405)
-      end
+      @record.destroy!
+      api_response(nil)
     end
   end
 

data/lib/rest_framework/serializers.rb

@@ -7,34 +7,102 @@ module RESTFramework
       @data = data
       @controller = controller
     end
-
-    def is_valid
-      return true
-    end
   end
 
   # This serializer uses `.as_json` to serialize objects. Despite the name, `.as_json` is a Rails
   # method which converts objects to Ruby primitives (with the top-level being either an array or a
   # hash).
   class NativeModelSerializer < BaseSerializer
-    def initialize(model: nil, **kwargs)
+    class_attribute :config
+    class_attribute :singular_config
+    class_attribute :plural_config
+    class_attribute :action_config
+
+    def initialize(model: nil, many: nil, **kwargs)
       super(**kwargs)
-      @model = model || @controller.send(:get_model)
+      @many = many
+      @model = model || (@controller ? @controller.send(:get_model) : nil)
+    end
+
+    # Get controller action, if possible.
+    def get_action
+      return @controller&.action_name&.to_sym
+    end
+
+    # Get a locally defined configuration, if one is defined.
+    def get_local_serializer_config
+      action = self.get_action
+
+      if action && self.action_config
+        # index action should use :list serializer config if :index is not provided
+        action = :list if action == :index && !self.action_config.key?(:index)
+
+        return self.action_config[action] if self.action_config[action]
+      end
+
+      # no action_config, so try singular/plural config
+      return self.plural_config if @many && self.plural_config
+      return self.singular_config if !@many && self.singular_config
+
+      # lastly, try the default config
+      return self.config
     end
 
     # Get a configuration passable to `as_json` for the model.
-    def get_native_serializer_config
-      fields = @controller.send(:get_fields)
+    def get_serializer_config
+      # return a locally defined serializer config if one is defined
+      local_config = self.get_local_serializer_config
+      return local_config if local_config
+
+      # return a serializer config if one is defined
+      serializer_config = @controller.send(:get_native_serializer_config)
+      return serializer_config if serializer_config
+
+      # otherwise, build a serializer config from fields
+      fields = @controller.send(:get_fields) if @controller
       unless fields.blank?
         columns, methods = fields.partition { |f| f.to_s.in?(@model.column_names) }
         return {only: columns, methods: methods}
       end
+
       return {}
     end
 
     # Convert the object(s) to Ruby primitives.
     def serialize
-      return @object.as_json(self.get_native_serializer_config)
+      if @object
+        @many = @object.respond_to?(:each) if @many.nil?
+        return @object.as_json(self.get_serializer_config)
+      end
+      return nil
+    end
+
+    # Allow a serializer instance to be used as a hash directly in a nested serializer config.
+    def [](key)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.get_serializer_config
+      end
+      return @_nested_config[key]
+    end
+    def []=(key, value)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.get_serializer_config
+      end
+      return @_nested_config[key] = value
+    end
+
+    # Allow a serializer class to be used as a hash directly in a nested serializer config.
+    def self.[](key)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.new.get_serializer_config
+      end
+      return @_nested_config[key]
+    end
+    def self.[]=(key, value)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.new.get_serializer_config
+      end
+      return @_nested_config[key] = value
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.14
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails