ShyCouch 0.6.0 → 0.7.0

data/readme.md

@@ -0,0 +1,117 @@
+ShyCouch
+--------
+
+
+Ruby library for CouchDB providing a native objects layer, abstracting the HTTP interface.
+
+It's for those who think that ActiveRecord and even Django's lovely ORMs don't get you far enough away from SQL. It's for people who want to make funky websites and self-managed / self-hosted web services, not like, you know, Define Business Requirements And Cardinalities or whatever.
+
+Soon it'll have support for native Ruby views on the view server. In the meantime, views are written inline in Ruby and then parsed in JavaScript using ShyRubyJS. ShyRubyJS is not very mature, so for anything complex you should write them as inline JavaScript.
+
+If anyone can think of a good semantics to prevent confusion between Couch views and the views in an MVC framework that might use this library, I'd love to hear it.
+
+Usage
+-----
+
+Create a database object, automatically initializing the database on the CouchDB instance if it doesn't exist
+
+````ruby
+couch_settings = {
+  "db"=> {
+      "host" => "localhost",
+      "port" => 5984,
+      "name" => "food-app",
+      "user" => "myUsername",
+      "password" => "myPassword"
+    }
+}
+
+@couchdb = ShyCouch::getDB(couch_settings)
+````
+Create a design document and give it some views.
+
+Note: soon there'll be a syntax for having default HTTP query options (e.g. `?include_docs=true`) on particular views.
+
+````ruby
+design = ShyCouch::Data::Design.new :food, {:push_to => @couchdb}
+
+view1 = ShyCouch::Data::View :all_recipes do
+	map do
+		emit(doc._id, null) if doc.kind == "Recipe"
+	end
+end
+view2 = ShyCouch::Data::View :recipe_count do
+	map do
+		emit(doc._id, null) if doc.kind == "Recipe"
+	end
+	reduce do
+		return sum(values)
+	end
+end
+
+design.add_views [view1, view2]
+design.push!
+````
+Subclass the CouchDocument class to represent your data types:
+
+````ruby
+class Recipe < ShyCouch::Data::CouchDocument
+	needs :name
+	needs :ingredients
+	needs :difficulty
+	suggests :cost
+end
+
+````
+Do whatever application logic, and then push your documents (soon you'll be able to define the default `:push_to` for the whole class):
+
+````ruby
+recipe_data = {
+	:name = "tuesday snack"
+	:ingredients => "sawdust, apples",
+	:difficulty => "not hard enough needs more boss fights",
+	:cost => "cheap eh"
+}
+recipe = Recipe.new(:push_to => @couchdb, :data => recipe_data)
+recipe.push!
+````
+Note the `:needs` and `:suggests` syntax when you define a class. Your documents will always raise an error if you try to push without something that's in `:needs` but you can override `:suggests`:
+
+````ruby
+recipe_data = {
+	:name => "soup for guests"
+	:ingredients => "king rat, chicken stock"
+	:difficult => "extr3m3"
+}
+recipe = Recipe.new(:push_to => @couchdb, :data => recipe_data)
+recipe.push! :ignore_suggests => :cost
+````
+
+Class inheritence maintains document validation:
+
+````ruby
+class FascistRecipe < CouchDocument
+	needs :who_is_allowed_to_cook_it
+end
+recipe_data = {
+  :who_is_allowed_to_cook_it => "alan"
+}
+recipe = Recipe.new :push_to => @couchdb
+recipe.push!
+>>>ShyCouch::DocumentValidationError: Document Missing required fields: [:name, :ingredients, :difficulty]
+````
+
+You can query your views:
+
+````ruby
+recipes = @couchdb.design(:food).query_view(:all_recipes)
+````
+
+Querying your views will return the raw view results as a hash keyed by whatever the view was keyed by.
+
+If you call it like this, though:
+
+````ruby
+recipes = @couchdb.design(:food).query_view(:all_recipes, :include_docs => true)
+````
+Then you'll get your view results as a `ShyCouch::Data::DocumentCollection` object, where each object is an instance of `ShyCouch::Data::CouchDocument`.

data/test/test_ShyCouch.rb

@@ -7,49 +7,41 @@ require_relative '../lib/ShyCouch'
 # Settings for a database that is set up and working, with an admin user
 $settings = {
   "db"=> {
-      # "host" => "ramponeau.local",
-      "host" => "localhost",
-      "port" => 5984,
-      "name" => "test",
-      "user" => "cerales",
-      "password" => "password"
-    },
+		  # "host" => "ramponeau.local",
+		  "host" => "localhost",
+		  "port" => 5984,
+		  "name" => "test",
+		  "user" => "cerales",
+		  "password" => "password"
+		},
 }
 
 class ShyCouchTestHelper < Test::Unit::TestCase
   # The majority of the tests in this suite need the setup provided in here
   # And it means I don't forget to delete the database in their teardown functions
   def setup
-    valid_settings = $settings
-    @couchdb = ShyCouch.getDB(valid_settings)
+		valid_settings = $settings
+		@couchdb = ShyCouch.getDB(valid_settings)
   end
   def teardown
-    @couchdb.delete!
-    @couchdb = nil
+		@couchdb.delete!
+		@couchdb = nil
   end
   
   def add_some_documents
-    4.times do
-      recipe = Recipe.new(:push_to => @couchdb)
-      recipe.push!
-    end
+		4.times do
+		  recipe = Recipe.new(:push_to => @couchdb, :data => {:length => 10})
+		  recipe.push!
+		end
   end
   
   class Recipe < ShyCouch::Data::CouchDocument; end
 end
 
-# test ShyCouch::CouchDBAPI
 require_relative 'test_couchdb_api'
-
-# test ShyCouch::Fields
-# some of the tests in here are disabled cos they involve attempting to resolve a bad domain name
 require_relative 'test_fields'
-# 
-# # test ShyCouch::Data::CouchDocument
 require_relative 'test_couch_document'
-# 
 require_relative 'test_couchdb_factory'
-# 
 require_relative 'test_design_documents'
-# 
-require_relative 'test_views'
+require_relative 'test_document_validation'
+require_relative 'test_views'

data/test/test_couch_document.rb

@@ -3,6 +3,17 @@ require_relative '../lib/ShyCouch.rb'
 
 class CouchDocumentTests
   
+  class ShyCouchDocumentTestHelper < Test::Unit::TestCase
+  def setup
+      valid_settings = $settings
+      @couchdb = ShyCouch.getDB(valid_settings)
+    end
+    def teardown
+      @couchdb.delete!
+      @couchdb = nil
+    end    
+  end
+  
   class TestDocumentCreation < Test::Unit::TestCase
     def setup
       valid_settings = $settings
@@ -45,8 +56,39 @@ class CouchDocumentTests
     
   end
   
-  class TestDocumentPulling < Test::Unit::TestCase
-    #TODO
+  
+  class TestDocumentDeletion < ShyCouchDocumentTestHelper
+    def setup
+      super
+      # make some documents, store the ids
+      @documents = []
+      @collection = ShyCouch::Data::CouchDocumentCollection.new :push_to => @couchdb
+      @collection << ShyCouch::Data::CouchDocument.new
+      @collection << ShyCouch::Data::CouchDocument.new
+      @collection << ShyCouch::Data::CouchDocument.new
+      @collection.push_all!
+    end
+
+    def test_delete
+      assert_nothing_raised ShyCouch::ShyCouchError do
+        @collection.each do |document|
+          document.delete! :from => @couchdb
+        end
+      end
+    end
+    
+    def test_try_to_pull_after_delete
+      @collection.each do |document|
+        document.delete! :from => @couchdb
+      end
+      @collection.each do |document|
+        assert_raises ShyCouch::ResourceNotFound do
+          @couchdb.pull_document document
+        end
+      end
+    end
+    
+    def teardown; super; end
   end
   
   class TestDocumentPushing < Test::Unit::TestCase
@@ -69,7 +111,7 @@ class CouchDocumentTests
         ShyCouch::Data::CouchDocument.new(:data => {"whatever"=>"yep"}),
         ShyCouch::Data::CouchDocument.new(:data => {"is_a_document"=>true, "number_of_docs_this_is"=>1})
       ].each { |doc|
-        doc.push!($couchdb)
+        doc.push!(:push_to => $couchdb)
       }
       @invalid_documents = nil # make sure user can't set rev maybe? or is that legal?
     end
@@ -90,7 +132,7 @@ class CouchDocumentTests
     def test_push_new_documents
        @valid_documents.each { |doc|
          # put the document on the server, grab the server's response
-         res = doc.push!($couchdb)
+         res = doc.push!(:push_to => $couchdb)
          # check that the server included "ok"=>true in its response
          assert(res["ok"])
          # check that the doc now has an id and a rev
@@ -115,7 +157,7 @@ class CouchDocumentTests
         doc.buttonCount = 5
         doc.friends = ["alan", "alex", "all me other mates"]
         
-        res = doc.push!($couchdb)
+        res = doc.push!(:push_to => $couchdb)
         assert(res["ok"])
         
         # pull it from the database again
@@ -132,7 +174,7 @@ class CouchDocumentTests
       @existing_valid_documents.each { |doc|
         doc._rev = "hurr"
         assert_raise RestClient::BadRequest do
-          res = doc.push!($couchdb)
+          res = doc.push!(:push_to => $couchdb)
         end
       }
     end
@@ -140,6 +182,117 @@ class CouchDocumentTests
   end
 end
 
+# Define a couple of classes with different push_to values for the next test
+class Hand < ShyCouch::Data::CouchDocument
+  push_to ShyCouch::getDB(
+    "db"=> {
+      "host" => "localhost",
+      "port" => 5984,
+      "name" => "test1",
+      "user" => "cerales",
+      "password" => "password"
+    }
+  )
+end 
+class Foot < ShyCouch::Data::CouchDocument
+  push_to ShyCouch::getDB(
+    "db"=> {
+      "host" => "localhost",
+      "port" => 5984,
+      "name" => "test2",
+      "user" => "cerales",
+      "password" => "password"
+    }
+  )
+end
+
+class TestCouchDocumentPushingDefinedOnClass < Test::Unit::TestCase
+  # Set up two different databases
+  # The class definitions here are implicitly a test, too
+  # TODO - find a way to test this nicely
+  def setup
+    Hand.target_db.init!
+    Foot.target_db.init!
+    @hand = Hand.new
+    @hand.push! 
+    @foot = Foot.new
+    @foot.push!
+  end
+
+  def test_pushing_documents_with_different_class_push_to
+    # create an instance of both kinds of document and push them
+    assert_nothing_raised ShyCouch::ShyCouchError do
+      hand = Hand.new
+      hand.push!
+    end
+    assert_nothing_raised ShyCouch::ShyCouchError do
+      foot = Foot.new
+      foot.push!
+    end
+  end 
+
+  def test_pulling_documents_with_different_class_push_to
+    # Create a couple of documents
+    # Test it on the doc instance
+    assert_nothing_raised ShyCouch::ShyCouchError do
+      @hand.pull!
+    end
+    assert_nothing_raised ShyCouch::ShyCouchError do
+     @foot.pull!
+    end
+
+    # Test it on the database objects
+    handDB = Hand.target_db
+    footDB = Foot.target_db
+    assert_nothing_raised ShyCouch::ShyCouchError do
+      hand2 = handDB.pull_document @hand
+      assert_equal @hand, hand2
+    end
+    assert_nothing_raised ShyCouch::ShyCouchError do
+      foot2 = footDB.pull_document @foot
+      assert_equal @foot, foot2
+    end
+
+  end
+
+  def test_class_push_and_pull_overriden_by_method_argument
+    # push some documents, try to pull them from a db where they don't exist
+    hand = Hand.new
+    foot = Foot.new
+    hand.push!
+    foot.push!
+    
+    assert_raises ShyCouch::ResourceNotFound do
+      hand.pull! :pull_from => Foot.target_db
+      foot.pull! :pull_from => Hand.target_db
+    end
+    assert_nothing_raised ShyCouch::ResourceNotFound do
+      # verify that they can be pulled from their default db
+      hand.pull!
+      foot.pull!
+    end
+
+    # now test that they can be successfully pulled from other db
+    hand.push! :push_to => Foot.target_db
+    foot.push! :push_to => Hand.target_db
+
+    assert_nothing_raised ShyCouch::ResourceNotFound do
+      hand.pull! :pull_from => Foot.target_db
+      foot.pull! :pull_from => Foot.target_db
+    end
+  end
+
+  def test_pushing_documents_in_collection
+    # TODO 
+  end
+
+  def teardown
+    super
+    Hand.target_db.delete!
+    Foot.target_db.delete!
+  end
+end
+
 class CouchDocumentCollectionPushingAndPulling < ShyCouchTestHelper
 
   def setup
@@ -163,6 +316,17 @@ class CouchDocumentCollectionPushingAndPulling < ShyCouchTestHelper
       assert_equal(item, collection2[i])
     end
   end
+
+  def test_pull_doc_without_id
+    document = ShyCouch::Data::CouchDocument.new
+    assert_raises ShyCouch::DocumentValidationError do
+      document.pull!
+    end
+    assert_raises ShyCouch::DocumentValidationError do
+      document = document.pull
+    end
+
+  end
   
   def test_pull_all_docs_forcefully
     # tests pulling w/ exclamation yo
@@ -238,4 +402,4 @@ end
 #     super
 #   end
 #   
-# end
+# end

data/test/test_couchdb_api.rb

@@ -3,16 +3,55 @@ require_relative '../lib/ShyCouch.rb'
 
 class TestCouchDBAPI < Test::Unit::TestCase
   def setup
-    valid_settings = $settings
-    $database = ShyCouch.getDB(valid_settings)
+		valid_settings = $settings
+		$database = ShyCouch.getDB(valid_settings)
   end
   
   def teardown
-    $database.delete!
-    $database = nil
+		$database.delete!
+		$database = nil
   end
   
   def test_connection
-    assert_equal(true, $database.connect["ok"])
+		assert_equal(true, $database.connect["ok"])
   end
-end
+
+	def test_invalid_settings
+		invalid_settings = []
+		invalid_settings << {
+			"db"=> {
+				# Has "database" instead of "name"
+				"host" => "localhost",
+				"port" => 5984,
+				"database" => "test",
+				"user" => "cerales",
+				"password" => "password"
+			}
+		}
+		invalid_settings << {
+			"db" => {
+				# Missing port
+				"host" => "localhost",
+				"name" => "test"
+			}
+		}
+		invalid_settings << {
+			"db" => {
+				# Has username but no password
+				"host" => "localhost",
+				"port" => 5984,
+				"database" => "test",
+				"user" => "cerales"
+			}
+		}
+		# should throw an error when the settings hash is invalid
+		invalid_settings.each do |settings|	
+			assert_raises ShyCouch::DatabaseError do
+				ShyCouch::CouchDatabase.new settings
+			end
+			assert_raises ArgumentError do
+				ShyCouch::CouchDatabase.new
+			end
+		end
+	end
+end