reso_api 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e51657547bb2a45e16490860b4aded5a31d850ba2a3d7a15b224e36ea25fd402
-  data.tar.gz: 6948ea2f8c1144cf48969a384ee692ce2a43470b17efa9e87779b0263067d192
+  metadata.gz: d4a950c58781ec5c74884efd37ceb091855cdc061e491c83a206d47e8121a4a7
+  data.tar.gz: a05ad1c1835d3d097e828462028132cd1b508bc1eee4a475bee94c112dfbe38c
 SHA512:
-  metadata.gz: 42bec1b92b962854d32eedb70b938418c8bd403542508e6339ebf1282f4dcfc8ed085de96c46aebc1fc7684f55408d82466ff3a146b40d97e7a3634892545b7a
-  data.tar.gz: a174d7fab55595c742da77961e81b5520d6ba48c2aba2c5ba18fd9a89ebff657f42c0d180e68b104ae8b8fffc963bddebb469b09fff648c87e655be23de0e21e
+  metadata.gz: 8076aca2231e877bd54c27a64595dfa6f58ee8e5078ba6d5f4d289b7e642387ad28407485e7203ffb4e1416f8ebc813be3906393a60ba726494ca9ca4af4789a
+  data.tar.gz: 54b68fdbcdde0c9332db35b862c83497ffd0df1f19e676fe390a3bd6bf1246f3cf15723214bbb75f9867df0a0ab7ad6252ec6f7123071041d500bb87b76cd4d0

data/Gemfile.lock

@@ -1,62 +1,81 @@
 PATH
   remote: .
   specs:
-    reso_api (0.2.0)
+    reso_api (0.2.1)
       activesupport
       oauth2
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    faraday (0.15.4)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    i18n (1.6.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jwt (2.1.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    jwt (2.2.3)
+    minitest (5.14.4)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    oauth2 (1.4.1)
-      faraday (>= 0.8, < 0.16.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    rack (2.0.7)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rack (2.2.3)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (>= 2.2.10)
+  rake (>= 12.3.3)
   reso_api!
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.27

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.
@@ -132,6 +135,14 @@ You can order the results by a field using `$orderby`:
 client.properties(orderby: "City desc")
 ```
 
+#### $expand
+
+$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(expand: "Media")
+```
+
 #### Pagination, $top, and $skip
 
 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.
@@ -192,6 +203,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,21 +29,21 @@ 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|
@@ -82,7 +83,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.0"
+  VERSION = "0.3.1"
 end

data/reso_api.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency 'activesupport'
   spec.add_dependency "oauth2"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: reso_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Michael Edlund
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: RESO Web API Wrapper
 test_files: []