spark_api 2.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 225a876c0d7cc718e2f7b02544ad280b304d2dae759af03e1a0f2a54558f5323
-  data.tar.gz: 0da2c909ca58b47e9dd9583a6fef4256fcf0ab55448a6eff00ff29cc6a42bd5c
+  metadata.gz: 353a8083132bf4adf595f251845285fb20a0c11705b023d44da0cf77bedde244
+  data.tar.gz: 873de66f1df1457fd51f3f5ea4d40c7270d7ad59b764de91b908442078da9953
 SHA512:
-  metadata.gz: 7435c421f7978b5e48b79a6d2f2cb9fc9e88ac664b5b4c9b9f956e0e72b7d4cf115e7ebb4024b0551aacc98975d887f0957c67ddecc232fa6777d92567d20875
-  data.tar.gz: 6a71260f031fd07ac91721b026beec5665986b447a25d1465ff1875819197d38840999879d0ec73717b844e9abb00f94d8e5103a001152bdfaa49ec4853503cf
+  metadata.gz: cfbb0fd6551de1400c563517ed704938ced9ff7d9bc275dd485f568368f9f6a9f79c631848d845078ec1ca2339c96d0277114ecb2bc7652f185dc9003d075adc
+  data.tar.gz: 4aae25e2056353ce88b9d5375d39a3c1553f90fd3cbb44dc8c1d1148c877ad196ac6e121409f374924e241d23cded008d8c928f0ab189ee69a20d41870d7dbfe

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.3

data/lib/spark_api/request.rb

@@ -42,6 +42,19 @@ module SparkApi
       request(:put, path, body, options)
     end
 
+    # Perform an HTTP PATCH request
+    #
+    # * path - Path of an api resource, excluding version and endpoint (domain) information
+    # * body - Hash for patch body data
+    # * options - Resource request options as specified being supported via and api resource
+    # :returns:
+    #   Hash of the json results as documented in the api.
+    # :raises:
+    #   SparkApi::ClientError or subclass if the request failed.
+    def patch(path, body = nil, options={})
+      request(:patch, path, body, options)
+    end
+
     # Perform an HTTP DELETE request
     # 
     # * path - Path of an api resource, excluding version and endpoint (domain) information

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/request_spec.rb

@@ -120,8 +120,11 @@ describe SparkApi do
         }
         stub.put('/v1/arraydata?ApiSig=SignedToken&AuthToken=1234', '{"D":["A","B","C"]}') {[200, {}, '{"D": {
           "Success": true}}']}
+        stub.patch('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"WLMCEWENS Contact","PrimaryEmail":"wlmcewen789@fbsdata.com"}]}}') { [200, {}, '{"D": {
+          "Success": true}}']
+        }
         stub.delete('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234') { [200, {}, '{"D": {
-          "Success": true}}'] 
+          "Success": true}}']
         }
         # Other MISC requests
         stub.post('/v1/stringdata?ApiSig=SignedToken&AuthToken=1234', 'I am a lonely String!') { [200, {}, '{"D": {
@@ -214,6 +217,11 @@ describe SparkApi do
         expect(subject.put('/contacts/1000', data).size).to be(0)
         # No validation here, if no error is raised, everything is hunky dory
       end
+      it "should patch to a service" do
+        data = {"Contacts" => [{"DisplayName"=>"WLMCEWENS Contact","PrimaryEmail"=>"wlmcewen789@fbsdata.com"}]}
+        expect(subject.patch('/contacts/1000', data).size).to be(0)
+        # No validation here, if no error is raised, everything is hunky dory
+      end
       it "should delete from a service" do
         # This is a hypothetical unsupported service action at this time
         expect(subject.delete('/contacts/1000').size).to be(0)

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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.3
 platform: ruby
 authors:
 - Brandon Hornseth
 - Wade McEwen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2026-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -129,6 +129,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -516,12 +530,13 @@ 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:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -537,7 +552,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.8'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A library for interacting with the Spark web services.
 test_files:
@@ -739,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