flexmls_api 0.4.5 → 0.6.4

data/lib/flexmls_api/cli/setup.rb

@@ -0,0 +1,44 @@
+require "rubygems"
+require 'pp'
+
+if ENV["FLEXMLS_API_CONSOLE"].nil?
+  require 'flexmls_api'
+else
+  puts "Enabling console mode for local gem"
+  Bundler.require(:default, "development") if defined?(Bundler)
+  path = File.expand_path(File.dirname(__FILE__) + "/../../../lib/")
+  $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+  require path + '/flexmls_api'
+end
+
+IRB.conf[:AUTO_INDENT]=true
+IRB.conf[:PROMPT][:FLEXMLS]= {
+  :PROMPT_I => "flexmlsApi:%03n:%i> ",
+  :PROMPT_S => "flexmlsApi:%03n:%i%l ",
+  :PROMPT_C => "flexmlsApi:%03n:%i* ",
+  :RETURN => "%s\n"
+} 
+
+IRB.conf[:PROMPT_MODE] = :FLEXMLS
+
+path = File.expand_path(File.dirname(__FILE__) + "/../../../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require path + '/flexmls_api'
+
+module FlexmlsApi
+  def self.logger
+    if @logger.nil?
+      @logger = Logger.new(STDOUT)
+      @logger.level = ENV["VERBOSE"].nil? ? Logger::WARN : Logger::DEBUG
+    end
+    @logger
+  end
+end
+
+FlexmlsApi.logger.info("Client configured!")
+
+include FlexmlsApi::Models
+
+def c
+  FlexmlsApi.client
+end

data/lib/flexmls_api/configuration.rb

@@ -2,7 +2,7 @@ module FlexmlsApi
   module Configuration
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, :user_agent, :version, :ssl, :oauth2_provider, :authentication_mode].freeze
-      
+    
     DEFAULT_API_KEY = nil
     DEFAULT_API_SECRET = nil
     DEFAULT_API_USER = nil
@@ -11,6 +11,8 @@ module FlexmlsApi
     DEFAULT_USER_AGENT = "flexmls API Ruby Gem #{VERSION}"
     DEFAULT_SSL = false
     DEFAULT_OAUTH2 = nil
+    
+    X_FLEXMLS_API_USER_AGENT = "X-flexmlsApi-User-Agent"
 
     attr_accessor *VALID_OPTION_KEYS
     def configure
@@ -21,24 +23,22 @@ module FlexmlsApi
       base.reset_configuration
     end
 
-
     def options
       VALID_OPTION_KEYS.inject({}) do |opt,key|
         opt.merge(key => send(key))
       end
     end
 
-
     def reset_configuration
       self.api_key     = DEFAULT_API_KEY
       self.api_secret  = DEFAULT_API_SECRET
       self.api_user    = DEFAULT_API_USER
+      self.authentication_mode = FlexmlsApi::Authentication::ApiAuth
       self.endpoint    = DEFAULT_ENDPOINT
-      self.version     = DEFAULT_VERSION
+      self.oauth2_provider = DEFAULT_OAUTH2
       self.user_agent  = DEFAULT_USER_AGENT
       self.ssl         = DEFAULT_SSL
-      self.oauth2_provider = DEFAULT_OAUTH2
-      self.authentication_mode = FlexmlsApi::Authentication::ApiAuth
+      self.version     = DEFAULT_VERSION
       self
     end
   end

data/lib/flexmls_api/faraday.rb

@@ -2,21 +2,12 @@ module FlexmlsApi
   module FaradayExt
     #=Flexmls API Faraday middleware
     # 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|
-            validate_and_build_response(finished_env)
-          end
-        end
-      rescue LoadError, NameError => e
-        self.load_error = e
-      end
+    class FlexmlsMiddleware < Faraday::Response::ParseJson
       
       # 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]
+      def on_complete(finished_env)
+        body = parse(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"
@@ -24,30 +15,29 @@ module FlexmlsApi
         response = ApiResponse.new body
         case finished_env[:status]
         when 400, 409
-          raise BadResourceRequest.new(response.code, finished_env[:status]), response.message
+          raise BadResourceRequest, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 401
           # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
           # OAuth2 implementations and wouldn't hurt to log.
           auth_header_error = finished_env[:request_headers]["WWW-Authenticate"]
           FlexmlsApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
-          raise PermissionDenied.new(response.code, finished_env[:status]), response.message
+          raise PermissionDenied, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 404
-          raise NotFound.new(response.code, finished_env[:status]), response.message
+          raise NotFound, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 405
-          raise NotAllowed.new(response.code, finished_env[:status]), response.message
+    raise NotAllowed, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 500
-          raise ClientError.new(response.code, finished_env[:status]), response.message
+          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 200..299
           FlexmlsApi.logger.debug("Success!")
         else 
-          raise ClientError.new(response.code, finished_env[:status]), response.message
+          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         end
         finished_env[:body] = response
       end
-
+      
       def initialize(app)
-        super
-        @parser = nil
+        super(app)
       end
       
     end

data/lib/flexmls_api/models.rb

@@ -17,6 +17,9 @@ 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__)
 
 module FlexmlsApi
   module Models

data/lib/flexmls_api/models/account.rb

@@ -1,22 +1,65 @@
 module FlexmlsApi
   module Models
     class Account < Base
+      extend Finders
       self.element_name="accounts"
       
       SUBELEMENTS = [:emails, :phones, :websites, :addresses, :images]
-      attr_accessor *SUBELEMENTS
+      attr_accessor :my_account, *SUBELEMENTS 
       
       def initialize(attributes={})
         @emails = subresource(Email, "Emails", attributes)
         @phones = subresource(Phone, "Phones", attributes)
         @websites = subresource(Website, "Websites", attributes)
         @addresses = subresource(Address, "Addresses", attributes)
-        @images = subresource(Image, "Images", attributes)
+        if attributes["Images"]
+          @images = [] 
+          attributes["Images"].each { |i| @images << Image.new(i) }
+        else
+          @images = nil
+        end
+        @my_account = false
         super(attributes)
       end
 
       def self.my(arguments={})
-        collect(connection.get("/my/account", arguments)).first
+        account  = collect(connection.get("/my/account", arguments)).first
+        account.my_account = true
+        account
+      end
+      
+      def my_account?
+        @my_account
+      end
+      
+      def self.by_office(office_id, arguments={})
+        collect(connection.get("#{self.path()}/by/office/#{office_id}", arguments))
+      end
+
+      def primary_img(typ)
+        if @images.is_a?(Array)
+          matches = @images.select {|i| i.Type == typ}
+          matches.sort {|a,b| a.Name <=> b.Name }.first
+        else
+          nil
+        end
+      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={})
+        # The long-term idea is that any setting in the user's account could be updated by including
+        # an attribute and calling PUT /my/account, but for now only the GetEmailUpdates attribute 
+        # is supported
+        save_path = my_account? ? "/my/account" : self.class.path
+        results = connection.put save_path, {"GetEmailUpdates" => self.GetEmailUpdates }, arguments
+        true
       end
 
       private
@@ -46,10 +89,10 @@ module FlexmlsApi
       class Address < Base
         include Primary
       end
+
       class Image < Base
-        include Primary
       end
     end
   end
 
-end
+end

data/lib/flexmls_api/models/base.rb

@@ -68,12 +68,37 @@ module FlexmlsApi
             attributes[$`] = arguments.first
             # TODO figure out a nice way to present setters for the standard fields
           when "?" 
-            attributes[$`]
+            if attributes.include?($`)
+              attributes[$`] ? true : false
+            else
+              raise NoMethodError
+            end
           end 
         else
           return attributes[method_name] if attributes.include?(method_name)
           super # GTFO
-        end 
+        end
+      end
+
+      def respond_to?(method_symbol, include_private=false)
+        if super
+          return true
+        else
+          method_name = method_symbol.to_s
+
+          if method_name =~ /=$/
+            true
+          elsif method_name =~ /(\?)$/
+            attributes.include?($`)
+          else
+            attributes.include?(method_name)
+          end
+
+        end
+      end
+      
+      def parse_id(uri)
+        uri[/\/.*\/(.+)$/, 1]
       end
     end
   end

data/lib/flexmls_api/models/contact.rb

@@ -4,23 +4,42 @@ module FlexmlsApi
       extend Finders
       self.element_name="contacts"
       
-      def save
+      def save(arguments={})
         begin
-          return save!
-        rescue BadResourceRequest => e
-        rescue NotFound => e
-          # log and leave
-          FlexmlsApi.logger.error("Failed to save contact #{self}: #{e.message}")
+          return save!(arguments)
+        rescue NotFound, BadResourceRequest => e
+          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
         end
         false
       end
-      def save!
-        results = connection.post self.class.path, "Contacts" => [ attributes ]
+      def save!(arguments={})
+        results = connection.post self.class.path, {"Contacts" => [ attributes ], "Notify" => notify? }, arguments
         result = results.first
         attributes['ResourceUri'] = result['ResourceUri']
-        attributes['Id'] = result['ResourceUri'][/\/.*\/(.+)$/, 1]
+        attributes['Id'] = parse_id(result['ResourceUri'])
         true
       end
+      
+      def self.by_tag(tag_name, arguments={})
+        collect(connection.get("#{path}/tags/#{tag_name}", arguments))
+      end
+
+      def self.tags(arguments={})
+        connection.get("#{path}/tags", arguments)
+      end
+
+      def self.my(arguments={})
+        new(connection.get('/my/contact', arguments).first)
+      end
+            
+      # Notify the agent of contact creation via a flexmls message.
+      def notify?
+        @notify == true
+      end
+      def notify=(notify_me=true)
+        @notify = notify_me
+      end
+      
     end
   end
 end

data/lib/flexmls_api/models/listing_cart.rb

@@ -0,0 +1,72 @@
+module FlexmlsApi
+  module Models
+    class ListingCart < Base 
+      extend Finders
+      self.element_name="listingcarts"
+
+      def ListingIds=(listing_ids)
+        attributes["ListingIds"] = Array(listing_ids)
+      end
+      def Name=(name)
+        attributes["Name"] = name
+      end
+      
+      def add_listing(listing)
+        id = listing.respond_to?(:Id) ? listing.Id : listing.to_s
+        results = connection.post("#{self.class.path}/#{self.Id}", {"ListingIds" => [ listing ]})
+        self.ListingCount = results.first["ListingCount"]
+      end
+      
+      def remove_listing(listing)
+        id = listing.respond_to?(:Id) ? listing.Id : listing.to_s
+        results = connection.delete("#{self.class.path}/#{self.Id}/listings/#{id}")
+        self.ListingCount = results.first["ListingCount"]
+      end
+      
+      def self.for(listings,arguments={})
+        keys = Array(listings).map { |l| l.respond_to?(:Id) ? l.Id : l.to_s }
+        collect(connection.get("/#{self.element_name}/for/#{keys.join(",")}", arguments))
+      end
+
+      def self.my(arguments={})
+        collect(connection.get("/my/#{self.element_name}", arguments))
+      end
+
+      def self.portal(arguments={})
+          collect(connection.get("/#{self.element_name}/portal", arguments))
+      end
+      
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          FlexmlsApi.logger.error("Failed to save contact #{self}: #{e.message}")
+        end
+        false
+      end
+      def save!(arguments={})
+        attributes['Id'].nil? ? create!(arguments) : update!(arguments)
+      end
+      
+      def delete(args={})
+        connection.delete("#{self.class.path}/#{self.Id}", args)
+      end
+      
+      private 
+      def create!(arguments={})
+        results = connection.post self.class.path, {"ListingCarts" => [ attributes ]}, arguments
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        attributes['Id'] = parse_id(result['ResourceUri'])
+        true
+      end
+      def update!(arguments={})
+        results = connection.put "#{self.class.path}/#{self.Id}", {"ListingCarts" => [ {"Name" => attributes["Name"], "ListingIds" => attributes["ListingIds"]} ] }, arguments
+        true
+      end
+
+    end
+  end
+end

data/lib/flexmls_api/models/note.rb

@@ -13,7 +13,6 @@ module FlexmlsApi
         end
       end
 
-
       def save(arguments={})
         begin
           return save!(arguments)
@@ -37,7 +36,6 @@ module FlexmlsApi
         connection.delete(self.class.path, args)
       end
 
-
     end
   end
 end

data/lib/flexmls_api/models/saved_search.rb

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