flexmls_api 0.3.2

data/lib/flexmls_api/faraday.rb

@@ -0,0 +1,52 @@
+module FlexmlsApi
+  module FaradayExt
+    #=Flexmls API Faraday middle way
+    # HTTP Response after filter to package api responses and bubble up basic api errors.
+    class FlexmlsMiddleware < Faraday::Response::Middleware
+      begin
+        def self.register_on_complete(env)
+          env[:response].on_complete do |finished_env|
+            FlexmlsApi.logger.debug("hashed response: #{finished_env[:body].inspect}")
+            validate_and_build_response(finished_env)
+          end
+        end
+      rescue LoadError, NameError => e
+        self.load_error = e
+      end
+      
+      # Handles pretty much all the api response parsing and error handling.  All responses that
+      # indicate a failure will raise a FlexmlsApi::ClientError exception
+      def self.validate_and_build_response(finished_env)
+        body = finished_env[:body]
+        FlexmlsApi.logger.debug("Response Body: #{body.inspect}")
+        unless body.is_a?(Hash) && body.key?("D")
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        response = ApiResponse.new body
+        case finished_env[:status]
+        when 400, 409
+          raise BadResourceRequest.new(response.code, finished_env[:status]), response.message
+        when 401
+          raise PermissionDenied.new(response.code, finished_env[:status]), response.message
+        when 404
+          raise NotFound.new(response.code, finished_env[:status]), response.message
+        when 405
+          raise NotAllowed.new(response.code, finished_env[:status]), response.message
+        when 500
+          raise ClientError.new(response.code, finished_env[:status]), response.message
+        when 200..299
+          FlexmlsApi.logger.debug("Success!")
+        else 
+          raise ClientError.new(response.code, finished_env[:status]), response.message
+        end
+        finished_env[:body] = response
+      end
+
+      def initialize(app)
+        super
+        @parser = nil
+      end
+      
+    end
+  end
+end

data/lib/flexmls_api/models/base.rb

@@ -0,0 +1,76 @@
+module FlexmlsApi
+  module Models
+    # =API Model Base class
+    # Intended to be a lot like working with ActiveResource, this class adds most of the basic 
+    # active model type niceties.
+    class Base
+      extend Paginate
+
+      attr_accessor :attributes
+      
+      # Name of the resource as related to the path name
+      def self.element_name
+        # TODO I'd love to pull in active model at this point to provide default naming
+        @element_name ||= "resource"
+      end
+
+      def self.element_name=(name)
+        @element_name = name
+      end
+      
+      # Resource path prefix, prepended to the url
+      def self.prefix
+        @prefix ||= "/"
+      end
+      def self.prefix=(prefix)
+        @prefix = prefix
+      end
+      def self.path
+        "#{prefix}#{element_name}"
+      end
+      
+      def self.connection
+        FlexmlsApi.client
+      end
+      def connection
+        self.class.connection
+      end
+
+      def initialize(attributes={})
+        @attributes = {}
+        load(attributes)
+      end
+
+      def load(attributes)
+        attributes.each do |key,val|
+          @attributes[key.to_s] = val
+        end
+      end
+      
+      def self.get(options={})
+        collect(connection.get(path, options))
+      end
+
+      def self.first(options={})
+        get(options)[0]
+      end
+
+      def method_missing(method_symbol, *arguments)
+        method_name = method_symbol.to_s
+
+        if method_name =~ /(=|\?)$/
+          case $1
+          when "=" 
+            attributes[$`] = arguments.first
+            # TODO figure out a nice way to present setters for the standard fields
+          when "?" 
+            attributes[$`]
+          end 
+        else
+          return attributes[method_name] if attributes.include?(method_name)
+          super # GTFO
+        end 
+      end
+    end
+  end
+end

data/lib/flexmls_api/models/connect_prefs.rb

@@ -0,0 +1,10 @@
+module FlexmlsApi
+  module Models
+    class Connect < Base
+      self.element_name="connect"
+      def self.prefs
+        connection.get("#{path}/prefs")
+      end
+    end
+  end
+end

data/lib/flexmls_api/models/contact.rb

@@ -0,0 +1,25 @@
+module FlexmlsApi
+  module Models
+    class Contact < Base
+      self.element_name="contacts"
+      
+      def save
+        begin
+          return save!
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          FlexmlsApi.logger.error("Failed to save contact #{self}: #{e.message}")
+        end
+        false
+      end
+      def save!
+        results = connection.post self.class.path, "Contacts" => [ attributes ]
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        attributes['Id'] = result['ResourceUri'][/\/.*\/(.+)$/, 1]
+        true
+      end
+    end
+  end
+end

data/lib/flexmls_api/models/custom_fields.rb

@@ -0,0 +1,12 @@
+module FlexmlsApi
+  module Models
+    class CustomFields < Base
+      self.element_name="customfields"
+
+
+      def self.find_by_property_type(card_fmt, user)
+        collect(connection.get("#{self.path}/#{card_fmt}", :ApiUser => user))
+      end
+    end
+  end
+end

data/lib/flexmls_api/models/document.rb

@@ -0,0 +1,11 @@
+module FlexmlsApi
+  module Models
+    class Document < Base
+      extend Subresource
+
+      self.element_name="documents"
+      
+
+    end
+  end
+end

data/lib/flexmls_api/models/idx_link.rb

@@ -0,0 +1,45 @@
+module FlexmlsApi
+  module Models
+    class IdxLink < Base
+      self.element_name="idxlinks"
+
+      #TODO Work all below into common base class
+      def self.find(*arguments)
+        scope = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        
+        case scope
+          when :all   then find_every(options)
+          when :first then find_every(options).first
+          when :last  then find_every(options).last
+          when :one   then find_one(options)
+          else             find_single(scope, options)
+        end
+      end
+      
+      def self.first(*arguments)
+        find(:first, *arguments)
+      end
+
+      def self.last(*arguments)
+        find(:last, *arguments)
+      end
+
+      private
+
+      def self.find_every(options)
+        raise NotImplementedError # TODO
+      end
+
+      def self.find_one(options)
+        raise NotImplementedError # TODO
+      end
+
+      def self.find_single(scope, options)
+        resp = FlexmlsApi.client.get("/idxlinks/#{scope}", options)
+        new(resp[0])
+      end
+
+    end
+  end
+end

data/lib/flexmls_api/models/listing.rb

@@ -0,0 +1,110 @@
+module FlexmlsApi
+  module Models
+    class Listing < Base 
+      attr_accessor :photos, :videos, :virtual_tours, :documents
+      self.element_name="listings"
+
+      def initialize(attributes={})
+        @photos = []
+        @videos = []
+        @virtual_tours = []
+        @documents = []
+
+
+        if attributes.has_key?('StandardFields')
+          pics, vids, tours, docs = attributes['StandardFields'].values_at('Photos','Videos', 'VirtualTours', 'Documents')
+        end
+        
+        if pics != nil
+          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')
+        end
+
+        if tours != nil
+          tours.collect { |tour| @virtual_tours.push(VirtualTour.new(tour)) }
+          attributes['StandardFields'].delete('VirtualTours')
+        end
+
+        if docs != nil
+          docs.collect { |doc| @documents.push(Document.new(doc)) }
+          attributes['StandardFields'].delete('Documents')
+        end
+        
+      
+        super(attributes)
+      end
+
+
+      def self.find(*arguments)
+        scope = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        
+        case scope
+          when :all   then find_every(options)
+          when :first then find_every(options).first
+          when :last  then find_every(options).last
+          when :one   then find_one(options)
+          else             find_single(scope, options)
+        end
+      end
+
+      def self.find_by_cart_id(cart_id, owner, options={}) 
+        options.merge!({ :ApiUser => owner, :_filter => "ListingCart Eq '#{cart_id}'" })
+        find(:all, options) 
+      end
+      
+      def self.first(*arguments)
+        find(:first, *arguments)
+      end
+
+      def self.last(*arguments)
+        find(:last, *arguments)
+      end
+
+      def self.my(arguments={})
+        collect(connection.get("/my/listings", arguments))
+      end
+
+
+      private
+
+      def self.find_every(options)
+        collect(connection.get('/listings', options))
+      end
+
+      def self.find_one(options)
+        raise NotImplementedError # TODO
+      end
+
+      def self.find_single(scope, options)
+        resp = FlexmlsApi.client.get("/listings/#{scope}", options)
+        new(resp[0])
+      end
+
+
+      # TODO trim this down so we're only overriding the StandardFields access
+      def method_missing(method_symbol, *arguments)
+        method_name = method_symbol.to_s
+
+        if method_name =~ /(=|\?)$/
+          case $1
+          when "="
+            attributes[$`] = arguments.first
+            # TODO figure out a nice way to present setters for the standard fields
+          when "?"
+            attributes[$`]
+          end  
+        else 
+          return attributes[method_name] if attributes.include?(method_name)
+          return @attributes['StandardFields'][method_name] if attributes['StandardFields'].include?(method_name)
+          super # GTFO
+        end
+      end
+    end
+  end
+end

data/lib/flexmls_api/models/market_statistics.rb

@@ -0,0 +1,33 @@
+module FlexmlsApi
+  module Models
+    class MarketStatistics < Base
+      self.element_name="marketstatistics"
+      
+      def self.absorption(parameters={})
+        self.stat('absorption',parameters)
+      end
+      def self.inventory(parameters={})
+        self.stat('inventory',parameters)
+      end
+      def self.price(parameters={})
+        self.stat('price',parameters)
+      end
+      def self.ratio(parameters={})
+        self.stat('ratio',parameters)
+      end
+      def self.dom(parameters={})
+        self.stat('dom',parameters)
+      end
+      def self.volume(parameters={})
+        self.stat('volume',parameters)
+      end
+
+      private 
+      def self.stat(stat_name, parameters={})
+        resp = connection.get("#{path}/#{stat_name}", parameters)
+        new(resp[0])
+      end
+      
+    end
+  end
+end

data/lib/flexmls_api/models/photo.rb

@@ -0,0 +1,15 @@
+module FlexmlsApi
+  module Models
+    class Photo < Base
+      extend Subresource
+
+      self.element_name = "photos"
+
+      def primary? 
+        @attributes["Primary"] == true 
+      end
+
+
+    end
+  end
+end

data/lib/flexmls_api/models/property_types.rb

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

data/lib/flexmls_api/models/standard_fields.rb

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

data/lib/flexmls_api/models/subresource.rb

@@ -0,0 +1,13 @@
+module FlexmlsApi
+  module Models
+    module Subresource 
+    
+      def find_by_listing_key(key, user)
+        collect(connection.get("/listings/#{key}#{self.path}", :ApiUser => user))
+      end
+
+
+
+    end
+  end
+end

data/lib/flexmls_api/models/system_info.rb

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