nwmls_client 1.0.1

data/lib/nwmls_client/commercial.rb

@@ -0,0 +1,23 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class Commercial < Listing
+
+    def initialize(criteria = {})
+      criteria[:property_code] = "COMI"
+      criteria[:property_type] = :commercial_industrial
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+    
+  end
+  
+end
+
+
+if __FILE__ == $0
+  commercial = NwmlsClient::Commercial.new()
+  listings = commercial.retrieve_data
+  commercial.display(listings)
+end

data/lib/nwmls_client/community.rb

@@ -0,0 +1,38 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class Community < Listing
+
+    def initialize(criteria = {})
+      criteria[:operation] = :retrieve_area_community_data
+      criteria[:data_response] = :retrieve_area_community_data_response
+      criteria[:data_result] = :retrieve_area_community_data_result
+      criteria[:data_types] = :areas_communities
+      criteria[:data_type] = :areacommunity
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+
+    def display(community_data)
+
+      if community_data.is_a?(Array)
+        community_data.each do |item|
+          item.each do |key, value|
+            puts "#{key}: #{value}"
+          end
+          puts "\n"
+        end
+      end        
+    end
+
+  end
+  
+end
+
+
+if __FILE__ == $0
+  community = NwmlsClient::Community.new()
+  data = community.retrieve_data
+  community.display(data)
+end

data/lib/nwmls_client/condominium.rb

@@ -0,0 +1,23 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class Condominium < Listing
+
+    def initialize(criteria = {})
+      criteria[:property_code] = "COND"
+      criteria[:property_type] = :condominium
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+    
+  end
+  
+end
+
+
+if __FILE__ == $0
+  condo = NwmlsClient::Condominium.new()
+  listings = condo.retrieve_data
+  condo.display(listings)
+end

data/lib/nwmls_client/farmranch.rb

@@ -0,0 +1,23 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class FarmRanch < Listing
+
+    def initialize(criteria = {})
+      criteria[:property_code] = "FARM"
+      criteria[:property_type] = :farm_ranch
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+    
+  end
+  
+end
+
+
+if __FILE__ == $0
+  farm_ranch = NwmlsClient::FarmRanch.new()
+  listings = farm_ranch.retrieve_data
+  farm_ranch.display(listings)
+end

data/lib/nwmls_client/history.rb

@@ -0,0 +1,48 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class History < Listing
+
+    def initialize(criteria = {})
+      criteria[:operation] = :retrieve_listing_history_data
+      criteria[:data_response] = :retrieve_listing_history_data_response
+      criteria[:data_result] = :retrieve_listing_history_data_result
+      criteria[:data_types] = :listing_history
+      criteria[:data_type] = :history
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+
+    def display(history_data)
+
+      if history_data.is_a?(Array)
+        history_data.each do |item|
+          item.each do |key, value|
+            if key.to_s == "ml_number"
+              puts "#{key}: #{value}"
+            else
+              if value.is_a?(Array)
+                value.each do |item2|
+                  puts "list price: #{item2[:list_price]} change date: #{item2[:change_date]}"                
+                end
+              else
+                puts "list price: #{value[:list_price]} change date: #{value[:change_date]}"
+              end
+            end 
+          end
+        end
+      end        
+    end
+
+  end
+  
+end
+
+  
+if __FILE__ == $0
+  history = NwmlsClient::History.new()
+  data = history.retrieve_data
+  #puts "#{data}"
+  history.display(data)
+end

data/lib/nwmls_client/image.rb

@@ -0,0 +1,125 @@
+require 'savon'
+
+module NwmlsClient
+
+  class Image
+
+    DEFAULT_SCHEMA_NAME = 'StandardXML1_3'
+    MLS = 'NWMLS'
+    DEFAULT_PTYP = 'RESI'
+    IMAGE_SCHEMA = 'NWMLS:EverNet:ImageData:1.0'
+
+    attr_accessor :schema_name
+    attr_accessor :user_id
+    attr_accessor :password
+    attr_accessor :listing_number
+
+    def initialize(listing_number = nil)
+      @user_id = nil
+      @password = nil
+      @listing_number = listing_number    
+    end
+    
+    def retrieve_images()
+
+      if !@user_id && !@password
+        puts "\nBoth user_id and password must be provided.\nExample:  #{Image.name}.user_id\n\n"
+      end
+
+      request = { 'query' => build_request()}
+
+      begin
+        @client = create_client()
+        response = @client.call(:retrieve_images, message: request)
+      rescue Savon::SOAPFault => error
+        #puts "The call to retrieve_listing_data failed: #{$!}"
+        puts "Error making call to retrieve_images:  #{error.http.code}"
+      end
+
+      cdata = response.body[:retrieve_images_response][:retrieve_images_result] 
+      nori_options = { :convert_tags_to => lambda { |tag| tag.snakecase.to_sym } }
+      result = Nori.new(nori_options).parse(cdata)
+
+      images_data = result[:results][:images]
+
+      if images_data == nil
+        puts "No images found for MLS# #{@listing_number}, ensure MLS# is correct."
+        return images_data
+      else
+        image_folder = File.join(Dir.pwd, "images")
+        if not Dir.exist?(image_folder)
+          Dir.mkdir(image_folder)
+        end
+
+        dirpath = File.join(Dir.pwd, "images/#{@listing_number}")
+        if not Dir.exist?(dirpath)
+          Dir.mkdir(dirpath)
+        end
+
+        image_data = images_data[:image]
+        if image_data.is_a?(Array)
+          image_data.each do |image|
+
+            filename = File.join(dirpath, "#{@listing_number}_#{image[:image_order]}.jpg")
+            File.open(filename, 'wb') do |f|
+              f.write(Base64.decode64(image[:blob]))
+            end
+          end
+        else
+          image = image_data
+
+          filename = File.join(dirpath, "#{@listing_number}_#{image[:image_order]}.jpg")
+          File.open(filename, 'wb') do |f|
+            f.write(Base64.decode64(image[:blob]))
+          end
+        end
+      end
+
+    end
+
+
+  private
+
+    def create_client()
+
+      @client = Savon.client(
+        wsdl: "http://images.idx.nwmls.com/imageservice/imagequery.asmx?wsdl"
+        #log_level: :debug, # can be: :debug, warn, :error, :fatal, :info
+        #log: true,
+        #open_timeout: 10,
+        #read_timeout: 60
+        )
+
+    end
+
+    def build_request()
+
+      xm = Builder::XmlMarkup.new
+
+      # Generate query to obtain actual images of specified property
+      xm.instruct! :xml, :version=>"1.0"
+      xm.ImageQuery(:xmlns => "NWMLS:EverNet:ImageQuery:1.0") {
+        xm.Auth {
+          xm.UserId user_id
+          xm.Password password
+        }
+        xm.Query {
+          xm.ByListingNumber @listing_number
+        }
+        xm.Results {
+          xm.Schema IMAGE_SCHEMA
+        }
+      }
+
+    end
+
+  end
+  
+end
+
+if __FILE__ == $0
+  image = NwmlsClient::Image.new(877620)
+  image.user_id = "nwmls_user_id"
+  image.password = "secret_password"
+  images = image.retrieve_images
+end

data/lib/nwmls_client/image_data.rb

@@ -0,0 +1,37 @@
+require_relative "listing"
+
+module NwmlsClient
+
+  class ImageData < Listing
+
+    def initialize(criteria = {})
+      criteria[:operation] = :retrieve_image_data
+      criteria[:data_response] = :retrieve_image_data_response
+      criteria[:data_result] = :retrieve_image_data_result
+      criteria[:data_types] = :images
+      criteria[:data_type] = :image
+      @criteria = criteria 
+      super(@criteria)    
+    end 
+
+    def display(image_data)
+
+      if image_data.is_a?(Array)
+        image_data.each do |item|
+          item.each do |key, value|
+            puts "#{key}: #{value}"
+          end
+          puts "\n"
+        end
+      end        
+    end
+
+  end
+  
+end
+
+if __FILE__ == $0
+  image_data = NwmlsClient::ImageData.new()
+  data = image_data.retrieve_data
+  image_data.display(data)
+end

data/lib/nwmls_client/listing.rb

@@ -0,0 +1,195 @@
+require 'rubygems'
+require 'savon'
+require 'date'
+require 'yaml'
+require_relative 'codes'
+
+module NwmlsClient
+
+  class Listing
+
+    DEFAULT_SCHEMA_NAME = 'StandardXML1_3'
+    MLS = 'NWMLS'
+    DEFAULT_PTYP = 'RESI'
+    IMAGE_SCHEMA = 'NWMLS:EverNet:ImageData:1.0'
+    AMENITY_FILE = "amenity.yml"
+
+    attr_accessor :criteria
+    attr_accessor :schema_name
+    attr_accessor :user_id
+    attr_accessor :password
+
+    def initialize(criteria = {})
+      @user_id = nil
+      @password = nil
+      @criteria = criteria
+      @criteria[:property_type] ||= :residential
+      @criteria[:begin_date] ||= DateTime.now-1
+      @criteria[:end_date] ||= DateTime.now
+    end  
+
+    def retrieve_data()
+
+      operation = ( @criteria[:operation] || :retrieve_listing_data )
+      data_response = ( @criteria[:data_response] || :retrieve_listing_data_response )
+      data_result = ( @criteria[:data_result] || :retrieve_listing_data_result )
+      data_types = ( @criteria[:data_types] || :listings )
+      data_type = ( @criteria[:data_type] || @criteria[:property_type] )
+
+      if !@user_id && !@password
+        puts "\nBoth user_id and password must be provided.\nExample:  #{Listing.name}.user_id\n\n"
+      end
+
+      request = { 'v_strXmlQuery' => build_request()}
+
+      begin
+        @client = create_client()
+        response = @client.call(operation, message: request)
+      rescue Savon::SOAPFault => error
+        #puts "The call to retrieve_listing_data failed: #{$!}"
+        puts "Error making call to retrieve_listing_data:  #{error.http.code}"
+      end
+
+      cdata = response.body[data_response][data_result] 
+      nori_options = { :convert_tags_to => lambda { |tag| tag.snakecase.to_sym } }
+      result = Nori.new(nori_options).parse(cdata)
+      
+      if result[data_types][data_type] == nil
+        puts "Unable to retrieve data, please review returned data:\n#{result}"
+      end
+
+      listing_data = result[data_types][data_type]
+
+    end
+
+    def display(listing_data)
+
+      if !listing_data
+        puts "Unable to display data.  Invalid listing_data: #{listing_data}"
+        return 
+      end
+
+      puts "listing_data input: #{listing_data}"
+
+      begin      
+        amenity = YAML.load(File.open(File.join(Dir.pwd, AMENITY_FILE)))
+      rescue ArgumentError => e
+        puts "Could not parse YAML: #{e.message}"
+      end
+
+      # TODO: Is there a way to load the listing data and replace both 
+      # Codes and Amenities with the friendly names using regular expressions?
+
+      # Check if there is a list of items to display
+      # or only one
+      if listing_data.is_a?(Array)
+        listing_data.each do |item|
+          item.each do |key, value|
+            items = []
+            code = key.to_s.upcase
+            friendly_name = Codes.expand_code(code)
+
+            if amenity[code] && value
+              amenities = value.split('|')
+              amenities.each do |am|
+                items << "#{amenity[code][am]}"
+              end
+              puts "#{friendly_name}: #{items.join(", ")}"
+            else
+              puts "#{friendly_name}: #{value}"
+            end
+
+          end
+          puts "\n"
+        end
+      else
+        listing_data.each do |key, value|
+
+          if value != nil
+            items = []
+            code = key.to_s.upcase
+            friendly_name = Codes.expand_code(code)
+
+            if amenity[code]
+              amenities = value.split('|')
+              amenities.each do |am|
+                items << "#{amenity[code][am]}"
+              end
+              puts "#{friendly_name}: #{items.join(', ')}"
+            else
+              puts "#{friendly_name}: #{value}"
+            end
+
+          end
+
+        end
+      end
+    end
+
+
+  private
+
+    def create_client()
+
+      @client = Savon.client(
+        wsdl: "http://evernet.nwmls.com/evernetqueryservice/evernetquery.asmx?wsdl"
+        #log_level: :debug, # can be: :debug, warn, :error, :fatal, :info
+        #log: true,
+        #open_timeout: 10,
+        #read_timeout: 60
+        )
+
+    end
+
+    def build_request()
+
+      xm = Builder::XmlMarkup.new
+
+      #Generate query to obtain data from Evernet web service
+      xm.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8", :standalone=>"no"
+      xm.EverNetQuerySpecification(:xmlns => "urn:www.nwmls.com/Schemas/General/EverNetQueryXML.xsd") {
+        xm.Message {
+          xm.Head {
+            xm.UserId user_id
+            xm.Password password
+            xm.SchemaName (schema_name || DEFAULT_SCHEMA_NAME)
+          }
+          xm.Body {
+            xm.Query {
+              xm.MLS MLS
+              if @criteria[:listing_number]
+                xm.ListingNumber @criteria[:listing_number] if @criteria[:listing_number]
+                xm.PropertyType (@criteria[:property_code] || DEFAULT_PTYP)
+              else
+                xm.PropertyType (@criteria[:property_code] || DEFAULT_PTYP)
+                xm.Status @criteria[:status] if @criteria[:status]
+                xm.County @criteria[:county] if @criteria[:county]
+                xm.Area @criteria[:area] if @criteria[:area]
+                xm.City @criteria[:city] if @criteria[:city]
+                xm.BeginDate @criteria[:begin_date]
+                xm.EndDate @criteria[:end_date]
+                xm.OfficeId @criteria[:office_id] if @criteria[:office_id]
+                xm.AgentId @criteria[:agent_id] if @criteria[:agent_id]
+                xm.Bedrooms @criteria[:bedrooms] if @criteria[:bedrooms]
+                xm.Bathrooms @criteria[:bathrooms] if @criteria[:bathrooms]
+              end
+            }
+            xm.Filter @criteria[:filters].join(',') if @criteria[:filters]
+          }
+        }
+      }
+
+    end
+
+  end
+  
+end
+
+
+if __FILE__ == $0
+  listing = NwmlsClient::Listing.new()
+  listing.user_id = "nwmls_user_id"
+  listing.password = "secret_password"
+  data = listing.retrieve_data
+  listing.display(data)
+end