flexmls_api 0.6.5 → 0.7.0

data/lib/flexmls_api/faraday.rb

@@ -3,7 +3,7 @@ module FlexmlsApi
     #=Flexmls API Faraday middleware
     # HTTP Response after filter to package api responses and bubble up basic api errors.
     class FlexmlsMiddleware < Faraday::Response::ParseJson
-      
+      include FlexmlsApi::PaginateHelper      
       # Handles pretty much all the api response parsing and error handling.  All responses that
       # indicate a failure will raise a FlexmlsApi::ClientError exception
       def on_complete(finished_env)
@@ -13,6 +13,16 @@ module FlexmlsApi
           raise InvalidResponse, "The server response could not be understood"
         end
         response = ApiResponse.new body
+        paging = response.pagination
+        if paging.nil?
+          results = response
+        else
+          if finished_env[:url].query_values["_pagination"] == "count"
+            results = paging['TotalRows']
+          else
+            results = paginate_response(response, paging)
+          end
+        end
         case finished_env[:status]
         when 400, 409
           raise BadResourceRequest, {:message => response.message, :code => response.code, :status => finished_env[:status]}
@@ -33,7 +43,7 @@ module FlexmlsApi
         else 
           raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         end
-        finished_env[:body] = response
+        finished_env[:body] = results
       end
       
       def initialize(app)

data/lib/flexmls_api/models.rb

@@ -1,26 +1,28 @@
-require File.expand_path('../models/base', __FILE__)
-require File.expand_path('../models/finders', __FILE__)
-require File.expand_path('../models/account', __FILE__)
-require File.expand_path('../models/listing', __FILE__)
-require File.expand_path('../models/subresource', __FILE__)
-require File.expand_path('../models/photo', __FILE__)
-require File.expand_path('../models/system_info', __FILE__)
-require File.expand_path('../models/standard_fields', __FILE__)
-require File.expand_path('../models/custom_fields', __FILE__)
-require File.expand_path('../models/property_types', __FILE__)
-require File.expand_path('../models/connect_prefs', __FILE__)
-require File.expand_path('../models/contact', __FILE__)
-require File.expand_path('../models/idx_link', __FILE__)
-require File.expand_path('../models/market_statistics', __FILE__)
-require File.expand_path('../models/video', __FILE__)
-require File.expand_path('../models/open_house', __FILE__)
-require File.expand_path('../models/tour_of_home', __FILE__)
-require File.expand_path('../models/virtual_tour', __FILE__)
-require File.expand_path('../models/document', __FILE__)
-require File.expand_path('../models/note', __FILE__)
-require File.expand_path('../models/listing_cart.rb', __FILE__)
-require File.expand_path('../models/shared_listing.rb', __FILE__)
-require File.expand_path('../models/saved_search.rb', __FILE__)
+require 'flexmls_api/models/base'
+require 'flexmls_api/models/finders'
+require 'flexmls_api/models/constraint'
+
+require 'flexmls_api/models/account'
+require 'flexmls_api/models/listing'
+require 'flexmls_api/models/subresource'
+require 'flexmls_api/models/photo'
+require 'flexmls_api/models/system_info'
+require 'flexmls_api/models/standard_fields'
+require 'flexmls_api/models/custom_fields'
+require 'flexmls_api/models/property_types'
+require 'flexmls_api/models/connect_prefs'
+require 'flexmls_api/models/contact'
+require 'flexmls_api/models/idx_link'
+require 'flexmls_api/models/market_statistics'
+require 'flexmls_api/models/video'
+require 'flexmls_api/models/open_house'
+require 'flexmls_api/models/tour_of_home'
+require 'flexmls_api/models/virtual_tour'
+require 'flexmls_api/models/document'
+require 'flexmls_api/models/note'
+require 'flexmls_api/models/listing_cart'
+require 'flexmls_api/models/shared_listing'
+require 'flexmls_api/models/saved_search'
 
 module FlexmlsApi
   module Models

data/lib/flexmls_api/models/constraint.rb

@@ -0,0 +1,16 @@
+module FlexmlsApi
+  module Models
+    class Constraint
+      ATTRIBUTES = ["RuleValue","Value","RuleFieldValue","RuleField","RuleName"]
+      attr_accessor *ATTRIBUTES
+      def initialize(args)
+        ATTRIBUTES.each { |f| send("#{f}=", args[f]) if args.include?(f) || args.include?(f.to_sym) }
+      end
+      
+      def to_s
+        "#{self.RuleName}: Field(#{self.RuleField},#{self.RuleFieldValue}) Value(#{self.RuleValue},#{self.Value})"
+      end
+    end
+  end
+end
+

data/lib/flexmls_api/models/listing.rb

@@ -3,14 +3,17 @@ module FlexmlsApi
     class Listing < Base 
       extend Finders
       attr_accessor :photos, :videos, :virtual_tours, :documents
+      attr_accessor :constraints
       self.element_name="listings"
+      DATA_MASK = "********"
 
       def initialize(attributes={})
         @photos = []
         @videos = []
         @virtual_tours = []
         @documents = []
-
+        @constraints = []
+        
         if attributes.has_key?('StandardFields')
           pics, vids, tours, docs = attributes['StandardFields'].values_at('Photos','Videos', 'VirtualTours', 'Documents')
         end
@@ -19,7 +22,7 @@ module FlexmlsApi
           pics.collect { |pic| @photos.push(Photo.new(pic)) } 
           attributes['StandardFields'].delete('Photos')
         end
-         
+        
         if vids != nil
           vids.collect { |vid| @videos.push(Video.new(vid)) } 
           attributes['StandardFields'].delete('Videos')
@@ -88,6 +91,46 @@ module FlexmlsApi
         end
       end
 
+      def street_address
+        "#{self.StreetNumber} #{self.StreetDirPrefix} #{self.StreetName} #{self.StreetSuffix} #{self.StreetDirSuffix} #{self.StreetAdditionalInfo}".delete(DATA_MASK).strip().gsub(/\s{2,}/, ' ')
+      end
+
+      def region_address
+        "#{self.City}, #{self.StateOrProvince} #{self.PostalCode}".delete(DATA_MASK).strip().gsub(/^,\s/, '').gsub(/,$/, '')
+      end
+
+      def full_address
+        "#{self.street_address}, #{self.region_address}".strip().gsub(/^,\s/, '').gsub(/,$/, '')
+      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={})
+        results = connection.put "#{self.class.path}/#{self.Id}", {"ListPrice"=> self.ListPrice}, arguments
+        @contstraints = []
+        results.details.each do |detail|
+          detail.each_pair do |k,v|
+            v.each { |constraint| @constraints << Constraint.new(constraint)}
+          end
+        end
+        true
+      end
+      
+      def editable?(editable_settings = [])
+        settings = Array(editable_settings)
+        editable = attributes.include?("Permissions") && self.Permissions["Editable"] == true
+        if editable
+          settings.each{ |setting| editable = false unless self.Permissions["EditableSettings"][setting.to_s] == true }
+        end
+        editable
+      end
+      
       
       private
 

data/lib/flexmls_api/models/photo.rb

@@ -2,13 +2,68 @@ 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

data/lib/flexmls_api/models/subresource.rb

@@ -6,11 +6,14 @@ module FlexmlsApi
         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/flexmls_api/multi_client.rb

@@ -1,6 +1,7 @@
 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 
@@ -13,8 +14,8 @@ module FlexmlsApi
     def activate(sym)
       if block_given?
         original_client = Thread.current[:flexmls_api_client]
-        activate_client(sym)
         begin
+          activate_client(sym)
           yield
         ensure
           Thread.current[:flexmls_api_client] = original_client
@@ -27,11 +28,25 @@ module FlexmlsApi
     private 
     
     # set the active client for the symbol
-    def activate_client(sym)
-      active_client = Thread.current[sym] || FlexmlsApi.send(sym)
-      Thread.current[:flexmls_api_client] = active_client unless active_client.nil?
-    rescue NoMethodError => e
-      raise ArgumentError, "The symbol #{sym} is missing a corresponding FlexmlsApi.#{sym} method.", e.backtrace
+    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)
+      Client.new(yaml.client_keys)
+    end
+    
   end
 end

data/lib/flexmls_api/paginate.rb

@@ -55,13 +55,28 @@ module FlexmlsApi
     def per_page
       DEFAULT_PAGE_SIZE
     end
+    
+    
   end
 
   # ==Paginate Api Responses
-  # Module use by the request layer to decorate the response's results array with paging support.
+  # 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.
@@ -73,6 +88,8 @@ module FlexmlsApi
       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

data/lib/flexmls_api/request.rb

@@ -3,7 +3,6 @@ require 'cgi'
 module FlexmlsApi
   # HTTP request wrapper.  Performs all the api session mumbo jumbo so that the models don't have to.
   module Request
-    include PaginateResponse
     # Perform an HTTP GET request
     # 
     # * path - Path of an api resource, excluding version and endpoint (domain) information
@@ -89,78 +88,9 @@ module FlexmlsApi
         FlexmlsApi.logger.error("Authentication failed or server is sending us expired tokens, nothing we can do here.")
         raise
       end
-      results = response.body.results
-      paging = response.body.pagination
-      unless paging.nil?
-        if request_opts[:_pagination] == "count"
-          results = paging['TotalRows']
-        else
-          results = paginate_response(results, paging)
-        end
-      end
-      results
+      response.body
     end
     
   end
  
-  # All known response codes listed in the API
-  module ResponseCodes
-    NOT_FOUND = 404
-    METHOD_NOT_ALLOWED = 405
-    INVALID_KEY = 1000
-    DISABLED_KEY = 1010
-    API_USER_REQUIRED = 1015
-    SESSION_TOKEN_EXPIRED = 1020
-    SSL_REQUIRED = 1030
-    INVALID_JSON = 1035
-    INVALID_FIELD = 1040
-    MISSING_PARAMETER = 1050
-    INVALID_PARAMETER = 1053
-    CONFLICTING_DATA = 1055
-    NOT_AVAILABLE= 1500
-    RATE_LIMIT_EXCEEDED = 1550
-  end
-  
-  # Errors built from API responses
-  class InvalidResponse < StandardError; end
-  class ClientError < StandardError
-    attr_reader :code, :status
-    def initialize (options = {})
-      # Support the standard initializer for errors
-      opts = options.is_a?(Hash) ? options : {:message => options.to_s}
-      @code = opts[:code]
-      @status = opts[:status]
-      super(opts[:message])
-    end
-    
-  end
-  class NotFound < ClientError; end
-  class PermissionDenied < ClientError; end
-  class NotAllowed < ClientError; end
-  class BadResourceRequest < ClientError; end
-  
-  # Nice and handy class wrapper for the api response hash
-  class ApiResponse
-    attr_accessor :code, :message, :results, :success, :pagination
-    def initialize(d)
-      begin
-        hash = d["D"]
-        if hash.nil? || hash.empty?
-          raise InvalidResponse, "The server response could not be understood"
-        end
-        self.message  = hash["Message"]
-        self.code     = hash["Code"]
-        self.results  = hash["Results"]
-        self.success  = hash["Success"]
-        self.pagination = hash["Pagination"]
-      rescue Exception => e
-        FlexmlsApi.logger.error "Unable to understand the response! #{d}"
-        raise
-      end
-    end
-    def success?
-      @success
-    end
-  end
-
 end

data/lib/flexmls_api/response.rb

@@ -0,0 +1,69 @@
+module FlexmlsApi
+  # API Response interface
+  module Response
+    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details]
+    attr_accessor *ATTRIBUTES
+    def success?
+      @success
+    end
+  end
+  
+  # All known response codes listed in the API
+  module ResponseCodes
+    NOT_FOUND = 404
+    METHOD_NOT_ALLOWED = 405
+    INVALID_KEY = 1000
+    DISABLED_KEY = 1010
+    API_USER_REQUIRED = 1015
+    SESSION_TOKEN_EXPIRED = 1020
+    SSL_REQUIRED = 1030
+    INVALID_JSON = 1035
+    INVALID_FIELD = 1040
+    MISSING_PARAMETER = 1050
+    INVALID_PARAMETER = 1053
+    CONFLICTING_DATA = 1055
+    NOT_AVAILABLE= 1500
+    RATE_LIMIT_EXCEEDED = 1550
+  end
+  
+  # Errors built from API responses
+  class InvalidResponse < StandardError; end
+  class ClientError < StandardError
+    attr_reader :code, :status
+    def initialize (options = {})
+      # Support the standard initializer for errors
+      opts = options.is_a?(Hash) ? options : {:message => options.to_s}
+      @code = opts[:code]
+      @status = opts[:status]
+      super(opts[:message])
+    end
+    
+  end
+  class NotFound < ClientError; end
+  class PermissionDenied < ClientError; end
+  class NotAllowed < ClientError; end
+  class BadResourceRequest < ClientError; end
+  
+  # Nice and handy class wrapper for the api response hash
+  class ApiResponse < ::Array
+    include FlexmlsApi::Response
+    def initialize(d)
+      begin
+        hash = d["D"]
+        if hash.nil? || hash.empty?
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        self.message    = hash["Message"]
+        self.code       = hash["Code"]
+        self.results    = Array(hash["Results"])
+        self.success    = hash["Success"]
+        self.pagination = hash["Pagination"]
+        self.details    = hash["Details"] || []
+        super(results)
+      rescue Exception => e
+        FlexmlsApi.logger.error "Unable to understand the response! #{d}"
+        raise
+      end
+    end
+  end
+end