skinny_controllers 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e421158402ef37ad4aedb544359ada894d6ba616
-  data.tar.gz: 7c084cdbf5699bee2ca251abeec24ff98cfbb060
+  metadata.gz: 33cb5420fdc28bbd364bb6016c4d6aead5d6a0ae
+  data.tar.gz: 0e9f8d8868d29ae0dac511c30e82dd9f06120cc7
 SHA512:
-  metadata.gz: 10dad383fd05c9c5454a583cb93555962833c389936ff1366ff193a567b5ac96f31fa5d8b2afbdd72c5cc1804247b2d7f020289ffb9262e5c5398dcb314fd903
-  data.tar.gz: b5cd1fe9e58ef4168a6858e05da1e2ebaf89e723261c37e811d85657778b7b9f28c595167bd35a5e5ea97906b409d92369af3d27a64681cb1fe658c5d6abd517
+  metadata.gz: 557258742889bd97ad31e7c27db3a04fec56406d0eb08f59341f59c4736ce54e77f6d59bf7676009f5174cb50b984ec4cfbf1704411085efbb3f2ecb9683261c
+  data.tar.gz: 8986b7e99959fd999bd3a5891e73c78f55b06eb7ab0e3aec53d960d4393eadaec9e3d29de15e7e3e467f62247edd23379f347e6543420817750874f03c04dc22

data/README.md

@@ -87,7 +87,7 @@ end
 private
 
 def host_from_subdomain
-  @host ||= HostOperations::Read.new(current_user, host_params).run
+  @host ||= HostOperations::Read.new(current_user, params, host_params).run
 end
 
 def host_params
@@ -95,6 +95,26 @@ def host_params
 end
 ```
 
+### For JSON-API
+
+Strong parameters must be used on create/update actions.
+
+Here is an example params method
+
+```ruby
+private
+
+def event_params
+  params
+    .require(:data)
+    .require(:attributes)
+    .permit(:name)
+end
+```
+
+Note that we don't need the id under the data hash, because in a RESTful api, the id will be available to us through the top level params hash.
+
+
 ## Defining Operations
 
 Operations should be placed in `app/operations` of your rails app.
@@ -219,7 +239,6 @@ The following options are available:
 |`accessible_to_method`|`is_accessible_to?`| method to call an the object that the user might be able to access |
 |`accessible_to_scope`| `accessible_to`| scope / class method on an object that the user might be able to access |
 |`action_map`| see [skinny_controllers.rb](./lib/skinny_controllers.rb#L61)| |
-|`params_format`|`:json`| or `:json_api`|
 
 ## TODO
 

data/lib/skinny_controllers/diet.rb

@@ -10,7 +10,7 @@ module SkinnyControllers
     #
     # @return an instance of the operation with default parameters
     def operation
-      @operation ||= operation_class.new(current_user, params_for_action)
+      @operation ||= operation_class.new(current_user, params, params_for_action, action_name)
     end
 
     # Assumes the operation name from the controller name

data/lib/skinny_controllers/operation/base.rb

@@ -15,22 +15,28 @@ module SkinnyControllers
     class Base
       include ModelHelpers
 
-      attr_accessor :params, :current_user, :authorized_via_parent
+      attr_accessor :params, :current_user, :authorized_via_parent, :action, :params_for_action
 
       def self.run(current_user, params)
         object = new(current_user, params)
         object.run
       end
 
-      def initialize(current_user, params)
-        self.current_user = current_user
-        self.params = params
+      # @param [Model] current_user the logged in user
+      # @param [Hash] controller_params the params hash raw from the controller
+      # @param [Hash] params_for_action optional params hash, generally the result of strong parameters
+      # @param [string] action the current action on the controller
+      def initialize(current_user, controller_params, params_for_action = nil, action = nil)
         self.authorized_via_parent = false
+        self.current_user = current_user
+        self.action = action || controller_params[:action]
+        self.params = controller_params
+        self.params_for_action = params_for_action || controller_params
       end
 
       def id_from_params
         unless @id_from_params
-          @id_from_params = params[:data] ? params[:data][:id] : params[:id]
+          @id_from_params = params[:id]
           if filter = params[:filter]
             @id_from_params = filter[:id].split(',')
           end

data/lib/skinny_controllers/operation/default.rb

@@ -27,15 +27,15 @@ module SkinnyControllers
       private
 
       def creating?
-        params[:action] == 'create'
+        action == 'create'
       end
 
       def updating?
-        params[:action] == 'update'
+        action == 'update'
       end
 
       def destroying?
-        params[:action] == 'destroy'
+        action == 'destroy'
       end
     end
   end

data/lib/skinny_controllers/operation/model_helpers.rb

@@ -28,20 +28,7 @@ module SkinnyControllers
         # for mass-assignment, rails doesn't accept
         # stringified keys.
         # TODO: why did the params hash lose its indifferent access
-        @model_params ||= param_parser.model_params.symbolize_keys
-      end
-
-      def param_parser
-        unless @param_parser
-          @param_parser =
-            if SkinnyControllers.params_format == :json
-              Params::Json.new(params, model_param_name)
-            else
-              Params::JsonApi.new(params, model_param_name)
-            end
-        end
-
-        @param_parser
+        @model_params ||= (params_for_action[model_param_name] || params_for_action).symbolize_keys
       end
 
       def model_param_name

data/lib/skinny_controllers/version.rb

@@ -1,3 +1,3 @@
 module SkinnyControllers
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

data/lib/skinny_controllers.rb

@@ -7,9 +7,6 @@ require 'active_support/core_ext/string/inflections'
 
 # files for this gem
 require 'skinny_controllers/default_verbs'
-require 'skinny_controllers/json_api_document'
-require 'skinny_controllers/params/json'
-require 'skinny_controllers/params/json_api'
 require 'skinny_controllers/lookup/controller'
 require 'skinny_controllers/lookup/model'
 require 'skinny_controllers/lookup/operation'
@@ -64,10 +61,6 @@ module SkinnyControllers
     :accessible_to
   end
 
-  cattr_accessor :params_format do
-    :json # or :json_api
-  end
-
   # the diet uses ActionController::Base's
   # `action_name` method to get the current action.
   # From that action, we map what verb we want to use for our operation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skinny_controllers
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - L. Preston Sego III
@@ -189,7 +189,6 @@ files:
 - lib/skinny_controllers.rb
 - lib/skinny_controllers/default_verbs.rb
 - lib/skinny_controllers/diet.rb
-- lib/skinny_controllers/json_api_document.rb
 - lib/skinny_controllers/lookup/controller.rb
 - lib/skinny_controllers/lookup/model.rb
 - lib/skinny_controllers/lookup/operation.rb
@@ -197,8 +196,6 @@ files:
 - lib/skinny_controllers/operation/base.rb
 - lib/skinny_controllers/operation/default.rb
 - lib/skinny_controllers/operation/model_helpers.rb
-- lib/skinny_controllers/params/json.rb
-- lib/skinny_controllers/params/json_api.rb
 - lib/skinny_controllers/policy/allow_all.rb
 - lib/skinny_controllers/policy/base.rb
 - lib/skinny_controllers/policy/default.rb
@@ -227,5 +224,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: SkinnyControllers-0.5.6
+summary: SkinnyControllers-0.5.7
 test_files: []

data/lib/skinny_controllers/json_api_document.rb

@@ -1,29 +0,0 @@
-module SkinnyControllers
-  # currently copied from NullVoxPopuli/json-api-document
-  # Not sure if this should be its own gem or not
-  class JsonApiDocument
-    attr_accessor :data, :id, :attributes
-
-    # @param [Hash] json the json api document
-    # @param [Symbol] key_formatter converts the attribute keys
-    def initialize(json, key_formatter: nil)
-      json = JSON.parse(json) if json.is_a?(String)
-
-      self.data = json['data']
-      self.id = json['id'] || data.try(:[], 'id')
-      self.attributes = format_keys(data.try(:[], 'attributes'), key_formatter)
-    end
-
-    private
-
-    # TODO: how to handle nested hashes
-    def format_keys(hash, key_format_method)
-      return hash unless key_format_method
-
-      hash.each_with_object({}) do | (k, v), result |
-        new_key = k.send(key_format_method)
-        result[new_key] = v
-      end
-    end
-  end
-end

data/lib/skinny_controllers/params/json.rb

@@ -1,20 +0,0 @@
-module SkinnyControllers
-  module Params
-    class Json
-      attr_accessor :document, :model_key
-      # @param [Params] params from controller
-      def initialize(params, model_key)
-        self.document = params
-        self.model_key = model_key
-      end
-
-      def model_params
-        document[model_key].symbolize_keys
-      end
-
-      def id
-        document[:id]
-      end
-    end
-  end
-end

data/lib/skinny_controllers/params/json_api.rb

@@ -1,21 +0,0 @@
-module SkinnyControllers
-  module Params
-    class JsonApi
-      attr_accessor :document, :model_key
-
-      # @param [Params] params from controller
-      def initialize(params, model_key)
-        self.document = JsonApiDocument.new(params)
-        self.model_key = model_key
-      end
-
-      def model_params
-        document.attributes
-      end
-
-      def id
-        document.id
-      end
-    end
-  end
-end