reso_api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a950c58781ec5c74884efd37ceb091855cdc061e491c83a206d47e8121a4a7
-  data.tar.gz: a05ad1c1835d3d097e828462028132cd1b508bc1eee4a475bee94c112dfbe38c
+  metadata.gz: df418de7906726ce76a9ef70d0b28bb65f21fe04b5264a6e8f2f6eaeb5a67853
+  data.tar.gz: 1b193a3d83c5c6449def7557e098f70f1079b01217768587c542fd763f020710
 SHA512:
-  metadata.gz: 8076aca2231e877bd54c27a64595dfa6f58ee8e5078ba6d5f4d289b7e642387ad28407485e7203ffb4e1416f8ebc813be3906393a60ba726494ca9ca4af4789a
-  data.tar.gz: 54b68fdbcdde0c9332db35b862c83497ffd0df1f19e676fe390a3bd6bf1246f3cf15723214bbb75f9867df0a0ab7ad6252ec6f7123071041d500bb87b76cd4d0
+  metadata.gz: 94f88f67b6a5e455d0be9964e57941e7546add7f731ec066399e515734554f4b31cfb56eebf69b601977a0126b5ac77011dd3d701392cc4b3732df57dc35e19e
+  data.tar.gz: 7662e7a7d27c917cfea6467cefc24c08def9bb332bd2f76eeb88834ffb465767f05ba4400e66dbd33133b9fa7984d4cf568b75911f5265d9b953b72c7bbda80c

data/README.md

@@ -143,7 +143,24 @@ $expand in oData is meant to join two resources together. For the Syndication AP
 client.properties(expand: "Media")
 ```
 
-#### Pagination, $top, and $skip
+#### Automatically iterate over all results
+
+By passing a block to Media, Member, Office, and Property resource calls, subsequent paginated calls will automatically be made until the whole result set has been traversed. The block provided is executed for each returned object hash.
+
+Here are a couple of examples of how that can be used:
+
+```ruby
+client.properties(filter: "StandardStatus eq 'Active'") do |hash|
+  puts "#{hash['ListingKey']} – #{hash['UnparsedAddress']}"
+end
+
+client.properties(filter: "StandardStatus eq 'Active'") do |hash|
+  Listing.create(listing_key: hash['ListingKey'], data: hash)
+end
+```
+
+
+#### Manually iterate over all results
 
 The default number of results returned is 100. You can override the default limit using the `$top` parameter. The higher the number specific for `$top`, the longer the API response will take, and pay attention to that different services does enforce a cap for number of records returned.
 

data/lib/reso_api/app/models/reso/api/client.rb

@@ -47,7 +47,7 @@ module RESO
       }
 
       FILTERABLE_ENDPOINTS.keys.each do |method_name|
-        define_method method_name do |*args|
+        define_method method_name do |*args, &block|
           hash = args.first.is_a?(Hash) ? args.first : {}
           endpoint = FILTERABLE_ENDPOINTS[method_name]
           params = {
@@ -61,7 +61,16 @@ module RESO
             "$count": hash[:count].to_s.presence,
             "$debug": hash[:debug]
           }.compact
-          return perform_call(endpoint, params)
+          if !block.nil?
+            response = perform_call(endpoint, params)
+            response["value"].each{|hash| block.call(hash)} if response["value"].class.eql?(Array)
+            while response["@odata.nextLink"].present?
+              response = perform_call(response["@odata.nextLink"], nil)
+              response["value"].each{|hash| block.call(hash)} if response["value"].class.eql?(Array)
+            end
+          else
+            return perform_call(endpoint, params)
+          end
         end
       end
 

data/lib/reso_api/version.rb

@@ -1,3 +1,3 @@
 module ResoApi
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Edlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler