rest_framework 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ed68df38881608ec5cc6c66c286624a600398a745ab730e6cef89513f0138f
-  data.tar.gz: 7f2654b29027aa24357b14082e0e0236d9024521fe47e3ae90be7fdeda535b5f
+  metadata.gz: 8c3691667e86ee77e9d15a1732d0013687a2e63a062a4ff01d1c6d8cc66f45fc
+  data.tar.gz: 6bcab926c283feb9a0643a06eab750f941882e5b56b294c59794f64a966883bb
 SHA512:
-  metadata.gz: 460fd09cc0b375e5509a83ff64bf5ffb87f864cb53e5cb51aa1027bce3a39bbd12a8f692a3c621ad93ac200f98bb095b369610b2953eedb9a47a181568fea948
-  data.tar.gz: 03c6ec7c3d910dac783e2ddb927ea53212e066246dcf1b2673d95e703754a9295a5e792d9daeb3c40fd5d334491e489e076b4740f766ab7880eaf3d731344bda
+  metadata.gz: 204e0b5ea7b46710968a6274791f9e0f676db34f4eaefa1cf831fe8f9e4ab1f076a24b0375ef0554e1c4b57db3d1787adeebc31c4201da40b504aded51ca097b
+  data.tar.gz: 7e46ed5bbe61832045207664d679ecf394aead2928cdd78a1b29873087b78130546fd80595fe443680d5c26eebfa8bf5f23246b56a9a4a83e801c7763c024c76

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

@@ -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.10
+0.0.12

data/lib/rest_framework/controller_mixins/base.rb

@@ -74,35 +74,42 @@ module RESTFramework
       }.select { |r| r[:path].start_with?(request.path) }
     end
 
-    # Helper alias for `respond_to`/`render`, and replace nil responses with blank ones. `payload`
-    # should be already serialized to Ruby primitives.
-    def api_response(payload, html_kwargs: nil, json_kwargs: nil, xml_kwargs: nil, **kwargs)
+    # Helper alias for `respond_to`/`render`. `payload` should be already serialized to Ruby
+    # primitives.
+    def api_response(payload=nil, html_kwargs: nil, json_kwargs: nil, xml_kwargs: nil, **kwargs)
       html_kwargs ||= {}
       json_kwargs ||= {}
       xml_kwargs ||= {}
 
-      # make empty responses status 204 unless a status is already explicitly defined
-      if (payload.nil? || payload == '') && !kwargs.key?(:status)
-        kwargs[:status] = 204
-      end
+      # 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

data/lib/rest_framework/controller_mixins/models.rb

@@ -67,7 +67,7 @@ module RESTFramework
     # 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
@@ -77,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

data/lib/rest_framework/serializers.rb

@@ -59,7 +59,7 @@ module RESTFramework
       return serializer_config if serializer_config
 
       # otherwise, build a serializer config from fields
-      fields = @controller.send(:get_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}
@@ -68,54 +68,41 @@ module RESTFramework
       return {}
     end
 
-    # Recursive method for traversing a config and evaluating nested serializers.
-    def _resolve_serializer_config(node: nil)
-      # First base case: found a serializer, so evaluate it and return it.
-      if node.is_a?(Class) && (node < BaseSerializer)
-        return node.new(controller: @controller).get_resolved_serializer_config
-      end
-
-      # Second base case: found a serializer instance, so evaluate it and return it.
-      if node.is_a?(BaseSerializer)
-        return node.get_resolved_serializer_config
+    # Convert the object(s) to Ruby primitives.
+    def serialize
+      if @object
+        @many = @object.respond_to?(:each) if @many.nil?
+        return @object.as_json(self.get_serializer_config)
       end
+      return nil
+    end
 
-      # Third base case: node is not iterable, so return it.
-      unless node.respond_to?(:each)
-        return node
+    # 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
-
-      # Recursive case: node is iterable, so iterate and recursively resolve serializers.
-      if node.is_a? Hash
-        node.each do |k,v|
-          node[k] = self._resolve_serializer_config(node: v)
-        end
-      else
-        node.map! do |v|
-          self._resolve_serializer_config(node: v)
-        end
+      return @_nested_config[key]
+    end
+    def []=(key, value)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.get_serializer_config
       end
-
-      return node
+      return @_nested_config[key] = value
     end
 
-    # Get a serializer config and resolve any nested serializers into configs.
-    def get_resolved_serializer_config
-      config = self.get_serializer_config
-
-      # traverse the config, resolving nested serializers
-      return _resolve_serializer_config(node: config)
+    # 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
-
-    # Convert the object(s) to Ruby primitives.
-    def serialize
-      if @object
-        @many = @object.respond_to?(:each) if @many.nil?
-        return @object.as_json(
-          self.get_resolved_serializer_config
-        )
+    def self.[]=(key, value)
+      unless instance_variable_defined?(:@_nested_config)
+        @_nested_config = self.new.get_serializer_config
       end
-      return nil
+      return @_nested_config[key] = value
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Gregory N. Schmit