simple_resource_controller 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47980430e7b6f9e6e4e160644c0b15bef32f4fa7084be7fc1d84da28ba270f85
-  data.tar.gz: 02fbe09e21a500beab18a9fcb38cea7467dacc607c26f4d65a9e8fb7cb945da7
+  metadata.gz: 11ecf5e2bc0b286fa0709a401ed41a7a204a15cd0cc54e4379a31ae70c77d492
+  data.tar.gz: d382ef1a1b0752b8cd8e5e23dcb247e9bfe485d01af6b4149765a0fa26768cd7
 SHA512:
-  metadata.gz: 4e8380546a598b1e3c0ec73296e09824ff551b5b81788a633cdb930e0d216d54b07a5b2a1d109fcaab129805175b9c155b6a877eed0064e77157a8abb8ed4946
-  data.tar.gz: 4079c1811ef11b80fa863d4c579c14c1688953beca269ed0dac2caedd526dcf122cad137d384261af49b8b605f161b27d8c0000d1c2e65e23b4f2d8e7915c19e
+  metadata.gz: 19582cab4d75ae48b61f42d92c3a9485949cd470f9e900b5565d9bcc92e21a8f5dd5c6e8faa9786429b751e0ee8fca2a9c8fa4f8f2b281e58dcf1948c3a0b922
+  data.tar.gz: aedab8f8ca87baac41c871668af80e392c7f064c7d27a4429e3864db17fb7bd226afa5a2b9f56f0259852c77aab2dd3a47cc066c4070552a790f5aff2f5c9502

data/README.md

@@ -63,6 +63,36 @@ class AnotherArticlesController < ApplicationController
 end
 ```
 
+### API examples
+
+Gem suppports [jbuilder](https://github.com/rails/jbuilder) and [activemodel_serializer](https://github.com/rails-api/active_model_serializers) as API serializers
+
+#### JBuilder
+
+```ruby
+resource_api jbuilder: true
+```
+
+But you will also need to add all view files for your actions, including `new` and `edit`.
+
+**You can find example inside tests.**
+
+#### ActiveModel::Serializer
+
+Minimum config:
+
+```ruby
+resource_api activemodel_serializer: { }
+```
+
+All options:
+
+```ruby
+resource_api activemodel_serializer: { record_serializer: MyArticleSerializer, error_serializer: MyErrorSerializer }
+```
+
+**You can find example inside tests.**
+
 ### Controller configuration
 
 The first required configuration is an action name.
@@ -394,6 +424,11 @@ This is my favorite one. The `responders` gem follows the next logic - if a reco
 If you will get this exception - check your ActiveRecord callbacks, your code has some smells.
 
 
+#### `error_serializer should be configured for the activemodel API`
+
+You are trying to use the `resource_api` DSL to setup the activemodel_serializer, faced with the validation error in create or update action.
+But didn't configured an error serializer: `resource_api activemodel_serializer: { error_serializer: MyErrorSerializer }`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/c3gdlk/simple_resource_controller. This project is intended to be a safe, welcoming space for collaboration.

data/lib/simple_resource_controller/controller.rb

@@ -26,8 +26,7 @@ module SimpleResourceController
       def create(options={}, &block)
         build_resource
         success = save_resource_and_respond!(options, &block)
-      ensure
-        setup_flash_messages(after_create_messages) if success
+        setup_flash_messages(after_create_messages) if success && !current_controller_api?
       end
       alias :create! :create
     end
@@ -42,8 +41,7 @@ module SimpleResourceController
     module Update
       def update(options={}, &block)
         success = save_resource_and_respond!(options, &block)
-      ensure
-        setup_flash_messages(after_update_messages) if success
+        setup_flash_messages(after_update_messages) if success && !current_controller_api?
       end
       alias :update! :update
     end
@@ -52,7 +50,7 @@ module SimpleResourceController
       def destroy(options={}, &block)
         destroy_resource_and_respond!(options, &block)
       ensure
-        setup_flash_messages(after_destroy_messages)
+        setup_flash_messages(after_destroy_messages) unless current_controller_api?
       end
       alias :destroy! :destroy
     end
@@ -60,6 +58,20 @@ module SimpleResourceController
     module CommonMethods
       private
 
+      def current_controller_api?
+        self.class.api_config.present?
+      end
+
+      def activemodel_serializer?
+        current_controller_api? && self.class.api_config.dig(:activemodel_serializer).present?
+      end
+
+      def render_resource_with_activemodel_serializer(options)
+        record_serializer = self.class.api_config.dig(:activemodel_serializer, :record_serializer)
+
+        render({ json: resource, status: :ok }.merge(record_serializer ? { serializer: record_serializer } : {} ).merge(options))
+      end
+
       def collection
         return instance_variable_get(:"@#{collection_name}") if instance_variable_get(:"@#{collection_name}").present?
         instance_variable_set(:"@#{collection_name}", apply_scopes_and_pagination(association_chain))
@@ -159,11 +171,15 @@ module SimpleResourceController
       def destroy_resource_and_respond!(options={}, &block)
         resource.destroy
 
-        unless block_given? || options[:location].present?
+        unless block_given? || options[:location].present? || current_controller_api?
           options[:location] = after_destroy_redirect_path
         end
 
-        respond_with resource, options, &block
+        if activemodel_serializer?
+          render_resource_with_activemodel_serializer(options)
+        else
+          respond_with resource, options, &block
+        end
       end
 
       def save_resource_and_respond!(options={}, &block)
@@ -175,12 +191,21 @@ module SimpleResourceController
         end
 
         if result.present?
-          unless block_given? || options[:location].present?
+          unless block_given? || options[:location].present? || current_controller_api?
             options[:location] = after_save_redirect_path
           end
+        elsif activemodel_serializer?
+          error_serializer = self.class.api_config.dig(:activemodel_serializer, :error_serializer)
+
+          raise "error_serializer should be configured for the activemodel API" unless error_serializer.present?
+          options[:serializer] = error_serializer
         end
 
-        respond_with resource, options, &block
+        if result.present? && activemodel_serializer?
+          render_resource_with_activemodel_serializer(options)
+        else
+          respond_with resource, options, &block
+        end
 
         result
       end
@@ -258,6 +283,14 @@ module SimpleResourceController
       def paginate_collection(value)
         @paginate_collection_config = value
       end
+
+      def api_config
+        @api_config
+      end
+
+      def resource_api(value)
+        @api_config = value
+      end
     end
 
     class ActionsBuilder

data/lib/simple_resource_controller/version.rb

@@ -1,3 +1,3 @@
 module SimpleResourceController
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/simple_resource_controller.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "jbuilder"
+  spec.add_development_dependency 'active_model_serializers', '~> 0.10.0'
 
   spec.add_dependency "railties"
   spec.add_dependency "actionpack"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_resource_controller
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleg Zaporozhchenko
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement