spark_api 1.0.2 → 1.0.4

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

@@ -1,24 +0,0 @@
-require 'date'
-require 'time'
-
-module FlexmlsApi
-  module Models
-    class OpenHouse < Base
-      extend Subresource
-
-      self.element_name = "openhouses"
-      
-      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/photo.rb~

@@ -1,70 +0,0 @@
-module FlexmlsApi
-  module Models
-    class Photo < Base
-      extend Subresource
-      self.element_name = "photos"
-      
-      attr_accessor :update_path
-      
-      EDITABLE_FIELDS = [:Picture, :FileName, :Name, :Caption, :Primary]
-      
-      def initialize(opts={})
-        defaulted_opts = {}
-        EDITABLE_FIELDS.each do |k|
-          key = k.to_s()
-          defaulted_opts[key] = opts[key] || nil
-        end
-        super(opts.merge(defaulted_opts))
-      end
-
-      def primary? 
-        @attributes["Primary"] == true 
-      end
-      
-      def save(arguments={})
-        begin
-          return save!(arguments)
-        rescue NotFound, BadResourceRequest => e
-          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
-        end
-        false
-      end
-      def save!(arguments={})
-        payload = {"Photos" => [ build_photo_hash]}
-        if exists?
-          results = connection.put "#{update_path}/#{self.Id}", payload, arguments
-        else
-          results = connection.post update_path, payload, arguments
-        end
-        result = results.first
-        load(result)
-        true
-      end
-      
-      def load_picture(file_name)
-        self.Picture = Base64.encode64(File.open(file_name, 'rb').read).gsub(/\n/, '')
-        self.FileName = File.basename(file_name)
-      end
-      
-      def delete(args={})
-        connection.delete("#{update_path}/#{self.Id}", args)
-      end
-      
-      def exists?
-        @attributes.include?("Id")
-      end
-      
-      private
-      
-      def build_photo_hash
-        results_hash = {} 
-        EDITABLE_FIELDS.each do |k|
-          key = k.to_s
-          results_hash[key] = @attributes[key] unless @attributes[key].nil?
-        end
-        results_hash
-      end
-
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-module FlexmlsApi
-  module Models
-    class PropertyTypes < Base
-      self.element_name="propertytypes"
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-module FlexmlsApi
-  module Models
-    class SavedSearch < Base 
-      extend Finders
-      self.element_name="savedsearches"
-
-      def self.provided()
-        Class.new(self).tap do |provided|
-          provided.element_name = '/savedsearches'
-          provided.prefix = '/provided'
-          FlexmlsApi.logger.info("#{self.name}.path: #{provided.path}")
-        end
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-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~

@@ -1,50 +0,0 @@
-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~

@@ -1,19 +0,0 @@
-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~

@@ -1,14 +0,0 @@
-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~

@@ -1,24 +0,0 @@
-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~

@@ -1,16 +0,0 @@
-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~

@@ -1,18 +0,0 @@
-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~

@@ -1,59 +0,0 @@
-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

data/lib/spark_api/paginate.rb~

@@ -1,109 +0,0 @@
-require 'will_paginate/collection'
-
-# =Pagination for api resource collections
-# Will paginate adapter for the api client.  Utilizes the same interface as will paginate and returns the 
-# same WillPaginate::Collection for finder results.
-module FlexmlsApi
-  module Paginate
-    
-    DEFAULT_PAGE_SIZE = 25
-    
-    # == Replacement hook for will_paginate's class method
-    # Does a best effort to mimic the will_paginate method of same name.  All arguments are
-    # passed on to the finder method except the special keys for the options hash listed below.
-    #
-    # == Special parameters for paginating finders
-    # * <tt>:page</tt> -- REQUIRED, but defaults to 1 if false or nil
-    # * <tt>:per_page</tt> -- defaults to <tt>CurrentModel.per_page</tt> (which is 25 if not overridden)
-    # * <tt>:finder</tt> -- name of the finder used (default: "get").  This needs to be a class finder method on the class
-    def paginate(*args)
-      options = args.last.is_a?(::Hash) ? args.pop : {}
-      page = options.delete(:page) || 1
-      items_per_page = options.delete(:per_page) || self.per_page
-      finder = (options.delete(:finder) || 'get').to_s
-      page_options = {
-        "_pagination" => 1,
-        "_limit" => items_per_page,
-        "_page" => page
-      }
-      options.merge!(page_options)
-      args << options
-      collection = send(finder,*args)
-    end
-    
-    # == Instanciate class instances from array of hash representations.  
-    # Needs to be called by all finders that would like to support paging.  Takes the hash result 
-    # set from the request layer and instanciates instances of the class called for the finder.
-    #
-    # * result_array -- the results object returned from the api request layer.  An array of hashes.
-    # 
-    # :returns:
-    #   An array of class instances for the Class of the calling finder
-    def collect(result_array)
-      
-      # when conducting a count (pagination=count), the result_array is not an array
-      # in those cases, simply return the Fixnum
-      return result_array unless result_array.kind_of? Array
-      
-      collection = result_array.collect { |item| new(item)}
-      result_array.replace(collection)
-      result_array
-    end
-    
-    # Default per_page limit set on all models.  Override this method in the model such ala the 
-    # will_paginate gem to change
-    def per_page
-      DEFAULT_PAGE_SIZE
-    end
-    
-    
-  end
-
-  # ==Paginate Api Responses
-  # Module used by the request layer to decorate the response's results array with paging support.
-  # Pagination only happens if the response includes the pagination information as specified by the 
-  # API.
-  module PaginateResponse
-    attr_accessor :results
-    def method_missing(method_symbol, *arguments)
-      if results.respond_to?(method_symbol)
-        arguments.empty? ? self.results.send(method_symbol) : self.results.send(method_symbol, arguments)
-      else
-        super
-      end
-    end
-  end
-    
-  # ==Pagination Helpers
-  # Helpers to create the pagination collection
-  module PaginateHelper
-    # ==Enable pagination
-    # * results -- array of hashes representing api resources
-    # * paging_hash -- the pagination response information from the api representing paging state.
-    # 
-    # :returns:
-    #   The result set decorated as a WillPaginate::Collection
-    def paginate_response(results, paging_hash)
-      pager = Pagination.new(paging_hash)
-      paged_results = WillPaginate::Collection.create(pager.current_page, pager.page_size, pager.total_rows) do |p|
-        p.replace(results)
-      end
-      paged_results.extend PaginateResponse
-      paged_results.results = results
-      paged_results
-    end
-  end
-
-  # ==Pagination
-  #   Simple class representing the API's pagination response object
-  class Pagination
-    attr_accessor :total_rows, :page_size, :total_pages, :current_page
-    def initialize(hash)
-      @total_rows     = hash["TotalRows"]
-      @page_size      = hash["PageSize"]
-      @total_pages    = hash["TotalPages"]
-      @current_page   = hash["CurrentPage"]
-    end
-  end
-  
-end