Added ResultIterator filtering

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.6.1
+
+Feature:
+
+- Added `where` filtering to result iterators (thanks to Jeljer te Wies for the feature).
+
 ## 1.6.0
 
 Feature:

README.md

@@ -1201,7 +1201,19 @@ The following attributes will pass validation since they explicitly `allow_nil`:
 - `:retirement_age`
 - `:favorite_authors`
 
-### Debugging
+### Filtering result lists
+
+If the API returns a JSON list of items, this is retured to you as a `Flexirest::ResultIterator` object. A `ResultIterator` sorts simple filtering of the list based on values matching a specified criteria (or matching using regular expressions):
+
+```ruby
+class Article < Flexirest::Base
+  get :all, "/articles"
+end
+
+Article.all.where(published: true, department: /technical\-/)
+```
+
+## Debugging
 
 You can turn on verbose debugging to see what is sent to the API server and what is returned in one of these two ways:
 

lib/flexirest/result_iterator.rb

@@ -63,6 +63,20 @@ def delete_if
       self
     end
 
+    def where(criteria={})
+      @items.select do |object|
+        select = true
+        criteria.each do |k, v|
+          if v.is_a?(Regexp)
+            select = false if !object[k][v]
+          else
+            select = false if object[k] != v
+          end
+        end
+        select
+      end
+    end
+
     def parallelise(method=nil)
       collected_responses = []
       threads = []

lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

spec/lib/result_iterator_spec.rb

@@ -109,7 +109,30 @@
     expect(result.items).to eq(["a"])
   end
 
+  it "can filter results by simple matching criteria" do
+    class Something < Flexirest::Base
+    end
+
+    results = Flexirest::ResultIterator.new
+    results << Something.new(type: "foo")
+    results << Something.new(type: "foo")
+    results << Something.new(type: "bar")
+
+    expect(results.where(type: "foo").count).to eq(2)
+  end
 
+  it "can filter results using regular expression matching criteria" do
+    class Something < Flexirest::Base
+    end
+
+    results = Flexirest::ResultIterator.new
+    results << Something.new(type: "fooo")
+    results << Something.new(type: "foo")
+    results << Something.new(type: "fo")
+    results << Something.new(type: "bar")
+
+    expect(results.where(type: /foo+/).count).to eq(2)
+  end
 
   it "can parallelise calls to each item" do
     result = Flexirest::ResultIterator.new