spark_api 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7851c708d86ee3e4e8163208a82df7c3324b3e74bffe946f9835fd2ed1239956
-  data.tar.gz: 4e5e264d9171f59937ea86faf990f5da95b1d41db4c4c2061f3a5b83c7f8085e
+  metadata.gz: 353a8083132bf4adf595f251845285fb20a0c11705b023d44da0cf77bedde244
+  data.tar.gz: 873de66f1df1457fd51f3f5ea4d40c7270d7ad59b764de91b908442078da9953
 SHA512:
-  metadata.gz: 8e8f11e72f6cd4156d31e7d51e10936213402e751dda09c9788e673a6469a76fb217554cd2b35daf2f4349485fbb8fd8ac94e21948bf39156b671ef5341ecfeb
-  data.tar.gz: 05ea289076fc911908aeaa5b130ca361eb46290c89baa8a4dade37b2dc8cf318a822748dc3b86c4652f10e1037c68c7994df7cf5484c4639ea20b835b4a3c948
+  metadata.gz: cfbb0fd6551de1400c563517ed704938ced9ff7d9bc275dd485f568368f9f6a9f79c631848d845078ec1ca2339c96d0277114ecb2bc7652f185dc9003d075adc
+  data.tar.gz: 4aae25e2056353ce88b9d5375d39a3c1553f90fd3cbb44dc8c1d1148c877ad196ac6e121409f374924e241d23cded008d8c928f0ab189ee69a20d41870d7dbfe

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.3

data/lib/spark_api/reso_faraday_middleware.rb

@@ -13,8 +13,11 @@ module SparkApi
         env[:body] = body
       rescue MultiJson::ParseError => e
         # We will allow the client to choose their XML parser, but should do
-        # some minor format verification
-        raise e if body.strip[/\A<\?xml/].nil?
+        # some minor format verification.
+        # Note: the JSON decode above raised before assigning +body+, so the
+        # local +body+ is still nil here. Reference the raw +env[:body]+
+        # instead — that's what we actually want to inspect for an XML prolog.
+        raise e if env[:body].to_s.strip[/\A<\?xml/].nil?
       end
     end
   end

data/spec/unit/spark_api/reso_faraday_middleware_spec.rb

@@ -0,0 +1,63 @@
+require './spec/spec_helper'
+
+describe SparkApi::ResoFaradayMiddleware do
+  def reso_test_connection(stubs)
+    Faraday.new(nil, headers: SparkApi::Client.new.headers) do |conn|
+      conn.response :reso_api
+      conn.adapter :test, stubs
+    end
+  end
+
+  let(:xml_metadata) do
+    %(<?xml version="1.0" encoding="UTF-8"?>\n<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx"/>\n)
+  end
+
+  let(:json_d_envelope) do
+    '{"D":{"Success":true,"Results":[{"Name":"My User"}]}}'
+  end
+
+  let(:plain_json_no_d) do
+    '{"@odata.context":"https://api.example.com/$metadata#Property","value":[]}'
+  end
+
+  let(:non_json_non_xml_garbage) do
+    'TOTAL GARBAGE'
+  end
+
+  it "passes JSON bodies wrapped in the legacy +D+ envelope through to the parent middleware" do
+    stubs = Faraday::Adapter::Test::Stubs.new { |s| s.get('/v1/system') { [200, {}, json_d_envelope] } }
+    response = reso_test_connection(stubs).get('/v1/system')
+    expect(response.body.success).to eq(true)
+    expect(response.body.results.first['Name']).to eq('My User')
+  end
+
+  it "decodes a flat OData JSON response (no +D+ envelope) and stores it on +env[:body]+" do
+    stubs = Faraday::Adapter::Test::Stubs.new { |s| s.get('/Property') { [200, {}, plain_json_no_d] } }
+    response = reso_test_connection(stubs).get('/Property')
+    expect(response.body).to be_a(Hash)
+    expect(response.body['@odata.context']).to eq('https://api.example.com/$metadata#Property')
+  end
+
+  # Regression: prior to this fix the JSON parse-error rescue referenced the
+  # local +body+ variable, but the +MultiJson.decode+ call in the +begin+
+  # block had already raised before +body+ was assigned, so it was always
+  # nil at the rescue point. Calling +.strip+ on nil raised
+  # +NoMethodError: undefined method `strip' for nil:NilClass+ for *every*
+  # XML response, including the +/$metadata+ endpoint.
+  it "passes a RESO XML metadata body through without raising NoMethodError" do
+    stubs = Faraday::Adapter::Test::Stubs.new do |s|
+      s.get('/$metadata') { [200, { 'Content-Type' => 'application/xml' }, xml_metadata] }
+    end
+    expect {
+      response = reso_test_connection(stubs).get('/$metadata')
+      expect(response.body).to eq(xml_metadata)
+    }.not_to raise_error
+  end
+
+  it "raises the original MultiJson::ParseError for non-JSON, non-XML bodies" do
+    stubs = Faraday::Adapter::Test::Stubs.new do |s|
+      s.get('/garbage') { [200, {}, non_json_non_xml_garbage] }
+    end
+    expect { reso_test_connection(stubs).get('/garbage') }.to raise_error(MultiJson::ParseError)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Brandon Hornseth
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-06 00:00:00.000000000 Z
+date: 2026-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -530,6 +530,7 @@ files:
 - spec/unit/spark_api/paginate_spec.rb
 - spec/unit/spark_api/primary_array_spec.rb
 - spec/unit/spark_api/request_spec.rb
+- spec/unit/spark_api/reso_faraday_middleware_spec.rb
 - spec/unit/spark_api_spec.rb
 homepage: https://github.com/sparkapi/spark_api
 licenses:
@@ -753,5 +754,6 @@ test_files:
 - spec/unit/spark_api/paginate_spec.rb
 - spec/unit/spark_api/primary_array_spec.rb
 - spec/unit/spark_api/request_spec.rb
+- spec/unit/spark_api/reso_faraday_middleware_spec.rb
 - spec/unit/spark_api_spec.rb
 - spec/spec_helper.rb