spark_api 1.0.0

data/lib/spark_api/models/account.rb

@@ -0,0 +1,115 @@
+module SparkApi
+  module Models
+    class Account < Base
+      extend Finders
+      self.element_name="accounts"
+      
+      SUBELEMENTS = [:emails, :phones, :websites, :addresses, :images]
+      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)
+        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={})
+        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={})
+        self.errors = [] # clear the errors hash
+        begin
+          return save!(arguments)
+        rescue NotFound, BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          SparkApi.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 = "/accounts/"+self.Id
+        
+        ojbsome = {}
+        if attributes['GetEmailUpdates']
+          save_path = my_account? ? "/my/account" : self.class.path
+          ojbsome["GetEmailUpdates"] = attributes['GetEmailUpdates']
+        end
+        if attributes['PasswordValidation']
+          ojbsome["PasswordValidation"] = attributes['PasswordValidation']
+        end
+        if attributes['Password']
+          ojbsome["Password"] = attributes['Password']
+        end    
+          
+        results = connection.put save_path, ojbsome, arguments
+        true
+      end
+
+
+      private
+
+      def subresource(klass, key, attributes)
+        return nil unless attributes.key?(key)
+        array = attributes[key]
+        result = PrimaryArray.new()
+        array.each do |i|
+          result << klass.new(i)
+        end
+        result
+      end
+
+      class Email < Base
+        include Primary
+      end
+
+      class Phone < Base
+        include Primary
+      end
+
+      class Website < Base
+        include Primary
+      end
+
+      class Address < Base
+        include Primary
+      end
+
+      class Image < Base
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,115 @@
+module FlexmlsApi
+  module Models
+    class Account < Base
+      extend Finders
+      self.element_name="accounts"
+      
+      SUBELEMENTS = [:emails, :phones, :websites, :addresses, :images]
+      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)
+        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={})
+        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={})
+        self.errors = [] # clear the errors hash
+        begin
+          return save!(arguments)
+        rescue NotFound, BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          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 = "/accounts/"+self.Id
+        
+        ojbsome = {}
+        if attributes['GetEmailUpdates']
+          save_path = my_account? ? "/my/account" : self.class.path
+          ojbsome["GetEmailUpdates"] = attributes['GetEmailUpdates']
+        end
+        if attributes['PasswordValidation']
+          ojbsome["PasswordValidation"] = attributes['PasswordValidation']
+        end
+        if attributes['Password']
+          ojbsome["Password"] = attributes['Password']
+        end    
+          
+        results = connection.put save_path, ojbsome, arguments
+        true
+      end
+
+
+      private
+
+      def subresource(klass, key, attributes)
+        return nil unless attributes.key?(key)
+        array = attributes[key]
+        result = PrimaryArray.new()
+        array.each do |i|
+          result << klass.new(i)
+        end
+        result
+      end
+
+      class Email < Base
+        include Primary
+      end
+
+      class Phone < Base
+        include Primary
+      end
+
+      class Website < Base
+        include Primary
+      end
+
+      class Address < Base
+        include Primary
+      end
+
+      class Image < Base
+      end
+    end
+  end
+
+end

data/lib/spark_api/models/base.rb

@@ -0,0 +1,118 @@
+module SparkApi
+  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, :errors
+      attr_reader :changed
+      
+      # 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
+        SparkApi.client
+      end
+      def connection
+        self.class.connection
+      end
+
+      def initialize(attributes={})
+        @attributes = {}
+        @errors = []
+        @changed = []
+        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).first
+      end
+
+      def self.count(options={})
+        connection.get(path, options.merge({:_pagination=>"count"}))
+      end
+      
+      def method_missing(method_symbol, *arguments)
+        method_name = method_symbol.to_s
+
+        if method_name =~ /(=|\?)$/
+          case $1
+          when "=" 
+            write_attribute($`, arguments.first)
+            # TODO figure out a nice way to present setters for the standard fields
+          when "?" 
+            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
+      
+      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
+      
+      protected
+      
+      def write_attribute(attribute,  value)
+        unless attributes[attribute] == value
+          attributes[attribute] = value
+          @changed << attribute unless @changed.include?(attribute)
+        end
+      end
+        
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+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, :errors
+      attr_reader :changed
+      
+      # 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 = {}
+        @errors = []
+        @changed = []
+        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).first
+      end
+
+      def self.count(options={})
+        connection.get(path, options.merge({:_pagination=>"count"}))
+      end
+      
+      def method_missing(method_symbol, *arguments)
+        method_name = method_symbol.to_s
+
+        if method_name =~ /(=|\?)$/
+          case $1
+          when "=" 
+            write_attribute($`, arguments.first)
+            # TODO figure out a nice way to present setters for the standard fields
+          when "?" 
+            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
+      
+      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
+      
+      protected
+      
+      def write_attribute(attribute,  value)
+        unless attributes[attribute] == value
+          attributes[attribute] = value
+          @changed << attribute unless @changed.include?(attribute)
+        end
+      end
+        
+    end
+  end
+end