flexirest 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8959a6f4a0183bc9395d12c61676d30da8157f30
-  data.tar.gz: dedf65e6535a9da183a39a8cae90aea1c95584f6
+  metadata.gz: 96c037bf934becbdc7d5381bfaef226550e1a3c1
+  data.tar.gz: 99c2aa6b76d361c1b6862c9bf82fc28b1914737a
 SHA512:
-  metadata.gz: 49edb2862a956a893d484d01a9baab9a53645129d29c8445cbabb59684355381b8127d3be16ec93d7b67b033984247efe9a6b74654ab579829a59ad661f9729d
-  data.tar.gz: 1edb7882ab1e52bfbffebf5940c53e95f878a9665aa2c07a8789a1f038b62c60b04f514d491b54c3964cef0b49753effffa97d1b0621e490633937f9f1da4c1d
+  metadata.gz: fe9c061af6b61f68cdffc1243546285f4a33450624dd08b77b8428cb9f58a4ecbf2be4605ff21654f86a35a41713e10055ba92badd4d0c4aaead4a6ff6d5c6f0
+  data.tar.gz: c7342b08bb159edbb8691166668e49d0235cd87c7aee73a27c7a127de495f1e81f17a44cbe95e5e58e003ea276d265739b1e67bd3709b4a52518b4328a0bbebd

data/.travis.yml

@@ -6,4 +6,3 @@ rvm:
   - 2.2.0
   - 2.1.0
   - 2.0.0
-  - 1.9.3

data/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:

data/README.md

@@ -45,12 +45,13 @@ If you are a previous user of ActiveRestClient, there's some more information on
   - [Proxying APIs](#proxying-apis)
   - [Translating APIs](#translating-apis)
   - [Default Parameters](#default-parameters)
-  - [Root element removal](#root-element-removal)
+  - [Root elements](#root-elements)
   - [Required Parameters](#required-parameters)
   - [Updating Only Changed/Dirty](#updating-only-changed-dirty)
   - [HTTP/Parse Error Handling](#httpparse-error-handling)
   - [Validation](#validation)
     - [Permitting nil values](#permitting-nil-values)
+  - [Filtering result lists](#filtering-result-lists)
 - [Debugging](#debugging)
 - [XML Responses](#xml-responses)
 - [Contributing](#contributing)
@@ -1201,7 +1202,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:
 

data/lib/flexirest/result_iterator.rb

@@ -63,6 +63,20 @@ module Flexirest
       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 = []

data/lib/flexirest/version.rb

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

data/spec/lib/result_iterator_spec.rb

@@ -109,7 +109,30 @@ describe Flexirest::ResultIterator do
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Andy Jeffries