rails-rapido 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c7123a3a6f6a4c588644079e1aa18d1f2f43f65fba2a073bdf65ad5d969f84f
-  data.tar.gz: 06b29712f5d93a0121b71a6f5af810cdbf9c3869049a202a2f5923f8333743f8
+  metadata.gz: c6d9f200d77def28ea4f71d5f762d6989f11005129072a3bcd711e0aac99a0e5
+  data.tar.gz: 8b150492c2c5a75fdb197453ca6e2be63206899486b379e5f0b85d05402cc17f
 SHA512:
-  metadata.gz: bad24cf889ce9d2fda165b50850a60b7b2bcb8a38800d8224027d1b9efd8fc68e2584a3b6e5356604437f4d6587568ec33b7bc7270f71e95801a1a6f2115bdd7
-  data.tar.gz: 3af33765a75abeb4b7abf4c9ba4ada1dc1d0190fae2f45fa2af2b48ba6d8b15b7a4b0e607e70f54549d24b88017151cf58e14e5180a0615d24a47075dee4077f
+  metadata.gz: 073b9199bc61ab3d01ff15e8eee7d454137323fbcac21cdb156cd604b481acd99aced9ecdb612a75328bc10777c9b01812d1ca33e11b423d7410bfa08ae67568
+  data.tar.gz: 7f5cd3ab73eb1b7eaba8b9791e81c07ee41baf75da6ab4f3968bdf6395d124aadafee024fd84154f22ca2aa57ae5c95389d6c02259606ba774503d9018f747d4

data/.codeclimate.yml

@@ -0,0 +1,52 @@
+version: "2"
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 4
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 8
+  file-lines:
+    enabled: true
+    config:
+      threshold: 350
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 8
+  method-count:
+    enabled: true
+    config:
+      threshold: 30
+  method-lines:
+    enabled: true
+    config:
+      threshold: 25
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: false
+  similar-code:
+    enabled: false
+  identical-code:
+    enabled: false
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-70
+  brakeman:
+    enabled: true
+exclude_patterns:
+- "config/"
+- "db/"
+- "dist/"
+- "features/"
+- "**/node_modules/"
+- "script/"
+- "public/"
+- "tmp/"
+- "**/vendor/"

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/README.md

@@ -76,10 +76,6 @@ Accepts a list of symbols. These symbols specify the attributes that are supplie
 
 This will disallow any parameters in `create` and `update` actions.
 
-#### `permit_all_params!`
-
-This will permit all parameters in `create` and `update` actions.
-
 ## Notes
 
 Authentication & AppController functionality will be deprecated in v0.6 and removed in v1.0. With the 1.0 release, Rapido will remove all functionality that is not strictly oriented to streamlining API Controller development and security.

data/lib/rapido/api_controller.rb

@@ -13,6 +13,8 @@ module Rapido
       rescue_from RecordNotFound do |e|
         render json: { errors: [ e.to_s ] }, status: 404
       end
+
+      before_action :permit_only_allowed_actions
     end
 
     def index
@@ -24,42 +26,92 @@ module Rapido
     end
 
     def create
+      before_build
       new_resource = build_resource(resource_params)
+      before_create(new_resource)
       if new_resource.save
+        after_create_success(new_resource)
+        return if performed?
         render json: present_resource(new_resource), status: :created
       else
+        after_create_failure(new_resource)
+        return if performed?
         render json: { errors: new_resource.errors.full_messages }, status: 422
       end
     end
 
     def destroy
       resource_before_destruction = present_resource(resource)
+      before_destroy
       resource.destroy
+      after_destroy_success
+      return if performed?
       render json: resource_before_destruction
     end
 
     def update
+      before_assign_attributes
       resource.assign_attributes(resource_params)
+      before_update
       if resource.save
+        after_update_success
+        return if performed?
         render json: present_resource(resource)
       else
+        after_update_failure
+        return if performed?
         render json: { errors: resource.errors.full_messages }, status: 422
       end
     end
 
     private
 
-    def present_resource(resource)
-      args = presenter_args.nil? ? nil : presenter_args.map { |arg| params[arg] }
-      return presenter.new(*[resource, *args]).as_json if presenter
-      resource.to_h
-    end
+      def after_create_failure(new_resource)
+      end
 
-    def present_resource_collection(resource_collection)
-      args = collection_presenter_args.nil? ? nil : collection_presenter_args.map { |arg| params[arg] }
-      return collection_presenter.new(*[resource_collection, *args]).as_json if collection_presenter
-      return resource_collection.map{ |r| presenter.new(r).as_json } if presenter
-      resource_collection.map(&:to_h)
-    end
+      def after_create_success(new_resource)
+      end
+
+      def after_destroy_success
+      end
+
+      def after_update_failure
+      end
+
+      def after_update_success
+      end
+
+      def before_assign_attributes
+      end
+
+      def before_build
+      end
+
+      def before_create(new_resource)
+      end
+
+      def before_destroy
+      end
+
+      def before_update
+      end
+
+      def permit_only_allowed_actions
+        return unless allowed_actions
+        head :unauthorized unless allowed_actions.include?(params[:action].to_sym)
+      end
+
+      def present_resource(resource)
+        args = presenter_args.nil? ? nil : presenter_args.map { |arg| params[arg] }
+        return presenter.new(*[resource, *args]).as_json if presenter
+        resource.to_h
+      end
+
+      def present_resource_collection(resource_collection)
+        args = collection_presenter_args.nil? ? nil : collection_presenter_args.map { |arg| params[arg] }
+        return collection_presenter.new(*[resource_collection, *args]).as_json if collection_presenter
+        return resource_collection.map { |r| presenter.new(r).as_json } if presenter
+        resource_collection.map(&:to_h)
+      end
   end
 end

data/lib/rapido/app_controller.rb

@@ -8,7 +8,7 @@ module Rapido
     include Rapido::Errors
 
     included do
-      Rails.logger.info "The AppController has been deprecated and will be removed in the v1.0 release."
+      Rails.logger.info 'The AppController has been deprecated and will be removed in the v1.0 release.'
       before_action do
         resource_permitted_params
       end
@@ -71,54 +71,54 @@ module Rapido
 
     private
 
-    def after_create_success(*)
-    end
+      def after_create_success(*)
+      end
 
-    def after_create_failure(*)
-    end
+      def after_create_failure(*)
+      end
 
-    def after_update_success(*)
-    end
+      def after_update_success(*)
+      end
 
-    def after_update_failure(*)
-    end
+      def after_update_failure(*)
+      end
 
-    def after_destroy_success(*)
-    end
+      def after_destroy_success(*)
+      end
 
-    def resource_path(action, resource = nil)
-      keys = { controller: params[:controller], action: action }
-      keys[resource_lookup_param] = resource.send(resource_lookup_param) if resource
-      keys[owner_lookup_param] = owner.send(owner_lookup_field) if owner_lookup_param.present?
-      url_for(keys)
-    end
+      def resource_path(action, resource = nil)
+        keys = { controller: params[:controller], action: action }
+        keys[resource_lookup_param] = resource.send(resource_lookup_param) if resource
+        keys[owner_lookup_param] = owner.send(owner_lookup_field) if owner_lookup_param.present?
+        url_for(keys)
+      end
 
-    def edit_path(resource)
-      @edit_path ||= resource_path(:edit, resource)
-    end
+      def edit_path(resource)
+        @edit_path ||= resource_path(:edit, resource)
+      end
 
-    def show_path(resource)
-      @show_path ||= resource_path(:show, resource)
-    end
+      def show_path(resource)
+        @show_path ||= resource_path(:show, resource)
+      end
 
-    def new_path
-      @new_path ||= resource_path(:new)
-    end
+      def new_path
+        @new_path ||= resource_path(:new)
+      end
 
-    def index_path
-      @index_path ||= resource_path(:index)
-    end
+      def index_path
+        @index_path ||= resource_path(:index)
+      end
 
-    def after_create_path(resource)
-      show_path(resource)
-    end
+      def after_create_path(resource)
+        show_path(resource)
+      end
 
-    def after_update_path(resource)
-      show_path(resource)
-    end
+      def after_update_path(resource)
+        show_path(resource)
+      end
 
-    def after_delete_path(*)
-      index_path
-    end
+      def after_delete_path(*)
+        index_path
+      end
   end
 end

data/lib/rapido/auth/api_key.rb

@@ -4,7 +4,7 @@ module Rapido
       extend ActiveSupport::Concern
 
       included do
-        Rails.logger.info "The Auth module has been deprecated and will be removed in the 1.0 release."
+        Rails.logger.info 'The Auth module has been deprecated and will be removed in the 1.0 release.'
         before_action :load_authority
 
         rescue_from LackAuthority do |e|

data/lib/rapido/controller.rb

@@ -24,6 +24,14 @@ module Rapido
     end
 
     class_methods do
+      def allow_only(*ary)
+        @allowed_actions = ary
+      end
+
+      def attr_permitted(*ary)
+        @resource_permitted_params = ary
+      end
+
       def belongs_to(sym, opts = {})
         @owner_class = sym.to_sym
         define_method @owner_class do
@@ -55,7 +63,7 @@ module Rapido
       end
 
       def owner_lookup_param(*args)
-        return @owner_lookup_param = str.to_sym if args.count == 1
+        return @owner_lookup_param = args[0].to_sym if args.count == 1
         @owner_lookup_param = args.join('_').to_sym
       end
 
@@ -71,14 +79,6 @@ module Rapido
         @resource_lookup_param = str.to_sym
       end
 
-      def attr_permitted(*ary)
-        @resource_permitted_params = ary
-      end
-
-      def permit_all_params!
-        @permit_all_params = true
-      end
-
       def resource_class_from_controller
         self.name.split('::')[-1].remove('Controller').singularize.underscore
       end
@@ -95,13 +95,17 @@ module Rapido
 
     private
 
+      def allowed_actions
+        setting(:allowed_actions)
+      end
+
       def build_resource(params = {})
-        return owner.send("build_" + resource_class_name, params) if setting(:has_one)
+        return owner.send('build_' + resource_class_name, params) if setting(:has_one)
         return owner.send(resource_class_name.pluralize).build(params) if owner && owner.respond_to?(resource_class_name.pluralize)
         begin
           send(:build)
         rescue NoMethodError
-          raise "Rapido::Controller must belong to something that responds to build or define a build method"
+          raise 'Rapido::Controller must belong to something that responds to build or define a build method'
         end
       end
 
@@ -174,9 +178,9 @@ module Rapido
               .find_by!(resource_lookup_param => params[resource_lookup_param])
           else
             begin NoMethodError
-              send(:find)
+                  send(:find)
             rescue
-              raise "Rapido::Controller must belong to something that has many or has one of resource, or define a find method"
+              raise 'Rapido::Controller must belong to something that has many or has one of resource, or define a find method'
             end
           end
        rescue ActiveRecord::RecordNotFound
@@ -216,11 +220,7 @@ module Rapido
       def resource_params
         return {} if setting(:permit_no_params)
         base = params.require(resource_class_name)
-        if setting(:permit_all_params)
-          base.permit!
-        else
-          base.permit(resource_permitted_params)
-        end
+        base.permit(resource_permitted_params)
       end
 
       def setting(var)

data/lib/rapido/version.rb

@@ -1,3 +1,3 @@
 module Rapido
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/rapido.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'bin'
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '> 1.15'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-rapido
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jonathan Kirst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,8 +47,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -89,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails API Dryer-o