reso_api 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec848b7c652396095ce3180d40c57015bdd40a20f54898500cf560ed66b0f4dd
-  data.tar.gz: a2a40ca2833627b66fa7b2d64381ec57ab96ac0b846ff3a9290299dd4574aa3d
+  metadata.gz: 5babf97fd51193ebd80b33651871b83e12749395760c5d4db13d3232ebee4548
+  data.tar.gz: dfd4f7f31c5273d01d6b5084ed42aadeb9784903891074c9adaaed26ab3e3a52
 SHA512:
-  metadata.gz: 21caa86ce758a79a23b4b8729a887a698aff3f236f310ced36b2f1cfadc8184cf605021ed31ff97a4d7731d36a0f5aaaf2be1ae63e9ff049c36b63d66794b8bd
-  data.tar.gz: 0f6f792e96a0690a2e7a66fd94175c373df2f1a9e64e00f0e98087aa3a95e21c2f50bb218a28415de1bab00447c2d7992c9d9718233e4265645826deff214791
+  metadata.gz: 756f59ac0272091ee42faa06cd76d4ddfa3212cf07cbe0ec373f0a523afe9aaeb659b0a83496863f77473aa89a0dc3185f67dd3de3c18fb5dacff685837e7a2b
+  data.tar.gz: ace0e14e850638bb71741290fc48dea35210d8102b65fda5f01e1b710c2ebae705ea43a6b7c4a726a559e584fb946b707ff52aa73aebbdb571bf9fd0a0f224ca

data/README.md

@@ -37,15 +37,18 @@ To set up an API client using OAuth2 authentication, you need four pieces of inf
 
 - Client ID
 - Client Secret
-- Base API endpoint
 - Authentication URL
+- Base URL
+- Scope
+
+Often, the base URL ends with `/odata`, and the authentication URL often ends with `/token`.
 
-Often, the base API endpoint ends with `/odata`, and the authentication URL often ends with `/token`.
+Scope defaults to "api" and only needs to be included if it is "OData" or something else.
 
 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, auth_url: auth_url, 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, scope: scope)
 ```
 
 When calling API endpoints using the initialized client, it will automatically fetch and manage access and authentication tokens transparently in the background.

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

@@ -7,10 +7,10 @@ module RESO
       require 'json'
       require 'tmpdir'
 
-      attr_accessor :access_token, :client_id, :client_secret, :auth_url, :base_url
+      attr_accessor :access_token, :client_id, :client_secret, :auth_url, :base_url, :scope
 
       def initialize(**opts)
-        @access_token, @client_id, @client_secret, @auth_url, @base_url = opts.values_at(:access_token, :client_id, :client_secret, :auth_url, :base_url)
+        @access_token, @client_id, @client_secret, @auth_url, @base_url, @scope = opts.values_at(:access_token, :client_id, :client_secret, :auth_url, :base_url, :scope)
         validate!
       end
 
@@ -29,6 +29,7 @@ module RESO
         media: "MediaKey",
         members: "MemberKey",
         offices: "OfficeKey",
+        open_houses: "OpenHouseKey",
         properties: "ListingKey"
       }
 
@@ -36,6 +37,7 @@ module RESO
         medium: "/Media",
         member: "/Member",
         office: "/Office",
+        open_house: "/OpenHouse",
         property: "/Property"
       }
 
@@ -43,6 +45,7 @@ module RESO
         media: "/Media",
         members: "/Member",
         offices: "/Office",
+        open_houses: "/OpenHouse",
         properties: "/Property"
       }
 
@@ -58,9 +61,9 @@ module RESO
           params = {
             "$select": hash[:select],
             "$filter": hash[:filter],
-            "$top": hash[:top] ||= 100,
+            "$top": hash[:top].presence,
             "$skip": hash[:skip],
-            "$orderby": hash[:orderby] ||= RESOURCE_KEYS[method_name],
+            "$orderby": hash[:orderby].to_a.presence,
             "$skiptoken": hash[:skiptoken],
             "$expand": hash[:expand],
             "$count": hash[:count].to_s.presence,
@@ -109,7 +112,7 @@ module RESO
           client_id,
           client_secret,
           token_url: auth_url,
-          scope: "api",
+          scope: scope.presence || "api",
           grant_type: "client_credentials"
         )
       end
@@ -128,7 +131,7 @@ module RESO
       end
 
       def fresh_oauth2_payload
-        @oauth2_payload = oauth2_client.client_credentials.get_token('client_id' => client_id, 'client_secret' => client_secret)
+        @oauth2_payload = oauth2_client.client_credentials.get_token('client_id' => client_id, 'client_secret' => client_secret, 'scope' => scope || "api")
         File.write(oauth2_token_path, @oauth2_payload.to_hash.to_json)
         return @oauth2_payload
       end
@@ -146,7 +149,7 @@ module RESO
           persisted = File.read(oauth2_token_path)
           payload = OAuth2::AccessToken.from_hash(oauth2_client, JSON.parse(persisted))
         else
-          payload = oauth2_client.client_credentials.get_token('client_id' => client_id, 'client_secret' => client_secret)
+          payload = oauth2_client.client_credentials.get_token('client_id' => client_id, 'client_secret' => client_secret, 'scope' => scope || "api")
           File.write(oauth2_token_path, payload.to_hash.to_json)
         end
         return payload
@@ -179,7 +182,7 @@ module RESO
             fresh_oauth2_payload
             raise StandardError
           elsif response.is_a?(Hash) && response.has_key?("error")
-            puts "Error."
+            puts "Error: #{response.inspect}"
             raise StandardError
           elsif response.is_a?(Hash) && response.has_key?("retry-after")
             puts "Error: Retrying in #{response["retry-after"].to_i}} seconds."

data/lib/reso_api/version.rb

@@ -1,3 +1,3 @@
 module ResoApi
-  VERSION = "1.6.0"
+  VERSION = "1.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_api
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Michael Edlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: RESO Web API Wrapper