reso_api 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd054df51a2872e84c6828f7feb57c73657d5d8f0b81ee8635c42373f5b8cdaf
-  data.tar.gz: 5cbab3e17c508eafe75757797a9ff7201652b7fb3aed8643634d86899627ad5e
+  metadata.gz: df418de7906726ce76a9ef70d0b28bb65f21fe04b5264a6e8f2f6eaeb5a67853
+  data.tar.gz: 1b193a3d83c5c6449def7557e098f70f1079b01217768587c542fd763f020710
 SHA512:
-  metadata.gz: ab2cc31aa83fea44277e85e90969090a11262aaa3a6d6878e910599a516d47229878411f94fad9ad5f242a44029e62dab90e75437f5d297d3c35cfc4653b7632
-  data.tar.gz: b4763063bd29b3899229c19521d0b841050027e9e4c101bc49a36b4f79cbb418df93b50646de7d99bd4129caea183b4a89bdc2fae4b4ccb46a97cc61315b9b05
+  metadata.gz: 94f88f67b6a5e455d0be9964e57941e7546add7f731ec066399e515734554f4b31cfb56eebf69b601977a0126b5ac77011dd3d701392cc4b3732df57dc35e19e
+  data.tar.gz: 7662e7a7d27c917cfea6467cefc24c08def9bb332bd2f76eeb88834ffb465767f05ba4400e66dbd33133b9fa7984d4cf568b75911f5265d9b953b72c7bbda80c

data/README.md

@@ -31,11 +31,14 @@ To set up an API client and access a service, you need three pieces of informati
 - Client ID
 - Client Secret
 - Base API endpoint
+- Authentication URL
 
-You pass these three pieces of information when creating an instance of an API client:
+You'll recognize the base API endpoint by it ending with /odata, and the authentication URL by it likely ending with /token.
+
+You pass these four pieces of information to create an instance of an API client:
 
 ```ruby
-client = RESO::API::Client.new(client_id: client_id, client_secret: client_secret, base_url: base_url)
+client = RESO::API::Client.new(client_id: client_id, client_secret: client_secret, auth_url: auth_url, base_url: base_url)
 ```
 
 When calling API endpoints using the initialized client, it will automatically fetch and manage access and authentication tokens transparently in the background.
@@ -137,10 +140,27 @@ client.properties(orderby: "City desc")
 $expand in oData is meant to join two resources together. For the Syndication API this means you can bring in photos to any property query.
 
 ```ruby
-client.properties(еxpand: "Media")
+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.
 
@@ -200,6 +220,7 @@ client.properties(top: 5, orderby: "ListingKey", skiptoken: "3yd-AAABORMI-320039
 This gem should work with any RESO Web API compliant service, but these are those that have been confirmed to work.
 
 - [ListHub](https://www.listhub.com)
+- [CoreLogic Trestle](https://trestle.corelogic.com)
 
 If you use this gem to connect to another service or MLS, please submit a pull request with that service added in alphabetical order in this list.
 

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

@@ -7,16 +7,17 @@ module RESO
       require 'json'
       require 'tmpdir'
 
-      attr_accessor :client_id, :client_secret, :base_url
+      attr_accessor :client_id, :client_secret, :auth_url, :base_url
 
       def initialize(**opts)
-        @client_id, @client_secret, @base_url = opts.values_at(:client_id, :client_secret, :base_url)
+        @client_id, @client_secret, @auth_url, @base_url = opts.values_at(:client_id, :client_secret, :auth_url, :base_url)
         validate!
       end
 
       def validate!
         raise 'Missing Client ID `client_id`' if client_id.nil?
         raise 'Missing Client Secret `client_secret`' if client_secret.nil?
+        raise 'Missing Authentication URL `auth_url`' if auth_url.nil?
         raise 'Missing API Base URL `base_url`' if base_url.nil?
       end
 
@@ -28,25 +29,25 @@ module RESO
       }
 
       DETAIL_ENDPOINTS = {
-        medium: "odata/Media",
-        member: "odata/Member",
-        office: "odata/Office",
-        property: "odata/Property"
+        medium: "/Media",
+        member: "/Member",
+        office: "/Office",
+        property: "/Property"
       }
 
       FILTERABLE_ENDPOINTS = {
-        media: "odata/Media",
-        members: "odata/Member",
-        offices: "odata/Office",
-        properties: "odata/Property"
+        media: "/Media",
+        members: "/Member",
+        offices: "/Office",
+        properties: "/Property"
       }
 
       PASSTHROUGH_ENDPOINTS = {
-        metadata: "odata/$metadata"
+        metadata: "/$metadata"
       }
 
       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 = {
@@ -60,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
 
@@ -82,7 +92,9 @@ module RESO
         OAuth2::Client.new(
           client_id,
           client_secret,
-          token_url: [base_url, "oauth2/token"].join
+          token_url: auth_url,
+          scope: "api",
+          grant_type: "client_credentials"
         )
       end
 

data/lib/reso_api/version.rb

@@ -1,3 +1,3 @@
 module ResoApi
-  VERSION = "0.2.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.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Edlund
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ files:
 homepage: https://github.com/arcticleo/reso_api
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: RESO Web API Wrapper
 test_files: []