spark_api 1.4.29 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe8ad347473ad647fb0da6fd681ebe2c6da50daa
-  data.tar.gz: 7d17ef58323eb5aad73e09167478d0456a7f1df9
+SHA256:
+  metadata.gz: b9c9695944207ba64adf36cd6417e6f534222643a04058581af5451ef4e0361e
+  data.tar.gz: 4911595b9144031b4659ef04bbd1ca8689090e23297d686741c26649c359b0ed
 SHA512:
-  metadata.gz: 0c2df47ef7d780b071df24b586c35838ef1537b68fbd4aac78d8adc99786c2b7de3e81f5d322e781bd0d06defd27fd4bb9f2058788d169d6e48184e346b629ef
-  data.tar.gz: a23bbccaab494a0007fc75ba5f7317473bc66bfaa268e221b008ad9eef1accbea77008fdc2ba246ebe5508a4f328164c27876f6404bfa3bf1bbfb049e3bed26e
+  metadata.gz: d1e45e5ebb03f2561b2d1a8234510598ced6b3816f961dd84e2200f66359bd22a6360b4bdba06bfcaad46e2a5bbac5c22cb03611dc0b4b249ea001ac5022964b
+  data.tar.gz: 5259a965c9131db98ef5c9ca876f59189a43274fa30c780c98b1d56b1d762fd974f9a618a407e0daf0d16c9f1e0b690ffd0a500dfe4f225c9eadc2b81091ec6e

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.29
+1.5.1

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,10 +20,12 @@ 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'
 require 'spark_api/models/market_statistics'
+require 'spark_api/models/media'
 require 'spark_api/models/message'
 require 'spark_api/models/news_feed_meta'
 require 'spark_api/models/newsfeed'

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

@@ -0,0 +1,30 @@
+module SparkApi
+    module Models
+      module Media
+        # This module is effectively an interface and helper to combine common media
+        # actions and information. Media types (videos, virtual tours, etc)
+        # should include this module and implement the methods contained
+
+        def url
+            raise "Not Implemented"
+        end
+
+        def description
+            raise "Not Implemented"
+        end
+
+        def private?
+            attributes['Privacy'] == 'Private'
+        end
+          
+        def public?
+            attributes['Privacy'] == 'Public'
+        end
+          
+        def automatic?
+            attributes['Privacy'] == 'Automatic'
+        end
+
+      end
+    end
+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/models/video.rb

@@ -1,7 +1,12 @@
+require 'net/http'
 module SparkApi
   module Models
     class Video < Base
       extend Subresource
+      include Media
+      include Concerns::Savable,
+              Concerns::Destroyable
+
       self.element_name = 'videos'
 
       def branded?
@@ -11,6 +16,109 @@ module SparkApi
       def unbranded?
         attributes['Type'] == 'unbranded'
       end
+
+      def url
+        attributes['ObjectHtml']
+      end
+
+      def description
+        attributes['Name']
+      end
+
+      # Some youtube URLS are youtu.be instead of youtube
+      SUPPORTED_VIDEO_TYPES = %w[vimeo youtu].freeze
+
+      def is_supported_type?
+        # Unfortunately there are so many formats of vimeo videos that we canot support all vimeo videos
+        # Therefore, we need to do a little more checking here and validate that we can get video codes out of the urls
+        (self.ObjectHtml.include?('youtu') && youtube_video_code.present?) || (self.ObjectHtml.include?('vimeo') && vimeo_video_code.present?)
+      end
+
+      def is_valid_iframe?
+        self.ObjectHtml.include?('<iframe') && self.ObjectHtml.include?('</iframe>')
+      end
+
+      # gets the thumbnail to be shown on supported (Vimeo and Youtube) videos
+      # YouTube provides a predictable url for each video's images
+      # for Vimeo, a get request is necessary
+      def display_image
+        url = self.video_link
+        if url
+          if(url.include?('youtube'))
+            youtube_thumbnail_url
+          else 
+            vimeo_thumbnail_url
+          end
+        end
+      end
+
+      def video_link
+        return nil unless is_supported_type?
+
+        if self.ObjectHtml.include?('youtu')
+            youtube_link
+        elsif self.ObjectHtml.include?('vimeo')
+            vimeo_link
+        end
+      end
+
+      private
+
+      def vimeo_video_code
+        html = self.ObjectHtml
+        if html.match(/(src=)('|")((https:)?\/\/player\.vimeo\.com\/video\/)/)
+          new_url = html.split(/(src=')|(src=")/)
+          if new_url[2]
+            html = new_url[2].split(/("|')/)[0]
+          end
+        end
+        if html.match(/(?:.+?)?(player\.vimeo\.com|vimeo.com\/(?:channels\/(?:\w+\/)?|groups\/([^\/]*)\/videos\/|album\/(\d+)\/video\/|)(\d+)(?:$|\/|\?))/)
+          code = html.split('/').last.split('?').first
+          # Vimeo Ids are always numerical
+          code.to_i.to_s === code ? code : nil
+        else
+          nil
+        end
+      end
+
+      # This if correctly embedded by the user is an embed
+      # If not, it could be pretty much anything
+      def youtube_video_code
+        html = self.ObjectHtml
+        if html.match(/(?:.+?)?(?:\/v\/|watch\/|\?v=|\&v=|youtu\.be\/|\/v=|^youtu\.be\/|embed\/|watch\%3Fv\%3D)([a-zA-Z0-9_-]{11})/) || html.match(/(iframe)(.*)(src=)('|")(https:\/\/www\.youtube\.com\/embed)/)
+          html.split(/([a-zA-Z0-9_-]{11})/)[1]
+        else
+          nil
+        end
+      end
+
+      def youtube_link
+        normalize_youtube_url
+        code = youtube_video_code
+        code ? "https://www.youtube.com/watch?v=#{code}" : nil
+      end
+
+      def vimeo_link
+        code = vimeo_video_code
+        code ? "https://vimeo.com/#{code}" : nil
+      end
+
+      def youtube_thumbnail_url
+        code = youtube_video_code
+        code ? "https://i1.ytimg.com/vi/#{code}/hqdefault.jpg" : nil
+      end
+
+      def vimeo_thumbnail_url
+        # due to the rate limiting issue that surfaced shortly before launch,
+        # we will temporarily not return vimeo thumbnails until
+        # there is bandwidth to implement the solution in FLEX-9959
+        return nil
+      end
+
+      def normalize_youtube_url
+        self.ObjectHtml.sub!('-nocookie', '')
+      end
+      
     end
   end
 end

data/lib/spark_api/models/virtual_tour.rb

@@ -2,6 +2,10 @@ module SparkApi
   module Models
     class VirtualTour < Base
       extend Subresource
+      include Media
+      include Concerns::Savable,
+              Concerns::Destroyable
+
       self.element_name="virtualtours"
       
 
@@ -13,6 +17,18 @@ module SparkApi
         attributes["Type"] == "unbranded"
       end
 
+      def url
+        attributes['Uri']
+      end
+
+      def description
+        attributes['Name']
+      end
+
+      def display_image
+        # Currently we have no universally good mechanism to get images for virtual tours
+        return nil
+      end
     end
   end
 end

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
+    }]
+  }
+}