leanback 0.3.4 → 0.4.0

data/Changelog.rdoc

@@ -1,3 +1,18 @@
+=0.4.0
+June 9, 2013
+* added ability to find documents by multiple keys
+Example:
+ keys = {:gender => 'male',:age => '34'}
+ Couchdb.find_by_keys({:database => 'friends', :keys => keys})
+This will return all documents in the friends database with gender = male and age = 34
+* added the ability to count documents by multiple keys 
+Example:
+ keys = {:gender => 'male',:age => '40'}
+ count = Couchdb.count_by_keys({:database => 'friends', :keys => keys})
+This will return the number of documents in the friends database with gender = male and age = 40.
+See documentation for details.
+ 
+
 =0.3.4
 June 2, 2013
 * added options for manipulating query results, the options available are limit, skip, descending, startkey, endkey

data/README.md

@@ -14,7 +14,7 @@ This project is still under development. Not complete by any means. I made this
 Upgraded and tested on CouchDB 1.2.0. CouchDB 1.0.1 should still work fine. 
 
 ##Changes
-(https://github.com/obi-a/leanback/blob/master/Changelog.rdoc)
+View the [Changelog](https://github.com/obi-a/leanback/blob/master/Changelog.rdoc)
 
 ##Usage
 
@@ -26,9 +26,13 @@ Upgraded and tested on CouchDB 1.2.0. CouchDB 1.0.1 should still work fine.
    + [Basic CouchDB Operations](http://www.whisperservers.com/leanback/basic-couchdb-operations/)
    
    + [Find Documents by Key](http://www.whisperservers.com/leanback/find-documents-by-key/)
+    
+   + [Find Document By Multiple Keys] (http://www.whisperservers.com/leanback/find-document-by-multiple-keys/)
 
    + [Count Documents by Key](http://www.whisperservers.com/leanback/count-documents-by-key/)
 
+   + [Count Documents by Multiple Keys] (http://www.whisperservers.com/leanback/count-by-multiple-documents/)
+
    + Working with [CouchDB Views](http://www.whisperservers.com/leanback/design-documents-and-permanent-views/)
 
    + [Error Handling](http://www.whisperservers.com/leanback/error-handling/)

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/leanback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "leanback"
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]
-  s.date = "2013-06-02"
+  s.date = "2013-06-09"
   s.description = "lightweight Ruby interface to CouchDB"
   s.email = "obioraakubue@yahoo.com"
   s.extra_rdoc_files = [

data/lib/leanback.rb

@@ -396,6 +396,62 @@ def self.add_finder(options,auth_session = "")
  end
 end
 
+#add a multiple finder method to the database
+#this creates a find by keys method
+def self.add_multiple_finder(options,auth_session = "")
+ set_address 
+ db_name = options[:database]
+ keys = options[:keys]
+ view_name = keys.join("_")
+ key = keys.join(",doc.")
+ condition = keys.join(" && doc.")
+ design_doc_name = view_name + '_keys_finder'
+
+ view = '{
+ "language" : "javascript",
+ "views" :{
+    "find_by_keys_'+view_name+'" : {
+      "map" : "function(doc){ if(doc.'+condition+') emit([doc.'+key+'],doc);}"
+    }
+ }
+}' 
+
+ begin  
+  response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, view, {:cookies => {"AuthSession" => auth_session}}
+ rescue => e
+    hash = Yajl::Parser.parse(e.response.to_s)
+    raise CouchdbException.new(hash), "CouchDB: Error - " + hash.values[0] + ". Reason - "  + hash.values[1]
+ end
+end
+
+#add a multiple counter method to the database
+#this creates a count by keys method
+def self.add_multiple_counter(options,auth_session = "")
+ set_address 
+ db_name = options[:database]
+ keys = options[:keys]
+ view_name = keys.join("_")
+ key = keys.join(",doc.")
+ condition = keys.join(" && doc.")
+ design_doc_name = view_name + '_keys_counter'
+
+ view = '{
+ "language" : "javascript",
+ "views" :{
+    "count_by_keys_'+view_name+'" : {
+      "map" : "function(doc){ if(doc.'+condition+') emit([doc.'+key+'],null);}", "reduce": "_count"
+    }
+ }
+}' 
+
+ begin  
+  response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, view, {:cookies => {"AuthSession" => auth_session}}
+ rescue => e
+    hash = Yajl::Parser.parse(e.response.to_s)
+    raise CouchdbException.new(hash), "CouchDB: Error - " + hash.values[0] + ". Reason - "  + hash.values[1]
+ end
+end
+
 #add a counter method to the database
 #this creates a count method that counts documents by key
 def self.add_counter(options,auth_session = "")
@@ -443,6 +499,40 @@ def self.count(options,auth_session = "")
  return count.to_i
 end
 
+#count by keys
+#example: 
+#hash = {:firstname =>'john', :gender => 'male' }
+#Couchdb.count_by_keys({:database => 'contacts', :keys => hash},auth_session)
+def self.count_by_keys(options,auth_session = "", params = {})
+ set_address
+ db_name = options[:database]
+ keys = []
+ search_term = []
+ hash = options[:keys]
+
+ hash.each do |k,v|
+  keys << k
+  search_term << v
+ end
+ index = keys.join("_")
+ design_doc_name = index + '_keys_counter'
+ view_name = 'count_by_keys_' + index
+ params[:startkey] = search_term
+ params[:endkey] = search_term
+ 
+ begin 
+  view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
+  docs = find view,auth_session,key=nil,params
+ rescue CouchdbException => e
+    #add a finder/index if one doesn't already exist in the database
+    #then find_by_keys
+    add_multiple_counter({:database => db_name, :keys => keys},auth_session)
+    docs = find view,auth_session,key=nil,params
+ end
+ count = docs[0]
+ return count.to_i
+end
+
 #find by key 
 def self.find_by(options,auth_session = "", params = {})
  set_address 
@@ -464,6 +554,39 @@ def self.find_by(options,auth_session = "", params = {})
  return docs
 end
 
+#find by keys
+#example: 
+#hash = {:firstname =>'john', :gender => 'male' }
+#Couchdb.find_by_keys({:database => 'contacts', :keys => hash},auth_session)
+def self.find_by_keys(options,auth_session = "", params = {})
+ set_address
+ db_name = options[:database]
+ keys = []
+ search_term = []
+ hash = options[:keys]
+
+ hash.each do |k,v|
+  keys << k
+  search_term << v
+ end
+ index = keys.join("_")
+ design_doc_name = index + '_keys_finder'
+ view_name = 'find_by_keys_' + index
+ params[:startkey] = search_term
+ params[:endkey] = search_term
+ 
+ begin 
+  view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
+  docs = find view,auth_session,key=nil,params
+ rescue CouchdbException => e
+    #add a finder/index if one doesn't already exist in the database
+    #then find_by_keys
+    add_multiple_finder({:database => db_name, :keys => keys},auth_session)
+    docs = find view,auth_session,key=nil,params
+ end
+ return docs
+end
+
  #return a list of all docs in the database
 def self.docs_from(database_name,auth_session = "")
   set_address

data/spec/admin_party/database_spec.rb

@@ -64,6 +64,39 @@ it "find items by key" do
     Couchdb.delete_doc({:database => 'friends', :doc_id => '_design/lastname_finder'})
 end
 
+it "should find items by multiple keys" do
+ keys = {:gender => 'male',:age => '34'}
+ docs = Couchdb.find_by_keys({:database => 'friends', :keys => keys})
+ d = docs[0]
+ d["age"].should == "34"
+end
+
+it "should find items by multiple keys using a single key" do
+ keys = {:lastname => 'smith'}
+ docs = Couchdb.find_by_keys({:database => 'friends', :keys => keys})
+ d = docs[0]
+ d["lastname"].should == "smith"
+end
+
+it "should find items by multiple keys" do
+ keys = {:gender => 'male',:age => '40'}
+ docs = Couchdb.find_by_keys({:database => 'friends', :keys => keys})
+ docs.should == []
+end
+
+it "should count items by multiple keys" do
+ keys = {:gender => 'male',:age => '34'}
+ count = Couchdb.count_by_keys({:database => 'friends', :keys => keys})
+ count.should == 1
+end
+
+it "should count items by multiple keys" do
+ keys = {:gender => 'male',:age => '40'}
+ count = Couchdb.count_by_keys({:database => 'friends', :keys => keys})
+ count.should == 0
+end
+
+
 it "should query a permanent view that doesn't exist and handle exception" do
   begin
      view = { :database => "friends", :design_doc => 'more_views', :view => 'get_user_email'}
@@ -205,6 +238,13 @@ it "should test finder options" do
   data = {:firstname => 'sam', :gender =>'male', :age => '28', :salary => '97000'}
   doc = {:database => 'fishes', :doc_id => 'sam', :data => data}
   Couchdb.create_doc doc
+
+
+ keys = {:age =>'28', :gender => 'male'}
+ hash = Couchdb.find_by_keys({:database => 'fishes', :keys => keys},'', options = {:limit => 2, :skip => 1})
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
   
   #create the design doc to be queryed in the test
   Couchdb.find_by({:database => 'fishes', :gender => 'male'})

data/spec/no_admin_party/database_spec.rb

@@ -70,6 +70,37 @@ it "find items by key" do
     Couchdb.delete_doc({:database => 'contacts', :doc_id => '_design/lastname_finder'},@@auth_session)
 end
 
+it "should find items by multiple keys" do
+ keys = {:gender => 'male',:age => '34'}
+ docs = Couchdb.find_by_keys({:database => 'contacts', :keys => keys},@@auth_session)
+ d = docs[0]
+ d["age"].should == "34"
+end
+
+it "should find items by multiple keys using a single key" do
+ keys = {:lastname => 'smith'}
+ docs = Couchdb.find_by_keys({:database => 'contacts', :keys => keys},@@auth_session)
+ d = docs[0]
+ d["lastname"].should == "smith"
+end
+
+it "should find items by multiple keys" do
+ keys = {:gender => 'male',:age => '40'}
+ docs = Couchdb.find_by_keys({:database => 'contacts', :keys => keys},@@auth_session)
+ docs.should == []
+end
+
+it "should count items by multiple keys" do
+ keys = {:gender => 'male',:age => '34'}
+ count = Couchdb.count_by_keys({:database => 'contacts', :keys => keys},@@auth_session)
+ count.should == 1
+end
+
+it "should count items by multiple keys" do
+ keys = {:gender => 'male',:age => '40'}
+ count = Couchdb.count_by_keys({:database => 'contacts', :keys => keys},@@auth_session)
+ count.should == 0
+end
 
 
 
@@ -213,6 +244,13 @@ it "should test finder options" do
   data = {:firstname => 'sam', :gender =>'male', :age => '28', :salary => '97000'}
   doc = {:database => 'fishes', :doc_id => 'sam', :data => data}
   Couchdb.create_doc doc,@@auth_session
+
+
+ keys = {:age =>'28', :gender => 'male'}
+ hash = Couchdb.find_by_keys({:database => 'fishes', :keys => keys},@@auth_session, options = {:limit => 2, :skip => 1})
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
   
   #create the design doc to be queryed in the test
   Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session)
@@ -421,7 +459,7 @@ it "should switch to default bind address" do
      data = {:section => "httpd",
               :key => "port",
                 :value => "5984" }
-     Couchdb.set_config(data,@@auth_session)
+    Couchdb.set_config(data,@@auth_session)
   
     #Couchdb.address = nil
     #Couchdb.port = nil

data/test/main.rb

@@ -44,7 +44,7 @@ view = { :database => "zralph1369728249zeb1292e18b998352",
 view = { :database => "monitors", 
           :design_doc => 'test_finder', 
             :view => 'find_by_test'}
-hash = Couchdb.find view,auth_session,key=nil, options = {:startkey => ["1000","UP"], :endkey => ["6000","UP"]}
+#hash = Couchdb.find view,auth_session,key=nil, options = {:startkey => ["1000","UP"], :endkey => ["6000","UP"]}
 
 #hash = Couchdb.find view,auth_session,key=nil, options = {:startkey => ["3300","UP"],:descending => true}
 
@@ -54,6 +54,33 @@ hash = Couchdb.find view,auth_session,key=nil, options = {:startkey => ["1000","
 
 #hash = Couchdb.find view,auth_session,key= '?keys=%5B%228800%22,%22UP%22%5D'
 
+keys = {:tag =>'ralph', :via => 'ses' }
+hash = Couchdb.find_by_keys({:database => 'monitors', :keys => keys},auth_session)
+
+#keys = {:tag =>'ralph', :via => 'ses' }
+#num = Couchdb.count_by_keys({:database => 'monitors', :keys => keys},auth_session)
+
+#keys = {:tag =>'ralph', :via => 'ses', :every => '1m'}
+#hash = Couchdb.find_by_keys({:database => 'monitors', :keys => keys},auth_session, options = {:limit => 1, :skip => 1})
+
+#keys = {:tag =>'ralph', :via => 'ses', :every => '5m'}
+#num = Couchdb.count_by_keys({:database => 'monitors', :keys => keys},auth_session)
+
+#keys = {:tag => 'ralph'}
+#hash = Couchdb.find_by_keys({:database => 'monitors', :keys => keys},auth_session)
+
+#keys = {:tag => 'ralph'}
+#num = Couchdb.count_by_keys({:database => 'monitors', :keys => keys},auth_session)
+
+
+#Couchdb.add_multiple_finder({:database => "monitors", :keys => ["tag","via"]},auth_session)
+
+#Couchdb.add_multiple_finder({:database => "monitors", :keys => ["tag","via","state"]},auth_session)
+
+#Couchdb.add_multiple_finder({:database => "monitors", :keys => ["tag"]},auth_session)
+
+#puts num.to_s
+
 puts hash.inspect
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leanback
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -167,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 887863200366044810
+      hash: -3576361140829374907
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: