simple_resource_controller 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb28b4c9ce2a17fae1264f71a4091cd4913ed6fc2aeb727b395c27764ffe0f60
-  data.tar.gz: 16aaee6c115b1a59ba7d083290db63693103da35099cf24f17296a4ec133cf4c
+  metadata.gz: 11ecf5e2bc0b286fa0709a401ed41a7a204a15cd0cc54e4379a31ae70c77d492
+  data.tar.gz: d382ef1a1b0752b8cd8e5e23dcb247e9bfe485d01af6b4149765a0fa26768cd7
 SHA512:
-  metadata.gz: 7a845c5c753d2b4a7c14dd38c4b216a72d23a5d8b85bd4a2f7db591e4f9bed28d1b5121a59c61bb93bc17e8388235013d8c77f0045c76e8051f4d064cae328b4
-  data.tar.gz: 7c8b9ad5385472b79a5cc96fb09e81858e96a9201382257130e62b388b6812260ea93aee060578b10808e9e69b5432d8ee481a9cc4762ddafd11c95dca91e32d
+  metadata.gz: 19582cab4d75ae48b61f42d92c3a9485949cd470f9e900b5565d9bcc92e21a8f5dd5c6e8faa9786429b751e0ee8fca2a9c8fa4f8f2b281e58dcf1948c3a0b922
+  data.tar.gz: aedab8f8ca87baac41c871668af80e392c7f064c7d27a4429e3864db17fb7bd226afa5a2b9f56f0259852c77aab2dd3a47cc066c4070552a790f5aff2f5c9502

data/.gitignore

@@ -13,3 +13,4 @@ coverage
 
 *.sqlite3
 spec/dummy_app/log/
+spec/dummy_app/tmp/

data/Gemfile

@@ -5,7 +5,7 @@ group :development, :test do
   gem 'rails'
   gem 'byebug'
   gem 'pry'
-  gem 'responders', '~> 2.0'
+  gem 'responders', '= 3.0'
   gem 'kaminari'
   gem 'has_scope'
 end
@@ -15,6 +15,7 @@ group :test do
   gem 'database_cleaner'
   gem 'simplecov'
   gem 'mutant-rspec'
+  gem 'rails-controller-testing'
 end
 
 # Specify your gem's dependencies in simple_resource_controller.gemspec

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))
@@ -96,7 +108,7 @@ module SimpleResourceController
       end
 
       def resource_name
-        resource_class_name.underscore
+        resource_class_name.split('::').last.underscore
       end
 
       def resource_relation_name
@@ -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)
@@ -174,11 +190,22 @@ module SimpleResourceController
           resource.errors[:base] << resource_wasnt_saved_message
         end
 
-        unless block_given? || options[:location].present?
-          options[:location] = after_save_redirect_path
+        if result.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
@@ -256,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.4"
+  VERSION = "0.2.0"
 end

data/simple_resource_controller.gemspec

@@ -19,11 +19,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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", ">= 3.2"
-  spec.add_dependency "actionpack", ">= 3.2"
-  spec.add_dependency "responders", "~> 2.0"
+  spec.add_dependency "railties"
+  spec.add_dependency "actionpack"
+  spec.add_dependency "responders"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simple_resource_controller
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleg Zaporozhchenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,48 +52,76 @@ 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
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 description: This gem allows to write explicit resource controllers
 email:
 - c3.gdlk@gmail.com
@@ -136,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple gem for resource controllers