giraffesoft-classy_resources 0.0.1 → 0.1.0

data/README.rdoc

@@ -2,6 +2,10 @@
 
 Think resource_controller, except for Sinatra.
 
+= Installation
+
+  sudo gem install giraffesoft-classy_resources
+
 = Usage
 
   require 'rubygems'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 0
 :major: 0
-:minor: 0
+:minor: 1

data/lib/classy_resources.rb

@@ -11,8 +11,25 @@ module ClassyResources
     ResourceBuilder.new(self, *options)
   end
 
-  def collection_url_for(resource, format)
-    "/#{resource}.#{format}" 
+  def load_collection(resource, parent = nil)
+    parent.nil? ? load_shallow_collection(resource) : load_nested_collection(resource, parent)
+  end
+
+  def create_object(resource, object_params, parent = nil)
+    parent.nil? ? create_shallow_object(resource, object_params) : create_nested_object(resource, object_params, parent)
+  end
+
+  def load_parent_object(parent)
+    load_object(parent, params[parent_id_name(parent)])
+  end
+
+  def parent_id_name(parent)
+    :"#{parent.to_s.singularize}_id"
+  end
+
+  def collection_url_for(resource, format, parent = nil)
+    parent = parent.nil? ? "" : "/#{parent}/:#{parent_id_name(parent)}"
+    [parent, "/#{resource}.#{format}"].join
   end
 
   def object_route_url(resource, format)
@@ -57,16 +74,18 @@ module ClassyResources
 
     protected
       def define_collection_get(resource, format)
-        get collection_url_for(resource, format) do
+        parent = options[:parent]
+        get collection_url_for(resource, format, parent) do
           set_content_type(format)
-          serialize(load_collection(resource), format)
+          serialize(load_collection(resource, parent), format)
         end
       end
       
       def define_collection_post(resource, format)
-        post collection_url_for(resource, format) do
+        parent = options[:parent]
+        post collection_url_for(resource, format, parent) do
           set_content_type(format)
-          object = create_object(resource, params[resource.to_s.singularize])
+          object = create_object(resource, params[resource.to_s.singularize] || {}, parent)
           redirect object_url_for(resource, format, object)
         end
       end
@@ -74,7 +93,7 @@ module ClassyResources
       def define_member_get(resource, format)
         get object_route_url(resource, format) do
           set_content_type(format)
-          object = find_object(resource, params[:id])
+          object = load_object(resource, params[:id])
           serialize(object, format)
         end
       end
@@ -82,7 +101,7 @@ module ClassyResources
       def define_member_put(resource, format)
         put object_route_url(resource, format) do
           set_content_type(format)
-          object = find_object(resource, params[:id])
+          object = load_object(resource, params[:id])
           update_object(object, params[resource.to_s.singularize])
           serialize(object, format)
         end
@@ -91,7 +110,7 @@ module ClassyResources
       def define_member_delete(resource, format)
         delete object_route_url(resource, format) do
           set_content_type(format)
-          object = find_object(resource, params[:id])
+          object = load_object(resource, params[:id])
           destroy_object(object)
           ""
         end

data/lib/classy_resources/active_record.rb

@@ -1,14 +1,22 @@
 module ClassyResources
   module ActiveRecord
-    def load_collection(resource)
+    def load_shallow_collection(resource)
       class_for(resource).all
     end
 
-    def create_object(resource, params)
+    def load_nested_collection(resource, parent)
+      load_parent_object(parent).send(resource)
+    end
+
+    def create_shallow_object(resource, params)
       class_for(resource).create!(params)
     end
 
-    def find_object(resource, id)
+    def create_nested_object(resource, params, parent)
+      load_parent_object(parent).send(resource).create!(params)
+    end
+
+    def load_object(resource, id)
       class_for(resource).find(id)
     end
 

data/lib/classy_resources/sequel.rb

@@ -1,14 +1,23 @@
 module ClassyResources
   module Sequel
-    def load_collection(resources)
-      class_for(resources).all
+    def load_shallow_collection(resource)
+      class_for(resource).all
     end
 
-    def create_object(resource, params)
-      class_for(resource).create(params)
+    def load_nested_collection(resource, parent)
+      load_parent_object(parent).send(resource)
     end
 
-    def find_object(resource, id)
+    def create_shallow_object(resource, object_params)
+      class_for(resource).create(object_params)
+    end
+
+    def create_nested_object(resource, object_params, parent)
+      c = create_shallow_object(resource, object_params)
+      load_parent_object(parent).send(:"add_#{resource.to_s.singularize}", c)
+    end
+
+    def load_object(resource, id)
       class_for(resource).find(:id => id)
     end
 

data/test/active_record_test.rb

@@ -77,4 +77,29 @@ class ActiveRecordTest < Test::Unit::TestCase
       assert_nil Post.find_by_id(@post)
     end
   end
+
+  context "on GET to /posts/id/comments" do
+    setup do
+      @post = create_post
+      2.times { @post.comments.create!(hash_for_comment) }
+      2.times { create_comment }
+      get "/posts/#{@post.id}/comments.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+    expect { assert_equal @post.comments.to_xml, @response.body }
+  end
+
+  context "on POST to /posts/id/comments" do
+    setup do
+      @post = create_post
+      post "/posts/#{@post.id}/comments.xml", :comment => hash_for_comment
+    end
+
+    expect { assert_equal 302, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+    expect { assert_equal "/comments/#{@post.comments.reload.first.id}.xml", @response.location }
+    expect { assert_equal 1, @post.comments.reload.count }
+  end
 end

data/test/fixtures/active_record_test_app.rb

@@ -14,12 +14,26 @@ ActiveRecord::Schema.define(:version => 0) do
   create_table :posts do |t|
     t.string :title
   end
+
+  create_table :comments do |t|
+    t.integer :post_id
+    t.string :author
+  end
 end
 
 class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
 end
 
 
 define_resource :posts, :collection => [:get, :post],
                         :member     => [:get, :put, :delete],
                         :formats    => [:xml, :json]
+
+define_resource :comments, :collection => [:get, :post],
+                           :parent     => :posts
+

data/test/fixtures/sequel_test_app.rb

@@ -10,10 +10,24 @@ Sequel::Model.db.instance_eval do
     primary_key :id
     varchar :name
   end
+
+  create_table! :subscriptions do
+    primary_key :id
+    int :user_id
+    varchar :name
+  end
 end
 
 class User < Sequel::Model(:users)
+  one_to_many :subscriptions
+end
+
+class Subscription < Sequel::Model(:subscriptions)
+  many_to_one :users
 end
 
 define_resource :users, :collection => [:get, :post],
                         :member     => [:put, :delete, :get]
+
+define_resource :subscriptions, :collection => [:get, :post],
+                                :parent     => :users

data/test/sequel_test.rb

@@ -73,4 +73,38 @@ class SequelTest < Test::Unit::TestCase
       assert_nil User.find(:id => @user.id)
     end
   end
+
+  context "on GET to /users/id/comments" do
+    setup do
+      @user = create_user
+      2.times { @user.add_subscription(create_subscription) }
+      2.times { create_subscription }
+      get "/users/#{@user.id}/subscriptions.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+    expect { assert_equal @user.subscriptions.to_xml, @response.body }
+  end
+
+  context "on POST to /users/id/subscriptions" do
+    setup do
+      @user = create_user
+      post "/users/#{@user.id}/subscriptions.xml", :subscription => hash_for_subscription
+    end
+
+    expect { assert_equal 302, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+    expect { assert_equal "/subscriptions/#{@user.reload.subscriptions.first.id}.xml", @response.location }
+    expect { assert_equal 1, @user.reload.subscriptions.length }
+  end
+
+  context "on POST to /users/id/subscriptions with no params" do
+    should "not raise" do
+      @user = create_user
+      assert_nothing_raised {
+        post "/users/#{@user.id}/subscriptions.xml", :subscription => {}
+      }
+    end
+  end
 end

data/test/test_helper.rb

@@ -11,9 +11,27 @@ class Test::Unit::TestCase
       Post.create!({}.merge(opts))
     end
 
+    def hash_for_comment(opts = {})
+      {}.merge(opts)
+    end
+
+    def create_comment(opts = {})
+      Comment.create!(hash_for_comment(opts))
+    end
+
     def create_user(opts = {})
       u = User.new({}.merge(opts))
       u.save
       u
     end
+
+    def hash_for_subscription(opts = {})
+      {:name => "emptiness is depressing"}.merge(opts)
+    end
+
+    def create_subscription(opts = {})
+      s = Subscription.new(hash_for_subscription(opts))
+      s.save
+      s
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: giraffesoft-classy_resources
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - James Golick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-27 00:00:00 -08:00
+date: 2009-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: []