resource 0.1.0

data/lib/api_resource/attributes.rb

@@ -0,0 +1,154 @@
+module ApiResource
+
+  module Attributes
+  
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Dirty
+    
+    included do
+      
+      alias_method_chain :save, :dirty_tracking
+      
+      class_inheritable_accessor :attribute_names, :public_attribute_names, :protected_attribute_names
+      
+      attr_accessor :attributes
+      
+      self.attribute_names = []
+      self.public_attribute_names = []
+      self.protected_attribute_names = []
+      
+      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
+      
+    end
+    
+    module ClassMethods
+      
+      def define_attributes(*args)
+        # 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
+        define_attribute_methods args
+        args.each do |arg|
+          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}
+              self.attributes[:#{arg}]
+            end
+          
+            def #{arg}=(val)
+              #{arg}_will_change! unless self.#{arg} == val
+              self.attributes[:#{arg}] = val
+            end
+            
+            def #{arg}?
+              self.attributes[:#{arg}].present?
+            end
+          EOE
+        end
+        self.attribute_names.uniq!
+        self.public_attribute_names.uniq!
+      end
+      
+      def define_protected_attributes(*args)
+        define_attribute_methods args
+        args.each do |arg|
+          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.attributes[:#{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 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
+    
+    module InstanceMethods
+      
+      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)
+        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
+    end
+    
+  end
+  
+end

data/lib/api_resource/base.rb

@@ -0,0 +1,517 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/string_inquirer'
+
+module ApiResource
+  
+  class Base
+    
+    class_inheritable_accessor :site, :proxy, :user, :password, :auth_type, :format, :timeout, :ssl_options
+    
+    class_inheritable_accessor :include_root_in_json; self.include_root_in_json = true
+    class_inheritable_accessor :include_blank_attributes_on_create; self.include_blank_attributes_on_create = false
+    class_inheritable_accessor :include_all_attributes_on_update; self.include_blank_attributes_on_create = false
+    
+    attr_accessor_with_default :primary_key, 'id'
+    
+    attr_accessor :prefix_options
+    
+    class << self
+      
+      attr_accessor_with_default(:element_name) { model_name.element }
+      attr_accessor_with_default(:collection_name) { ActiveSupport::Inflector.pluralize(element_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)
+            super
+          end
+        EOE
+        # Now we can make a call to setup the inheriting klass with its attributes
+        klass.set_class_attributes_upon_load unless klass.instance_variable_defined?(:@class_data)
+        klass.instance_variable_set(:@class_data, true)
+      end
+
+      
+      # This makes a request to new_element_path
+      def set_class_attributes_upon_load
+        begin
+          class_data = self.connection.get(self.new_element_path)
+          # 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 do |hash|
+              self.scope hash.first[0], hash.first[1]
+            end
+          end
+          # Then associations
+          if class_data["associations"]
+            class_data["associations"].each do |(key,hash)|
+              hash.each do |assoc_name, assoc_options|
+                self.send(key, assoc_name, assoc_options)
+              end
+            end
+          end
+        # Swallow up any loading errors because the site may be incorrect
+        rescue Exception => e
+          return nil
+        end
+      end
+
+      def reload_class_attributes
+        # clear the public_attribute_names, protected_attribute_names
+        self.clear_attributes
+        self.clear_associations
+        self.set_class_attributes_upon_load
+      end
+
+      def site=(site)
+        @connection = nil
+        # reset class attributes and try to reload them if the site changed
+        unless site.to_s == self.site.to_s
+          self.reload_class_attributes
+        end
+        if site.nil?
+          write_inheritable_attribute(:site, nil)
+        else
+          write_inheritable_attribute(:site, create_site_uri_from(site))
+        end
+      end
+      
+      
+      def format=(mime_type_or_format)
+        format = mime_type_or_format.is_a?(Symbol) ? ApiResource::Formats[mime_type_or_format] : mime_type_or_format
+        write_inheritable_attribute(:format, format)
+        self.connection.format = format if self.site
+      end
+      
+      # Default format is json
+      def format
+        read_inheritable_attribute(:format) || ApiResource::Formats::JsonFormat
+      end
+      
+      def timeout=(timeout)
+        @connection = nil
+        write_inheritable_attribute(:timeout, timeout)
+      end
+      
+      def connection(refresh = false)
+        @connection = Connection.new(self.site, self.format) if refresh || @connection.nil?
+        @connection.timeout = self.timeout
+        @connection
+      end
+      
+      def headers
+        @headers || {}
+      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
+      
+      # 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?
+        "#{prefix(prefix_options)}#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
+      end
+      
+      def new_element_path(prefix_options = {})
+        "#{prefix(prefix_options)}#{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?
+        "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+      end
+      
+      def build(attributes = {})
+        self.new(attributes)
+      end
+      
+      def create(attributes = {})
+        self.new(attributes).tap{ |resource| resource.save }
+      end
+      
+      def find(*arguments)
+        scope   = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+
+        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
+
+
+      # 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
+      
+      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) || []), prefix_options )
+            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), prefix_options)
+        end
+
+        def instantiate_collection(collection, prefix_options = {})
+          collection.collect! { |record| instantiate_record(record, prefix_options) }
+        end
+
+        def instantiate_record(record, prefix_options = {})
+          new(record).tap do |resource|
+            resource.prefix_options = prefix_options
+          end
+        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 = {})
+      @prefix_options = {}
+      load(attributes)
+    end
+    
+    def new?
+      id.nil?
+    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 && other.prefix_options == self.prefix_options)
+    end
+    
+    def eql?(other)
+      self == other
+    end
+    
+    def hash
+      id.hash
+    end
+    
+    def dup
+      self.class.new.tap do |resource|
+        resource.attributes = self.attributes
+        resource.prefix_options = @prefix_options
+      end
+    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
+      self.load(self.class.find(to_param, :params => @prefix_options).attributes)
+    end
+    
+    def load(attributes)
+      return if attributes.nil?
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @prefix_options, attributes = split_options(attributes)
+     
+      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.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
+              value
+            end
+          when Hash
+            if self.has_many?(key)
+              MultiObjectProxy.new(self.has_many_class_name(key), value)
+            elsif self.association?(key)
+              SingleObjectProxy.new(self.association_class_name(key), value)
+            else
+              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)
+            value.dup rescue 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}:0x%08x @attributes=#{self.attributes.inject({}){|accum,(k,v)| self.association?(k) ? accum : accum.merge(k => v)}}" % (self.object_id * 2)
+    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 = {})
+      options[:include_associations] = options[:include_associations] ? options[:include_associations].symbolize_array : []
+      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 self.association?(key) && options[:include_associations].include?(key.to_sym)
+          accum.merge(key => val.serializable_hash({}))
+        elsif options[:include_extras].include?(key.to_sym)
+          accum.merge(key => val)
+        elsif options[:except].include?(key.to_sym)
+          accum
+        else
+          self.association?(key) || !self.attribute?(key) || self.protected_attribute?(key) ? accum : accum.merge(key => val)
+        end
+      end
+    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_options = {}, query_options = nil)
+      self.class.element_path(id, prefix_options, query_options)
+    end
+    
+    def new_element_path(prefix_options = {})
+      self.class.new_element_path(prefix_options)
+    end
+    
+    def collection_path(prefix_options = {},query_options = nil)
+      self.class.collection_path(prefix_options, query_options)
+    end
+    
+    def create(*args)
+      opts = args.extract_options!
+      # When we create we should not include any blank attributes unless they are associations
+      except = self.class.include_blank_attributes_on_create ? {} : self.attributes.select{|k,v| v.blank?}
+      opts[:except] = opts[:except] ? opts[:except].concat(except.keys).uniq.symbolize_array : except.keys.symbolize_array
+      opts[:include_associations] = opts[:include_associations] ? opts[:include_associations].concat(args) : []
+      opts[:include_extras] ||= []
+      body = RestClient::Payload.has_file?(self.attributes) ? self.serializable_hash(opts) : encode(opts)
+      connection.post(collection_path, body, self.class.headers).tap do |response|
+        load_attributes_from_response(response)
+      end
+    end
+    
+    def update(*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_associations] = opts[:include_associations] ? opts[:include_associations].concat(args).concat(changed_associations).uniq : changed_associations.concat(args)
+      opts[:include_extras] ||= []
+      opts[:except] = [:id] if self.class.include_all_attributes_on_update
+      body = RestClient::Payload.has_file?(self.attributes) ? self.serializable_hash(opts) : encode(opts)
+      # We can just ignore the response
+      connection.put(element_path(self.id, prefix_options), body, self.class.headers).tap do |response|
+        load_attributes_from_response(response)
+      end
+    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 Associations, Callbacks, Attributes, ModelErrors
+    
+  end
+  
+end