spark_api 1.0.0

data/lib/spark_api/models/note.rb

@@ -0,0 +1,41 @@
+module SparkApi
+  module Models
+    class Note < Base
+      extend Subresource 
+      self.element_name = "notes" # not sure this is really of any use...
+      
+      def self.get(options={})
+        ret = super(options)
+        if ret.empty?
+          return nil
+        else
+          return ret.first
+        end
+      end
+
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          SparkApi.logger.error("Failed to save note #{self} (path: #{self.class.path}): #{e.message}")
+        end 
+        false
+      end 
+
+      def save!(args={})
+        args.merge(:Notes => attributes['Note'])
+        results = connection.put(self.class.path, {:Note => attributes['Note']}, args)
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        true
+      end 
+
+      def delete(args={})
+        connection.delete(self.class.path, args)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module FlexmlsApi
+  module Models
+    class Note < Base
+      extend Subresource 
+      self.element_name = "notes" # not sure this is really of any use...
+      
+      def self.get(options={})
+        ret = super(options)
+        if ret.empty?
+          return nil
+        else
+          return ret.first
+        end
+      end
+
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          FlexmlsApi.logger.error("Failed to save note #{self} (path: #{self.class.path}): #{e.message}")
+        end 
+        false
+      end 
+
+      def save!(args={})
+        args.merge(:Notes => attributes['Note'])
+        results = connection.put(self.class.path, {:Note => attributes['Note']}, args)
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        true
+      end 
+
+      def delete(args={})
+        connection.delete(self.class.path, args)
+      end
+
+    end
+  end
+end

data/lib/spark_api/models/notification.rb

@@ -0,0 +1,42 @@
+module SparkApi
+  module Models
+    class Notification < Base
+
+      self.element_name = 'notifications'
+
+      def save(arguments={})
+        self.errors = [] # clear the errors hash
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          SparkApi.logger.error("Failed to save resource #{self}: #{e.message}")
+        rescue NotFound => e
+          SparkApi.logger.error("Failed to save resource #{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
+
+      def self.unread()
+        # force pagination so response knows to deal with returned pagination info
+        result = connection.get "#{self.path}/unread", {:_pagination => 'count'}
+        result
+      end
+
+      def self.mark_read(notifications, arguments={})
+        notifications = Array(notifications)
+
+        ids = notifications.map { |n| n.respond_to?('Id') ? n.Id : n }
+        result = connection.put "#{self.path}/#{ids.join(',')}", {'Read' => true}, arguments
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module FlexmlsApi
+  module Models
+    class Notification < Base
+
+      self.element_name = 'notifications'
+
+      def save(arguments={})
+        self.errors = [] # clear the errors hash
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
+        rescue NotFound => e
+          FlexmlsApi.logger.error("Failed to save resource #{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
+
+      def self.unread()
+        # force pagination so response knows to deal with returned pagination info
+        result = connection.get "#{self.path}/unread", {:_pagination => 'count'}
+        result
+      end
+
+      def self.mark_read(notifications, arguments={})
+        notifications = Array(notifications)
+
+        ids = notifications.map { |n| n.respond_to?('Id') ? n.Id : n }
+        result = connection.put "#{self.path}/#{ids.join(',')}", {'Read' => true}, arguments
+      end
+
+    end
+  end
+end

data/lib/spark_api/models/open_house.rb

@@ -0,0 +1,24 @@
+require 'date'
+require 'time'
+
+module SparkApi
+  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/open_house.rb~

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

@@ -0,0 +1,70 @@
+module SparkApi
+  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
+          SparkApi.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/photo.rb~

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

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

data/lib/spark_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/spark_api/models/saved_search.rb

@@ -0,0 +1,16 @@
+module SparkApi
+  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'
+          SparkApi.logger.info("#{self.name}.path: #{provided.path}")
+        end
+      end
+    end
+  end
+end

data/lib/spark_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

data/lib/spark_api/models/shared_listing.rb

@@ -0,0 +1,35 @@
+module SparkApi
+  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
+          SparkApi.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