reso_api 1.5.13 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c60f3b7a93a8fdff58458cb3ceedc48021d007bf88c65fc81455fde74002da9e
-  data.tar.gz: 97509b32ddd67a2d5ee5857d25fb322e55f3d1e3cb4246c451c0b02f1865fd36
+  metadata.gz: ec848b7c652396095ce3180d40c57015bdd40a20f54898500cf560ed66b0f4dd
+  data.tar.gz: a2a40ca2833627b66fa7b2d64381ec57ab96ac0b846ff3a9290299dd4574aa3d
 SHA512:
-  metadata.gz: eaa3ebf09faee81c40d59063d77468e716f14377a6ae3fd5bb8b59423831b7c3008b0d968cf91962948d828150680caadb7c4fc5f3a2997fa7710527dae9e2b3
-  data.tar.gz: 196d66437d0ceb577aa3521fb2bee7ae7fb996c2a3b46520ee5ea7268d2cda33751744c314939f57c1676db8657942a52d12f1711ace54e55c7010cef318fcc2
+  metadata.gz: 21caa86ce758a79a23b4b8729a887a698aff3f236f310ced36b2f1cfadc8184cf605021ed31ff97a4d7731d36a0f5aaaf2be1ae63e9ff049c36b63d66794b8bd
+  data.tar.gz: 0f6f792e96a0690a2e7a66fd94175c373df2f1a9e64e00f0e98087aa3a95e21c2f50bb218a28415de1bab00447c2d7992c9d9718233e4265645826deff214791

data/README.md

@@ -26,14 +26,21 @@ Or install it yourself as:
 
 ### Authentication and Access
 
-To set up an API client and access a service, you need three pieces of information:
+This gem supports two types of authentication:
+
+- OAuth2
+- Access Token
+
+#### OAuth2
+
+To set up an API client using OAuth2 authentication, you need four pieces of information:
 
 - Client ID
 - Client Secret
 - Base API endpoint
 - Authentication URL
 
-You'll recognize the base API endpoint by it ending with /odata, and the authentication URL by it likely ending with /token.
+Often, the base API endpoint ends with `/odata`, and the authentication URL often ends with `/token`.
 
 You pass these four pieces of information to create an instance of an API client:
 
@@ -43,6 +50,20 @@ client = RESO::API::Client.new(client_id: client_id, client_secret: client_secre
 
 When calling API endpoints using the initialized client, it will automatically fetch and manage access and authentication tokens transparently in the background.
 
+#### Access Token
+
+Some systems, like MLSGRID and Spark/Flexmls provides a persistent Access Token. In these cases, you need these two pieces of information to set up an API client:
+
+- Access Token
+- Base API endpoint
+
+You pass these two pieces of information to create an instance of an API client:
+
+```ruby
+client = RESO::API::Client.new(access_token: access_token, base_url: base_url)
+```
+
+
 ### Resources
 
 #### Supported Resources

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

@@ -7,18 +7,22 @@ module RESO
       require 'json'
       require 'tmpdir'
 
-      attr_accessor :client_id, :client_secret, :auth_url, :base_url
+      attr_accessor :access_token, :client_id, :client_secret, :auth_url, :base_url
 
       def initialize(**opts)
-        @client_id, @client_secret, @auth_url, @base_url = opts.values_at(:client_id, :client_secret, :auth_url, :base_url)
+        @access_token, @client_id, @client_secret, @auth_url, @base_url = opts.values_at(:access_token, :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?
+        if access_token.nil?
+          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?
+        else
+          raise 'Missing API Base URL `base_url`' if base_url.nil?
+        end
       end
 
       RESOURCE_KEYS = {
@@ -96,6 +100,10 @@ module RESO
         end
       end
 
+      def auth_token
+        access_token.presence ? access_token : oauth2_token
+      end
+
       def oauth2_client
         OAuth2::Client.new(
           client_id,
@@ -158,7 +166,7 @@ module RESO
         end
         begin
           req = Net::HTTP::Get.new(uri.request_uri)
-          req['Authorization'] = "Bearer #{oauth2_token}"
+          req['Authorization'] = "Bearer #{auth_token}"
           res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
             http.request(req)
           end

data/lib/reso_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_api
 version: !ruby/object:Gem::Version
-  version: 1.5.13
+  version: 1.6.0
 platform: ruby
 authors:
 - Michael Edlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-10-25 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.16
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: RESO Web API Wrapper