spark_api 1.4.28 → 1.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzJlMDhlOWU3YmE2MjRlOWI1YzUxZGRhZmQ2ODE1MWM3NTVhNGFhZQ==
-  data.tar.gz: !binary |-
-    OTBkZWY3NzI2NGFlODdjOGY2N2JkMmM0NDlhNWIxZTZjMDhkMGIwOQ==
+SHA256:
+  metadata.gz: 17eaaa74af21a3a858941c286e4731ae9d67d1b315f06f5a3409d78d7d4fa89e
+  data.tar.gz: 51373eaa638eefed5245d88d78cc0e1374d75cdfe385c3c358d4d40348059514
 SHA512:
-  metadata.gz: !binary |-
-    Zjc1MGQ4NmY0NWE0MjNmYTUzYmMzNzM4MTcxY2VmY2ZkODE1YTgxMjYwZjU3
-    NmIxMmVkZjI1OGYyMmM4NDAwMWU3ZmIwNzUwOWU2MmFmNDdmN2U1NDcwMTQ3
-    NTY5NjM0NmQzNTAzNzQ1NDUwYmYzMDFmZjg3NWRiYmQxNzk3YzU=
-  data.tar.gz: !binary |-
-    NDc5YTFmNzVlNjcwMWRjNzE2NzI2ZDdmYjVmNzg0ZjQ5ZjBmNDA1MThmMzNh
-    YTI0NjIxYzZkYjY2YTA0NDVkMzA0ZWU3M2ZjMmNiMjY0Y2E1NDgzMTY0ZWYx
-    MjEwNTAxNmI2ZjMxNjk2YTBkZjc0Y2VhNzExZTY1NDE0NzU0NDI=
+  metadata.gz: 7d81cd63e089a1182557cdeb95ab1e52d526904879294f66e22026c68d3dd4dd5ec8408763fd9d62ac72a9fcf23964ee9eec3d5e6e104a214e33c5a46ece21f7
+  data.tar.gz: c44265855abe3384dea240410e96230b68fca9f9ac3cef702feb1ff0e05d026d571833591d5fa4865c21f04dc9f48d7f2987ffc9895088ac5c4431d73fa9b3c0

data/README.md

@@ -1,6 +1,6 @@
 Spark API
 =====================
-[![Build Status](https://travis-ci.org/sparkapi/spark_api.png?branch=master)](http://travis-ci.org/sparkapi/spark_api) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/sparkapi/spark_api)
+![CI](https://github.com/sparkapi/spark_api/workflows/CI/badge.svg) ![Code Climate](https://codeclimate.com/badge.png)
 
 A Ruby wrapper for the Spark REST API. Loosely based on ActiveResource to provide models to interact with remote services.
 

data/VERSION

@@ -1 +1 @@
-1.4.28
+1.5.0

data/lib/spark_api/authentication/api_auth.rb

@@ -62,7 +62,7 @@ module SparkApi
       
       # Perform an HTTP request (no data)
       def request(method, path, body, options)
-        escaped_path = URI.escape(path)
+        escaped_path = Addressable::URI.escape(path)
         request_opts = {
           :AuthToken => @session.auth_token
         }

data/lib/spark_api/authentication/oauth2.rb

@@ -40,7 +40,7 @@ module SparkApi
       
       # Perform an HTTP request (no data)
       def request(method, path, body, options={})
-        escaped_path = URI.escape(path)
+        escaped_path = Addressable::URI.escape(path)
         connection = @client.connection(true)  # SSL Only!
         connection.headers.merge!(self.auth_header)
 

data/lib/spark_api/authentication/oauth2_impl/grant_type_base.rb

@@ -45,7 +45,7 @@ module SparkApi
           response.expires_in = provider.session_timeout if response.expires_in.nil?
           SparkApi.logger.debug { "[oauth2] New session created #{response}" }
           response
-        rescue Faraday::Error::ConnectionFailed => e
+        rescue Faraday::ConnectionFailed => e
           if @client.ssl_verify && e.message =~ /certificate verify failed/
             SparkApi.logger.error { SparkApi::Errors.ssl_verification_error }
           end

data/lib/spark_api/client.rb

@@ -2,7 +2,7 @@ module SparkApi
   # =API Client
   # Main class to setup and run requests on the API.  A default client is accessible globally as 
   # SparkApi::client if the global configuration has been set as well.  Otherwise, this class may 
-  # be instanciated separately with the configuration information.
+  # be instantiated separately with the configuration information.
   class Client
     include Connection
     include Authentication
@@ -21,7 +21,7 @@ module SparkApi
       Configuration::VALID_OPTION_KEYS.each do |key|
         send("#{key}=", options[key])
       end
-      # Instanciate the authenication class passed in.
+      # Instantiate the authentication class passed in.
       @authenticator = authentication_mode.send("new", self)
     end
     

data/lib/spark_api/models.rb

@@ -20,6 +20,7 @@ require 'spark_api/models/fields'
 require 'spark_api/models/idx'
 require 'spark_api/models/idx_link'
 require 'spark_api/models/incomplete_listing'
+require 'spark_api/models/floplan'
 require 'spark_api/models/listing'
 require 'spark_api/models/listing_cart'
 require 'spark_api/models/listing_meta_translations'

data/lib/spark_api/models/account.rb

@@ -52,7 +52,13 @@ module SparkApi
           nil
         end
       end
-      
+
+      def logo
+        if images.kind_of? Array
+          images.find { |image| image.Type == "Logo" }
+        end
+      end
+            
       def save(arguments={})
         self.errors = [] # clear the errors hash
         begin

data/lib/spark_api/models/account_report.rb

@@ -21,11 +21,6 @@ module SparkApi
         end
       end
 
-      def logo
-        if images.kind_of? Array
-          images.find { |image| image.Type == "Logo" }
-        end
-      end
     end
   end
 end

data/lib/spark_api/models/floplan.rb

@@ -0,0 +1,24 @@
+module SparkApi
+  module Models
+    class FloPlan < Base
+      extend Subresource
+      self.element_name = 'floplans'
+
+      attr_accessor :images, :thumbnails
+
+      def initialize(attributes={})
+        @images = []
+        @thumbnails = []
+
+        attributes['Images'].each do |img|
+          if img["Type"].include?('thumbnail')
+            @thumbnails << img
+          else
+            @images << img
+          end
+        end
+        super(attributes)
+      end
+    end
+  end
+end

data/lib/spark_api/models/listing.rb

@@ -2,7 +2,7 @@ module SparkApi
   module Models
     class Listing < Base 
       extend Finders
-      attr_accessor :photos, :videos, :virtual_tours, :documents, :open_houses, :tour_of_homes, :rental_calendars
+      attr_accessor :photos, :videos, :virtual_tours, :documents, :open_houses, :tour_of_homes, :rental_calendars, :floplans
       attr_accessor :constraints
       self.element_name="listings"
       DATA_MASK = "********"
@@ -17,6 +17,7 @@ module SparkApi
         @constraints = []
         @tour_of_homes = []
         @open_houses = []
+        @floplans = []
 
         if attributes.has_key?('StandardFields')
           pics, vids, tours, docs, ohouses, tourhomes = attributes['StandardFields'].values_at('Photos','Videos', 'VirtualTours', 'Documents', 'OpenHouses', 'TourOfHomes')
@@ -26,6 +27,10 @@ module SparkApi
           rentalcalendars = attributes['RentalCalendar']
         end
 
+        if attributes.has_key?('FloPlans')
+          floplans = attributes['FloPlans']
+        end
+
         if pics != nil
           setup_attribute(@photos, pics, Photo)
           attributes['StandardFields'].delete('Photos')
@@ -61,6 +66,11 @@ module SparkApi
           attributes.delete('RentalCalendar')
         end
 
+        if floplans != nil
+          setup_attribute(@floplans, floplans, FloPlan)
+          attributes.delete('FloPlans')
+        end
+
         super(attributes)
       end
 

data/lib/spark_api/models/subresource.rb

@@ -16,10 +16,10 @@ module SparkApi
 
       def parse_date_start_and_end_times(attributes)
         # Transform the date strings
-        unless attributes['Date'].nil?
+        unless attributes['Date'].nil? || attributes['Date'].empty?
           date = Date.strptime attributes['Date'], '%m/%d/%Y'
           ['StartTime','EndTime'].each do |time|
-            next if attributes[time].nil?
+            next if attributes[time].nil? || attributes[time].empty?
             formatted_date = "#{attributes['Date']}T#{attributes[time]}"
             datetime = nil
 

data/lib/spark_api/request.rb

@@ -99,7 +99,7 @@ module SparkApi
       else
         return response.body
       end
-    rescue Faraday::Error::ConnectionFailed => e
+    rescue Faraday::ConnectionFailed => e
       if self.ssl_verify && e.message =~ /certificate verify failed/
         SparkApi.logger.error { SparkApi::Errors.ssl_verification_error }
       end
@@ -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/fixtures/listings/floplans_index.json

@@ -0,0 +1,15 @@
+{
+  "D":{
+    "Results":[{
+      "Id": 4300,
+      "Name": "Feb 13",
+      "Images": [
+        {"Uri": "https://foo.bar",
+          "Type":"all_in_one_png"},
+        {"Uri": "https://foo.bar",
+          "Type": "all_in_one_thumbnail_png"}
+      ], 
+  "Success":true
+    }]
+  }
+}

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ end
 
 require "rubygems"
 require "rspec"
-require 'rspec/autorun'
 require 'webmock/rspec'
 require "json"
 require 'multi_json'
@@ -22,6 +21,13 @@ require path + '/spark_api'
 
 require 'spark_api'
 
+if ENV['COVERAGE'] == "on"
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start { add_filter %w(/vendor /spec /test) }
+end
+
 FileUtils.mkdir 'log' unless File.exists? 'log'
 
 module SparkApi
@@ -48,17 +54,16 @@ end
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
 RSpec.configure do |config|
-  
+
   config.include WebMock::API
   config.include StubApiRequests
 
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.alias_example_to :on_get_it, :method => 'GET'
   config.alias_example_to :on_put_it, :method => 'PUT'
   config.alias_example_to :on_post_it, :method => 'POST'
   config.alias_example_to :on_delete_it, :method => 'DELETE'
   config.before(:all) { reset_config }
-  config.color_enabled = true
+  config.color = true
 end
 
 def jruby? 

data/spec/unit/spark_api/authentication/api_auth_spec.rb

@@ -4,15 +4,14 @@ describe SparkApi::Authentication::ApiAuth  do
   subject {SparkApi::Authentication::ApiAuth.new(nil) }
   describe "build_param_hash" do
     it "should return a blank string when passed nil" do
-      subject.build_param_string(nil).should be_empty
+      expect(subject.build_param_string(nil)).to be_empty
     end
     it "should return a correct param string for one item" do
-      subject.build_param_string({:foo => "bar"}).should match("foobar")
+      expect(subject.build_param_string({:foo => "bar"})).to match("foobar")
     end
     it "should alphabatize the param names by key first, then by value" do
-      subject.build_param_string({:zoo => "zar", :ooo => "car"}).should match("ooocarzoozar")
-      subject.build_param_string({:Akey => "aValue", :aNotherkey => "AnotherValue"}).should 
-           match "AkeyaValueaNotherkeyAnotherValue"
+      expect(subject.build_param_string({:zoo => "zar", :ooo => "car"})).to match("ooocarzoozar")
+      expect(subject.build_param_string({:Akey => "aValue", :aNotherkey => "AnotherValue"})).to match("AkeyaValueaNotherkeyAnotherValue")
     end
   end
   
@@ -33,7 +32,7 @@ describe SparkApi::Authentication::ApiAuth  do
       stub_request(:post, "https://api.sparkapi.com/#{SparkApi.version}/session").
                   with(:query => {:ApiKey => "my_key", :ApiSig => "c731cf2455fbc7a4ef937b2301108d7a"}).
                   to_return(:body => fixture("authentication_failure.json"), :status=>401)
-      expect {subject.authenticate()}.to raise_error(SparkApi::ClientError){ |e| e.status.should == 401 }
+      expect {subject.authenticate()}.to raise_error(SparkApi::ClientError){ |e| expect(e.status).to eq(401) }
     end
   end
 
@@ -41,16 +40,16 @@ describe SparkApi::Authentication::ApiAuth  do
     let(:session) { Object.new }
     it "should return true when session is active" do
       subject.session = session
-      session.stub(:expired?) { false }
-      subject.authenticated?.should eq(true)
+      allow(session).to receive(:expired?) { false }
+      expect(subject.authenticated?).to eq(true)
     end
     it "should return false when session is expired" do
       subject.session = session
-      session.stub(:expired?) { true }
-      subject.authenticated?.should eq(false)
+      allow(session).to receive(:expired?) { true }
+      expect(subject.authenticated?).to eq(false)
     end
     it "should return false when session is uninitialized" do
-      subject.authenticated?.should eq(false)
+      expect(subject.authenticated?).to eq(false)
     end
   end
 
@@ -61,14 +60,14 @@ describe SparkApi::Authentication::ApiAuth  do
     it "should logout when there is an active session" do
       logged_out = false
       subject.session = session
-      client.stub(:delete).with("/session/1234") { logged_out = true }
+      allow(client).to receive(:delete).with("/session/1234") { logged_out = true }
       subject.logout
-      subject.session.should eq(nil)
-      logged_out.should eq(true)
+      expect(subject.session).to eq(nil)
+      expect(logged_out).to eq(true)
     end
     it "should skip logging out when there is no active session information" do 
-      client.stub(:delete) { raise "Should not be called" }
-      subject.logout.should eq(nil)
+      allow(client).to receive(:delete) { raise "Should not be called" }
+      expect(subject.logout).to eq(nil)
     end
   end
   
@@ -98,7 +97,7 @@ describe SparkApi::Authentication::ApiAuth  do
           :AuthToken => "1234"}.merge(args)).
         to_return(:body => fixture("listings/no_subresources.json"))
       subject.session = session
-      subject.request(:get, "/#{SparkApi.version}/listings", nil, args).status.should eq(200)
+      expect(subject.request(:get, "/#{SparkApi.version}/listings", nil, args).status).to eq(200)
     end
     it "should handle a post request" do
       stub_auth_request
@@ -118,14 +117,14 @@ describe SparkApi::Authentication::ApiAuth  do
             }]}
           }', 
           :status=>201)
-      subject.request(:post, "/#{SparkApi.version}/contacts", contact, args).status.should eq(201)
+      expect(subject.request(:post, "/#{SparkApi.version}/contacts", contact, args).status).to eq(201)
     end
   end
   
   describe "sign" do
     it "should sign the auth parameters correctly" do
       sign_token = "my_secretApiKeymy_key"
-      subject.sign(sign_token).should eq("c731cf2455fbc7a4ef937b2301108d7a")
+      expect(subject.sign(sign_token)).to eq("c731cf2455fbc7a4ef937b2301108d7a")
     end
   end
   
@@ -134,7 +133,7 @@ describe SparkApi::Authentication::ApiAuth  do
     subject {SparkApi::Authentication::ApiAuth.new(client) }
     it "should fully sign the token" do
       parms = {:AuthToken => "1234", :ApiUser => "CoolAsIce"}
-      subject.sign_token("/test", parms).should eq("7bbe3384a8b64368357f8551cab271e3")
+      expect(subject.sign_token("/test", parms)).to eq("7bbe3384a8b64368357f8551cab271e3")
     end
   end
   
@@ -160,8 +159,8 @@ describe SparkApi::Authentication::ApiAuth  do
           to_return(:body => fixture('listings/with_documents.json'))
       l = Listing.find('1234', :_expand => "Documents")
       
-      count.should eq(2)
-      SparkApi.client.session.expired?.should eq(false)
+      expect(count).to eq(2)
+      expect(SparkApi.client.session.expired?).to eq(false)
     end
   end