spark_api 1.4.29 → 1.4.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe8ad347473ad647fb0da6fd681ebe2c6da50daa
-  data.tar.gz: 7d17ef58323eb5aad73e09167478d0456a7f1df9
+SHA256:
+  metadata.gz: '08a105761151bdff166a7c512a604339da3170b73d145f7842d17ccfaa06920d'
+  data.tar.gz: 3a6303ce787ba904c3c5bec3c1bdca6549e45115aa108d3c71bbfe8262646536
 SHA512:
-  metadata.gz: 0c2df47ef7d780b071df24b586c35838ef1537b68fbd4aac78d8adc99786c2b7de3e81f5d322e781bd0d06defd27fd4bb9f2058788d169d6e48184e346b629ef
-  data.tar.gz: a23bbccaab494a0007fc75ba5f7317473bc66bfaa268e221b008ad9eef1accbea77008fdc2ba246ebe5508a4f328164c27876f6404bfa3bf1bbfb049e3bed26e
+  metadata.gz: 1eb046b673d876b4226c341a0b1ed085ea80b29b4f8dbf600fc4f8156f4084582343861c4e4f9da2333f45c8a1d8e10cca7320b95a42cfc802ef26b177354b3e
+  data.tar.gz: 90b225ad0f9dd8801bf46488d8bb3f006d06bf700d4f93fcc9d5ec62667daa925bdd63410e8297efc860947ac67fce6d1932ca6d935a9e2d5949cc56abe92245

data/VERSION

@@ -1 +1 @@
-1.4.29
+1.4.31

data/lib/spark_api/request.rb

@@ -107,7 +107,7 @@ module SparkApi
     end
     
     def process_request_body(body)
-      if body.is_a?(Hash)
+      if body.is_a?(Hash) || body.is_a?(Array)
         body.empty? ? nil : {"D" => body }.to_json
       else
         body

data/script/reso_middleware_example.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+# This script demonstrates how to use the RESO Web API with the Ruby client by pulling listings
+# and replacing encoded field values with their corresponding human-readable values, which are
+# pulled from the XML returned by the RESO metadata endpoint.
+
+require "spark_api"
+require "nokogiri"
+
+# set up session and RESO Web API middleware
+SparkApi.configure do |config|
+    config.authentication_mode = SparkApi::Authentication::OAuth2
+    config.middleware = :reso_api
+end
+
+SparkApi.client.session = SparkApi::Authentication::OAuthSession.new({ :access_token => "OAUTH2_ACCESS_TOKEN" })
+
+# pull metadata from RESO Web API
+metadata_res = (SparkApi.client.get("/$metadata", {:$ApiUser => "FLEXMLS_TECH_ID"}) )
+metadata_xml = Nokogiri::XML(metadata_res).remove_namespaces!
+
+# make an array of fields which need to be checked for readable values
+fields_to_lookup = []
+metadata_xml.xpath('//Schema/EnumType/@Name').each do |el|
+  fields_to_lookup << el.to_str
+end
+
+# get 25 listings
+listings = (SparkApi.client.get("/Property", {:$top => 25, :$ApiUser => "FLEXMLS_TECH_ID"} ))
+
+listings['value'].each do |listing| # for each listing,
+  fields_to_lookup.each do |field| # go through the array of fields to be checked.
+    if !!listing[field] # when one of the fields that needs to be checked exists in a listing,
+      if listing[field].is_a? String
+        readable = metadata_xml.xpath( # check for readable value to be swapped in
+          "//Schema/
+          EnumType[@Name=\"#{field}\"]/
+          Member[@Name=\"#{listing[field]}\"]/
+          Annotation"
+        ).attr("String")
+
+        # if there is a readable value, swap it in
+        if !!readable
+          listing[field] = readable.to_str
+        end
+
+      elsif listing[field].is_a? Array
+        readable_arr = []
+        listing[field].each do |el|
+          readable = metadata_xml.xpath( # check for readable value to be swapped in
+            "//Schema/
+            EnumType[@Name=\"#{field}\"]/
+            Member[@Name=\"#{el}\"]/
+            Annotation"
+          ).attr("String")
+
+          # assemble a new array with readable values and swap it in
+          if !!readable
+            readable_arr << readable.to_str
+          else
+            readable_arr << el
+          end
+          listing[field] = readable_arr
+        end
+      end
+    end
+  end
+end
+
+puts listings

data/spec/unit/spark_api/request_spec.rb

@@ -118,6 +118,8 @@ describe SparkApi do
         stub.put('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"WLMCEWENS Contact","PrimaryEmail":"wlmcewen789@fbsdata.com"}]}}') { [200, {}, '{"D": {
           "Success": true}}'] 
         }
+        stub.put('/v1/arraydata?ApiSig=SignedToken&AuthToken=1234', '{"D":["A","B","C"]}') {[200, {}, '{"D": {
+          "Success": true}}']}
         stub.delete('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234') { [200, {}, '{"D": {
           "Success": true}}'] 
         }
@@ -223,6 +225,10 @@ describe SparkApi do
         subject.post('/stringdata', 'I am a lonely String!').success?.should == true
       end
 
+      it "should support arrays in the body" do
+        subject.put('/arraydata', ["A","B","C"]).success?.should == true
+      end
+
       it "should allow response object to be returned instead of body" do
         r = subject.get('/system', { full_response: true })
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 1.4.29
+  version: 1.4.31
 platform: ruby
 authors:
 - Brandon Hornseth
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -382,6 +382,7 @@ files:
 - script/example.rb
 - script/oauth2_example.rb
 - script/release
+- script/reso_middleware_example.rb
 - spec/fixtures/accounts/all.json
 - spec/fixtures/accounts/my.json
 - spec/fixtures/accounts/my_portal.json
@@ -600,7 +601,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.8'
 requirements: []
 rubyforge_project: spark_api
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A library for interacting with the Spark web services.