fastapi 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 832572badad40969dcb8f6d057c0027d1715475d
-  data.tar.gz: 5ee51023d5100554b269cb038ba86083abca8667
+  metadata.gz: 914c5c91b0fd3b9f2b81b4da4d27554b05d254a5
+  data.tar.gz: ee22069497c8ba7c7704f60bbaf8a94af1df8ce2
 SHA512:
-  metadata.gz: 99cb06224e1c33548b2feb9c788d30f528f66dfe3c314dcc6f0930475eff980afd7213a3d9a08b5d6813bcee6be82c8758f8e50d182569e2f28640a4c5e163ca
-  data.tar.gz: 7cd11d4be9b02ba8f1d261b35411e76ed129f924838f791c92af706b85b00249760bbde389a2fb7516937a6d37eccd5673c0fdb97f46bedfc83bd5faaae7175a
+  metadata.gz: 267c4b35d3474ac545f24683baa22e7e4d1012de69c4cfb7d7dad20213d59a6a0816d2c951ed9db18f80d96da1c6e192a8168dbbaf1d4870c3f82fa702040083
+  data.tar.gz: 57fbf90fa9d58518b669aa95acec4f9b3904199e3c24609c8e0a9b0bd02e45d2fe87b10b88281302fec53e9035fc9cf9f205d009e8a9128ee81eeadc674cedb7

data/lib/fastapi.rb

@@ -28,12 +28,24 @@ class FastAPI
     @data = nil
     @metadata = nil
     @result_type = 0
+    @whitelist_fields = []
   end
 
   def inspect
     "<#{self.class}: #{@model}>"
   end
 
+  # Create and execute an optimized SQL query based on specified filters
+  #
+  # @param fields [Array] an array containing fields to whitelist for the SQL query
+  # @return [FastAPI] the current instance
+  def whitelist(fields = [])
+
+    @whitelist_fields.concat fields
+
+    self
+
+  end
 
   # Create and execute an optimized SQL query based on specified filters
   #
@@ -516,7 +528,7 @@ class FastAPI
           filters.each do |key, value|
             found_index = key.to_s.rindex('__')
             key_root = found_index.nil? ? key : key.to_s[0...found_index].to_sym
-            if not [:__order, :__offset, :__count].include? key and not self_obj.fastapi_fields_whitelist.include? key_root
+            if not [:__order, :__offset, :__count].include? key and not self_obj.fastapi_filters_whitelist.include? key_root
               raise 'Filter "' + key.to_s + '" not supported'
             end
           end
@@ -758,7 +770,11 @@ class FastAPI
 
       model_lookup = {}
 
-      @model.fastapi_fields.each do |field|
+      filter_fields = []
+      filter_fields.concat @model.fastapi_fields
+      filter_fields.concat @whitelist_fields
+
+      filter_fields.each do |field|
 
         if (@model.reflect_on_all_associations(:belongs_to).map(&:name).include? field or
           @model.reflect_on_all_associations(:has_one).map(&:name).include? field)

data/lib/fastapi/active_record_extension.rb

@@ -23,11 +23,12 @@ module FastAPIExtension
     end
 
     # Set safe fields for FastAPIInstance.safe_filter
+    # These are the fields that can be actively filtered by
     #
     # @param fields [Array] a list of fields in the form of symbols
     # @return [Array] the same array of fields
     def fastapi_safe_fields(fields)
-      @fastapi_fields_whitelist = fields
+      @fastapi_filters_whitelist = fields
     end
 
     # Used to set any default filters for the top level fastapi response
@@ -58,8 +59,8 @@ module FastAPIExtension
       @fastapi_fields_sub or [:id]
     end
 
-    def fastapi_fields_whitelist
-      @fastapi_fields_whitelist or @fastapi_fields or [:id]
+    def fastapi_filters_whitelist
+      @fastapi_filters_whitelist or @fastapi_fields or [:id]
     end
 
     def fastapi_filters

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastapi
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Keith Horwood