Ticket #6979: active_resource_custom_methods_patch_unblocked_fixed_tests.diff

test/base/custom_methods_test.rb

@@ +1 @@
+require "#{File.dirname(__FILE__)}/../abstract_unit"
+require "#{File.dirname(__FILE__)}/../fixtures/person"
+require "#{File.dirname(__FILE__)}/../fixtures/street_address"
+
+class CustomMethodsTest < Test::Unit::TestCase
+  def setup
+    @matz  = { :id => 1, :name => 'Matz' }.to_xml(:root => 'person')
+    @matz_deep  = { :id => 1, :name => 'Matz', :other => 'other' }.to_xml(:root => 'person')
+    @ryan  = { :name => 'Ryan' }.to_xml(:root => 'person')
+    @addy  = { :id => 1, :street => '12345 Street' }.to_xml(:root => 'address')
+    @addy_deep  = { :id => 1, :street => '12345 Street', :zip => "27519" }.to_xml(:root => 'address')
+    @default_request_headers = { 'Content-Type' => 'application/xml' }
+    
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/people/1.xml",             {}, @matz
+      mock.get    "/people/1.xml;shallow", {}, @matz
+      mock.get    "/people/1.xml;deep", {}, @matz_deep
+      mock.get    "/people.xml;retrieve?name=Matz", {}, "<people>#{@matz}</people>"
+      mock.put    "/people/1.xml;promote?position=Manager", {}, nil, 204
+      mock.put    "/people.xml;promote?name=Matz", {}, nil, 204, {}
+      mock.put    "/people.xml;sort?by=name", {}, nil, 204
+      mock.delete "/people.xml;deactivate?name=Matz", {}, nil, 200
+      mock.delete "/people/1.xml;deactivate", {}, nil, 200
+      mock.post   "/people.xml/new;register",      {}, @ryan, 201, 'Location' => '/people/5.xml'
+      mock.get    "/people/1/addresses/1.xml", {}, @addy
+      mock.get    "/people/1/addresses/1.xml;deep", {}, @addy_deep
+      mock.put    "/people/1/addresses/1.xml;normalize_phone?locale=US", {}, nil, 204
+      mock.put    "/people/1/addresses.xml;sort?by=name", {}, nil, 204
+      mock.post   "/people/1/addresses.xml/new;link", {}, { :street => '12345 Street' }.to_xml(:root => 'address'), 201, 'Location' => '/people/1/addresses/2.xml'
+    end
+  end  
+  
+  def test_custom_collection_method
+    
+    # GET
+    assert_equal([{ "id" => 1, "name" => 'Matz' }], Person.get(:retrieve, :name => 'Matz'))
+    
+    # PUT
+    assert_equal ActiveResource::Response.new({}, 204, {}),
+                   Person.put(:promote, {:name => 'Matz'}, 'atestbody')
+    assert_equal ActiveResource::Response.new({}, 204, {}), Person.put(:sort, :by => 'name')
+    
+    # DELETE
+    Person.delete :deactivate, :name => 'Matz'
+    
+    # Nested resource
+    assert_equal ActiveResource::Response.new({}, 204, {}), StreetAddress.put(:sort, :person_id => 1, :by => 'name')
+  end
+  
+  def test_custom_element_method
+    
+    # Test GET against an element URL
+    assert_equal Person.find(1).get(:shallow), {"id" => 1, "name" => 'Matz'}
+    assert_equal Person.find(1).get(:deep), {"id" => 1, "name" => 'Matz', "other" => 'other'}
+    
+    # Test PUT against an element URL
+    assert_equal ActiveResource::Response.new({}, 204, {}), Person.find(1).put(:promote, {:position => 'Manager'}, 'body')
+    
+    # Test DELETE against an element URL
+    assert_equal ActiveResource::Response.new({}, 200, {}), Person.find(1).delete(:deactivate)
+    
+    # With nested resources
+    assert_equal StreetAddress.find(1, :person_id => 1).get(:deep),
+                  { "id" => 1, "street" => '12345 Street', "zip" => "27519" }
+    assert_equal ActiveResource::Response.new({}, 204, {}),
+                   StreetAddress.find(1, :person_id => 1).put(:normalize_phone, :locale => 'US')
+  end
+  
+  def test_custom_new_element_method
+    
+    # Test POST against a new element URL
+    ryan = Person.new(:name => 'Ryan')
+    assert_equal ActiveResource::Response.new(@ryan, 201, {'Location' => '/people/5.xml'}), ryan.post(:register)
+    
+    # Test POST against a nested collection URL
+    addy = StreetAddress.new({:street => '123 Test Dr.'}, {:person_id => 1})
+    assert_equal ActiveResource::Response.new({ :street => '12345 Street' }.to_xml(:root => 'address'), 
+                   201, {'Location' => '/people/1/addresses/2.xml'}),
+                 addy.post(:link)
+  end
+  
+  def teardown
+    ActiveResource::HttpMock.reset!
+  end
+end

test/base_test.rb

@@ -95 +95 @@
-    assert_equal '/people.xml?gender=', Person.collection_path(:gender => nil)
-
-    assert_equal '/people.xml?gender=male', Person.collection_path('gender' => 'male')
-
+
+
+
+
+
-
-    assert_equal '/people.xml?name[]=bob&name[]=your+uncle%2Bme&name[]=&name[]=false', Person.collection_path(:name => ['bob', 'your uncle+me', nil, false])
-  end

lib/active_resource/custom_methods.rb

@@ +1 @@
+# Support custom REST methods, in synch with the Simply RESTful
+# plugin.
+#
+# I.e. on the server routes config you would have:
+#
+#   map.resources :people, :new => { :register => :post },
+#                          :element => { :promote => :put, :deactivate => :delete }
+#                          :collection => { :active => :get }
+#
+#  Which creates routes for the following http requests
+#
+#  POST: /people/new;register #=> PeopleController.register
+#  PUT: /people/1;promote #=> PeopleController.promote(:id => 1)
+#  DELETE: /people/1;deactivate #=> PeopleController.deactivate(:id => 1)
+#  GET: /people;active #=> PeopleController.active
+#
+# This module provides the ability for ActiveResource to call these
+# custom REST methods and get the response back.
+#
+#   class Person < ActiveResource::Base
+#     self.site = "http://37s.sunrise.i:3000"
+#   end
+#
+#   Person.new(:name => 'Ryan).post(:register) #=> {:id => 1, :name => 'Ryan'}
+#
+#   Person.find(1).put(:promote, :position => 'Manager') #=> <Response::XXXX>
+#   Person.find(1).delete(:deactivate) #=> <Response::XXXX>
+#
+#   Person.get(:active) #=> [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}]
+#   
+module ActiveResource
+  module CustomMethods
+      
+    def self.included(within)
+      within.class_eval do
+        class << self
+          
+          include ActiveResource::CustomMethods::ClassMethods
+          
+          alias :orig_delete :delete
+          
+          # Define the class level Http request methods - which are tied
+          # to a call on the collection url.
+      
+          def get(method_name, options = {})
+            connection.get(custom_method_collection_url(method_name, options))
+          end
+      
+          def post(method_name, options = {}, body = nil)
+            connection.post(custom_method_collection_url(method_name, options), body)
+          end
+      
+          def put(method_name, options = {}, body = nil)
+            connection.put(custom_method_collection_url(method_name, options), body)
+          end
+      
+          # Need to jump through some hoops to retain the original class 'delete' method
+          def delete(custom_method_name, options = {})
+            if(custom_method_name.is_a?(Symbol))
+              connection.delete(custom_method_collection_url(custom_method_name, options))
+            else
+              orig_delete(custom_method_name)
+            end
+          end
+        end
+
+      end
+
+      within.send(:include, ActiveResource::CustomMethods::InstanceMethods)
+    end
+    
+    module ClassMethods
+      def custom_method_collection_url(method_name, options = {})
+        "#{prefix(options)}#{collection_name}.xml;#{method_name}#{query_string(options)}"
+      end
+    end
+    
+    module InstanceMethods
+      
+      def get(method_name, options = {})
+        connection.get(custom_method_element_url(method_name, options))
+      end
+      
+      def post(method_name, options = {}, body = nil)
+        if(new?)
+          connection.post(custom_method_new_element_url(method_name, options),
+            (body.nil? ? to_xml : body))
+        else
+          connection.post(custom_method_element_url(method_name, options), body)
+        end
+      end
+      
+      def put(method_name, options = {}, body = nil)
+        connection.put(custom_method_element_url(method_name, options), body)
+      end
+      
+      def delete(method_name, options = {})
+        connection.delete(custom_method_element_url(method_name, options))
+      end
+      
+      private
+      
+        def custom_method_element_url(method_name, options = {})
+          "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}.xml;#{method_name}#{self.class.send(:query_string, options)}"
+        end
+      
+        def custom_method_new_element_url(method_name, options = {})
+          "#{self.class.prefix(prefix_options)}#{self.class.collection_name}.xml/new;#{method_name}#{self.class.send(:query_string, options)}"
+        end
+    end
+  end
+  
+end

lib/active_resource/http_mock.rb

@@ -110 +110 @@
-    def []=(key, value)
-      headers[key] = value
-    end
+    
+    def ==(other)
+      if(other.is_a?(Response))
+        other.body == body && other.message == message && other.headers == headers
+      else
+        false
+      end
+    end
-  end
-
-  class Connection

lib/active_resource.rb

@@ -37 +37 @@
-require 'active_resource/base'
-require 'active_resource/struct'
-require 'active_resource/validations'
+require 'active_resource/custom_methods'
-
-module ActiveResource
-  Base.class_eval do
-    include Validations
+    include CustomMethods
-  end
-end