sinja 1.1.0.pre1 → 1.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4491b24eba74ba902735fc26ff679b074bc5a76c
-  data.tar.gz: 54f55fd1b953b7dd31b5bb911386bb6f1bf83419
+  metadata.gz: d785d25fe6c9bd3e61893ca5a1ec23b237d9e3cb
+  data.tar.gz: 0eb4c07d1691587fb117ebbfc6d2fb63a911ae81
 SHA512:
-  metadata.gz: 362031551256e0e28912b13447825269388a54ff698624027ae44e557fc37489686c11427fe43c84b5983d23f8317772c58f5d0185c8373df1e4f43698abf90a
-  data.tar.gz: f282eef01caa1c271f7555f1121f3d2d7fba5e65962a20c10e8e688e380ec67930be8b95002eaad734de1ed9b573421cadaa95b77af6bcea9ef64dd3975e8bf7
+  metadata.gz: 0ee40f0a379063b13846967163f181c50ec7c86303155864ecf234369e41faf1d84006c3ac4d07aeff6df13cfcd7ae1010b8055e59b9d0e06d98e666700159aa
+  data.tar.gz: 6c82ef3fc4fba1670526d5f2aab3fa09ea76921cfe2c8de997f8b13fd52b110fcd45ea34c03bbfaeddc7c43dd76ded5936f71bd5acc1e12f73c47058331e280c

data/README.md

@@ -35,6 +35,7 @@ the {json:api} specification is).
     - [`resource`](#resource)
       - [`index {..}` => Array](#index---array)
       - [`show {|id| ..}` => Object](#show-id---object)
+      - [`show_many {|ids| ..}` => Array](#show_many-ids---array)
       - [`create {|attr, id| ..}` => id, Object?](#create-attr-id---id-object)
       - [`create {|attr| ..}` => id, Object](#create-attr---id-object)
       - [`update {|attr| ..}` => Object?](#update-attr---object)
@@ -114,7 +115,7 @@ all other {json:api} endpoints returning 404 or 405):
 * `POST /posts`
 
 The resource locator and other action helpers, documented below, enable other
-endpoints. Please see the [demo-app](/demo-app) for more complete examples.
+endpoints.
 
 Of course, "modular"-style Sinatra aplications require you to register the
 extension:
@@ -134,6 +135,8 @@ class App < Sinatra::Base
 end
 ```
 
+Please see the [demo-app](/demo-app) for a more complete example.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -172,11 +175,11 @@ with the JsonApi adapter, [JSONAPI::Resources][8] (JR), and
 [jsonapi-utils][26], all of which are designed to work with [Rails][16] and
 [ActiveRecord][17]/[ActiveModel][18] (although they may work with [Sequel][13]
 via [sequel-rails][14] and Sequel's [`:active_model` plugin][15]). Otherwise,
-you might use something like Sinatra, [Roda][20], or [Grape][19] with
-JSONAPI::Serializers (or another (de)serialization library), your own routes,
-and a ton of boilerplate. The goal of this extension is to provide most or all
-of the boilerplate for a Sintara application and automate the drawing of routes
-based on the resource definitions.
+you might use something like Sinatra, [Roda][20], or [Grape][19] with a
+(de)serialization library, your own routes, and a ton of boilerplate. The goal
+of this extension is to provide most or all of the boilerplate for a Sintara
+application and automate the drawing of routes based on the resource
+definitions.
 
 ### Ol' Blue Eyes is Back
 
@@ -836,7 +839,7 @@ resource :foos do
 end
 ```
 
-Please see the [demo-app](/demo-app) for more complete examples.
+Please see the [demo-app](/demo-app) for a more complete example.
 
 ### Query Parameters
 
@@ -847,8 +850,8 @@ a per-route whitelist, and interrogates your application to see which features
 it supports; for example, a route may allow a `filter` query parameter, but you
 may not have defined a `filter` helper.
 
-To allow a custom query parameter through, add it to the `query_params`
-configurable with a `nil` value:
+To let a custom query parameter through to the standard action helpers, add it
+to the `query_params` configurable with a `nil` value:
 
 ```ruby
 configure_jsonapi do |c|
@@ -898,6 +901,23 @@ resource :posts do
 end
 ```
 
+The easiest way to set a default filter is to tweak the post-processed query
+parameter(s) in a `before_<action>` hook:
+
+```ruby
+resource :posts do
+  helpers do
+    def before_index
+      params['filter']['type'] ||= 'article'
+    end
+  end
+
+  index do
+    # ..
+  end
+end
+```
+
 #### Sorting
 
 Allow clients to sort the collections returned by the `index` and `fetch`
@@ -924,6 +944,23 @@ resource :posts do
 end
 ```
 
+The easiest way to set a default sort order is to tweak the post-processed
+query parameter(s) in a `before_<action>` hook:
+
+```ruby
+resource :posts do
+  helpers do
+    def before_index
+      params['sort'] << [:title, :asc] if params['sort'].empty?
+    end
+  end
+
+  index do
+    # ..
+  end
+end
+```
+
 #### Paging
 
 Allow clients to page the collections returned by the `index` and `fetch`
@@ -965,6 +1002,23 @@ and `:size` for the above example) along with their default values (or `nil`).
 Please see the [Sequel helpers](/lib/sinja/helpers/sequel.rb) in this
 repository for a detailed, working example.
 
+The easiest way to page a collection by default is to tweak the post-processed
+query parameter(s) in a `before_<action>` hook:
+
+```ruby
+resource :posts do
+  helpers do
+    def before_index
+      params['page']['number'] ||= 1
+    end
+  end
+
+  index do
+    # ..
+  end
+end
+```
+
 #### Finalizing
 
 If you need to perform any additional actions on a collection after it is
@@ -1123,7 +1177,8 @@ either `graft` or `create`.
 `graft`, `merge`, and `clear` are the only action helpers invoked by
 sideloading. You must indicate which combinations are valid using the
 `:sideload_on` action helper option. (Note that if you want to sideload `merge`
-on `update`, you must define a `clear` action helper as well.) For example:
+on `update`, you must define a `clear` action helper and allow it to sideload
+on `update` as well.) For example:
 
 ```ruby
 resource :photos do
@@ -1259,7 +1314,26 @@ status 404.
 Optionally, to reduce round trips to the database, you may define a "special"
 `show_many` action helper that takes an array of IDs to show. It does not take
 `:roles` or any other options and will only be invoked if the current user has
-access to `show`. This feature is still experimental.
+access to `show`. This feature is experimental.
+
+Collections assembled during coalesced find requests will not be filtered,
+sorted, or paged. The easiest way to limit the number of records that can be
+queried is to define a `show_many` action helper and validate the length of the
+passed array in the `before_show_many` hook:
+
+```ruby
+resource :foos do
+  helpers do
+    def before_show_many(ids)
+      halt 413, 'You want the impossible.' if ids.length > 50
+    end
+  end
+
+  show_many do |ids|
+    # ..
+  end
+end
+```
 
 ### Patchless Clients
 

data/lib/sinja.rb

@@ -42,10 +42,8 @@ module Sinja
       define_singleton_method(:resource_config) { config[:resource] }
 
       helpers do
-        %i[can? sanity_check! sideload?].each do |meth|
-          define_method(meth) do |*args|
-            super(resource_name, *args)
-          end
+        define_method(:sanity_check!) do |*args|
+          super(resource_name, *args)
         end
       end
 
@@ -93,7 +91,7 @@ module Sinja
       condition do
         actions.each do |action|
           raise ForbiddenError, 'You are not authorized to perform this action' \
-            unless can?(action) || sideload?(action)
+            unless can?(action)
           raise MethodNotAllowedError, 'Action or method not implemented or supported' \
             unless respond_to?(action)
         end
@@ -178,14 +176,9 @@ module Sinja
         end
       end
 
-      def can?(resource_name, action, rel_type=nil, rel=nil)
-        config = settings._sinja.resource_config[resource_name]
-        config = rel_type && rel ? config[rel_type][rel] : config[:resource]
-        # JRuby issues with nil default_proc (fixed in 9.1.7.0?)
-        # https://github.com/jruby/jruby/issues/4302
-        #roles = config&.dig(action, :roles)
-        roles = config&.key?(action) && config[action][:roles]
-        !roles || roles.empty? || roles === memoized_role
+      def can?(action)
+        roles = settings._resource_config[:resource].fetch(action, {})[:roles]
+        roles.nil? || roles.empty? || roles === memoized_role
       end
 
       def content?
@@ -204,7 +197,7 @@ module Sinja
       def normalize_filter_params
         return {} unless params[:filter]&.any?
 
-        halt 400, "Unsupported `filter' query parameter(s)" \
+        raise BadRequestError, "Unsupported `filter' query parameter(s)" \
           unless respond_to?(:filter)
 
         params[:filter].map do |k, v|
@@ -212,10 +205,17 @@ module Sinja
         end.to_h
       end
 
+      def filter_by?(action)
+        return true if settings.resource_config[action][:filter_by].empty? ||
+          params[:filter].keys.to_set.subset?(settings.resource_config[action][:filter_by])
+
+        raise BadRequestError, "Invalid `filter' query parameter(s)"
+      end
+
       def normalize_sort_params
         return [] unless params[:sort]&.any?
 
-        halt 400, "Unsupported `sort' query parameter(s)" \
+        raise BadRequestError, "Unsupported `sort' query parameter(s)" \
           unless respond_to?(:sort)
 
         params[:sort].map do |k|
@@ -224,41 +224,40 @@ module Sinja
         end.to_h
       end
 
+      def sort_by?(action)
+        return true if settings.resource_config[action][:sort_by].empty? ||
+          params[:sort].keys.to_set.subset?(settings.resource_config[action][:sort_by])
+
+        raise BadRequestError, "Invalid `sort' query parameter(s)"
+      end
+
       def normalize_page_params
         return {} unless params[:page]&.any?
 
-        halt 400, "Unsupported `page' query parameter(s)" \
+        raise BadRequestError, "Unsupported `page' query parameter(s)" \
           unless respond_to?(:page)
 
-        h = params[:page].map do |k, v|
+        params[:page].map do |k, v|
           [dedasherize(k).to_sym, v]
         end.to_h
-
-        return h if h.keys.to_set.subset?(settings._sinja.page_using.keys.to_set)
-
-        halt 400, "Invalid `page' query parameter(s)"
       end
 
-      def filter_sort_page(collection, action)
-        unless params[:filter].empty?
-          halt 400, "Invalid `filter' query parameter(s)" \
-            unless settings.resource_config[action][:filter_by].empty? ||
-              params[:filter].keys.to_set.subset?(settings.resource_config[action][:filter_by])
+      def page_using?
+        return true if params[:page].keys.to_set.subset?(settings._sinja.page_using.keys.to_set)
 
-          collection = filter(collection, params[:filter])
-        end
-
-        unless params[:sort].empty?
-          halt 400, "Invalid `sort' query parameter(s)" \
-            unless settings.resource_config[action][:sort_by].empty? ||
-              params[:sort].keys.to_set.subset?(settings.resource_config[action][:sort_by])
+        raise BadRequestError, "Invalid `page' query parameter(s)"
+      end
 
-          collection = sort(collection, params[:sort])
-        end
+      def filter_sort_page?(action)
+        filter_by?(action) unless params[:filter].empty?
+        sort_by?(action) unless params[:sort].empty?
+        page_using? unless params[:page].empty?
+      end
 
-        unless params[:page].empty?
-          collection, pagination = page(collection, params[:page])
-        end
+      def filter_sort_page(collection)
+        collection = filter(collection, params[:filter]) unless params[:filter].empty?
+        collection = sort(collection, params[:sort]) unless params[:sort].empty?
+        collection, pagination = page(collection, params[:page]) unless params[:page].empty?
 
         collection = finalize(collection) if respond_to?(:finalize)
 
@@ -279,12 +278,6 @@ module Sinja
         @role ||= role
       end
 
-      def sideload?(resource_name, child)
-        return unless sideloaded?
-        parent = env['sinja.passthru'].to_sym
-        settings.resource_config[child][:sideload_on]&.include?(parent) && can?(parent)
-      end
-
       def sideloaded?
         env.key?('sinja.passthru')
       end

data/lib/sinja/helpers/sequel.rb

@@ -27,15 +27,15 @@ module Sinja
         ::Sequel::DATABASES.first
       end
 
-      def filter(collection, **fields)
+      def filter(collection, fields)
         collection.where(fields)
       end
 
-      def sort(collection, **fields)
+      def sort(collection, fields)
         collection.order(*fields.map { |k, v| ::Sequel.send(v, k) })
       end
 
-      def page(collection, **opts)
+      def page(collection, opts)
         opts = settings._sinja.page_using.merge(opts)
         collection = collection.dataset \
           unless collection.respond_to?(:paginate)

data/lib/sinja/relationship_routes/has_many.rb

@@ -23,8 +23,9 @@ module Sinja
         end
 
         app.get '', :qparams=>%i[include fields filter sort page], :actions=>:fetch do
+          filter_sort_page?(:fetch)
           collection, opts = fetch
-          collection, links = filter_sort_page(collection, :fetch)
+          collection, links = filter_sort_page(collection)
           (opts[:links] ||= {}).merge!(links)
           serialize_models(collection, opts)
         end

data/lib/sinja/resource.rb

@@ -92,8 +92,12 @@ module Sinja
           define_singleton_method(:resource_config) { config }
 
           helpers Helpers::Nested do
-            define_method(:can?) do |*args|
-              super(*args, rel_type, rel)
+            define_method(:can?) do |action, *args|
+              parent = sideloaded? && env['sinja.passthru'].to_sym
+
+              roles, sideload_on = config.fetch(action, {}).values_at(:roles, :sideload_on)
+              roles.nil? || roles.empty? || roles === memoized_role ||
+                parent && sideload_on.include?(parent) && super(parent, *args)
             end
 
             define_method(:serialize_linkage) do |*args|

data/lib/sinja/resource_routes.rb

@@ -18,21 +18,20 @@ module Sinja
         ids = ids.split(',') if String === ids
         ids = [*ids].tap(&:uniq!)
 
+        resources, opts = [], {}
         if respond_to?(:show_many)
           resources, opts = show_many(ids)
           raise NotFoundError, "Resource(s) not found" \
             unless ids.length == resources.length
-          serialize_models(resources, opts)
         else
-          opts = {}
-          resources = ids.map! do |id|
+          ids.each do |id|
             tmp, opts = show(id)
             raise NotFoundError, "Resource '#{id}' not found" unless tmp
-            tmp
+            resources << tmp
           end
-
-          serialize_models(resources, opts)
         end
+
+        serialize_models(resources, opts)
       end
 
       app.head '' do
@@ -40,8 +39,9 @@ module Sinja
       end
 
       app.get '', :qparams=>%i[include fields filter sort page], :actions=>:index do
+        filter_sort_page?(:index)
         collection, opts = index
-        collection, links = filter_sort_page(collection, :index)
+        collection, links = filter_sort_page(collection)
         (opts[:links] ||= {}).merge!(links)
         serialize_models(collection, opts)
       end

data/lib/sinja/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sinja
-  VERSION = '1.1.0.pre1'
+  VERSION = '1.1.0.pre2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre1
+  version: 1.1.0.pre2
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport