spark_api 1.4.31 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08a105761151bdff166a7c512a604339da3170b73d145f7842d17ccfaa06920d'
-  data.tar.gz: 3a6303ce787ba904c3c5bec3c1bdca6549e45115aa108d3c71bbfe8262646536
+  metadata.gz: 9dfabf550d6eea2fb80a30b047b5c0fb4a5aa95f4bad6ee2fd9135acc21ce479
+  data.tar.gz: 8587cc4fa49929d9286ec6ac37c9d97259e6fbdf2d7b583716edc5d67068d47f
 SHA512:
-  metadata.gz: 1eb046b673d876b4226c341a0b1ed085ea80b29b4f8dbf600fc4f8156f4084582343861c4e4f9da2333f45c8a1d8e10cca7320b95a42cfc802ef26b177354b3e
-  data.tar.gz: 90b225ad0f9dd8801bf46488d8bb3f006d06bf700d4f93fcc9d5ec62667daa925bdd63410e8297efc860947ac67fce6d1932ca6d935a9e2d5949cc56abe92245
+  metadata.gz: 2e0467d03ebcac984dd9ba6dbd0b120e60d1ef1c340d1972145140678a84b405567114a4af2eaba8776c8e9a20cc556dafada327cb9d86c9ad95dbec8ca2a1f5
+  data.tar.gz: 6b9107aa27eed9afd313b34144c1f2b22425fa421568d6b496edb7d96b9828313568651457b3cd3f71085c7b3d09ecfd7d7595cced256cdc0a01775edf46b308

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.31
+1.5.2

data/lib/spark_api.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'logger'
 require 'multi_json'
+require 'addressable'
 
 require 'spark_api/version'
 require 'spark_api/errors'

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

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