reso_api 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec848b7c652396095ce3180d40c57015bdd40a20f54898500cf560ed66b0f4dd
-  data.tar.gz: a2a40ca2833627b66fa7b2d64381ec57ab96ac0b846ff3a9290299dd4574aa3d
+  metadata.gz: 152e24a12afdb9af2c9385a365335df67b58704676b313c886a1833417ae8763
+  data.tar.gz: 88ca57e2199877808138e07f96999376541c40a138b90a920bf56940e786d212
 SHA512:
-  metadata.gz: 21caa86ce758a79a23b4b8729a887a698aff3f236f310ced36b2f1cfadc8184cf605021ed31ff97a4d7731d36a0f5aaaf2be1ae63e9ff049c36b63d66794b8bd
-  data.tar.gz: 0f6f792e96a0690a2e7a66fd94175c373df2f1a9e64e00f0e98087aa3a95e21c2f50bb218a28415de1bab00447c2d7992c9d9718233e4265645826deff214791
+  metadata.gz: 0e5c6750cddd94f0dc296e64baf3d008157754360c58c2350feb5df96fa4301f272ad4c1b81a3f20b809523bd16858fc018e38e0a190f71eb2b10f6b2b0552d5
+  data.tar.gz: 1a21eb60cd03e7e39a6cd33123f7635dd194f1cd4bb2e03d326788fecdc187316e9bfc79469f60847fe7d013d286611ef8e4dee49d0524a37d5b2bd3e1814912

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
 
@@ -109,7 +109,7 @@ module RESO
           client_id,
           client_secret,
           token_url: auth_url,
-          scope: "api",
+          scope: scope.presence || "api",
           grant_type: "client_credentials"
         )
       end
@@ -128,7 +128,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 +146,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 +179,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.0"
 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.0
 platform: ruby
 authors:
 - Michael Edlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-04-16 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