api_resource 0.4.1 → 0.4.2

data/lib/api_resource/associations/single_object_proxy.rb

@@ -0,0 +1,82 @@
+require 'api_resource/associations/association_proxy'
+
+module ApiResource
+  
+  module Associations
+    
+    class SingleObjectProxy < AssociationProxy
+
+      def serializable_hash(options = {})
+        return if self.internal_object.nil?
+        self.internal_object.serializable_hash(options)
+      end
+      
+      def internal_object=(contents)
+        if contents.is_a?(self.klass) ||
+          contents.respond_to?(:internal_object) && contents.internal_object.is_a?(self.klass) ||
+          contents.nil?
+          return @internal_object = contents 
+        else
+          return load(contents)
+        end
+      end
+      
+      def ==(other)
+        return false if self.class != other.class
+        return false if other.internal_object.attributes != self.internal_object.attributes
+        return true
+      end
+
+      protected
+      def load_scope_with_options(scope, options)
+        scope = self.loaded_hash_key(scope.to_s, options)
+        # If the service uri is blank you can't load
+        return nil if self.remote_path.blank?
+        self.loaded[scope] ||= begin
+          self.times_loaded += 1
+          self.klass.new(self.load_from_remote(options))
+        end
+      end
+
+      def load(contents)
+        # If we get something nil this should just behave like nil
+        return if contents.nil?
+        # if we get an array with a length of one, make it a hash
+        if contents.is_a?(self.class)
+          contents = contents.internal_object.serializable_hash
+        elsif contents.is_a?(Array) && contents.length == 1
+          contents = contents.first
+        end
+        raise "Expected an attributes hash got #{contents}" unless contents.is_a?(Hash)
+        contents = contents.with_indifferent_access
+        # If we don't have a 'service_uri' just assume that these are all attributes and make an object
+        return @internal_object = self.klass.new(contents) unless contents[self.class.remote_path_element]
+        # allow for symbols vs strings with these elements
+        self.remote_path = contents.delete(self.class.remote_path_element)
+        # There's only one hash here so it's hard to distinguish attributes from scopes, the key scopes_only says everything
+        # in this hash is a scope
+        no_attrs = (contents.delete(:scopes_only) || false)
+        attrs = {}
+        contents.each do |key, val|
+          # if this key is an attribute add it to attrs, warn if we've set scopes_only
+          if self.klass.attribute_names.include?(key.to_sym) && !no_attrs
+            attrs[key] = val
+          else
+            warn("#{key} is an attribute of #{self.klass}, beware of name collisions") if no_attrs && self.klass.attribute_names.include?(key)
+            raise "Expected the scope #{key} to have a hash for a value, got #{val}" unless val.is_a?(Hash)
+            self.instance_eval <<-EOE, __FILE__, __LINE__ + 1
+              def #{key}(opts = {})
+                @#{key} ||= ApiResource::Associations::RelationScope.new(self, :#{key}, opts)
+              end
+            EOE
+            self.scopes[key.to_s] = val
+          end
+        end
+        @internal_object = attrs.present? ? self.klass.new(attrs) : nil
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/api_resource/attributes.rb

@@ -0,0 +1,243 @@
+module ApiResource
+
+  module Attributes
+  
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Dirty
+    
+    included do
+      
+      alias_method_chain :save, :dirty_tracking
+      
+      class_attribute :attribute_names, :public_attribute_names, :protected_attribute_names, :attribute_types
+      
+      cattr_accessor :valid_typecasts; self.valid_typecasts = [:date, :time, :float, :integer, :int, :fixnum, :string, :array]
+
+      attr_reader :attributes
+      
+      self.attribute_names = []
+      self.public_attribute_names = []
+      self.protected_attribute_names = []
+      self.attribute_types = {}.with_indifferent_access
+      
+      define_method(:attributes) do
+        return @attributes if @attributes
+        # Otherwise make the attributes hash of all the attributes
+        @attributes = HashWithIndifferentAccess.new
+        self.class.attribute_names.each do |attr|
+          @attributes[attr] = self.send("#{attr}")
+        end
+        @attributes
+      end
+
+
+      # This method is important for reloading an object. If the
+      # object has already been loaded, its associations will trip
+      # up the load method unless we pass in the internal objects.
+
+      define_method(:attributes_without_proxies) do
+        attributes = @attributes
+
+        if attributes.nil?
+          attributes = self.class.attribute_names.each do |attr|
+            attributes[attr] = self.send("#{attr}")
+          end
+        end
+
+        attributes.each do |k,v|
+          if v.respond_to?(:internal_object)
+            if v.internal_object.present?
+              internal = v.internal_object
+              if internal.is_a?(Array)
+                attributes[k] = internal.collect{|item| item.attributes}
+              else
+                attributes[k] = internal.attributes
+              end
+            else
+              attributes[k] = nil
+            end
+          end
+        end
+
+        attributes
+      end
+      
+    end
+    
+    module ClassMethods
+      
+      def define_attributes(*args)
+        args.each do |arg|
+          if arg.is_a?(Array)
+            self.define_attribute_type(arg.first, arg.second)
+            arg = arg.first
+          end
+          self.attribute_names += [arg.to_sym]
+          self.public_attribute_names += [arg.to_sym]
+          
+          # Override the setter for dirty tracking
+          self.class_eval <<-EOE, __FILE__, __LINE__ + 1
+            def #{arg}
+              attribute_with_default(:#{arg})
+            end
+          
+            def #{arg}=(val)
+              real_val = typecast_attribute(:#{arg}, val)
+              #{arg}_will_change! unless self.#{arg} == real_val
+              attributes[:#{arg}] = real_val
+            end
+            
+            def #{arg}?
+              attributes[:#{arg}].present?
+            end
+          EOE
+        end
+        self.attribute_names.uniq!
+        self.public_attribute_names.uniq!
+      end
+      
+      def define_protected_attributes(*args)
+        args.each do |arg|
+          
+          if arg.is_a?(Array)
+            self.define_attribute_type(arg.first, arg.second)
+            arg = arg.first
+          end
+
+          self.attribute_names += [arg.to_sym]
+          self.protected_attribute_names += [arg.to_sym]
+          
+          # These attributes cannot be set, throw an error if you try
+          self.class_eval <<-EOE, __FILE__, __LINE__ + 1
+
+            def #{arg}
+              self.attribute_with_default(:#{arg})
+            end
+          
+            def #{arg}=(val)
+              raise "#{arg} is a protected attribute and cannot be set"
+            end
+            
+            def #{arg}?
+              self.attributes[:#{arg}].present?
+            end
+          EOE
+        end
+        self.attribute_names.uniq!
+        self.protected_attribute_names.uniq!
+      end
+      
+      def define_attribute_type(field, type)
+        raise "#{type} is not a valid type" unless self.valid_typecasts.include?(type.to_sym)
+        self.attribute_types[field] = type.to_sym
+      end
+      
+      
+      def attribute?(name)
+        self.attribute_names.include?(name.to_sym)
+      end
+      
+      def protected_attribute?(name)
+        self.protected_attribute_names.include?(name.to_sym)
+      end
+      
+      def clear_attributes
+        self.attribute_names.clear
+        self.public_attribute_names.clear
+        self.protected_attribute_names.clear
+      end
+    end
+    
+    # set new attributes
+    def attributes=(new_attrs)
+      new_attrs.each_pair do |k,v|
+        self.send("#{k}=",v) unless k.to_sym == :id
+      end
+      new_attrs
+    end
+    
+    def save_with_dirty_tracking(*args)
+      if save_without_dirty_tracking(*args)
+        @previously_changed = self.changes
+        @changed_attributes.clear
+        return true
+      else
+        return false
+      end
+    end
+    
+    def set_attributes_as_current(*attrs)
+      @changed_attributes.clear and return if attrs.blank?
+      attrs.each do |attr|
+        @changed_attributes.delete(attr.to_s)
+      end
+    end
+    
+    def reset_attribute_changes(*attrs)
+      attrs = self.class.public_attribute_names if attrs.blank?
+      attrs.each do |attr|
+        self.send("reset_#{attr}!")
+      end
+      
+      set_attributes_as_current(*attrs)
+    end
+    
+    def attribute?(name)
+      self.class.attribute?(name)
+    end
+    
+    def protected_attribute?(name)
+      self.class.protected_attribute?(name)
+    end
+    
+    def respond_to?(sym, include_private_methods = false)
+      if sym =~ /\?$/
+        return true if self.attribute?($`)
+      elsif sym =~ /=$/
+        return true if self.class.public_attribute_names.include?($`)
+      else
+        return true if self.attribute?(sym.to_sym)
+      end
+      super
+    end
+    
+    protected
+    
+    def attribute_with_default(field)
+      self.attributes[field].nil? ? self.default_value_for_field(field) : self.attributes[field]
+    end
+
+    def default_value_for_field(field)
+      case self.class.attribute_types[field.to_sym]
+        when :array
+          return []
+        else
+          return nil
+      end
+    end
+
+    def typecast_attribute(field, val)
+      return val unless self.class.attribute_types.include?(field)
+      case self.class.attribute_types[field.to_sym]
+        when :date
+          return val.class == Date ? val.dup : Date.parse(val)
+        when :time
+          return val.class == Time ? val.dup : Time.parse(val)
+        when :integer, :int, :fixnum
+          return val.class == Fixnum ? val.dup : val.to_i rescue val
+        when :float
+          return val.class == Float ? val.dup : val.to_f rescue val
+        when :string
+          return val.class == String ? val.dup : val.to_s rescue val
+        when :array
+          return val.class == Array ? val.dup : Array.wrap(val)
+        else
+          # catches the nil case and just leaves it alone
+          return val.dup rescue val
+      end
+    end
+    
+  end
+  
+end

data/lib/api_resource/base.rb

@@ -0,0 +1,717 @@
+require 'pp'
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/string_inquirer'
+
+module ApiResource
+  
+  class Base
+    
+    class_attribute :site, :proxy, :user, :password, :auth_type, :format, 
+      :timeout, :open_timeout, :ssl_options, :token, :ttl
+    
+
+    class_attribute :include_root_in_json
+    self.include_root_in_json = true
+    
+    class_attribute :include_nil_attributes_on_create
+    self.include_nil_attributes_on_create = false
+    
+    class_attribute :include_all_attributes_on_update
+    self.include_nil_attributes_on_create = false
+
+    class_attribute :format
+    self.format = ApiResource::Formats::JsonFormat
+    
+    class_attribute :primary_key
+    self.primary_key = "id"
+    
+    class << self
+      
+      # writers - accessors with defaults were not working
+      attr_writer :element_name, :collection_name
+      
+      def inherited(klass)
+        # Call the methods of the superclass to make sure inheritable accessors and the like have been inherited
+        super
+        # Now we need to define the inherited method on the klass that's doing the inheriting
+        # it calls super which will allow the chaining effect we need
+        klass.instance_eval <<-EOE, __FILE__, __LINE__ + 1
+          def inherited(klass)
+            klass.send(:define_singleton_method, :collection_name, lambda {self.superclass.collection_name})
+            super(klass)
+          end
+        EOE
+        true
+      end
+      # This makes a request to new_element_path
+      def set_class_attributes_upon_load
+        return true if self == ApiResource::Base
+        begin
+          class_data = self.connection.get(
+            self.new_element_path, self.headers
+          )
+          # Attributes go first
+          if class_data["attributes"]
+            
+            define_attributes(
+              *(class_data["attributes"]["public"] || [])
+            )
+            define_protected_attributes(
+              *(class_data["attributes"]["protected"] || [])
+            ) 
+            
+          end
+          # Then scopes
+          if class_data["scopes"]
+            class_data["scopes"].each_pair do |scope_name, opts|
+              self.scope(scope_name, opts)
+            end
+          end
+          # Then associations
+          if class_data["associations"]
+            class_data["associations"].each_pair do |key, hash|
+              hash.each_pair do |assoc_name, assoc_options|
+                self.send(key, assoc_name, assoc_options)
+              end
+            end
+          end
+          
+          # This is provided by ActiveModel::AttributeMethods, it should
+          # define the basic methods but we need to override all the setters 
+          # so we do dirty tracking
+          attrs = []
+          if class_data["attributes"] && class_data["attributes"]["public"]
+            attrs += class_data["attributes"]["public"].collect{|v| 
+              v.is_a?(Array) ? v.first : v
+            }.flatten
+          end
+          if class_data["associations"]
+            attrs += class_data["associations"].values.collect(&:keys).flatten
+          end
+          define_attribute_methods(attrs)
+          
+        # Swallow up any loading errors because the site may be incorrect
+        rescue Exception => e
+          if ApiResource.raise_missing_definition_error
+            raise e 
+          end
+          ApiResource.logger.warn(
+            "#{self} accessing #{self.new_element_path}"
+          )
+          ApiResource.logger.warn(
+            "#{self}: #{e.message[0..60].gsub(/[\n\r]/, '')} ...\n"
+          )
+          ApiResource.logger.debug(e.backtrace.pretty_inspect)
+          return e.respond_to?(:request) ? e.request : nil
+        end
+      end
+      
+      def reset_connection
+        remove_instance_variable(:@connection) if @connection.present?
+      end
+
+      # load our resource definition to make sure we know what this class
+      # responds to
+      def respond_to?(*args)
+        unless self.instance_variable_defined?(:@class_data)
+          self.instance_variable_set(:@class_data, true)
+          self.set_class_attributes_upon_load
+        end
+        super
+      end
+      
+      def reload_class_attributes
+        # clear the public_attribute_names, protected_attribute_names
+        remove_instance_variable(:@class_data) if instance_variable_defined?(:@class_data)
+        self.clear_attributes
+        self.clear_related_objects
+        self.set_class_attributes_upon_load
+      end
+      
+      def token_with_new_token_set=(new_token)
+        self.token_without_new_token_set = new_token
+        self.connection(true)
+        self.descendants.each do |child|
+          child.send(:token=, new_token)
+        end
+      end
+      
+      alias_method_chain :token=, :new_token_set
+
+      def site_with_connection_reset=(site)
+        # store so we can reload attributes if the site changed
+        old_site = self.site.to_s.clone
+        @connection = nil
+        
+        if site.nil?
+          self.site_without_connection_reset = nil
+          # no site, so we'll skip the reload
+          return site
+        else
+          self.site_without_connection_reset = create_site_uri_from(site)
+        end
+        
+        # reset class attributes and try to reload them if the site changed
+        unless self.site.to_s == old_site
+          self.reload_class_attributes
+        end
+        
+        return site
+      end
+      
+      alias_method_chain :site=, :connection_reset
+      
+      
+      def format_with_mimetype_or_format_set=(mime_type_or_format)
+        format = mime_type_or_format.is_a?(Symbol) ? ApiResource::Formats[mime_type_or_format] : mime_type_or_format
+        self.format_without_mimetype_or_format_set = format
+        self.connection.format = format if self.site
+      end
+      
+      alias_method_chain :format=, :mimetype_or_format_set
+      
+      def timeout_with_connection_reset=(timeout)
+        @connection = nil
+        self.timeout_without_connection_reset = timeout
+      end
+      
+      alias_method_chain :timeout=, :connection_reset
+      
+      def open_timeout_with_connection_reset=(timeout)
+        @connection = nil
+        self.open_timeout_without_connection_reset = timeout
+      end
+      
+      alias_method_chain :open_timeout=, :connection_reset
+      
+      def connection(refresh = false)
+        @connection = Connection.new(self.site, self.format, self.headers) if refresh || @connection.nil?
+        @connection.timeout = self.timeout
+        @connection
+      end
+            
+      def headers
+        {}.tap do |ret|
+          ret['Lifebooker-Token'] = self.token if self.token.present?
+        end
+      end
+      
+      def prefix(options = {})
+        default = (self.site ? self.site.path : '/')
+        default << '/' unless default[-1..-1] == '/'
+        self.prefix = default
+        prefix(options)
+      end
+      
+      def prefix_source
+        prefix
+        prefix_source
+      end
+
+      def prefix=(value = '/')
+        prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.escape options[#{key}].to_s}"}
+        @prefix_parameters = nil
+        silence_warnings do
+          instance_eval <<-EOE, __FILE__, __LINE__ + 1
+            def prefix_source() "#{value}" end
+            def prefix(options={}) "#{prefix_call}" end
+          EOE
+        end
+      rescue Exception => e
+        logger.error "Couldn't set prefix: #{e}\n #{code}" if logger
+        raise
+      end
+      
+      # element_name with default
+      def element_name
+        @element_name ||= self.model_name.element
+      end
+      # collection_name with default
+      def collection_name
+        @collection_name ||= ActiveSupport::Inflector.pluralize(self.element_name)
+      end
+      
+      # alias_method :set_prefix, :prefix=
+      # alias_method :set_element_name, :element_name=
+      # alias_method :set_collection_name, :collection_name=
+      
+      def element_path(id, prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+
+        # If we have a prefix, we need a foreign key id
+        # This regex detects '//', which means no foreign key id is present.
+        if prefix(prefix_options) =~ /\/\/$/
+          "/#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
+        else
+          # Fall back on this rather than search without the id
+          "#{prefix(prefix_options)}#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
+        end
+      end
+      
+      # TODO: Add back in support for non-dynamic prefix paths (e.g. /subdir/resources/new.json)
+      def new_element_path
+        "/#{collection_name}/new.#{format.extension}"
+      end
+      
+      def collection_path(prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+
+        # If we have a prefix, we need a foreign key id
+        # This regex detects '//', which means no foreign key id is present.
+        if prefix(prefix_options) =~ /\/\/$/
+          "/#{collection_name}.#{format.extension}#{query_string(query_options)}"
+        else
+          # Fall back on this rather than search without the id
+          "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+        end
+      end
+      
+      def build(attributes = {})
+        self.new(attributes)
+      end
+      
+      def create(attributes = {})
+        self.new(attributes).tap{ |resource| resource.save }
+      end
+      
+      # This decides which finder method to call. 
+      # It accepts arguments of the form "scope", "options={}"
+      # where options can be standard rails options or :expires_in. 
+      # If :expires_in is set, it caches it for expires_in seconds.
+      def find(*arguments)
+        scope   = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        
+        expiry = options.delete(:expires_in) || ApiResource::Base.ttl || 0
+        ApiResource.with_ttl(expiry.to_f) do
+          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
+      end
+
+
+      # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass
+      # in all the same arguments to this method as you can to
+      # <tt>find(:first)</tt>.
+      def first(*args)
+        find(:first, *args)
+      end
+
+      # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass
+      # in all the same arguments to this method as you can to
+      # <tt>find(:last)</tt>.
+      def last(*args)
+        find(:last, *args)
+      end
+
+      # This is an alias for find(:all).  You can pass in all the same
+      # arguments to this method as you can to <tt>find(:all)</tt>
+      def all(*args)
+        find(:all, *args)
+      end
+
+
+      # Deletes the resources with the ID in the +id+ parameter.
+      #
+      # ==== Options
+      # All options specify \prefix and query parameters.
+      #
+      # ==== Examples
+      #   Event.delete(2) # sends DELETE /events/2
+      #
+      #   Event.create(:name => 'Free Concert', :location => 'Community Center')
+      #   my_event = Event.find(:first) # let's assume this is event with ID 7
+      #   Event.delete(my_event.id) # sends DELETE /events/7
+      #
+      #   # Let's assume a request to events/5/cancel.xml
+      #   Event.delete(params[:id]) # sends DELETE /events/5
+      def delete(id, options = {})
+        connection.delete(element_path(id, options))
+      end
+      
+      protected
+        def method_missing(meth, *args, &block)
+          # make one attempt to load remote attrs
+          unless self.instance_variable_defined?(:@class_data)
+            self.set_class_attributes_upon_load
+            self.instance_variable_set(:@class_data, true)
+            return self.send(meth, *args, &block)
+          end
+          super
+        end
+      
+      private
+        # Find every resource
+        def find_every(options)
+          begin
+            case from = options[:from]
+            when Symbol
+              instantiate_collection(get(from, options[:params]))
+            when String
+              path = "#{from}#{query_string(options[:params])}"
+              instantiate_collection(connection.get(path, headers) || [])
+            else
+              prefix_options, query_options = split_options(options[:params])
+              path = collection_path(prefix_options, query_options)
+              instantiate_collection( (connection.get(path, headers) || []))
+            end
+          rescue ApiResource::ResourceNotFound
+            # Swallowing ResourceNotFound exceptions and return nil - as per
+            # ActiveRecord.
+            nil
+          end
+        end
+
+        # Find a single resource from a one-off URL
+        def find_one(options)
+          case from = options[:from]
+          when Symbol
+            instantiate_record(get(from, options[:params]))
+          when String
+            path = "#{from}#{query_string(options[:params])}"
+            instantiate_record(connection.get(path, headers))
+          end
+        end
+
+        # Find a single resource from the default URL
+        def find_single(scope, options)
+          prefix_options, query_options = split_options(options[:params])
+          path = element_path(scope, prefix_options, query_options)
+          instantiate_record(connection.get(path, headers))
+        end
+
+        def instantiate_collection(collection)
+          collection.collect! { |record| instantiate_record(record) }
+        end
+
+        def instantiate_record(record)
+          new(record)
+        end
+
+
+        # Accepts a URI and creates the site URI from that.
+        def create_site_uri_from(site)
+          site.is_a?(URI) ? site.dup : uri_parser.parse(site)
+        end
+
+        # Accepts a URI and creates the proxy URI from that.
+        def create_proxy_uri_from(proxy)
+          proxy.is_a?(URI) ? proxy.dup : uri_parser.parse(proxy)
+        end
+
+        # contains a set of the current prefix parameters.
+        def prefix_parameters
+          @prefix_parameters ||= prefix_source.scan(/:\w+/).map { |key| key[1..-1].to_sym }.to_set
+        end
+
+        # Builds the query string for the request.
+        def query_string(options)
+          "?#{options.to_query}" unless options.nil? || options.empty?
+        end
+
+        # split an option hash into two hashes, one containing the prefix options,
+        # and the other containing the leftovers.
+        def split_options(options = {})
+          prefix_options, query_options = {}, {}
+          (options || {}).each do |key, value|
+            next if key.blank?
+            (prefix_parameters.include?(key.to_sym) ? prefix_options : query_options)[key.to_sym] = value
+          end
+
+          [ prefix_options, query_options ]
+        end
+
+        def uri_parser
+          @uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
+        end
+       
+    end
+    
+    def initialize(attributes = {})
+      # if we initialize this class, load the attributes
+      unless self.class.instance_variable_defined?(:@class_data)
+        self.class.set_class_attributes_upon_load
+        self.class.instance_variable_set(:@class_data, true)
+      end
+      # Now we can make a call to setup the inheriting klass with its attributes
+      load(attributes)
+    end
+    
+    def new?
+      id.blank?
+    end
+    alias :new_record? :new?
+    
+    def persisted?
+      !new?
+    end
+    
+    def id
+      self.attributes[self.class.primary_key]
+    end
+    
+    # Bypass dirty tracking for this field
+    def id=(id)
+      attributes[self.class.primary_key] = id
+    end
+    
+    def ==(other)
+      other.equal?(self) || (other.instance_of?(self.class) && other.id == self.id)
+    end
+    
+    def eql?(other)
+      self == other
+    end
+    
+    def hash
+      id.hash
+    end
+    
+    def dup
+      self.class.new.tap do |resource|
+        resource.attributes = self.attributes
+      end
+    end
+    
+    def update_attributes(attrs)
+      self.attributes = attrs
+      self.save
+    end
+    
+    def save(*args)
+      new? ? create(*args) : update(*args)
+    end
+    
+    def save!(*args)
+      save(*args) || raise(ApiResource::ResourceInvalid.new(self))
+    end
+    
+    def destroy
+      connection.delete(element_path(self.id), self.class.headers)
+    end
+    
+    def encode(options = {})
+      self.send("to_#{self.class.format.extension}", options)
+    end
+    
+    def reload
+      remove_instance_variable(:@assoc_attributes) if instance_variable_defined?(:@assoc_attributes)
+      self.load(self.class.find(to_param, :params => @prefix_options).attributes_without_proxies)
+    end
+    
+    def to_param
+      # Stolen from active_record.
+      # We can't use alias_method here, because method 'id' optimizes itself on the fly.
+      id && id.to_s # Be sure to stringify the id for routes
+    end
+
+    def prefix_options
+      return {} unless self.class.prefix_source =~ /\:/
+      ret = {}
+      self.prefix_attribute_names.each do |name|
+        ret[name] = self.send(name)
+      end
+      ret
+    end
+
+    def prefix_attribute_names
+      return [] unless self.class.prefix_source =~ /\:/
+      self.class.prefix_source.scan(/\:(\w+)/).collect{|match| match.first.to_sym}
+    end
+    
+    def load(attributes)
+      return if attributes.nil?
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      
+      attributes.symbolize_keys.each do |key, value|
+        # If this attribute doesn't exist define it as a protected attribute
+        self.class.define_protected_attributes(key) unless self.respond_to?(key)
+        #self.send("#{key}_will_change!") if self.respond_to?("#{key}_will_change!")
+        self.attributes[key] =
+          case value
+            when Array
+              if self.has_many?(key)
+                MultiObjectProxy.new(self.has_many_class_name(key), value)
+              elsif self.association?(key)
+                raise ArgumentError, "Expected a hash value or nil, got: #{value.inspect}"
+              else
+                typecast_attribute(key, value)
+              end
+            when Hash
+              if self.has_many?(key)
+                MultiObjectProxy.new(self.has_many_class_name(key), value)
+              elsif self.association?(key)
+                #binding.pry
+                SingleObjectProxy.new(self.association_class_name(key), value)
+              else
+                typecast_attribute(key, value)
+              end
+            when NilClass
+              # If it's nil and an association then create a blank object
+              if self.has_many?(key)
+                return MultiObjectProxy.new(self.has_many_class_name(key), [])
+              elsif self.association?(key)
+                SingleObjectProxy.new(self.association_class_name(key), value)
+              end
+            else
+              raise ArgumentError, "expected an array or a hash for the association #{key}, got: #{value.inspect}" if self.association?(key)
+              typecast_attribute(key, value)
+          end
+      end
+      return self
+    end
+    
+    # Override to_s and inspect so they only show attributes
+    # and not associations, this prevents force loading of associations
+    # when we call to_s or inspect on a descendent of base but allows it if we 
+    # try to evaluate an association directly
+    def to_s
+      return "#<#{self.class}:#{(self.object_id * 2).to_s(16)} @attributes=#{self.attributes.inject({}){|accum,(k,v)| self.association?(k) ? accum : accum.merge(k => v)}}"
+    end
+    
+    alias_method :inspect, :to_s
+    
+    # Methods for serialization as json or xml, relying on the serializable_hash method
+    def to_xml(options = {})
+      self.serializable_hash(options).to_xml(:root => self.class.element_name)
+    end
+    
+    def to_json(options = {})
+      self.class.include_root_in_json ? {self.class.element_name => self.serializable_hash(options)}.to_json : self.serializable_hash(options).to_json
+    end
+    
+    def serializable_hash(options = {})
+      action = options[:action]
+      include_nil_attributes = options[:include_nil_attributes]
+      options[:include_associations] = options[:include_associations] ? options[:include_associations].symbolize_array : self.changes.keys.symbolize_array.select{|k| self.association?(k)}
+      options[:include_extras] = options[:include_extras] ? options[:include_extras].symbolize_array : []
+      options[:except] ||= []
+      ret = self.attributes.inject({}) do |accum, (key,val)|
+        # If this is an association and it's in include_associations then include it
+        if options[:include_extras].include?(key.to_sym)
+          accum.merge(key => val)
+        elsif options[:except].include?(key.to_sym)
+          accum
+        # this attribute is already accounted for in the URL
+        elsif self.prefix_attribute_names.include?(key.to_sym)
+          accum
+        elsif(!include_nil_attributes && val.nil? && self.changes[key].blank?)
+          accum
+        else
+          !self.attribute?(key) || self.protected_attribute?(key) ? accum : accum.merge(key => val)
+        end
+      end
+      options[:include_associations].each do |assoc|
+        ret[assoc] = self.send(assoc).serializable_hash({:include_id => true, :include_nil_attributes => include_nil_attributes, :action => action}) if self.association?(assoc)
+      end
+      # include id - this is for nested updates
+      ret[:id] = self.id if options[:include_id] && !self.new?
+      ret
+    end
+    
+    protected
+    def connection(refresh = false)
+      self.class.connection(refresh)
+    end
+    
+    def load_attributes_from_response(response)
+      load(response)
+    end
+    
+    def element_path(id, prefix_override_options = {}, query_options = nil)
+      self.class.element_path(
+        id, 
+        self.prefix_options.merge(prefix_override_options), 
+        query_options
+      )
+    end
+    
+    # list of all attributes that are not nil
+    def nil_attributes
+      self.attributes.select{|k,v|
+        # if our value is actually nil or if we are an association
+        # or array and we are blank
+        v.nil? || ((self.association?(k) || v.is_a?(Array)) && v.blank?)
+      }
+    end
+
+    def new_element_path(prefix_options = {})
+      self.class.new_element_path(prefix_options)
+    end
+    
+    def collection_path(override_prefix_options = {},query_options = nil)
+      self.class.collection_path(
+        self.prefix_options.merge(override_prefix_options), 
+        query_options
+      )
+    end
+    
+    def create(*args)
+      body = setup_create_call(*args)
+      connection.post(collection_path, body, self.class.headers).tap do |response|
+        load_attributes_from_response(response)
+      end
+    end
+
+    def setup_create_call(*args)
+      opts = args.extract_options!
+      # When we create we should not include any blank attributes unless they are associations
+      except = self.class.include_nil_attributes_on_create ? 
+        {} : self.nil_attributes
+      opts[:except] = opts[:except] ? opts[:except].concat(except.keys).uniq.symbolize_array : except.keys.symbolize_array
+      opts[:include_nil_attributes] = self.class.include_nil_attributes_on_create
+      opts[:include_associations] = opts[:include_associations] ? opts[:include_associations].concat(args) : []
+      opts[:include_extras] ||= []
+      opts[:action] = "create"
+      body = RestClient::Payload.has_file?(self.attributes) ? self.serializable_hash(opts) : encode(opts)
+    end
+
+    
+    def update(*args)
+      body = setup_update_call(*args)
+      # We can just ignore the response
+      connection.put(element_path(self.id), body, self.class.headers).tap do |response|
+        load_attributes_from_response(response)
+      end
+    end
+
+    def setup_update_call(*args)
+      opts = args.extract_options!
+      # When we create we should not include any blank attributes
+      except = self.class.attribute_names - self.changed.symbolize_array
+      changed_associations = self.changed.symbolize_array.select{|item| self.association?(item)}
+      opts[:except] = opts[:except] ? opts[:except].concat(except).uniq.symbolize_array : except.symbolize_array
+      opts[:include_nil_attributes] = self.include_all_attributes_on_update
+      opts[:include_associations] = opts[:include_associations] ? opts[:include_associations].concat(args).concat(changed_associations).uniq : changed_associations.concat(args)
+      opts[:include_extras] ||= []
+      opts[:action] = "update"
+      opts[:except] = [:id] if self.class.include_all_attributes_on_update
+      body = RestClient::Payload.has_file?(self.attributes) ? self.serializable_hash(opts) : encode(opts)
+    end
+    
+    private
+    
+    def split_options(options = {})
+      self.class.__send__(:split_options, options)
+    end
+    
+  end
+  
+  class Base
+    extend ActiveModel::Naming
+    # Order is important here
+    # It should be Validations, Dirty Tracking, Callbacks so the include order is the opposite
+    include AssociationActivation
+    self.activate_associations
+    
+    include Scopes, Callbacks, Attributes, ModelErrors
+    
+  end
+  
+end