leanback 0.1.7 → 0.1.8

data/README.rdoc

@@ -55,9 +55,9 @@ Lets edit that document to change the email address, phone number, and add a gen
  Document.edit doc
  # => {"ok"=>true, "id"=>"Linda", "rev"=>"2-e813a0e902e3ac114400ff3959a2adde"}
 
-Retrieve the document by id
+Retrieve/view the document 
  doc = {:database => 'contacts', :doc_id => 'Linda'}
- Couchdb.find doc
+ Couchdb.view doc
   #=> {"_id"=>"Linda", "_rev"=>"2-e813a0e902e3ac114400ff3959a2adde", "firstname"=>"Linda", 
                   "lastname"=>"smith", "email"=>"linda@mail.com", "gender"=>"female", "phone"=>"718-245-5611"} 
 
@@ -77,6 +77,48 @@ Retrieve all documents in a database
   puts d["phone"]
  end  
 
+===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", 
+                                    "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female"}]
+
+This is similar to sending a
+ GET http://127.0.0.1:5984/[database]/_design/[design_doc]/_view/[view_name] 
+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.
+
+===Create a design document with permanent views:
+First define the views in a JSON file 
+ //my_views.json
+ {
+  "language" : "javascript",
+  "views" :{
+     "get_email" : {
+       "map" : "function(doc){
+          if(doc.lastname && doc.email)
+            emit(doc.id,{Firstname: doc.firstname, Lastname: doc.lastname, Email: doc.email});
+         }"
+     }
+  }
+ }
+
+Now create the design document and add the json file
+ doc = { :database => 'contacts', :design_doc => 'more_views', :json_doc => '/path/to/my_views.json' }
+ hash = 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"}]
+
+
+===Error handling
 Attempting to create a database that already exists
  Couchdb.create 'contacts'
  # => {"error"=>"file_exists", "reason"=>"The database could not be created, the file already exists."} 
@@ -85,12 +127,13 @@ Attempting to delete a database that no longer exists
  Couchdb.delete 'more_books'
  # => {"error"=>"not_found", "reason"=>"missing"} 
 
-Most methods return a hash value unless otherwise specified. When a database transaction goes through successfully most methods will return a hash value # => {"ok" => true ...} and when something goes wrong it returns a hash value # => {"error" => ...}
+Most methods return a hash value unless otherwise specified. When a database transaction goes through successfully most methods will return a hash {"ok" => true ...} and when something goes wrong it returns a hash {"error" => ...}
 
 You can always check this value 
  hash = Couchdb.delete 'schools'
  puts hash.inspect
 
+===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'
  Couchdb.port = '6000'

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/leanback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leanback}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]
-  s.date = %q{2011-06-19}
+  s.date = %q{2011-07-04}
   s.description = %q{lightweight Ruby interface to CouchDB}
   s.email = %q{obioraakubue@yahoo.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "leanback.gemspec",
     "lib/leanback.rb",
     "test/helper.rb",
+    "test/my_views.json",
     "test/test_leanback.rb"
   ]
   s.homepage = %q{http://github.com/obi-a/leanback}

data/lib/leanback.rb

@@ -1,5 +1,6 @@
 require 'rest_client'
 require 'yajl'
+require 'erb'
 
 module Document
   
@@ -94,21 +95,64 @@ module Couchdb
        end
  end
 
-##find a document by _id
-def self.find(doc)
+##view a document 
+def self.view(doc)
  set_address
  db_name = doc[:database]
  doc_id = doc[:doc_id]
   begin
    response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/' + doc_id
    hash = Yajl::Parser.parse(response.to_str)
-   #puts hash.inspect
   rescue => e
    hash = Yajl::Parser.parse(e.response.to_s)
-   #puts hash.inspect
  end 
 end
 
+#query a permanent view
+def self.find(doc)
+ set_address
+ db_name = doc[:database]
+ design_doc_name = doc[:design_doc]
+ view_name = doc[:view]
+   begin
+     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name
+     hash = Yajl::Parser.parse(response.to_str)
+     rows = hash["rows"]
+     count = 0
+     rows.each do |row|
+      rows[count] = row["value"]
+      count += 1  
+     end
+     return rows
+   rescue => e
+    hash = Yajl::Parser.parse(e.response.to_s)
+   end
+end
+
+#create a design document with views
+def self.create_design(doc)
+ set_address
+ db_name = doc[:database]
+ design_doc_name = doc[:design_doc]
+ json_doc_name = doc[:json_doc]
+
+ begin
+  #bind json doc to string
+  message_template = ERB.new File.new(json_doc_name).read
+  str = message_template.result(binding)
+ rescue => e
+   raise e
+ end
+
+  begin
+   
+   response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, str, {:content_type => :json, :accept => :json}
+    hash = Yajl::Parser.parse(response.to_str)
+  rescue => e
+    hash = Yajl::Parser.parse(e.response.to_s)
+  end
+end
+
  #return a list of all docs in the database
 def self.docs_from(database_name)
   set_address
@@ -116,13 +160,12 @@ def self.docs_from(database_name)
          response = RestClient.get 'http://' + @address + ':' + @port + '/' + URI.escape(database_name) + '/_all_docs?include_docs=true', {:content_type => :json}
          hash = Yajl::Parser.parse(response.to_str)
          rows = hash["rows"]
-         only_rows = []
          count = 0 
          rows.each do |row|
-            only_rows[count] = row["doc"]
-            count = count + 1
+            rows[count] = row["doc"]
+            count += 1
           end
-        return only_rows
+        return rows
   rescue => e
      hash = Yajl::Parser.parse(e.response.to_s)
   end  

data/test/my_views.json

@@ -0,0 +1,11 @@
+{
+ "language" : "javascript",
+ "views" :{
+    "get_email" : {
+      "map" : "function(doc){
+         if(doc.lastname && doc.email)
+           emit(doc.id,{Firstname: doc.firstname, Lastname: doc.lastname, Email: doc.email});
+        }"
+    }
+ }
+}

data/test/test_leanback.rb

@@ -9,72 +9,81 @@ class TestLeanback < Test::Unit::TestCase
 
 
   should "create a database if it doesn't already exist" do
-	hash = Couchdb.create 'staff'
-	puts hash.inspect
+       hash = Couchdb.create 'staff'
+	#puts hash.inspect
   end
 
  should "create a database if it doesn't already exist" do
 	hash = Couchdb.create 'contacts'
-	puts hash.inspect
+	#puts hash.inspect
   end
 
-  #should "return error message illegal database name" do
- #	hash = Couchdb.create 'more books'
-#	puts hash.inspect
- # end
 
-  should "return a document by ID" do
+  should "view document doc" do
         
-        doc = {:database => 'monitors', :doc_id => 'ee6f4f65-2b5b-4452-a9c4-fd9d860ec17d'}
-        hash = Couchdb.find doc
-        puts hash.inspect
+        doc = {:database => 'monitors', :doc_id => '3-d71c8ee21d6753896f2d08f57a985e94'}
+        hash = Couchdb.view doc
+        #puts hash.inspect
+  end
+
+  should "Query a permanent view" do
+    view = { :database => "contacts", :design_doc => 'more_views', :view => 'get_email'}
+    puts 'viewing design doc...'
+    hash = Couchdb.find view 
+    puts hash.inspect
+  end
+
+  should "Create a design doc/permanent view" do
+    doc = { :database => 'contacts', :design_doc => 'more_views', :json_doc => '/home/obi/bin/leanback/test/my_views.json' }
+     hash = Couchdb.create_design doc
+     #puts hash.inspect
   end
 
   should "return a display a list of all databases" do
       databases = Couchdb.all
-        databases.each do |db_name| 
-           puts db_name
+       databases.each do |db_name| 
+           #puts db_name
         end
    end
 
    should "delete a database" do 
        hash = Couchdb.delete 'staff'
-       puts hash.inspect
+       #puts hash.inspect
    end
 
   should "create a document" do 
-        data = {:firstname => 'Mary', :lastname =>'smith', :phone => '212-234-1234',:email =>'john@mail.com'}
-         doc = {:database => 'contacts', :doc_id => 'Mary', :data => data}
+        data = {:firstname => 'Nancy', :lastname =>'Lee', :phone => '347-808-3734',:email =>'nancy@mail.com',:gender => 'female'}
+         doc = {:database => 'contacts', :doc_id => 'Nancy', :data => data}
          hash = Document.create doc
-         puts hash.inspect    
+         #puts hash.inspect    
   end
 
  should "edit a document" do 
          data = {:firstname => 'john', :lastname =>'smith', :email => 'john@mail.com',:gender=>'male', :_rev=>'2-e813a0e902e3ac114400ff3959a2adde'}
          doc = {:database => 'contacts', :doc_id => 'john', :data => data}
          hash = Document.edit doc
-         puts hash.inspect    
+         #puts hash.inspect    
   end
 
    should "delete a document" do 
          doc = {:database => 'contacts', :doc_id => 'john', :rev => '3-be02e80490f8e9e610d9a9e33d752316'}
          hash = Document.delete doc
-         puts hash.inspect
+         #puts hash.inspect
    end
 
    should "display all documents in the database" do 
       docs = Couchdb.docs_from 'monitors'
-       
+       puts 'docs = Couchdb.docs_from monitors'
       docs.each do |d| 
-          puts d["_rev"]
-          puts d["_id"]    
-          puts d["every"]
-          puts d["monitor"]
-          puts d["url"] 
-          puts d["test"]
-          puts d["contact"]
-          puts d["via"]
-          puts d["notify_interval"]
+         # puts "_rev: " + d["_rev"]
+          #puts "_id: " + d["_id"]    
+          #puts "every: " + d["every"]
+          #puts "monitor: " + d["monitor"]
+          #puts "url: " + d["url"] 
+          #puts "test: " + d["test"]
+          #puts "contact: " + d["contact"]
+          #puts  "via: " + d["via"]
+          #puts "notify_interval: " + d["notify_interval"]
        end
    end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Obi Akubue
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-19 00:00:00 -04:00
+date: 2011-07-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -119,6 +119,7 @@ files:
 - leanback.gemspec
 - lib/leanback.rb
 - test/helper.rb
+- test/my_views.json
 - test/test_leanback.rb
 has_rdoc: true
 homepage: http://github.com/obi-a/leanback
@@ -134,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 609197857
+      hash: 116332943
       segments: 
       - 0
       version: "0"