leanback 0.2.6 → 0.2.7

data/Changelog.rdoc

@@ -1,10 +1,23 @@
+=Leanback 0.2.7
+August 4, 2011:-
+* Added ability to Query a permanent view and create it on the fly from a json file, if it doesn't already exist and then return the values
+Example:
+     view = {:database => 'contacts',
+         :design_doc => 'my_views',
+          :view => 'get_emails',
+           :json_doc => '/path/to/my_views.json'}
+
+     Couchdb.find_on_fly(view)
+The above will query the view and add it to the database if it doesn't already exist and still return the values. 
+See README for details
+
 =Leanback 0.2.6
 August 3, 2011:-
 * Added ability to delete documents without having to retrieve the _rev revision number
 Example:
  doc = {:database => 'contacts', :doc_id => 'James'}
  Document.delete doc
-The above will delete the document with id 'james'. See README for details. 
+The above will delete the document with id 'James'. See README for details. 
 
 =Leanback 0.2.5
 August 2, 2011:-

data/README.rdoc

@@ -250,39 +250,34 @@ To query the view
          {"Firstname"=>"john", "Lastname"=>"smith", "Email"=>"john@mail.com"}]
 
 
-===Create View on the fly if it doesn't already exist 
+===Query a View and Create it 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.
 
+ 
  def get_emails
-  begin  
-   docs = Couchdb.find(:database => "contacts", :design_doc => 'my_views', :view => 'get_emails') 
-  rescue CouchdbException => e
-    doc = { :database => 'contacts', :design_doc => 'my_views', :json_doc => '/path/to/my_views.json' }
-    Couchdb.create_design doc
-    docs = Couchdb.find(:database => "contacts", :design_doc => 'my_views', :view => 'get_emails')      
+    view = {:database => 'contacts',
+         :design_doc => 'my_views',
+          :view => 'get_emails',
+           :json_doc => '/path/to/my_views.json'}
+
+    Couchdb.find_on_fly(view)
   end
-  return docs
- end
 
- email_list = get_emails()
- puts email_list.inspect
+  email_list = get_emails()
+  puts email_list.inspect 
 
  # => [{"Name"=>"Nancy", "Email"=>"nancy@mail.com"}, {"Name"=>"John", "Email"=>"john@mail.com"}]
 
 In get_emails(), 
- docs = Couchdb.find(:database => "contacts", :design_doc => 'my_views', :view => 'get_emails') 
+ Couchdb.find_on_fly(view)
 sends a request to the design_document (my_views) and view (get_emails). If this view is found in the database, it returns an Array with the name and email of all contacts:
   [{"Name"=>"Nancy", "Email"=>"nancy@mail.com"}, {"Name"=>"John", "Email"=>"john@mail.com"}]
-if the view doesn't exist it raises a CouchdbException. It catches this exception 
-  rescue CouchdbException => e
-and then it creates the design_document (my_views) and view (get_emails), since they don't already exist
-  doc = { :database => 'contacts', :design_doc => 'my_views', :json_doc => '/path/to/my_views.json' }
-  Couchdb.create_design doc
-next it sends a request for the view again. 
-   docs = Couchdb.find(:database => "contacts", :design_doc => 'my_views', :view => 'get_emails')
-Then it returns the email list
-   return docs
-So the first time the get_emails() method is called, the view will be created on the fly and added to the database.
+if the design document and view doesn't already exist, it creates it and adds it to the database using the json document
+   :json_doc => '/path/to/my_views.json' 
+  
+next it sends a request for the view again and then it returns the email list.
+
+So the first time the get_emails() method is called, the view will be created on the fly and added to the database. Future calls to get_email would simply return the values from the view.
 
 Source for the get_emails view:
  #my_views.json
@@ -298,6 +293,37 @@ Source for the get_emails view:
   }
  }
 
+You can also query a permanent view with a key and create it on the fly, if it doesn't already exist.
+Let's say we want to view all contacts with age = "36", and we already defined the view in a json file (view_age.json).
+  view = { :database => 'contacts', 
+           :design_doc => 'the_view', 
+            :view => 'age',
+             :json_doc => '/path/to/view_age.json'}
+
+  age = '36'
+  Couchdb.find_on_fly(view,key = age)
+
+ #=> [{"_id"=>"Nancy", "_rev"=>"2-4404d0a5a1a3dff103fd46faf1e46c30", "firstname"=>"Nancy", "lastname"=>"Lee", 
+                  "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female", "age"=>"36"}]
+
+The above example will query the design_document (the_view) and view (age) in the database (contacts), using the key (age). If the view doesn't exist it will be created from the json document (view.age.json). And then return the values from the view.
+
+This is similar to sending a
+ GET http://127.0.0.1:5984/contacts/_design/the_view/_view/age?key="36"
+
+The view is generated from the source code:
+ #view_age.json
+ {
+  "language" : "javascript",
+  "views" :{
+    "age" : {
+      "map" : "function(doc){
+         if(doc.age)
+           emit(doc.age,doc);
+        }"
+     }
+  }
+ }
 
 ===Error handling
 Every database operation raises a CouchdbException when things go wrong.
@@ -338,21 +364,8 @@ Attempting to query a permanent view that doesn't exist
  # => Error message: CouchDB: Error - not_found. Reason - missing_named_view
       Error value: not_found
 
-You can always check the information passed to the Exception. See example below:
-  begin
-   view = { :database => "contacts", :design_doc => 'more_views', :view => 'get_user_email'}
-   Couchdb.find view 
-  rescue CouchdbException => e
-    if e.error == "not_found"
-     doc = { :database => 'contacts', :design_doc => 'more_views', :json_doc => '/path/to/user_email.json' }
-     Couchdb.create_design doc
-     docs = Couchdb.find(:database => "contacts", :design_doc => 'more_views', :view => 'get_user_email')      
-    end
-  end 
-
-In the code above, the rescue block will create and request the permanent view if it's not found by the initial request outside the block. e.error is the value of the error returned by CouchDB.
+You can always check the information passed to the Exception. 
   
-
 ===Bind Address
 Leanback uses the default Couchdb bind address http://127.0.0.1:5984. To use a different bind address;
  Couchdb.address = '192.168.2.16'

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/leanback.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leanback}
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]

data/lib/leanback.rb

@@ -196,6 +196,32 @@ def self.create_design(doc)
   end
 end
 
+#Query view, create view on fly if it dosen't already exist
+def self.find_on_fly(doc, key = nil)  
+   db_name = doc[:database]
+   design_doc = doc[:design_doc]
+   view = doc[:view]
+   json_doc = doc[:json_doc]
+ 
+   begin 
+      if( key == nil)
+       docs = find(:database => db_name, :design_doc => design_doc, :view => view) 
+      else
+       docs = find({:database => db_name, :design_doc => design_doc, :view => view},key) 
+      end
+     rescue CouchdbException => e
+        document = { :database => db_name, :design_doc => design_doc, :json_doc => json_doc}
+        create_design document  
+        if( key == nil)
+          docs = find(:database => db_name, :design_doc => design_doc, :view => view) 
+        else
+          docs = find({:database => db_name, :design_doc => design_doc, :view => view},key) 
+        end
+      end
+    return docs
+ end
+
+
 #add a finder method to the database
 #this creates a find by key method
 def self.add_finder(options)

data/test/test_leanback.rb

@@ -82,6 +82,28 @@ class TestLeanback < Test::Unit::TestCase
     #puts hash.inspect
   end
 
+
+  should "Query a permanent view and create the view on the fly, if it doesn't already exist" do
+    view = {:database => 'contacts',
+         :design_doc => 'my_views',
+          :view => 'get_emails',
+           :json_doc => '/home/obi/bin/my_views.json'}
+
+     hash = Couchdb.find_on_fly(view)
+     #puts hash.inspect
+  end
+
+  should "Query a permanent view by key and create the view on the fly, if it doesn't already exist" do
+    view = { :database => 'contacts', 
+           :design_doc => 'the_view', 
+            :view => 'age',
+             :json_doc => '/home/obi/bin/view_age.json'}
+
+    age = '36'
+    hash = Couchdb.find_on_fly(view,key = age)
+    puts hash.inspect  
+  end
+
   should "Create a design doc/permanent view or handle exception" do
     doc = { :database => 'contacts', :design_doc => 'more_views', :json_doc => '/home/obi/bin/leanback/test/my_views.json' }
     begin 
@@ -119,7 +141,7 @@ class TestLeanback < Test::Unit::TestCase
 
  should  "update the document" do
    #data = {"age" => "42", "lastname" => "arnold", "phone" => "202-456-1234", "hobbies" => "football,running, video gamess" }
-   data = {"age" => "54" }
+   data = {:age => "41", :lastname => "Stevens" }
    doc = { :database => 'contacts', :doc_id => 'john', :data => data}   
    Document.update doc 
  end
@@ -145,11 +167,11 @@ class TestLeanback < Test::Unit::TestCase
         	 :email =>'james@mail.com'}
 
          doc = {:database => 'contacts', :doc_id => 'james', :data => data}
-         Document.create doc
+         #Document.create doc
 
          doc = {:database => 'contacts', :doc_id => 'James'}
          hash = Document.delete doc
-         puts hash.inspect
+         #puts hash.inspect
       rescue CouchdbException => e   
          #puts e.to_s
          #puts e.error

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Obi Akubue
@@ -136,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -85195711
+      hash: -441250723
       segments: 
       - 0
       version: "0"