reso_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd054df51a2872e84c6828f7feb57c73657d5d8f0b81ee8635c42373f5b8cdaf
-  data.tar.gz: 5cbab3e17c508eafe75757797a9ff7201652b7fb3aed8643634d86899627ad5e
+  metadata.gz: 91f8dc7ead6ed968688dfc9c53c0e5a35ed1c4dffe5801fad27d97fae704bf57
+  data.tar.gz: e5a3d7475620f94bf470fde3e92a4e9dfbd4820c44df7aa1ed056e35bdb04ace
 SHA512:
-  metadata.gz: ab2cc31aa83fea44277e85e90969090a11262aaa3a6d6878e910599a516d47229878411f94fad9ad5f242a44029e62dab90e75437f5d297d3c35cfc4653b7632
-  data.tar.gz: b4763063bd29b3899229c19521d0b841050027e9e4c101bc49a36b4f79cbb418df93b50646de7d99bd4129caea183b4a89bdc2fae4b4ccb46a97cc61315b9b05
+  metadata.gz: b1e5e3408a40ee54db7dec2d959a16af34a9f6b31e4590d30116da71a7b81b9513f4de5eb14f996cc3b21a1cd9293a8a48c31841cfbebdf1b2edba7e540cc9c5
+  data.tar.gz: e7a10e99a931cd6a7e3eeb122d27fbc8c77a872846c4709264d3054586b63fff6a66c56488e9e41d455a95f9c4047df6db92ea114f22502fb3fc1479d2167f40

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.
@@ -200,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.1"
+  VERSION = "0.3.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.3.0
 platform: ruby
 authors:
 - Michael Edlund
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-03-04 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: []