leanback 0.1.8 → 0.2.0

data/README.rdoc

@@ -77,6 +77,63 @@ Retrieve all documents in a database
   puts d["phone"]
  end  
 
+===To Find documents by key
+First add a finder/index to the database. Let's say we want to add an index to quickly search the database by an email value.
+ Couchdb.add_finder(:database => 'contacts', :key => 'email')
+
+We have just added a find_by_email index to the database.
+
+Now 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"}]
+
+====How the Find by key works
+The method
+ Couchdb.add_finder(:database => 'contacts', :key => 'email') 
+creates a new design document in the contacts database called _design/email_finder with a view called find_by_email
+ {
+   "_id": "_design/email_finder",
+   "_rev": "7-da7f3c0bf183f4a36a82013bd0ea6537",
+   "language": "javascript",
+   "views": {
+       "find_by_email": {
+           "map": "function(doc){
+              if(doc.email)          
+                  emit(doc.email,doc); 
+                 }"
+       }
+   }
+ }
+
+The method
+ Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
+will query the find_by_email view created above, with a
+ GET http://127.0.0.1:5984/contacts/_design/email_finder/_view/find_by_email?key="nancy@mail.com"
+This returns all contacts with email = 'nancy@mail.com'.
+Leanback parses the native JSON results to return only the data values.
+
+====Usage
+You also can do 
+  docs = Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
+     docs.each do |d| 
+ 	puts d["_rev"]
+ 	puts d["_id"]    
+ 	puts d["firstname"]
+ 	puts d["lastname"]
+ 	puts d["email"] 
+ 	puts d["phone"]
+    end
+
+ # => rev1-d15a83d2a23b495c19df2595b636ecc8
+      Nancy
+      Nancy
+      Lee
+      nancy@mail.com
+      347-808-3734
+
+
+
 ===Query a permanent view
  view = { :database => "contacts", :design_doc => 'my_views', :view => 'get_female_contacts'}
  Couchdb.find view 
@@ -108,7 +165,7 @@ 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' }
- hash = Couchdb.create_design doc 
+ Couchdb.create_design doc 
  # => {"ok"=>true, "id"=>"_design/more_views", "rev"=>"1-d67ae97ff03a98f68ddc300bf9ae5048"}
 
 To query the view
@@ -137,20 +194,17 @@ You can always check this value
 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'
- Couchdb.all
  ...
  Document.address = '192.168.2.16'
  Document.port = '6000'
- docs = Couchdb.docs_from 'contacts'  
+ 
 
 To change it back to default bind address at anytime, simply set the values to nil
  Couchdb.address = nil
  Couchdb.port = nil
- Couchdb.all
  ...
  Document.address = nil
  Document.port = nil
- docs = Couchdb.docs_from 'contacts'  
 
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.2.0

data/leanback.gemspec

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

data/lib/leanback.rb

@@ -71,7 +71,6 @@ module Couchdb
          hash = Yajl::Parser.parse(e.response.to_s)
        end
   end
-  
 
  #delete a database
  def self.delete(database_name)
@@ -109,13 +108,17 @@ def self.view(doc)
 end
 
 #query a permanent view
-def self.find(doc)
+def self.find(doc,key=nil)
  set_address
  db_name = doc[:database]
  design_doc_name = doc[:design_doc]
  view_name = doc[:view]
    begin
+    if key == nil
      response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name
+    else
+     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + URI.escape('?key="' + key + '"')
+    end
      hash = Yajl::Parser.parse(response.to_str)
      rows = hash["rows"]
      count = 0
@@ -125,7 +128,8 @@ def self.find(doc)
      end
      return rows
    rescue => e
-    hash = Yajl::Parser.parse(e.response.to_s)
+    puts e.inspect
+    #hash = Yajl::Parser.parse(e.response.to_s)
    end
 end
 
@@ -153,6 +157,46 @@ def self.create_design(doc)
   end
 end
 
+#add a finder method to the database
+#this creates a find by key method
+def self.add_finder(options)
+ set_address 
+ db_name = options[:database]
+ key = options[:key] 
+ design_doc_name = key + '_finder'
+ 
+ view ='{
+ "language" : "javascript",
+ "views" :{
+    "find_by_'+key+'" : {
+      "map" : "function(doc){
+         if(doc.'+key+')
+           emit(doc.'+key+',doc);
+        }"
+    }
+ }
+}'
+
+ begin  
+  response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, view, {:content_type => :json, :accept => :json}
+ rescue => e
+    hash = Yajl::Parser.parse(e.response.to_s)
+ end
+end
+
+#find by key 
+def self.find_by(options)
+ set_address 
+ db_name = options[:database]
+ index =  options.keys[1].to_s
+ search_term = options.values[1]
+ design_doc_name = index + '_finder'
+ view_name = 'find_by_' + index
+  
+ view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
+ find view,search_term
+end
+
  #return a list of all docs in the database
 def self.docs_from(database_name)
   set_address

data/test/test_leanback.rb

@@ -18,6 +18,15 @@ class TestLeanback < Test::Unit::TestCase
 	#puts hash.inspect
   end
 
+  should "add a finder method to the database" do
+       hash = Couchdb.add_finder(:database => 'contacts', :key => 'email') 
+       #puts hash.inspect
+  end
+
+ should "find items by key" do
+     docs = Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
+     puts docs.inspect
+ end
 
   should "view document doc" do
         
@@ -30,7 +39,7 @@ class TestLeanback < Test::Unit::TestCase
     view = { :database => "contacts", :design_doc => 'more_views', :view => 'get_email'}
     puts 'viewing design doc...'
     hash = Couchdb.find view 
-    puts hash.inspect
+    #puts  hash.inspect
   end
 
   should "Create a design doc/permanent view" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Obi Akubue
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-04 00:00:00 -04:00
+date: 2011-07-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 116332943
+      hash: 929290637
       segments: 
       - 0
       version: "0"