rails-rapido 0.9.3 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c62492980ddb246461582385eb1c9fa069b025ccbd39c4ae94189d33bafc836a
-  data.tar.gz: 14eb7a3269938509bb01ca8517cf68398445f05b6b93c92e918516e8c7c2aabd
+  metadata.gz: 4f94a2c707b7325512f48fee292918d01321378d6cfb6d87bbe9dc92e71a60ed
+  data.tar.gz: 954e3e1b070f353a3f4023202f301f52dc620498ff54aeea1cf7bc8e65a5dfd4
 SHA512:
-  metadata.gz: 05e5f8e6d38877005df077ab7b767c890158ba7a0be2f48130e0e16a41e5973f1ae4f16e40291f56481c9218425b9548707f22aeab2125b543515264d12f54eb
-  data.tar.gz: 26916c6b6672d778eec56db5fb1b52d1a03c805655a80322de84c5c8137a7ddc606c73d8bd7ad4a432aa557f849e0be2dcb01a56276a3459d399c8663210bf93
+  metadata.gz: 1a92e60537cca20540113fb1b6186ac9469e11d024127ddeda4391249a926909897198cc56472d7cdeeb80a18d41922601615199934ffc65cd1c993528662c63
+  data.tar.gz: b08530e8028fefcff3d737bb5d6ebd2580fe7949f0eda51b3c7747644433c56c800b4afb901d4b4a49e113fb384b37472336d097d595a722e5530dbb2cf9211a

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.0

data/README.md

@@ -14,8 +14,14 @@ Below is a typical example of a class using Rapido. More examples are available
 
 class DocumentsController < ApplicationController
   include Rapido::ApiController
+
+  allow_if do
+    current_user.is_editor?
+  end
+
+  allow_only :create, :delete, :index, :show, :update
   
-  attr_permitted :file, file_name, :category
+  attr_permitted :file, :file_name, :category
   
   belongs_to :user, getter: :current_user
   
@@ -46,6 +52,14 @@ end
 
 ## API
 
+### `allow_if`
+
+Accepts a method name as symbol or block. Method supplied or block must return true to allow the action to proceed, otherwise a status 401 is returned with no body.
+
+### `allow_only`
+
+Accepts a list of symbols. These symbols specify the controller actions that are allowed for this controller.
+
 ### `attr_permitted`
 
 Accepts a list of symbols. These symbols specify the attributes that are supplied to StrongParameters as permitted parameters in `create` and `update` actions.

data/lib/rapido/api_controller.rb

@@ -18,21 +18,61 @@ module Rapido
       end
 
       before_action :permit_only_allowed_actions
+
+      before_action :permit_only_if
     end
 
     def index
       return if performed?
-      render json: resource_collection_presenter
+      if request.format.to_sym == :json
+        if(params["filename"])
+          send_data resource_collection_presenter.as_json.to_json, filename: params["filename"]
+        else
+          render json: resource_collection_presenter
+        end
+      elsif request.format.to_sym == :xml
+        if(params["filename"])
+          send_data resource_collection_presenter.to_xml, filename: params["filename"]
+        else
+          render xml: resource_collection_presenter
+        end
+      elsif request.format.to_sym == :csv
+        if(params["filename"])
+          send_data resource_collection_presenter.to_csv, filename: params["filename"]
+        else
+          render plain: resource_collection_presenter.send("to_csv")
+        end
+      else
+        render json: resource_collection_presenter
+      end
     end
 
     def show
       return if performed?
       if request.format.to_sym == :json
-        render json: resource_presenter
+        if(params["filename"])
+          send_data resource_presenter.as_json.to_json, filename: params["filename"]
+        else
+          render json: resource_presenter
+        end
+      elsif request.format.to_sym == :html && !request.headers["accept"].include?("application/json")
+        if(params["filename"])
+          send_data resource_presenter.to_html, filename: params["filename"]
+        else
+          render html: resource_presenter.to_html.html_safe
+        end
       elsif request.format.to_sym == :xml
-        render xml: resource_presenter
+        if(params["filename"])
+          send_data resource_presenter.to_xml, filename: params["filename"]
+        else
+          render xml: resource_presenter
+        end
       elsif request.format.to_sym == :csv
-        render plain: resource_presenter.send("to_csv")
+        if(params["filename"])
+          send_data resource_presenter.to_csv, filename: params["filename"]
+        else
+          render plain: resource_presenter.send("to_csv")
+        end
       else
         render json: resource_presenter
       end
@@ -117,6 +157,14 @@ module Rapido
       head :unauthorized unless allowed_actions.include?(params[:action].to_sym)
     end
 
+    def permit_only_if
+      if(allow_if)
+        unless (allow_if.is_a?(Symbol) ? send(allow_if) : instance_eval(&allow_if))
+          head :unauthorized
+        end
+      end
+    end
+
     def resource_presenter(new_resource = nil)
       @resource_presenter ||= begin
         args = presenter_args.nil? ? nil : presenter_args.map { |arg| params[arg] }

data/lib/rapido/controller.rb

@@ -28,6 +28,10 @@ module Rapido
         @allowed_actions = ary
       end
 
+      def allow_if(str = nil, &block)
+        @allow_if = str || block
+      end
+
       def attr_permitted(*ary)
         @resource_permitted_params = ary
       end
@@ -101,6 +105,10 @@ module Rapido
       setting(:allowed_actions)
     end
 
+    def allow_if
+      setting(:allow_if)
+    end
+
     def build_resource(params = {})
       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)

data/lib/rapido/version.rb

@@ -1,3 +1,3 @@
 module Rapido
-  VERSION = '0.9.3'
+  VERSION = '0.9.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-rapido
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.7
 platform: ruby
 authors:
 - Jonathan Kirst
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,7 +68,7 @@ homepage: https://github.com/jskirst/rapido
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Rails API Dryer-o
 test_files: []