reso_api 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a24486d919c84b2bd716ce37c8b37ee62fca566624f3434acb475dfd2de462b
-  data.tar.gz: 0e0cdc536424944953720bfe4947b99dc2333c672aab55c6d4cb42908785e7a7
+  metadata.gz: f5624dabe91c3a3bd78ddcc2d97739ab10d59d57e4783c73dc47bbdb9c5375f7
+  data.tar.gz: cbba6150b14e931a7dec5e452aa58f9eff62714c0975b76b62017ff7e1f2e9db
 SHA512:
-  metadata.gz: 56c4522468e00c7891a244ae8efa9de68ea5b7575d72a61c373bd01e616c17a3cac7de8f84912cbd349e1bcb07e397b08c05db81ae34c6136fd07e3156c60385
-  data.tar.gz: 32c65364cce709339eaabe46a0e165efdfcbc54d7cca45d2cdd99e858af63df1b69adc5813c63fc4980ceb647821648186fcb41df20f8f0465313fc006a656da
+  metadata.gz: 0f8a79709def240a5b99ac99afaa3aab9fc716d3c4a81a1a46d8bbb33309f204867a15128ce0cfa3c2ec757b212f66cfb1692aa9139a233e6a94ea99e714c7f8
+  data.tar.gz: 00a6bc23609386cad5c943ba6b78b389d7c9309f320504818371e4faf5b9235719ca04266eb85cbfea317a3ef74a79f108939e1c44929bde642cd22a31e11cec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reso_api (2.0.0)
+    reso_api (2.0.1)
       activesupport
       jwt
       oauth2
@@ -9,53 +9,79 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     base64 (0.3.0)
     benchmark (0.5.0)
     bigdecimal (4.0.1)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    diff-lcs (1.6.2)
     drb (2.2.3)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
-    i18n (1.10.0)
+    faraday (2.14.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    hashie (5.1.0)
+      logger
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    jwt (2.3.0)
+    json (2.18.1)
+    jwt (3.1.2)
+      base64
     logger (1.7.0)
-    minitest (5.15.0)
-    multi_json (1.15.0)
-    multi_xml (0.6.0)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    multi_xml (0.8.1)
+      bigdecimal (>= 3.1, < 5)
     mutex_m (0.3.0)
-    oauth2 (1.4.9)
-      faraday (>= 0.17.3, < 3.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    oauth2 (2.0.18)
+      faraday (>= 0.17.3, < 4.0)
+      jwt (>= 1.0, < 4.0)
+      logger (~> 1.2)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    rack (2.2.3.1)
-    rake (13.0.6)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0, >= 2.0.3)
+      version_gem (~> 1.1, >= 1.1.9)
+    prism (1.9.0)
+    rack (3.2.4)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    securerandom (0.4.1)
+    snaky_hash (2.0.3)
+      hashie (>= 0.1.0, < 6)
+      version_gem (>= 1.1.8, < 3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.1.1)
+    version_gem (1.1.9)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -72,6 +72,14 @@ You pass these two pieces of information to create an instance of an API client:
 client = RESO::API::Client.new(access_token: access_token, base_url: base_url)
 ```
 
+#### Base URL for Replication
+
+Some systems, like Bridge Interactive, provide replication endpoints that differ from the ones for normal search requests by including an additional path segment *following* the resource segment. For example:
+
+    https://api.bridgedataoutput.com/api/v2/OData/{dataset_id}/Property/replication
+
+To accommodate this, the `base_url` parameter may contain a `/$resource$` segment which will be replaced for each API call with the appropriate resource segment.
+
 
 ### Resources
 
@@ -365,9 +373,17 @@ For servers that support it, `$ignorenulls` omits empty keys from the response t
 client.properties(ignorenulls: true)
 ```
 
+#### $ignorecase
+
+For servers that support it, `$ignorecase` performs case-insensitive filtering. Note that this is not a standard OData parameter and may only be supported by certain providers (e.g. Constellation1).
+
+```ruby
+client.members(filter: "MemberLastName eq 'Smith'", ignorecase: true)
+```
+
 #### Automatically iterate over all results
 
-By passing a block to Media, Member, Office, and Property resource calls, subsequent paginated calls will automatically be made until the whole result set has been traversed. The block provided is executed for each returned object hash. The `batch` option can be used to return the full array of results. 
+By passing a block to Media, Member, Office, and Property resource calls, subsequent paginated calls will automatically be made until the whole result set has been traversed. The block provided is executed for each returned object hash. The `batch` option can be used to return the full array of results.
 
 Here are a couple of examples of how that can be used:
 

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

@@ -64,8 +64,8 @@ module RESO
 
           hash = args.first.is_a?(Hash) ? args.first : {}
 
-          filter = hash[:filter].to_s
-          if !filter.include?('OriginatingSystemName') && osn.present?
+          filter = hash[:filter]
+          if !filter.to_s.include?('OriginatingSystemName') && osn.present?
             osn_filter = format("OriginatingSystemName eq '%s'", osn.to_s)
             filter = [filter.presence, osn_filter].compact.join(' and ')
           end
@@ -82,6 +82,7 @@ module RESO
             "$expand": hash[:expand],
             "$count": hash[:count].to_s.presence,
             "$ignorenulls": hash[:ignorenulls].to_s.presence,
+            "$ignorecase": hash[:ignorecase].to_s.presence,
             "$debug": hash[:debug]
           }.compact
           if !block.nil?
@@ -232,7 +233,12 @@ module RESO
       end
 
       def uri_for_endpoint endpoint
-        return URI(endpoint).host ? URI(endpoint) : URI([base_url, endpoint].join)
+        uri = URI(endpoint)
+        return uri if uri.host
+        uri = URI(base_url)
+        path = uri.path
+        uri.path = path.include?("/$resource$") ? path.sub("/$resource$", endpoint) : [path, endpoint].join
+        return uri
       end
 
       def perform_call(endpoint, params, max_retries = 5, debug = false)
@@ -275,7 +281,7 @@ module RESO
             fresh_oauth2_payload
             raise StandardError
           elsif response.is_a?(Hash) && response.has_key?("error")
-            error_msg = response.inspect
+            error_msg = "#{@last_request_url} => #{response.inspect}"
             puts "Error: #{error_msg}" if debug
             raise StandardError, error_msg
           elsif response.is_a?(Hash) && response.has_key?("retry-after")

data/lib/reso_api/version.rb

@@ -1,3 +1,3 @@
 module ResoApi
-  VERSION = "2.0.0"
+  VERSION = "2.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reso_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Michael Edlund