skinny_controllers 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad507c902cd85dc2b04c9cf80848dc34b34e7728
-  data.tar.gz: 871a3ba223e7420bfaff936411c6f0a236c1569f
+  metadata.gz: 52131d9a1e993b5046ea0104928cce55b32cfa8e
+  data.tar.gz: dbcc1157c9129361df79a71b2f8e5c103a9d94e0
 SHA512:
-  metadata.gz: 3fd245b0380353a4f4c71839db1e517ae1d04b30e07086fa2324ca0e66bea65362e5d2511f5ebe4ce158852586bb60eb8b887f3b435ab34d3301bd8a546da6f0
-  data.tar.gz: e2ada5f2cb8b6953ed8efd6cc1981a2ab80a8f25daaeee672751adcca4d1bbbe61af1e1b4bc67afaa71c7205c9577f29d7d0c314b62eee53fe9e2c628c57e53a
+  metadata.gz: 77aa4ae8568318784f6092a5d8f109f726a2a53134e5217ffe0b18ca1ab31bd63c81121ed62ca58c632f716221b587606a40b510768fd9c2d7743cb56307f51a
+  data.tar.gz: 968f986aa8a475bd965df72c49252b5c073466cca3b8a59d2b68293da93275c3b17c0a85fbb1bdfe49fcdf11d433d08a6c7f39a69027c607e3c390eb918797a6

data/README.md

@@ -11,6 +11,8 @@ The goal of this project is to help API apps be more slim, and separate logic as
 
 This gem is inspired by [trailblazer](https://github.com/apotonick/trailblazer), following similar patterns, yet allowing the structure of the rails app to not be entirely overhauled.
 
+Please note that this is a work in progress, and that the defaults are subject to change. If you have an idea or suggestion for improved defaults, please submit an issue or pull request. :-)
+
 # Installation
 
 ```ruby
@@ -37,10 +39,11 @@ The above does a multitude of assumptions to make sure that you can type the lea
 
 1. Your controller name is based off your model name (configurable per controller)
 2. Any defined policies or operations follow the formats (though they don't have to exist):
-  - `#{Model.name}Policy`
-  - `#{Model.name}Operations`
+  - `class #{Model.name}Policy`
+  - `module #{Model.name}Operations`
 3. Your model responds to `find`, and `where`
 4. Your model responds to `is_accessible_to?`. This can be changed at `SkinnyControllers.accessible_to_method`
+5. If relying on the default / implicit operations for create and update, the params key for your model's changes much be formatted as `{ Model.name.underscore => { attributes }}``
 
 ### Your model name might be different from your resource name
 Lets say you have a JSON API resource that you'd like to render that has some additional/subset of data.
@@ -104,6 +107,60 @@ module UserOperations
 end
 ```
 
+### Creating
+
+To achieve default functionality, this operation *may* be defined -- though, it is implicitly assumed to function this way if not defined.
+```ruby
+module UserOperations
+  class Create < SkinnyControllers::Operation::Base
+    def run
+      return unless allowed?
+      @model = model_class.new(model_params)
+      @model.save
+      @model # or just `model`
+    end
+  end
+end
+```
+
+### Updating
+```ruby
+module UserOperations
+  class Create < SkinnyControllers::Operation::Base
+    def run
+      return unless allowed?
+      model.update(model_params)
+      model
+    end
+  end
+end
+```
+
+### Deleting
+
+Goal: Users should only be able to delete themselves
+
+To achieve default functionality, this operation *may* be defined -- though, it is implicitly assumed to function this way if not defined.
+```ruby
+module UserOperations
+  class Delete < SkinnyControllers::Operation::Base
+    def run
+      model.destroy if allowed?
+    end
+  end
+end
+```
+
+And given that this method exists on the `User` model:
+```ruby
+# realistically, you'd only want users to be able to access themselves
+def is_accessible_to?(user)
+  self.id == user.id
+end
+```
+
+Making a call to the destroy action on the `UsersController` will only succeed if the user trying to delete themselves. (Possibly to 'cancel their account')
+
 
 ## Defining Policies
 

data/lib/skinny_controllers/operation/default.rb

@@ -2,7 +2,40 @@ module SkinnyControllers
   module Operation
     class Default < Base
       def run
-        model if allowed?
+        return unless allowed?
+
+        # Note that for explicitly defined operations,
+        # There should be a different operation for each
+        # action.
+        #
+        # e.g.:
+        #  - EventOperations::Create
+        #  - EventOperations::Update
+        #  - EventOperations::Destroy
+        if creating?
+          @model = model_class.new(model_params)
+          @model.save
+        elsif updating?
+          model.update(model_params)
+        elsif destroying?
+          model.destroy
+        end
+
+        model
+      end
+
+      private
+
+      def creating?
+        params[:action] == 'create'
+      end
+
+      def updating?
+        params[:action] == 'update'
+      end
+
+      def destroying?
+        params[:action] == 'destroy'
       end
     end
   end

data/lib/skinny_controllers/operation/model_helpers.rb

@@ -23,6 +23,18 @@ module SkinnyControllers
         params.slice(*keys).symbolize_keys
       end
 
+      # TODO: add a way to use existing strong parameters methods
+      def model_params
+        # for mass-assignment, rails doesn't accept
+        # stringified keys.
+        # TODO: why did the params hash lose its indifferent access
+        @model_params ||= params[model_param_name].symbolize_keys
+      end
+
+      def model_param_name
+        model_name.underscore
+      end
+
       def scoped_model(scoped_params)
         unless @scoped_model
           klass_name = scoped_params[:type]
@@ -42,7 +54,7 @@ module SkinnyControllers
           # It's better to filter in sql, than in the app, so if there is
           # a way to do the filtering in active query, do that. This will help
           # mitigate n+1 query scenarios
-          return ar_proxy.accessible_to(current_user)
+          return ar_proxy.send(SkinnyControllers.accessible_to_scope, current_user)
         end
 
         ar_proxy

data/lib/skinny_controllers/policy/allow_all.rb

@@ -1,9 +1,17 @@
 module SkinnyControllers
   module Policy
     class AllowAll < Base
-      def default?; true; end
-      def read?; true; end
-      def read_all?; true; end
+      def default?
+        true
+      end
+
+      def read?
+        true
+      end
+
+      def read_all?
+        true
+      end
     end
   end
 end

data/lib/skinny_controllers/policy/deny_all.rb

@@ -1,9 +1,17 @@
 module SkinnyControllers
   module Policy
     class DenyAll < Base
-      def default?; false; end
-      def read?; false; end
-      def read_all?; false; end
+      def default?
+        false
+      end
+
+      def read?
+        false
+      end
+
+      def read_all?
+        false
+      end
     end
   end
 end

data/lib/skinny_controllers/version.rb

@@ -1,3 +1,3 @@
 module SkinnyControllers
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skinny_controllers
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - L. Preston Sego III
@@ -224,5 +224,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: SkinnyControllers-0.3.3
+summary: SkinnyControllers-0.4.0
 test_files: []