jsonapi_compliable 0.11.13 → 0.11.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e51276044c4062270de44eda40b761e68de042a6
-  data.tar.gz: eaf59452eafd80b98c3ab1364ad765e9e6d1aae8
+  metadata.gz: 85cb483d105b4de74832a99fefe27def18abf39c
+  data.tar.gz: df674dec125d95d7a53850cffa4505cc25dc7cc7
 SHA512:
-  metadata.gz: 4cb12821a1359842eb6c96c617676c1c6f2ba130b7086b3db022f4378fa661bf354b9e5bc7d11f001954d7e5b1812d851cfad6756089c7c72ad77b2f13badb2d
-  data.tar.gz: 230c1750efd1c49d8ea71644bf52de3631bd819e1eb76c7473b27f8da147ab6009cfec2298626b7e810b89117e9398c2d52d2c8c8e243936248af7128127a0fd
+  metadata.gz: 9d8ccc89afff5695bb27ab30b1fa07a209ec349fb68f0c07042a152dc3b63a7775235bc20386ca75cae0c0a574564faf4a0316815a7226c4c0181beb5e431a82
+  data.tar.gz: 935e966df8bd96148ff5cadd32bee84257b723f1f7872236a8e2d7d32effc54e8e07ee93c9b5b8532240502a6422c34547c20149864bf30be67d2ad40450a70a

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.4.1

data/lib/jsonapi_compliable/errors.rb

@@ -47,5 +47,19 @@ module JsonapiCompliable
 
     class RecordNotFound < StandardError
     end
+
+    class RequiredFilter < StandardError
+      def initialize(attributes)
+        @attributes = Array(attributes)
+      end
+
+      def message
+        if @attributes.length > 1
+          "The required filters \"#{@attributes.join(', ')}\" were not provided"
+        else
+          "The required filter \"#{@attributes[0]}\" was not provided"
+        end
+      end
+    end
   end
 end

data/lib/jsonapi_compliable/resource.rb

@@ -172,7 +172,8 @@ module JsonapiCompliable
       config[:filters][name.to_sym] = {
         aliases: aliases,
         if: opts[:if],
-        filter: blk
+        filter: blk,
+        required: opts[:required].respond_to?(:call) ? opts[:required] : !!opts[:required]
       }
     end
 

data/lib/jsonapi_compliable/scoping/filter.rb

@@ -28,6 +28,7 @@ module JsonapiCompliable
     # aliases. If valid, call either the default or custom filtering logic.
     # @return the scope we are chaining/modifying
     def apply
+      raise JsonapiCompliable::Errors::RequiredFilter.new(missing_required_filters) unless required_filters_provided?
       each_filter do |filter, value|
         @scope = filter_scope(filter, value)
       end

data/lib/jsonapi_compliable/scoping/filterable.rb

@@ -23,5 +23,19 @@ module JsonapiCompliable
     def filter_param
       query_hash[:filter]
     end
+
+    def missing_required_filters
+      required_filters.keys - filter_param.keys
+    end
+
+    def required_filters
+      resource.filters.select do |_name, opts|
+        opts[:required].respond_to?(:call) ? opts[:required].call(resource.context) : opts[:required]
+      end
+    end
+
+    def required_filters_provided?
+      missing_required_filters.empty?
+    end
   end
 end

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.11.13"
+  VERSION = "0.11.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.11.13
+  version: 0.11.14
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable