leanback 0.2.4 → 0.2.5

data/Changelog.rdoc

@@ -1,13 +1,26 @@
+=Leanback 0.2.5
+August 2, 2011:-
+* Added dynamic updates for documents. This makes it easy to update documents without deleting old fields or having to track the _rev value. 
+To update a document now:
+ data = {"age" => "53" }
+   doc = { :database => 'contacts', :doc_id => 'john', :data => data}   
+   Document.update doc 
+This will update the document and change the John's age to 53. See README for details
+
+=Leanback 0.2.4
+July 20, 2011:-
+* find_by(database,key) has a bug in version 0.2.3, please use version 0.2.4 instead
+
 =Leanback 0.2.3
 July 19, 2011:-
 * Added better error handling all database operations now raise a CouchdbException when something goes wrong. It's now easy to track exceptions.
+
    begin 	
    Couchdb.create 'contacts'
   rescue => e
    puts "Error message: " + e.to_s
    puts "Error value: " + e.error
   end 
-
  # => Error message: CouchDB: Error - file_exists. Reason - The database could not be created, the file already exists.
       Error value: file_exists
 
@@ -21,3 +34,4 @@ The method:
  Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
 will add the finder to the database if one doesn't already exist. No need to call  
  Couchdb.add_finder(:database => 'contacts', :key => 'email')
+

data/README.rdoc

@@ -22,14 +22,17 @@ Require the leanback Gem
  
 Create a CouchDB database
  Couchdb.create 'contacts'
+
  # => {"ok"=>true}
 
 Delete a database
  Couchdb.delete 'contacts'
+
  # => {"ok"=>true} 
 
 Return a list of all Databases
  Couchdb.all
+
  # => ["maps", "inventory", "monitors", "contacts", "books"]
 
 Create a new document
@@ -40,30 +43,68 @@ Create a new document
 
  doc = {:database => 'contacts', :doc_id => 'Linda', :data => data}
  Document.create doc
+
  # => {"ok"=>true, "id"=>"Linda", "rev"=>"1-6f16274513f51e922ff1f745452a92b6"} 
 This will create a new document in the 'contacts' database, with document id 'Linda'.
 
-Lets edit that document to change the email address, phone number, and add a gender
+Let's update that document to change the email address
+ data = {"email" => "linda@mail.com" }
+ doc = { :database => 'contacts', :doc_id => 'Linda', :data => data}   
+ Document.update doc 
+
+Let's add gender and age 
+ data = {"age" => "32","gender" => "female" }
+ doc = { :database => 'contacts', :doc_id => 'Linda', :data => data}   
+ Document.update doc 
+
+
+To change phone# and add a fax number
+ data = {"phone" => "718-234-2904","fax" => "646-309-4049" }
+ doc = { :database => 'contacts', :doc_id => 'Linda', :data => data}   
+ Document.update doc
+ 
+Let's add twitter account, facebook account and website url
+  data = {"twitter" => "http://twitter.com/#!/linda", 
+           "faceboook" => "http://facebook.com/linda", 
+           "website" => "http://linda-blogs.com" }
+
+   doc = { :database => 'contacts', :doc_id => 'Linda', :data => data}   
+   Document.update doc 
+
+Retrieve/view the document 
+ doc = {:database => 'contacts', :doc_id => 'Linda'}
+ Couchdb.view doc
+
+ #=> {"_id"=>"Linda", "_rev"=>"5-f99fd63f2c784b5e2f7b7d92b2df9a1e", "firstname"=>"Linda", "lastname"=>"smith", 
+   "phone"=>"718-234-2904", "email"=>"linda@mail.com", "age"=>"32", "gender"=>"female", 
+      "fax"=>"646-309-4049", "twitter"=>"http://twitter.com/#!/linda", 
+             "faceboook"=>"http://facebook.com/linda", "website"=>"http://linda-blogs.com"}
+
+To edit the document and replace it with a new one
  data = {:firstname => 'Linda', 
          :lastname =>'smith', 
          :email => 'linda@mail.com',
          :gender=>'female',
          :phone =>'718-245-5611',
-         :_rev=>'1-6f16274513f51e922ff1f745452a92b6'}
+         :_rev=>'5-f99fd63f2c784b5e2f7b7d92b2df9a1e'}
 
  doc = {:database => 'contacts', :doc_id => 'Linda', :data => data}
  Document.edit doc
- # => {"ok"=>true, "id"=>"Linda", "rev"=>"2-e813a0e902e3ac114400ff3959a2adde"}
+
+ # => {"ok"=>true, "id"=>"Linda", "rev"=>"6-211ebb68bdd4ba8799387214b4a3b445"}
+This replaces the existing document with a new one, the _rev property must be included in the data.
 
 Retrieve/view the document 
  doc = {:database => 'contacts', :doc_id => 'Linda'}
  Couchdb.view doc
-  #=> {"_id"=>"Linda", "_rev"=>"2-e813a0e902e3ac114400ff3959a2adde", "firstname"=>"Linda", 
+
+  #=> {"_id"=>"Linda", "_rev"=>"6-211ebb68bdd4ba8799387214b4a3b445", "firstname"=>"Linda", 
                   "lastname"=>"smith", "email"=>"linda@mail.com", "gender"=>"female", "phone"=>"718-245-5611"} 
 
 Delete the document
  doc = {:database => 'contacts', :doc_id => 'Linda', :rev => '2-e813a0e902e3ac114400ff3959a2adde'}
  Document.delete doc
+
  # => {"ok"=>true, "id"=>"Linda", "rev"=>"3-48580d1806983b32cb03f114efb064e3"} 
 
 Retrieve all documents in a database
@@ -81,16 +122,19 @@ Retrieve all documents in a database
 ===To Find documents by key
 To find documents by email key (example: to find all contacts with email = 'nancy@mail.com')
  Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
+
  # => [{"_id"=>"Nancy", "_rev"=>"1-d15a83d2a23b495c19df2595b636ecc8", "firstname"=>"Nancy", "lastname"=>"Lee",
                    "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female"}]
 
 To find all contacts with lastname = 'Smith'
  Couchdb.find_by( :database => 'contacts', :lastname => 'Smith')  
+
  # => [{"_id"=>"john", "_rev"=>"5-642689e0a50843d6fa508159a01b4fd4", "firstname"=>"John", "lastname"=>"Smith",
                    "email"=>"john@mail.com", "gender"=>"male"}]
 
 To find all female contacts 
  Couchdb.find_by( :database => 'contacts', :gender => 'female') 
+
  # => [{"_id"=>"Nancy", "_rev"=>"1-d15a83d2a23b495c19df2595b636ecc8", "firstname"=>"Nancy", "lastname"=>"Lee",
                   "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female"}]
 
@@ -144,6 +188,7 @@ You can do
 ===Query a permanent view
  view = { :database => "contacts", :design_doc => 'my_views', :view => 'get_female_contacts'}
  Couchdb.find view 
+
  # => [{"_id"=>"Mary", "_rev"=>"5-bfcd67fd17dbb6a875af8f6dc497b15f", "firstname"=>"Mary", "lastname"=>"smith", 
                                          "phone"=>"212-234-1234", "email"=>"mary@mail.com", "gender"=>"female"}, 
  {"_id"=>"Nancy", "_rev"=>"1-d15a83d2a23b495c19df2595b636ecc8", "firstname"=>"Nancy", "lastname"=>"Lee", 
@@ -155,6 +200,21 @@ For the above example
  GET http://127.0.0.1:5984/contacts/_design/my_views/_view/get_female_contacts
 Leanback parses the native JSON results to return only the data values.
 
+===Query a view by key 
+ view = { :database => "contacts", :design_doc => 'the_view', :view => 'age'}
+ age = "36"
+ Couchdb.find(view,key = age)
+
+ # => [{"_id"=>"Nancy", "_rev"=>"2-4404d0a5a1a3dff103fd46faf1e46c30", "firstname"=>"Nancy", "lastname"=>"Lee", 
+                 "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female", "age"=>"36"}]
+
+This is similar to sending a
+ GET http://127.0.0.1:5984/[database]/_design/[design_doc]/_view/[view_name]?key="searchterm"
+For the above example
+ GET http://127.0.0.1:5984/contacts/_design/the_view/_view/age?key="36"
+Leanback parses the native JSON results to return only the data values.
+ 
+
 ===Create a design document with permanent views:
 First define the views in a JSON file 
  //my_views.json
@@ -173,17 +233,19 @@ First define the views in a JSON file
 Now create the design document and add the json file
  doc = { :database => 'contacts', :design_doc => 'more_views', :json_doc => '/path/to/my_views.json' }
  Couchdb.create_design doc 
+
  # => {"ok"=>true, "id"=>"_design/more_views", "rev"=>"1-d67ae97ff03a98f68ddc300bf9ae5048"}
 
 To query the view
  view = { :database => "contacts", :design_doc => 'more_views', :view => 'get_email'}
  Couchdb.find view 
+
  # => [{"Firstname"=>"Nancy", "Lastname"=>"Lee", "Email"=>"nancy@mail.com"}, 
          {"Firstname"=>"john", "Lastname"=>"smith", "Email"=>"john@mail.com"}]
 
 
 ===Create View on the fly if it doesn't already exist 
-Let's say we want to query a view and create it on the fly if it doesn't already exist, and still return the values. In this example we will query a view called get_emails view (which returns emails of all contacts), if this view doesn't already exist it will be added to the database.
+Let's say we want to query a view, and create it on the fly if it doesn't already exist, and still return the values. In this example we will query a view called get_emails view (which returns emails of all contacts), if this view doesn't already exist it will be added to the database.
 
  def get_emails
   begin  
@@ -198,6 +260,7 @@ Let's say we want to query a view and create it on the fly if it doesn't already
 
  email_list = get_emails()
  puts email_list.inspect
+
  # => [{"Name"=>"Nancy", "Email"=>"nancy@mail.com"}, {"Name"=>"John", "Email"=>"john@mail.com"}]
 
 In get_emails(), 
@@ -236,6 +299,7 @@ Every database operation raises a CouchdbException when things go wrong.
 Attempting to create a database that already exists
   begin 	
    Couchdb.create 'contacts'
+   #create static views
   rescue CouchdbException => e
    puts "Error message: " + e.to_s
    puts "Error value: " + e.error
@@ -305,3 +369,4 @@ To change it back to default bind address at anytime, simply set the values to n
 Copyright (c) 2011 Obi Akubue. See LICENSE.txt for
 further details.
 
+

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/leanback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leanback}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]
-  s.date = %q{2011-07-20}
+  s.date = %q{2011-08-03}
   s.description = %q{lightweight Ruby interface to CouchDB}
   s.email = %q{obioraakubue@yahoo.com}
   s.extra_rdoc_files = [

data/lib/leanback.rb

@@ -44,6 +44,18 @@ module Document
       end
   end
 
+ #update a doc
+ def self.update (doc)
+      db_name = doc[:database]
+      doc_id = doc[:doc_id]
+      data = doc[:data]
+      doc = {:database => db_name, :doc_id => doc_id}
+      options = Couchdb.view doc 
+      options = options.merge(data)
+      doc = {:database => db_name, :doc_id => doc_id, :data => options}
+      edit doc
+ end
+
  #delete a doc
  def self.delete(doc)
    db_name = doc[:database]

data/test/test_leanback.rb

@@ -117,6 +117,13 @@ class TestLeanback < Test::Unit::TestCase
       end  
   end
 
+ should  "update the document" do
+   #data = {"age" => "42", "lastname" => "arnold", "phone" => "202-456-1234", "hobbies" => "football,running, video gamess" }
+   data = {"age" => "13" }
+   doc = { :database => 'contacts', :doc_id => 'john', :data => data}   
+   Document.update doc 
+ end
+
  should "edit a document - handle exceptions" do 
         begin
          data = {:firstname => 'john', :lastname =>'smith', :email => 'john@mail.com',:gender=>'male', :_rev=>'2-e813a0e902e3ac114400ff3959a2adde'}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Obi Akubue
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 -04:00
+date: 2011-08-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -136,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 600156783
+      hash: 541704349
       segments: 
       - 0
       version: "0"