Ticket #6979: active_resource_custom_methods_path_consolidated.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 BaseTest < 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
+    
+    Person.invokes_custom_method do |person|
+      person.invokes :retrieve, :on => :collection, :using => :get
+      person.invokes [:promote, :sort], :on => :collection, :using => :put
+      person.invokes :deactivate, :on => :collection, :using => :delete
+    end
+    
+    # Test GET against a collection URL
+    assert_equal [Person.new(:id => 1, :name => 'Matz')], Person.retrieve(:name => 'Matz')
+    
+    # Test PUT against a collection URL
+    assert Person.promote(:name => 'Matz')
+    assert Person.sort(:by => 'name')
+    
+    # Test DELETE against a collection URL
+    assert Person.deactivate(:name => 'Matz')
+    
+    # With nested resources
+    StreetAddress.invokes_custom_method do |address|
+      address.invokes :sort, :on => :collection, :using => :put
+    end
+    
+    # Test PUT against a nested collection URL
+    assert StreetAddress.sort(:person_id => 1, :by => 'name')
+  end
+  
+  def test_custom_element_method
+    
+    Person.invokes_custom_method do |person|
+      person.invokes [:shallow, :deep]
+      person.invokes :promote, :using => :put
+      person.invokes :deactivate, :using => :delete
+    end
+    
+    # Test GET against an element URL
+    assert_equal Person.new(:id => 1, :name => 'Matz'), Person.find(1).shallow
+    assert_equal Person.new(:id => 1, :name => 'Matz', :other => 'other'), Person.find(1).deep
+    
+    # Test PUT against an element URL
+    assert Person.find(1).promote(:position => 'Manager')
+    
+    # Test DELETE against an element URL
+    assert Person.find(1).deactivate
+    
+    # With nested resources
+    StreetAddress.invokes_custom_method do |address|
+      address.invokes :deep
+      address.invokes :normalize_phone, :using => :put
+    end
+    
+    # Test GET against a nested collection URL
+    addy = StreetAddress.find(1, :person_id => 1)
+    assert !addy.defined?(:zip)
+    deep_addy = addy.deep
+    assert_not_nil deep_addy
+    assert_equal "27519", deep_addy.zip
+    
+    # Test PUT against a nested collection URL
+    assert addy.normalize_phone(:locale => 'US')
+  end
+  
+  def test_custom_new_element_method
+    
+    Person.invokes_custom_method do |person|
+      person.invokes :register, :on => :new, :using => :post
+    end
+    
+    # Test POST against a new element URL
+    ryan = Person.new(:name => 'Ryan')
+    assert ryan.register
+    assert_equal '5', ryan.id
+    
+    # With nested resources
+    StreetAddress.invokes_custom_method do |address|
+      address.invokes :link, :on => :new, :using => :post
+    end
+    
+    # Test POST against a nested collection URL
+    addy = StreetAddress.new({:street => '123 Test Dr.'}, {:person_id => 1})
+    assert addy.link
+    assert_equal "2", addy.id
+  end
+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:
+#
+#   class Person < ActiveResource::Base
+#     self.site = "http://37s.sunrise.i:3000"
+#
+#     self.invokes_custom_method do |person|
+#       person.invokes :register, :on => :new, :using => :post
+#       person.invokes :promote, :using => :put
+#       person.invokes :deactivate, :using => :delete
+#       person.invokes :active, :on => :collection
+#     end
+#   end
+#
+#   # Defined methods are now available as class/instance methods
+#
+#   ryan = Person.new(:name => 'Ryan)
+#   ryan.register  #=> true
+#   ryan.id #=> 1
+#
+#   ryan = Person.find(1)
+#   ryan.promote(:position => 'Manager') #=> true
+#   ryan.deactivate #=> true
+#
+#   Person.active #=> [<Person::xxx>, <Person::xxx>]
+#   
+module ActiveResource
+  module CustomMethods
+      
+    def self.included(within)
+      within.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def invokes_custom_method
+        yield ActiveResource::CustomMethodProxy.new(self)
+      end
+    end
+  end
+  
+  class CustomMethodProxy
+    
+    DEFAULT_OPTIONS = {:on => :element, :using => :get}
+    
+    def initialize(klass)
+      @klass = klass
+    end
+    
+    def invokes(custom_methods, options = {})
+      
+      method = options[:using] || DEFAULT_OPTIONS[:using]
+      type = options[:on] || DEFAULT_OPTIONS[:on]
+      
+      case type
+      when :collection then
+        CollectionCall.new(@klass).send(method, custom_methods)
+      when :element then
+        ElementCall.new(@klass).send(method, custom_methods)
+      when :new then
+        NewElementCall.new(@klass).send(method, custom_methods)
+      end
+    end
+  end
+  
+  # These feel bloated - revisit for more DRY...
+  
+  class CollectionCall
+    def initialize(klass)
+      @klass = klass
+    end
+    def get(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{@klass}.#{method}(url_options = {})
+            collection = connection.get("\#{prefix(url_options)}\#{collection_name}.xml;#{method}\#{query_string(url_options)}") || []
+            collection.collect! { |element| new(element, url_options) }            
+          end
+        end_eval
+      end
+    end
+    def put(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{@klass}.#{method}(url_options = {})
+            connection.put("\#{prefix(url_options)}\#{collection_name}.xml;#{method}\#{query_string(url_options)}")
+          end
+        end_eval
+      end
+    end
+    def delete(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{@klass}.#{method}(url_options = {})
+            connection.delete("\#{prefix(url_options)}\#{collection_name}.xml;#{method}\#{query_string(url_options)}")
+          end
+        end_eval
+      end
+    end
+  end
+  
+  class ElementCall
+    def initialize(klass)
+      @klass = klass
+    end
+    def get(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{method}(url_options = {})
+            #{@klass}.new(connection.get("\#{self.class.prefix(prefix_options)}\#{self.class.collection_name}/\#{id}.xml;#{method}\#{self.class.query_string(url_options)}"))
+          end
+        end_eval
+      end
+    end
+    def put(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{method}(url_options = {})
+            connection.put("\#{self.class.prefix(prefix_options)}\#{self.class.collection_name}/\#{id}.xml;#{method}\#{self.class.query_string(url_options)}")
+          end
+        end_eval
+      end
+    end
+    def delete(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{method}(url_options = {})
+            connection.delete("\#{self.class.prefix(prefix_options)}\#{self.class.collection_name}/\#{id}.xml;#{method}\#{self.class.query_string(url_options)}")
+          end
+        end_eval
+      end
+    end
+  end
+  
+  class NewElementCall
+    def initialize(klass)
+      @klass = klass
+    end
+    def post(*method_names)
+      method_names.flatten.each do |method|
+        @klass.class_eval <<-end_eval
+          def #{method}(url_options = {})
+            returning(connection.post("\#{self.class.prefix(prefix_options)}\#{self.class.collection_name}.xml/new;#{method}", to_xml)) do |response|
+              self.id = id_from_response(response)
+            end
+          end
+        end_eval
+      end
+    end
+  end
+end

lib/active_resource/base.rb

@@ -80 +80 @@
-        connection.delete(element_path(id))
-      end
-
+      # This was private but was needed in CustomMethods, pretty sure
+      # there's a better way to access it other than to promote it to
+      # public.
+      def query_string(options)
+        # Omit parameters which appear in the URI path.
+        query_params = options.reject { |key, value| prefix_parameters.include?(key) }
+
+        # Accumulate a list of escaped key=value pairs for the given parameters.
+        pairs = []
+        query_params.each do |key, value|
+          key = CGI.escape(key.to_s)
+
+          # a => b becomes a=b
+          # a => [b, c] becomes a[]=b&a[]=c
+          case value
+            when Array
+              value.each { |val| pairs << "#{key}[]=#{CGI.escape(val.to_s)}" }
+            else
+              pairs << "#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+
+        "?#{pairs * '&'}" unless pairs.empty?
+      end
+
-      private
-        def find_every(options)
-          collection = connection.get(collection_path(options)) || []
@@ -98 +123 @@
-        def prefix_parameters
-          @prefix_parameters ||= prefix_source.scan(/:\w+/).map { |key| key[1..-1].to_sym }.to_set
-        end
-
-        def query_string(options)
-          # Omit parameters which appear in the URI path.
-          query_params = options.reject { |key, value| prefix_parameters.include?(key) }
-
-          # Accumulate a list of escaped key=value pairs for the given parameters.
-          pairs = []
-          query_params.each do |key, value|
-            key = CGI.escape(key.to_s)
-
-            # a => b becomes a=b
-            # a => [b, c] becomes a[]=b&a[]=c
-            case value
-              when Array
-                value.each { |val| pairs << "#{key}[]=#{CGI.escape(val.to_s)}" }
-              else
-                pairs << "#{key}=#{CGI.escape(value.to_s)}"
-            end
-          end
-
-          "?#{pairs * '&'}" unless pairs.empty?
-        end
-    end
-
-    attr_accessor :attributes

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