spark_api 1.0.0

data/lib/spark_api/models/shared_listing.rb~

@@ -0,0 +1,35 @@
+module FlexmlsApi
+  module Models
+    class SharedListing < Base 
+      extend Finders
+      self.element_name="sharedlistings"
+      
+      def ListingIds=(listing_ids)
+        attributes["ListingIds"] = Array(listing_ids)
+      end
+      def ViewId=(id)
+        attributes["ViewId"] = id
+      end
+      def ReportId=(id)
+        attributes["ReportId"] = id
+      end
+      
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          FlexmlsApi.logger.error("Failed to save SharedListing #{self}: #{e.message}")
+        end
+        false
+      end
+      def save!(arguments={})
+        results = connection.post self.class.path, attributes, arguments
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        true
+      end
+    end
+  end
+end

data/lib/spark_api/models/standard_fields.rb

@@ -0,0 +1,50 @@
+module SparkApi
+  module Models
+    class StandardFields < Base
+      extend Finders
+      self.element_name="standardfields"
+      
+      # expand all fields passed in
+      def self.find_and_expand_all(fields, arguments={}, max_list_size=1000)
+        returns = {}
+        
+        # find all standard fields, but expand only the location fields
+        # TODO: when _expand support is added to StandardFields API, use the following
+        # standard_fields = find(:all, {:ApiUser => owner, :_expand => fields.join(",")}) 
+        standard_fields = find(:all, arguments)
+      
+        # filter through the list and return only the location fields found
+        fields.each do |field|
+          # search for field in the payload
+          if standard_fields.first.attributes.has_key?(field)
+            returns[field] = standard_fields.first.attributes[field]
+              
+            # lookup fully _expand field, if the field has a list
+            if returns[field]['HasList'] && returns[field]['MaxListSize'].to_i <= max_list_size
+              returns[field] = connection.get("/standardfields/#{field}", arguments).first[field]
+            end
+              
+          end
+        end
+        
+        returns
+      end
+      
+      
+      # find_nearby: find fields nearby via lat/lon
+      def self.find_nearby(prop_types = ["A"], arguments={})
+        return_json = {"D" => {"Success" => true, "Results" => []} }
+        
+        # add _expand=1 so the fields are returned
+        arguments.merge!({:_expand => 1})
+        
+        # find and return
+        return_json["D"]["Results"] = connection.get("/standardfields/nearby/#{prop_types.join(',')}", arguments)
+        
+        # return
+        return_json
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/standard_fields.rb~

@@ -0,0 +1,50 @@
+module FlexmlsApi
+  module Models
+    class StandardFields < Base
+      extend Finders
+      self.element_name="standardfields"
+      
+      # expand all fields passed in
+      def self.find_and_expand_all(fields, arguments={}, max_list_size=1000)
+        returns = {}
+        
+        # find all standard fields, but expand only the location fields
+        # TODO: when _expand support is added to StandardFields API, use the following
+        # standard_fields = find(:all, {:ApiUser => owner, :_expand => fields.join(",")}) 
+        standard_fields = find(:all, arguments)
+      
+        # filter through the list and return only the location fields found
+        fields.each do |field|
+          # search for field in the payload
+          if standard_fields.first.attributes.has_key?(field)
+            returns[field] = standard_fields.first.attributes[field]
+              
+            # lookup fully _expand field, if the field has a list
+            if returns[field]['HasList'] && returns[field]['MaxListSize'].to_i <= max_list_size
+              returns[field] = connection.get("/standardfields/#{field}", arguments).first[field]
+            end
+              
+          end
+        end
+        
+        returns
+      end
+      
+      
+      # find_nearby: find fields nearby via lat/lon
+      def self.find_nearby(prop_types = ["A"], arguments={})
+        return_json = {"D" => {"Success" => true, "Results" => []} }
+        
+        # add _expand=1 so the fields are returned
+        arguments.merge!({:_expand => 1})
+        
+        # find and return
+        return_json["D"]["Results"] = connection.get("/standardfields/nearby/#{prop_types.join(',')}", arguments)
+        
+        # return
+        return_json
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/subresource.rb

@@ -0,0 +1,19 @@
+module SparkApi
+  module Models
+    module Subresource 
+    
+      def build_subclass
+        Class.new(self)
+      end
+
+      def find_by_listing_key(key, arguments={})
+        collect(connection.get("/listings/#{key}#{self.path}", arguments))
+      end
+      
+      def find_by_id(id, parent_id, arguments={})
+        collect(connection.get("/listings/#{parent_id}#{self.path}/#{id}", arguments)).first
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/subresource.rb~

@@ -0,0 +1,19 @@
+module FlexmlsApi
+  module Models
+    module Subresource 
+    
+      def build_subclass
+        Class.new(self)
+      end
+
+      def find_by_listing_key(key, arguments={})
+        collect(connection.get("/listings/#{key}#{self.path}", arguments))
+      end
+      
+      def find_by_id(id, parent_id, arguments={})
+        collect(connection.get("/listings/#{parent_id}#{self.path}/#{id}", arguments)).first
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/system_info.rb

@@ -0,0 +1,14 @@
+module SparkApi
+  module Models
+    class SystemInfo < Base
+      self.element_name="system"
+
+      def primary_logo
+        logo = nil
+        mls_logos = attributes['Configuration'].first['MlsLogos']
+        logo = mls_logos.first if !mls_logos.nil? and !mls_logos.empty?
+        logo
+      end
+    end
+  end
+end

data/lib/spark_api/models/system_info.rb~

@@ -0,0 +1,14 @@
+module FlexmlsApi
+  module Models
+    class SystemInfo < Base
+      self.element_name="system"
+
+      def primary_logo
+        logo = nil
+        mls_logos = attributes['Configuration'].first['MlsLogos']
+        logo = mls_logos.first if !mls_logos.nil? and !mls_logos.empty?
+        logo
+      end
+    end
+  end
+end

data/lib/spark_api/models/tour_of_home.rb

@@ -0,0 +1,24 @@
+require 'date'
+require 'time'
+
+module SparkApi
+  module Models
+    class TourOfHome < Base
+      extend Subresource
+
+      self.element_name = "tourofhomes"
+      
+      def initialize(attributes={})
+        # Transform the date strings
+        unless attributes['Date'].nil?
+          date = Date.parse(attributes['Date'])
+          attributes['Date'] = date
+          attributes['StartTime'] = Time.parse("#{date}T#{attributes['StartTime']}") unless attributes['StartTime'].nil?
+          attributes['EndTime'] = Time.parse("#{date}T#{attributes['EndTime']}") unless attributes['EndTime'].nil?
+        end
+        super(attributes)
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/tour_of_home.rb~

@@ -0,0 +1,24 @@
+require 'date'
+require 'time'
+
+module FlexmlsApi
+  module Models
+    class TourOfHome < Base
+      extend Subresource
+
+      self.element_name = "tourofhomes"
+      
+      def initialize(attributes={})
+        # Transform the date strings
+        unless attributes['Date'].nil?
+          date = Date.parse(attributes['Date'])
+          attributes['Date'] = date
+          attributes['StartTime'] = Time.parse("#{date}T#{attributes['StartTime']}") unless attributes['StartTime'].nil?
+          attributes['EndTime'] = Time.parse("#{date}T#{attributes['EndTime']}") unless attributes['EndTime'].nil?
+        end
+        super(attributes)
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models/video.rb

@@ -0,0 +1,16 @@
+module SparkApi
+  module Models
+    class Video < Base
+      extend Subresource
+      self.element_name = 'videos'
+
+      def branded?
+        attributes['Type'] == 'branded'
+      end
+
+      def unbranded?
+        attributes['Type'] == 'unbranded'
+      end
+    end
+  end
+end

data/lib/spark_api/models/video.rb~

@@ -0,0 +1,16 @@
+module FlexmlsApi
+  module Models
+    class Video < Base
+      extend Subresource
+      self.element_name = 'videos'
+
+      def branded?
+        attributes['Type'] == 'branded'
+      end
+
+      def unbranded?
+        attributes['Type'] == 'unbranded'
+      end
+    end
+  end
+end

data/lib/spark_api/models/virtual_tour.rb

@@ -0,0 +1,18 @@
+module SparkApi
+  module Models
+    class VirtualTour < Base
+      extend Subresource
+      self.element_name="virtualtours"
+      
+
+      def branded? 
+        attributes["Type"] == "branded"
+      end
+
+      def unbranded?
+        attributes["Type"] == "unbranded"
+      end
+
+    end
+  end
+end

data/lib/spark_api/models/virtual_tour.rb~

@@ -0,0 +1,18 @@
+module FlexmlsApi
+  module Models
+    class VirtualTour < Base
+      extend Subresource
+      self.element_name="virtualtours"
+      
+
+      def branded? 
+        attributes["Type"] == "branded"
+      end
+
+      def unbranded?
+        attributes["Type"] == "unbranded"
+      end
+
+    end
+  end
+end

data/lib/spark_api/multi_client.rb

@@ -0,0 +1,59 @@
+module SparkApi
+  #===Active support for multiple clients
+  module MultiClient
+    include SparkApi::Configuration
+    
+    # Activate a specific instance of the client (with appropriate config settings).  Each client 
+    # is lazily instanciated by calling the matching SparkApi.symbol_name method on the 
+    # SparkApi module.  It's the developers responsibility to extend the module and provide this
+    # method.
+    # Parameters
+    #  @sym - the unique symbol identifier for a client configuration.
+    #  &block - a block of code to run with the specified client enabled, after which the original
+    #    client setting will be reenabled
+    def activate(sym)
+      if block_given?
+        original_client = Thread.current[:spark_api_client]
+        begin
+          activate_client(sym)
+          yield
+        ensure
+          Thread.current[:spark_api_client] = original_client
+        end
+      else
+        activate_client(sym)
+      end
+    end
+    
+    private 
+    
+    # set the active client for the symbol
+    def activate_client(symbol)
+      if !Thread.current[symbol].nil?
+        active_client = Thread.current[symbol]
+      elsif SparkApi.respond_to? symbol
+        active_client = SparkApi.send(symbol)
+      elsif YamlConfig.exists? symbol.to_s
+        active_client = activate_client_from_config(symbol)
+      else
+        raise ArgumentError, "The symbol #{symbol} is not setup correctly as a multi client key."
+      end
+      Thread.current[symbol] = active_client
+      Thread.current[:spark_api_client] = active_client
+    end
+    
+    def activate_client_from_config(symbol)
+      SparkApi.logger.debug("Loading multiclient [#{symbol.to_s}] from config")
+      yaml = YamlConfig.build(symbol.to_s)
+      if(yaml.oauth2?)
+        Client.new(yaml.client_keys.merge({
+              :oauth2_provider => Authentication::OAuth2Impl.load_provider(yaml.oauth2_provider, yaml.oauth2_keys),
+              :authentication_mode => SparkApi::Authentication::OAuth2,
+            }))
+      else
+        Client.new(yaml.client_keys)
+      end
+    end
+    
+  end
+end

data/lib/spark_api/multi_client.rb~

@@ -0,0 +1,59 @@
+module FlexmlsApi
+  #===Active support for multiple clients
+  module MultiClient
+    include FlexmlsApi::Configuration
+    
+    # Activate a specific instance of the client (with appropriate config settings).  Each client 
+    # is lazily instanciated by calling the matching FlexmlsApi.symbol_name method on the 
+    # FlexmlsApi module.  It's the developers responsibility to extend the module and provide this
+    # method.
+    # Parameters
+    #  @sym - the unique symbol identifier for a client configuration.
+    #  &block - a block of code to run with the specified client enabled, after which the original
+    #    client setting will be reenabled
+    def activate(sym)
+      if block_given?
+        original_client = Thread.current[:flexmls_api_client]
+        begin
+          activate_client(sym)
+          yield
+        ensure
+          Thread.current[:flexmls_api_client] = original_client
+        end
+      else
+        activate_client(sym)
+      end
+    end
+    
+    private 
+    
+    # set the active client for the symbol
+    def activate_client(symbol)
+      if !Thread.current[symbol].nil?
+        active_client = Thread.current[symbol]
+      elsif FlexmlsApi.respond_to? symbol
+        active_client = FlexmlsApi.send(symbol)
+      elsif YamlConfig.exists? symbol.to_s
+        active_client = activate_client_from_config(symbol)
+      else
+        raise ArgumentError, "The symbol #{symbol} is not setup correctly as a multi client key."
+      end
+      Thread.current[symbol] = active_client
+      Thread.current[:flexmls_api_client] = active_client
+    end
+    
+    def activate_client_from_config(symbol)
+      FlexmlsApi.logger.debug("Loading multiclient [#{symbol.to_s}] from config")
+      yaml = YamlConfig.build(symbol.to_s)
+      if(yaml.oauth2?)
+        Client.new(yaml.client_keys.merge({
+              :oauth2_provider => Authentication::OAuth2Impl.load_provider(yaml.oauth2_provider, yaml.oauth2_keys),
+              :authentication_mode => FlexmlsApi::Authentication::OAuth2,
+            }))
+      else
+        Client.new(yaml.client_keys)
+      end
+    end
+    
+  end
+end