leanback 0.3.3 → 0.3.4

data/Changelog.rdoc

@@ -1,3 +1,38 @@
+=0.3.4
+June 2, 2013
+* added options for manipulating query results, the options available are limit, skip, descending, startkey, endkey
+Example
+ options = {:skip => 10,:limit => 20}
+ Couchdb.find_by({:database => 'contacts', :gender => 'female'},auth_session, options)
+This will skip the first 10 results and return the next 20 that match the key :gender => 'female'
+
+Another example
+ options = {:startkey => "53000", :endkey => "99000",:limit => 20}
+ Couchdb.find_by({:database => 'employees', :salary => ''},auth_session, options)
+This will return all employees with salary between 53000 and 99000.
+
+Direct view query: 
+   view = { :database => "employees", 
+          :design_doc => 'salary_finder', 
+            :view => 'find_by_salary'}
+ options = {:startkey => "53000", :endkey => "99000"}
+ Couchdb.find view, auth_session,key=nil, options
+This will also return all employees with salary between 53000 and 99000.
+See leanback documentation for details.
+  
+=0.3.3
+May 26, 2013
+* Added ability to count the number of documents in a database by a specified key.
+Example: 
+ Couchdb.count({:database => 'contacts', :gender => 'female'},auth_session) 
+ # => 8
+This will count the number of documents with gender = 'female'
+See leanback documentation for details.
+
+=0.3.2
+December 01, 2012
+* Fixed issues with invalid JSON on CouchDB 1.2.0
+
 =Leanback 0.3.1
 December 5,2011
 * Added ability to change password for non-admin users.

data/README.md

@@ -13,6 +13,9 @@ This project is still under development. Not complete by any means. I made this
 ##Compatibility
 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)
+
 ##Usage
 
 
@@ -24,6 +27,8 @@ Upgraded and tested on CouchDB 1.2.0. CouchDB 1.0.1 should still work fine.
    
    + [Find Documents by Key](http://www.whisperservers.com/leanback/find-documents-by-key/)
 
+   + [Count Documents by Key](http://www.whisperservers.com/leanback/count-documents-by-key/)
+
    + Working with [CouchDB Views](http://www.whisperservers.com/leanback/design-documents-and-permanent-views/)
 
    + [Error Handling](http://www.whisperservers.com/leanback/error-handling/)
@@ -39,6 +44,6 @@ MIT License.
 
 ##Copyright
 
-Copyright (c) 2011 Obi Akubue. 
+Copyright (c) 2013 Obi Akubue. 
 
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/leanback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "leanback"
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]
-  s.date = "2013-05-26"
+  s.date = "2013-06-02"
   s.description = "lightweight Ruby interface to CouchDB"
   s.email = "obioraakubue@yahoo.com"
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     "test/main.rb",
     "test/my_view.json",
     "test/my_views.json",
+    "test/start.json",
     "test/test_leanback.rb",
     "test/view_age.json"
   ]

data/lib/leanback.rb

@@ -258,17 +258,53 @@ def self.view(doc,auth_session = "")
  end 
 end
 
+def self.get_params(options)
+ params = ""
+ if options.has_key?(:startkey)
+  if options[:startkey].is_a? String
+   params = 'startkey="' + options[:startkey] + '"'
+  else
+   params = 'startkey=' + options[:startkey].to_s # for complex keys
+  end
+ end
+ if options.has_key?(:endkey)
+  if options[:endkey].is_a? String
+   params = params + '&endkey="' + options[:endkey] + '"'
+  else
+   params = params + '&endkey=' + options[:endkey].to_s  #for complex keys
+  end
+ end
+
+ if options.has_key?(:limit)
+  params = params + "&" + "limit=" + options[:limit].to_s
+ end
+
+ if options.has_key?(:skip)
+  params = params + "&" + "skip=" + options[:skip].to_s
+ end
+
+  if options.has_key?(:descending)
+  params = params + "&" + "descending=true"
+ end
+
+ return params
+end
+
+
 #query a permanent view
-def self.find(doc,auth_session = "",key=nil)
+def self.find(doc,auth_session = "", key=nil, options = {})
  set_address
  db_name = doc[:database]
  design_doc_name = doc[:design_doc]
  view_name = doc[:view]
+ params = get_params(options)
+   
    begin
     if key == nil
-     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name,{:cookies => {"AuthSession" => auth_session}}
+     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + '?' + URI.escape(params),{:cookies => {"AuthSession" => auth_session}}
     else
-     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + URI.escape('?key="' + key + '"'),{:cookies => {"AuthSession" => auth_session}}
+      key = URI.escape('?key="' + key + '"')
+      response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + key + '&' + URI.escape(params) ,{:cookies => {"AuthSession" => auth_session}}
     end
      hash = Yajl::Parser.parse(response.to_str)
      rows = hash["rows"]
@@ -279,7 +315,6 @@ def self.find(doc,auth_session = "",key=nil)
      end
      return rows
    rescue => e
-    #puts e.inspect
     hash = Yajl::Parser.parse(e.response.to_s)
     raise CouchdbException.new(hash), "CouchDB: Error - " + hash.values[0] + ". Reason - "  + hash.values[1]
    end
@@ -311,7 +346,7 @@ def self.create_design(doc,auth_session = "")
 end
 
 #Query view, create view on fly if it dosen't already exist
-def self.find_on_fly(doc,auth_session = "",key = nil)  
+def self.find_on_fly(doc,auth_session = "",key = nil, options = {})  
    db_name = doc[:database]
    design_doc = doc[:design_doc]
    view = doc[:view]
@@ -319,17 +354,17 @@ def self.find_on_fly(doc,auth_session = "",key = nil)
  
    begin 
       if( key == nil)
-       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session) 
+       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key=nil,options) 
       else
-       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key) 
+       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key,options) 
       end
      rescue CouchdbException => e
         document = { :database => db_name, :design_doc => design_doc, :json_doc => json_doc}
         create_design document,auth_session
         if( key == nil)
-          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session) 
+          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key=nil,options) 
         else
-          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key) 
+          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key,options) 
         end
       end
     return docs
@@ -409,7 +444,7 @@ def self.count(options,auth_session = "")
 end
 
 #find by key 
-def self.find_by(options,auth_session = "")
+def self.find_by(options,auth_session = "", params = {})
  set_address 
  db_name = options[:database]
  index =  options.keys[1].to_s
@@ -419,12 +454,12 @@ def self.find_by(options,auth_session = "")
  
  begin 
   view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
-  docs = find view,auth_session,search_term
+  docs = find view,auth_session,search_term,params
  rescue CouchdbException => e
     #add a finder/index if one doesn't already exist in the database
     #then find_by_key
     add_finder({:database => db_name, :key => index},auth_session)
-    docs = find view,auth_session,search_term
+    docs = find view,auth_session,search_term,params
  end
  return docs
 end

data/spec/admin_party/database_spec.rb

@@ -185,6 +185,133 @@ it "should delete a document after creating it" do
     end
 end
 
+
+it "should test finder options" do
+
+  Couchdb.create('fishes')
+
+  data = {:firstname => 'aaron', :gender =>'male', :age => '28', :salary => '50000'}
+  doc = {:database => 'fishes', :doc_id => 'aaron', :data => data}
+  Couchdb.create_doc doc
+
+  data = {:firstname => 'john', :gender =>'male', :age => '28', :salary => '60000'}
+  doc = {:database => 'fishes', :doc_id => 'john', :data => data}
+  Couchdb.create_doc doc
+
+  data = {:firstname => 'peter', :gender =>'male', :age => '45', :salary => '78000'}
+  doc = {:database => 'fishes', :doc_id => 'peter', :data => data}
+  Couchdb.create_doc doc
+
+  data = {:firstname => 'sam', :gender =>'male', :age => '28', :salary => '97000'}
+  doc = {:database => 'fishes', :doc_id => 'sam', :data => data}
+  Couchdb.create_doc doc
+  
+  #create the design doc to be queryed in the test
+  Couchdb.find_by({:database => 'fishes', :gender => 'male'})
+
+
+  view = { :database => "fishes", 
+          :design_doc => 'gender_finder', 
+            :view => 'find_by_gender'}
+
+  hash = Couchdb.find view,"",key=nil, options = {:limit => 2, :skip => 1}
+  h = hash[0]
+  h["firstname"].should == "john"
+  hash.length.should == 2
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},"",options = {:limit => 2, :skip => 1})
+  h = hash[0]
+  h["firstname"].should == "john"
+  hash.length.should == 2
+
+ 
+
+ hash = Couchdb.find view,"",key='male', options = {:descending => true}
+ h = hash[0]
+ h["firstname"].should == "sam"
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},"", options = {:descending => true})
+ h = hash[0]
+ h["firstname"].should == "sam" 
+
+
+
+ hash = Couchdb.find view,"",key='male', options = {:limit => 3}
+ hash.length.should == 3
+
+ hash = Couchdb.find view,"",key=nil, options = {:skip => 2}
+ h = hash[0]
+ h["firstname"].should == "peter"
+ hash.length.should == 2
+
+ hash = Couchdb.find view,"",key='male', options = {:descending => true,:limit => 1}
+ h = hash[0]
+ h["firstname"].should == "sam"
+ hash.length.should == 1
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},"", options = {:descending => true,:limit => 1})
+ h = hash[0]
+ h["firstname"].should == "sam"
+ hash.length.should == 1
+
+ Couchdb.find_by({:database => 'fishes', :salary => '5000'})
+
+
+  view = { :database => "fishes", 
+          :design_doc => 'salary_finder', 
+            :view => 'find_by_salary'}
+
+ hash = Couchdb.find view, "",key=nil, options = {:startkey => "3000", :endkey => "65000"}
+ h = hash[0]
+ h["firstname"].should == "aaron"
+ hash.length.should == 2
+
+ hash = Couchdb.find view, "",key=nil, options = {:startkey => "53000", :endkey => "99000",:limit => 2}
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
+ 
+ Couchdb.find_by({:database => 'fishes', :salary => '5000'},"", options = {:startkey => "53000", :endkey => "99000",:limit => 2})
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
+
+    view = {:database => 'fishes',
+         :design_doc => 'my_views',
+          :view => 'age_gender',
+           :json_doc => '/home/obi/bin/leanback/test/start.json'}
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"], :limit => 2}
+     
+ hash = Couchdb.find_on_fly(view,"",key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "aaron"
+   h1["firstname"].should == "john"
+   hash.length.should == 2
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"], :skip => 1}
+
+  hash = Couchdb.find_on_fly(view,"",key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "john"
+   h1["firstname"].should == "sam"
+   hash.length.should == 2
+
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"]}
+
+  hash = Couchdb.find_on_fly(view,"",key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "aaron"
+   h1["firstname"].should == "john"
+   hash.length.should == 3
+
+ Couchdb.delete 'fishes'
+end
+
 #database: administration tasks
 
 it "should set a config section, retrieve it and delete it" do

data/spec/no_admin_party/database_spec.rb

@@ -194,6 +194,132 @@ it "should delete a document after creating it" do
     end
 end
 
+it "should test finder options" do
+
+  Couchdb.create('fishes',@@auth_session)
+
+  data = {:firstname => 'aaron', :gender =>'male', :age => '28', :salary => '50000'}
+  doc = {:database => 'fishes', :doc_id => 'aaron', :data => data}
+  Couchdb.create_doc doc,@@auth_session
+
+  data = {:firstname => 'john', :gender =>'male', :age => '28', :salary => '60000'}
+  doc = {:database => 'fishes', :doc_id => 'john', :data => data}
+  Couchdb.create_doc doc,@@auth_session
+
+  data = {:firstname => 'peter', :gender =>'male', :age => '45', :salary => '78000'}
+  doc = {:database => 'fishes', :doc_id => 'peter', :data => data}
+  Couchdb.create_doc doc,@@auth_session
+
+  data = {:firstname => 'sam', :gender =>'male', :age => '28', :salary => '97000'}
+  doc = {:database => 'fishes', :doc_id => 'sam', :data => data}
+  Couchdb.create_doc doc,@@auth_session
+  
+  #create the design doc to be queryed in the test
+  Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session)
+
+
+  view = { :database => "fishes", 
+          :design_doc => 'gender_finder', 
+            :view => 'find_by_gender'}
+
+  hash = Couchdb.find view,@@auth_session,key=nil, options = {:limit => 2, :skip => 1}
+  h = hash[0]
+  h["firstname"].should == "john"
+  hash.length.should == 2
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session,options = {:limit => 2, :skip => 1})
+  h = hash[0]
+  h["firstname"].should == "john"
+  hash.length.should == 2
+
+ 
+
+ hash = Couchdb.find view,@@auth_session,key='male', options = {:descending => true}
+ h = hash[0]
+ h["firstname"].should == "sam"
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session, options = {:descending => true})
+ h = hash[0]
+ h["firstname"].should == "sam" 
+
+
+
+ hash = Couchdb.find view,@@auth_session,key='male', options = {:limit => 3}
+ hash.length.should == 3
+
+ hash = Couchdb.find view,@@auth_session,key=nil, options = {:skip => 2}
+ h = hash[0]
+ h["firstname"].should == "peter"
+ hash.length.should == 2
+
+ hash = Couchdb.find view,@@auth_session,key='male', options = {:descending => true,:limit => 1}
+ h = hash[0]
+ h["firstname"].should == "sam"
+ hash.length.should == 1
+
+ Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session, options = {:descending => true,:limit => 1})
+ h = hash[0]
+ h["firstname"].should == "sam"
+ hash.length.should == 1
+
+ Couchdb.find_by({:database => 'fishes', :salary => '5000'},@@auth_session)
+
+
+  view = { :database => "fishes", 
+          :design_doc => 'salary_finder', 
+            :view => 'find_by_salary'}
+
+ hash = Couchdb.find view, @@auth_session,key=nil, options = {:startkey => "3000", :endkey => "65000"}
+ h = hash[0]
+ h["firstname"].should == "aaron"
+ hash.length.should == 2
+
+ hash = Couchdb.find view, @@auth_session,key=nil, options = {:startkey => "53000", :endkey => "99000",:limit => 2}
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
+ 
+ Couchdb.find_by({:database => 'fishes', :salary => ''},@@auth_session, options = {:startkey => "53000", :endkey => "99000",:limit => 2})
+ h = hash[0]
+ h["firstname"].should == "john"
+ hash.length.should == 2
+
+    view = {:database => 'fishes',
+         :design_doc => 'my_views',
+          :view => 'age_gender',
+           :json_doc => '/home/obi/bin/leanback/test/start.json'}
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"], :limit => 2}
+     
+ hash = Couchdb.find_on_fly(view,@@auth_session,key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "aaron"
+   h1["firstname"].should == "john"
+   hash.length.should == 2
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"], :skip => 1}
+
+  hash = Couchdb.find_on_fly(view,@@auth_session,key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "john"
+   h1["firstname"].should == "sam"
+   hash.length.should == 2
+
+
+ options = {:startkey => ["28","male"], :endkey => ["28","male"]}
+
+  hash = Couchdb.find_on_fly(view,@@auth_session,key=nil, options)
+   h0 = hash[0]
+   h1 = hash[1]
+   h0["firstname"].should == "aaron"
+   h1["firstname"].should == "john"
+   hash.length.should == 3
+
+ Couchdb.delete 'fishes',@@auth_session
+end
+
 #database: administration tasks
 
 it "should set a config section, retrieve it and delete it" do

data/test/main.rb

@@ -16,10 +16,53 @@ data = {:section => "admins",
 hash = Couchdb.login(username = 'obi',password ='trusted') 
 auth_session =  hash["AuthSession"]
 
+
+view = { :database => "monitors", 
+          :design_doc => 'tag_finder', 
+            :view => 'find_by_tag'}
+ 
+#hash = Couchdb.find view,auth_session,key='ralph', options = {:limit => 5, :skip => 1}
+
+#hash = Couchdb.find view,auth_session,key='ralph', options = {:limit => 5}
+
+
+#Couchdb.find_by({:database => 'zralph1369728249zeb1292e18b998352', :timestamp => 'Smith'},auth_session)
+
+#Couchdb.find_by({:database => 'monitors', :test => 'Smith'},auth_session)
+
+view = { :database => "zralph1369728249zeb1292e18b998352", 
+          :design_doc => 'timestamp_finder', 
+            :view => 'find_by_timestamp'}
+
+#hash = Couchdb.find view,auth_session,key=nil, options = {:startkey => "100", :endkey => "1369728370"}
+
+#hash = Couchdb.find view,auth_session,key="1369728370"
+
+#start 2013-05-29 20:22:07 -0400 1369873327 
+#end 2013-05-29 20:19:07 -0400 1369873147 
+
+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 => ["3300","UP"],:descending => true}
+
+#hash = Couchdb.find view,auth_session,key=nil, options = {:descending => true}
+
+#hash = Couchdb.find view,auth_session,key= {:keys => ['3300','UP']}
+
+#hash = Couchdb.find view,auth_session,key= '?keys=%5B%228800%22,%22UP%22%5D'
+
+puts hash.inspect
+
+
+###END OF KEYS TESTING########
+
 #user = { :username => "david", :password => "trusted", :roles => []}
 #Couchdb.add_user(user, auth_session )
 
-hash = Couchdb.delete 'staff',auth_session
+#hash = Couchdb.delete 'staff',auth_session
 
 #puts auth_session
 

data/test/start.json

@@ -0,0 +1,8 @@
+{
+ "language" : "javascript",
+ "views" :{
+    "age_gender" : {
+      "map" : "function(doc){ if(doc.age && doc.gender) emit([doc.age, doc.gender],doc); }"
+    }
+ }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leanback
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-26 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -149,6 +149,7 @@ files:
 - test/main.rb
 - test/my_view.json
 - test/my_views.json
+- test/start.json
 - test/test_leanback.rb
 - test/view_age.json
 homepage: http://github.com/obi-a/leanback
@@ -166,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -746348248553049715
+      hash: 887863200366044810
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: