jsonapi-scopes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33158dfc4e2dca2de6f9456be63d610b7e9fe991af9978e402f4fb83a1ca3f34
-  data.tar.gz: 2476592685ac57f54da4bfbcee51c9f82a36a3d8071c64fa353d6e1743fa3479
+  metadata.gz: cef6f1279f2c02d4fa7c4672b6c74f7920c17875b05d2bad161d0e6c0776ce45
+  data.tar.gz: 0ffe8a25b91a4f5df7e58fa2cadc449912f654c3dddb9497403db5e66a8bffae
 SHA512:
-  metadata.gz: 738a1e0b568ddccca26617937b45955d373f000fc56c2a38ddeee9d038566548b644fa8f0b97e03cce14d3fe8834f441354f60f326c380c408e6db0bef99bffe
-  data.tar.gz: 121fe2100e22ab0d0a073a3474d1ba7233bb842fd48c44fa8e97a4f78bc5bf97d8e212ef92106ed0f3f9b0bf37d39346f4ea5045415970f5fd2da9eb3727cf93
+  metadata.gz: b91918c357e2745abd0813d9b5ce181e8fd9e7262d000591fe5910cf2c3d97942ddc65fc659b00120abd89246d1e3b2e2075fe66d85091d0477fe5ea7617fd45
+  data.tar.gz: c6771c3aa0d76a0b4f176df986ca3bd556f6417723f6af5d6fcbc037415fce66333b8d56d163662c3093bbee5b70d42ea3e4b72b29acea29d4b03a30e06ae3d9

data/README.md

@@ -95,6 +95,25 @@ Or use negative sort `/contacts?sort=-firstname` to sort by firstname in `desc`
 
 You can even combine multiple sort `/contacts?sort=lastname,-firstname`
 
+
+### Rescuing a Bad Request in Rails
+
+Jsonapi::scope raises a `Jsonapi::InvalidAttributeError` you can [rescue_from](https://guides.rubyonrails.org/action_controller_overview.html#rescue-from) in your `ApplicationController`.
+
+If you want to follow the specification, you **must** respond with a `400 Bad Request`.
+
+```ruby
+class ApplicationController < ActionController::Base
+ rescue_from Jsonapi::InvalidAttributeError, with: :json_api_bad_request
+
+ private
+
+  def json_api_bad_request(exception)
+    render json: { error: exception.message }, status: :bad_request
+  end
+end
+```
+
 ## Contributing
 Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
 

data/lib/jsonapi/exceptions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Jsonapi
+  class Error < StandardError; end
+
+  class InvalidAttributeError < Error
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/jsonapi/scopes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+require 'jsonapi/exceptions'
 require 'jsonapi/scopes/filters'
 require 'jsonapi/scopes/sorts'

data/lib/jsonapi/scopes/filters.rb

@@ -21,7 +21,9 @@ module Jsonapi
         filtering_params.each do |key, value|
           value = value.to_s.split(',').reject(&:blank?) if value.include?(',')
 
-          records = records.public_send(key, value) if @filters.include?(key.to_sym)
+          raise InvalidAttributeError, "#{key} is not valid as filter attribute." unless @filters.include?(key.to_sym)
+
+          records = records.public_send(key, value)
         end
 
         records

data/lib/jsonapi/scopes/sorts.rb

@@ -21,16 +21,15 @@ module Jsonapi
       def apply_sort(params = {}, options = { allowed: [], default: {} })
         fields = params.dig(:sort)
 
-        allowed_fields = Array.wrap(options[:allowed]).presence || @sortable_fields
-        allowed_fields = allowed_fields.map(&:to_sym)
-
-        default_order = options[:default].presence || @default_sort
-        default_order = default_order.transform_keys(&:to_sym)
-
+        allowed_fields = (Array.wrap(options[:allowed]).presence || @sortable_fields).map(&:to_sym)
+        default_order = (options[:default].presence || @default_sort).transform_keys(&:to_sym)
         ordered_fields = convert_to_ordered_hash(fields)
-        filtered_fields = ordered_fields.select { |key, _| allowed_fields.include?(key) }
 
-        order = filtered_fields.presence || default_order
+        ordered_fields.each do |field, _|
+          raise InvalidAttributeError, "#{field} is not valid as sort attribute." unless allowed_fields.include?(field)
+        end
+
+        order = ordered_fields.presence || default_order
 
         self.order(order)
       end

data/lib/jsonapi/scopes/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Scopes
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-scopes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Guillaume Briday
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,6 +48,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/jsonapi/exceptions.rb
 - lib/jsonapi/scopes.rb
 - lib/jsonapi/scopes/filters.rb
 - lib/jsonapi/scopes/sorts.rb