Changeset 4890

Timestamp:

09/01/06 01:15:10 (2 years ago)

Author:

rick

Message:

Major updates to ActiveResource, please see changelog and unit tests [Rick Olson]

Files:

• trunk/activeresource/CHANGELOG (modified) (1 diff)
• trunk/activeresource/lib/active_resource/base.rb (modified) (5 diffs)
• trunk/activeresource/lib/active_resource/connection.rb (modified) (2 diffs)
• trunk/activeresource/test/base_test.rb (modified) (4 diffs)
• trunk/activeresource/test/fixtures/person.rb (modified) (1 diff)
• trunk/activeresource/test/fixtures/street_address.rb (added)
• trunk/activeresource/test/http_mock.rb (modified) (5 diffs)

trunk/activeresource/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Major updates [Rick Olson]
+
+  * Add full support for find/create/update/destroy
+  * Add support for specifying prefixes.
+  * Allow overriding of element_name, collection_name, and primary key
+  * Provide simpler HTTP mock interface for testing
+  
+    # rails routing code
+    map.resources :posts do |post|
+      post.resources :comments
+    end
+    
+    # ActiveResources
+    class Post < ActiveResource::Base
+      self.site = "http://37s.sunrise.i:3000/"
+    end
+
+    class Comment < ActiveResource::Base
+      self.site = "http://37s.sunrise.i:3000/posts/:post_id/"
+    end
+    
+    @post     = Post.find 5
+    @comments = Comment.find :all, :post_id => @post.id
+
+    @comment  = Comment.new({:body => 'hello world'}, {:post_id => @post.id})
+    @comment.save
-
-* Base.site= accepts URIs. 200...400 are valid response codes. PUT and POST request bodies default to ''. [Jeremy Kemper]

trunk/activeresource/lib/active_resource/base.rb

@@ -4 +4 @@
-  class Base
-    class << self
+      attr_reader :site
+
-      def site=(site)
-
-
-
-
-
+
-      end
-
@@ -24 +22 @@
-        element_name.pluralize
-      end
-
-
-
+
+
+
+
+
+
-      end
-      
-
-
+
+
+
+
-      end
-      
+      def set_element_name(value)
+        class << self ; attr_reader :element_name ; end
+        @element_name = value
+      end
+      
+      def set_collection_name(value)
+        class << self ; attr_reader :collection_name ; end
+        @collection_name = value
+      end
+
+      def element_path(id, options = {})
+        "#{prefix(options)}#{collection_name}/#{id}.xml"
+      end
+      
+      def collection_path(options = {})
+        "#{prefix(options)}#{collection_name}.xml"
+      end
+      
+      def primary_key
+        set_primary_key 'id'
+      end
+      
+      def set_primary_key(value)
+        class << self ; attr_reader :primary_key ; end
+        @primary_key = value
+      end
+      
+      # Person.find(1) # => GET /people/1.xml
+      # StreetAddress.find(1, :person_id => 1) # => GET /people/1/street_addresses/1.xml
-      def find(*arguments)
-
+
+
-
-        case scope
-
-
-
-
-
-
-
-
+
+
+
-        end
-      end
+
+      private
+        # { :people => { :person => [ person1, person2 ] } }
+        def find_every(options)
+          connection.get(collection_path(options)).values.first.values.first.collect { |element| new(element, options) }
+        end
+        
+        # { :person => person1 }
+        def find_single(scope, options)
+          new(connection.get(element_path(scope, options)).values.first, options)
+        end
-    end
-
-    attr_accessor :attributes
+    attr_accessor :prefix_options
-    
-
-
+
+
+
-    end
-
+
+
+
+
+
-    def id
-"id"
+self.class.primary_key
-    end
-    
-    def id=(id)
-"id"
+self.class.primary_key
-    end
-    
-    def save
-
+new_resource? ? create : 
-    end
-
-    def destroy
-)
+, prefix_options)[0..-5]
-    end
-    
@@ -74 +119 @@
-      attributes.to_xml(:root => self.class.element_name)
-    end
-
+
+
+
+
+
+
+
-    protected
-      def connection(refresh = false)
@@ -81 +132 @@
-    
-      def update
-)
+, prefix_options)[0..-5]
-      end
-
+
+
+
+
+
+
+
-      def method_missing(method_symbol, *arguments)
-        method_name = method_symbol.to_s
@@ -91 +148 @@
-            attributes[method_name.first(-1)] = arguments.first
-          when "?"
-# TODO
+attributes[method_name.first(-1)] == true
-          else
-[method_name] ||
+.has_key?(method_name) ? attributes[method_name] :
-        end
-      end

trunk/activeresource/lib/active_resource/connection.rb

@@ -34 +34 @@
-        @@requests ||= []
-      end
+      
+      def default_header
+        class << self ; attr_reader :default_header end
+        @default_header = { 'Content-Type' => 'application/xml' }
+      end
-    end
-
@@ -45 +50 @@
-
-    def delete(path)
-
+, self.class.default_header
-    end
-
-    def put(path, body = '')
-
+, self.class.default_header
-    end
-
-    def post(path, body = '')
-
+, self.class.default_header
-    end
-

trunk/activeresource/test/base_test.rb

@@ -1 +1 @@
-require "#{File.dirname(__FILE__)}/abstract_unit"
-require "fixtures/person"
+require "fixtures/street_address"
-
-class BaseTest < Test::Unit::TestCase
-  def setup
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  end
-
@@ -34 +46 @@
-  end
-
+  def test_collection_path
+    assert_equal '/people.xml', Person.collection_path
+  end
+
+  def test_custom_element_path
+    assert_equal '/people/1/addresses/1.xml', StreetAddress.element_path(1, :person_id => 1)
+  end
+
+  def test_custom_collection_path
+    assert_equal '/people/1/addresses.xml', StreetAddress.collection_path(:person_id => 1)
+  end
+
+  def test_custom_element_name
+    assert_equal 'address', StreetAddress.element_name
+  end
+
+  def test_custom_collection_name
+    assert_equal 'addresses', StreetAddress.collection_name
+  end
+
+  def test_prefix
+    assert_equal "/", Person.prefix
+  end
+
+  def test_custom_prefix
+    assert_equal '/people//', StreetAddress.prefix
+    assert_equal '/people/1/', StreetAddress.prefix(:person_id => 1)
+  end
+
-  def test_find_by_id
-    matz = Person.find(1)
-    assert_kind_of Person, matz
-    assert_equal "Matz", matz.name
+  end
+
+  def test_find_by_id_with_custom_prefix
+    addy = StreetAddress.find(1, :person_id => 1)
+    assert_kind_of StreetAddress, addy
+    assert_equal '12345 Street', addy.street
-  end
-
@@ -56 +103 @@
-  def test_find_by_id_not_found
-    assert_raises(ActiveResource::ResourceNotFound) { Person.find(99) }
+    assert_raises(ActiveResource::ResourceNotFound) { StreetAddress.find(1) }
-  end
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-  def test_update
-    matz = Person.find(:first)
@@ -65 +125 @@
-    matz.save
-  end
-
+
+
+
+
+
+
+
+
+
-  def test_destroy
-    assert Person.find(1).destroy
-
+
+
+
+
+
+
+
+
+
+
+
+
-  end
-end

trunk/activeresource/test/fixtures/person.rb

@@ -1 +1 @@
-class Person < ActiveResource::Base
-/
+
-end

trunk/activeresource/test/http_mock.rb

@@ -3 +3 @@
-module ActiveResource
-  class HttpMock
+    class Responder
+      def initialize(responses)
+        @responses = responses
+      end
+      
+      for method in [ :post, :put, :get, :delete ]
+        module_eval <<-EOE
+          def #{method}(path, body = nil, status = 200, headers = {})
+            @responses[Request.new(:#{method}, path, nil)] = Response.new(body || {}, status, headers)
+          end
+        EOE
+      end
+    end
+
-    class << self
-      def requests
@@ -12 +26 @@
-      end
-
-
+ = {}
-        reset!
-        pairs.each do |(path, response)|
-          responses[path] = response
-        end
+        yield Responder.new(responses) if block_given?
-      end
-
@@ -43 +58 @@
-    attr_accessor :path, :method, :body
-    
-
+, headers = nil
-      @method, @path, @body = method, path, body
-    end
@@ -65 +80 @@
-  
-  class Response
-
+, :headers
-    
-
- = body, code
+, headers = nil
+, @headers = body, code, headers
-    end
-    
@@ -74 +89 @@
-      (200..299).include?(code)
-    end
+
+    def [](key)
+      headers[key]
+    end
+    
+    def []=(key, value)
+      headers[key] = value
+    end
+
-  end
-