rest_framework 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 825e7e7ac0e9c8ae57250288a54dc3ef6510665ce3d4fee23245c559aa8e8233
-  data.tar.gz: 2211c303d14708ef94a4cb35d6e3b25bf78b3b08645f2990ca5448354d8dd64e
+  metadata.gz: 46db4e7aa05600caaa4c1f9f645f417b4d3cd9e5bcde7da0b54d3c5fa84e872e
+  data.tar.gz: 95c9d018b687795f80c38b43289f19ffd44eb1b170d883c164b590ab6b1c20d0
 SHA512:
-  metadata.gz: 0ee2cf406f2b8d77d9ea63650b080d037a759143e0a3e19846585d493a386a4647db0fe59188aa0fd887257a18087aaca82b80d99dee962af1dfdb7eca66a07c
-  data.tar.gz: 6248caea5ad7f5a37a55f7da6aae55c70dc284b9f04d046fc6149a13dff4ae34410106c97f54274f59a8353c79fe97073b7dcba51d65d9c94eb0f9cff1a205ac
+  metadata.gz: 2c376d191ffa5ae9de932dceb8411362a00be789ff9aa3733f038608da890fc5437d981576e3b17d402b857f7966cb15e437d7cbe2c8447191088a9a2249134f
+  data.tar.gz: 72e31acb2e66c6d8d2af2dd7375e7732a93b5e66b1c1fedf4c1d781421422c582958d32c6022305cd9cc2ca9dda51e2c2f6c540b1737e11eb3506501ef91b618

data/README.md

@@ -117,4 +117,5 @@ $ rake test
 ```
 
 To interact with the test app, `cd test` and operate it via the normal Rails interfaces. Ensure you
-run `rake db:schema:load` before running `rails server` or `rails console`.
+run `rake db:schema:load` before running `rails server` or `rails console`. You can also load the
+test fixtures with `rake db:fixtures:load`.

data/lib/rest_framework/VERSION_STAMP

@@ -1 +1 @@
-0.0.16
+0.1.0

data/lib/rest_framework/controller_mixins/base.rb

@@ -36,8 +36,6 @@ module RESTFramework
           extra_actions: nil,
           extra_member_actions: nil,
           filter_backends: nil,
-          native_serializer_config: nil,
-          native_serializer_action_config: nil,
           paginator_class: nil,
           page_size: nil,
           page_query_param: 'page',
@@ -77,17 +75,12 @@ module RESTFramework
 
     # Helper to get filtering backends with a sane default.
     def get_filter_backends
-      if self.class.filter_backends
-        return self.class.filter_backends
-      end
-
-      # By default, return nil.
-      return nil
+      return self.class.filter_backends || []
     end
 
     # Filter the recordset over all configured filter backends.
     def get_filtered_data(data)
-      (self.get_filter_backends || []).each do |filter_class|
+      self.get_filter_backends.each do |filter_class|
         filter = filter_class.new(controller: self)
         data = filter.get_filtered_data(data)
       end
@@ -95,9 +88,9 @@ module RESTFramework
       return data
     end
 
-    # Helper to get the configured serializer class, or `NativeModelSerializer` as a default.
+    # Helper to get the configured serializer class.
     def get_serializer_class
-      return self.class.serializer_class || NativeModelSerializer
+      return self.class.serializer_class
     end
 
     # Get a native serializer config for the current action.

data/lib/rest_framework/controller_mixins/models.rb

@@ -23,6 +23,10 @@ module RESTFramework
           fields: nil,
           action_fields: nil,
 
+          # Attributes for the default native serializer.
+          native_serializer_config: nil,
+          native_serializer_action_config: nil,
+
           # Attributes for default model filtering (and ordering).
           filterset_fields: nil,
           ordering_fields: nil,
@@ -44,6 +48,11 @@ module RESTFramework
 
     protected
 
+    # Helper to get the configured serializer class, or `NativeModelSerializer` as a default.
+    def get_serializer_class
+      return self.class.serializer_class || RESTFramework::NativeModelSerializer
+    end
+
     # Get a list of parameters allowed for the current action.
     def get_allowed_parameters
       allowed_action_parameters = self.class.allowed_action_parameters || {}
@@ -57,11 +66,9 @@ module RESTFramework
 
     # Get the list of filtering backends to use.
     def get_filter_backends
-      backends = super
-      return backends if backends
-
-      # By default, return the standard model filter backend.
-      return [RESTFramework::ModelFilter, RESTFramework::ModelOrderingFilter]
+      return self.class.filter_backends || [
+        RESTFramework::ModelFilter, RESTFramework::ModelOrderingFilter
+      ]
     end
 
     # Get a list of fields for the current action.
@@ -76,14 +83,14 @@ module RESTFramework
     end
 
     # Filter the request body for keys in current action's allowed_parameters/fields config.
-    def _get_parameter_values_from_request_body
+    def get_body_params
       fields = self.get_allowed_parameters || self.get_fields
-      return @_get_parameter_values_from_request_body ||= (request.request_parameters.select { |p|
+      return @get_body_params ||= (request.request_parameters.select { |p|
         fields.include?(p.to_sym) || fields.include?(p.to_s)
       })
     end
-    alias :get_create_params :_get_parameter_values_from_request_body
-    alias :get_update_params :_get_parameter_values_from_request_body
+    alias :get_create_params :get_body_params
+    alias :get_update_params :get_body_params
 
     # Get a record by `id` or return a single record if recordset is filtered down to a single
     # record.

data/lib/rest_framework/paginators.rb

@@ -11,7 +11,7 @@ module RESTFramework
       @page_size = self._page_size
 
       @total_pages = @count / @page_size
-      @total_pages += 1 if @count % @page_size
+      @total_pages += 1 if (@count % @page_size != 0)
     end
 
     def _page_size

data/lib/rest_framework/routers.rb

@@ -2,6 +2,41 @@ require 'action_dispatch/routing/mapper'
 
 module ActionDispatch::Routing
   class Mapper
+    # Helper to take extra_actions hash and convert to a consistent format.
+    protected def _parse_extra_actions(extra_actions)
+      return (extra_actions || {}).map do |k,v|
+        kwargs = {}
+        path = k
+
+        # Convert structure to path/methods/kwargs.
+        if v.is_a?(Hash)  # allow kwargs
+          v = v.symbolize_keys
+
+          # Ensure methods is an array.
+          if v[:methods].is_a?(String) || v[:methods].is_a?(Symbol)
+            methods = [v.delete(:methods)]
+          else
+            methods = v.delete(:methods)
+          end
+
+          # Override path if it's provided.
+          if v.key?(:path)
+            path = v.delete(:path)
+          end
+
+          # Pass any further kwargs to the underlying Rails interface.
+          kwargs = kwargs.merge(v)
+        elsif v.is_a?(Symbol) || v.is_a?(String)
+          methods = [v]
+        else
+          methods = v
+        end
+
+        # Return a hash with keys: :path, :methods, :kwargs.
+        {path: path, methods: methods, kwargs: kwargs}
+      end
+    end
+
     # Private interface to get the controller class from the name and current scope.
     protected def _get_controller_class(name, pluralize: true, fallback_reverse_pluralization: true)
       # get class name
@@ -40,16 +75,16 @@ 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
-    # @param skip_undefined [Boolean] whether we should skip routing undefined actions
+    # @param skip_undefined [Boolean] whether we should skip routing undefined resourceful actions
     protected def _rest_resources(default_singular, name, skip_undefined: true, **kwargs, &block)
-      controller = kwargs[:controller] || name
+      controller = kwargs.delete(:controller) || name
       if controller.is_a?(Class)
         controller_class = controller
       else
         controller_class = _get_controller_class(controller, pluralize: !default_singular)
       end
 
-      # set controller if it's not explicitly set
+      # Set controller if it's not explicitly set.
       kwargs[:controller] = name unless kwargs[:controller]
 
       # determine plural/singular resource
@@ -70,25 +105,20 @@ module ActionDispatch::Routing
       public_send(resource_method, name, except: skip, **kwargs) do
         if controller_class.respond_to?(:extra_member_actions)
           member do
-            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)
+            actions = self._parse_extra_actions(controller_class.extra_member_actions)
+            actions.each do |action_config|
+              action_config[:methods].each do |m|
+                public_send(m, action_config[:path], **action_config[:kwargs])
               end
             end
           end
         end
 
         collection do
-          actions = controller_class.extra_actions || {}
-          actions = actions.select { |k,v| controller_class.method_defined?(k) } if skip_undefined
-          actions.reject! { |k,v| skip.include? k }
-          actions.each do |action, methods|
-            methods = [methods] if methods.is_a?(Symbol) || methods.is_a?(String)
-            methods.each do |m|
-              public_send(m, action)
+          actions = self._parse_extra_actions(controller_class.extra_actions)
+          actions.each do |action_config|
+            action_config[:methods].each do |m|
+              public_send(m, action_config[:path], **action_config[:kwargs])
             end
           end
         end
@@ -112,42 +142,55 @@ module ActionDispatch::Routing
     end
 
     # Route a controller without the default resourceful paths.
-    def rest_route(path=nil, skip_undefined: true, **kwargs, &block)
-      controller = kwargs.delete(:controller) || path
-      path = path.to_s
+    def rest_route(name=nil, **kwargs, &block)
+      controller = kwargs.delete(:controller) || name
+      if controller.is_a?(Class)
+        controller_class = controller
+      else
+        controller_class = self._get_controller_class(controller, pluralize: false)
+      end
 
-      # route actions
-      controller_class = self._get_controller_class(controller, pluralize: false)
-      skip = controller_class.get_skip_actions(skip_undefined: skip_undefined)
-      actions = controller_class.extra_actions || {}
-      actions = actions.select { |k,v| controller_class.method_defined?(k) } if skip_undefined
-      actions.reject! { |k,v| skip.include? k }
-      actions.each do |action, methods|
-        methods = [methods] if methods.is_a?(Symbol) || methods.is_a?(String)
-        methods.each do |m|
-          public_send(m, File.join(path, action.to_s), controller: controller, action: action)
+      # Set controller if it's not explicitly set.
+      kwargs[:controller] = name unless kwargs[:controller]
+
+      # Route actions using the resourceful router, but skip all builtin actions.
+      actions = self._parse_extra_actions(controller_class.extra_actions)
+      public_send(:resource, name, only: [], **kwargs) do
+        actions.each do |action_config|
+          action_config[:methods].each do |m|
+            public_send(m, action_config[:path], **action_config[:kwargs])
+          end
+          yield if block_given?
         end
-        yield if block_given?
       end
     end
 
     # Route a controller's `#root` to '/' in the current scope/namespace, along with other actions.
     # @param label [Symbol] the snake_case name of the controller
-    def rest_root(path=nil, **kwargs, &block)
-      # by default, use RootController#root
+    def rest_root(name=nil, **kwargs, &block)
+      # By default, use RootController#root.
       root_action = kwargs.delete(:action) || :root
-      controller = kwargs.delete(:controller) || path || :root
-      path = path.to_s
+      controller = kwargs.delete(:controller) || name || :root
 
-      # route the root
-      get path, controller: controller, action: root_action
+      # Route the root.
+      get name.to_s, controller: controller, action: root_action
 
-      # route any additional actions
+      # Route any additional actions.
       controller_class = self._get_controller_class(controller, pluralize: false)
-      (controller_class.extra_actions || {}).each do |action, methods|
-        methods = [methods] if methods.is_a?(Symbol) || methods.is_a?(String)
-        methods.each do |m|
-          public_send(m, File.join(path, action.to_s), controller: controller, action: action)
+      actions = self._parse_extra_actions(controller_class.extra_actions)
+      actions.each do |action_config|
+        # Add :action unless kwargs defines it.
+        unless action_config[:kwargs].key?(:action)
+          action_config[:kwargs][:action] = action_config[:path]
+        end
+
+        action_config[:methods].each do |m|
+          public_send(
+            m,
+            File.join(name.to_s, action_config[:path].to_s),
+            controller: controller,
+            **action_config[:kwargs],
+          )
         end
         yield if block_given?
       end

data/lib/rest_framework/serializers.rb

@@ -8,18 +8,25 @@ module RESTFramework
     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 NativeSerializer < BaseSerializer
+  # This serializer uses `.as_json` to serialize objects. Despite the name, `.as_json` is an
+  # `ActiveModel` method which converts objects to Ruby primitives (with the top-level being either
+  # an array or a hash).
+  class NativeModelSerializer < BaseSerializer
     class_attribute :config
     class_attribute :singular_config
     class_attribute :plural_config
     class_attribute :action_config
 
-    def initialize(many: nil, **kwargs)
+    def initialize(many: nil, model: nil, **kwargs)
       super(**kwargs)
-      @many = many
+
+      if many.nil?
+        @many = @object.respond_to?(:count) ? @object.count : nil
+      else
+        @many = many
+      end
+
+      @model = model || (@controller ? @controller.send(:get_model) : nil)
     end
 
     # Get controller action, if possible.
@@ -58,6 +65,13 @@ module RESTFramework
         return serializer_config
       end
 
+      # If the config wasn't determined, build a serializer config from model fields.
+      fields = @controller.try(: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
 
@@ -99,27 +113,4 @@ module RESTFramework
     end
   end
 
-  # `NativeModelSerializer` is similar to `NativeSerializer` but with some customizations to work
-  # with `ActiveModel`.
-  class NativeModelSerializer < NativeSerializer
-    def initialize(model: nil, **kwargs)
-      super(**kwargs)
-      @model = model || (@controller ? @controller.send(:get_model) : nil)
-    end
-
-    # Get a configuration passable to `as_json` for the object.
-    def get_serializer_config
-      config = super
-      return config unless config.blank?
-
-      # If the config wasn't determined, build a serializer config from model fields.
-      fields = @controller.try(: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
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.0
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,11 +48,11 @@ files:
 - lib/rest_framework/routers.rb
 - lib/rest_framework/serializers.rb
 - lib/rest_framework/version.rb
-homepage: https://github.com/gregschmit/rails-rest-framework
+homepage: https://rails-rest-framework.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/gregschmit/rails-rest-framework
+  homepage_uri: https://rails-rest-framework.com
   source_code_uri: https://github.com/gregschmit/rails-rest-framework
 post_install_message:
 rdoc_options: []
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: A framework for DRY RESTful APIs in Ruby on Rails.