leanback 0.4.1 → 0.4.2

data/Changelog.rdoc

@@ -1,7 +1,23 @@
+0.4.2
+November 16, 2013
+* Optionally return documents and query results as hashmaps with symbolized keys
+Example:
+ Couchdb.find_by({:database => 'contacts', :email => 'nancy@mail.com'} ,auth_session, symbolize_keys: true))  
+ # => [{:_id =>"Nancy", :_rev =>"1-d15a83d2a23b495c19df2595b636ecc8", :firstname =>"Nancy", :lastname =>"Lee",
+ #  :phone =>"347-808-3734", :email =>"nancy@mail.com", :gender =>"female"}]
+And
+ Couchdb.find_by({:database => 'contacts', :email => 'nancy@mail.com'} , auth_session, symbolize_keys: true)  
+
+ # => [{:_id=>"Nancy", :_rev=>"1-d15a83d2a23b495c19df2595b636ecc8", :firstname =>"Nancy", :lastname =>"Lee",
+ #  :phone =>"347-808-3734", :email =>"nancy@mail.com", :gender =>"female"}] 
+ 
+This works for view document results and also works for all finders and queries. See documentation for details. 
+
 0.4.1
 August 23,2013
 * Changed bind address to require prefix (http:// or https://)
-Example: Couchdb.address = "http://whisperservers.cloudant.com" 
+Example: 
+ Couchdb.address = "http://whisperservers.cloudant.com" 
 See documentation for details
 
 =0.4.0

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/leanback.gemspec

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

data/lib/leanback.rb

@@ -238,13 +238,13 @@ module Couchdb
   end
 
   ##view a document 
-  def self.view(doc,auth_session = "")
+  def self.view(doc,auth_session = "", options = {})
     set_address
     db_name = doc[:database]
     doc_id = doc[:doc_id]
     begin
       response = RestClient.get "#{@address}:#{@port}/#{db_name}/#{doc_id}",{:cookies => {"AuthSession" => auth_session}}
-      hash = Yajl::Parser.parse(response.to_str)
+      hash = Yajl::Parser.parse(response.to_str, symbolize_keys(options))
     rescue => e
       couch_error(e)
     end 
@@ -298,14 +298,16 @@ module Couchdb
         key = URI.escape('?key="' + key + '"')
         response = RestClient.get "#{@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"]
-      count = 0
+      hash = Yajl::Parser.parse(response.to_str, symbolize_keys(options))
+      data = []
+      rows = hash["rows"] unless hash["rows"].nil?
+      rows = hash[:rows] unless hash[:rows].nil?
       rows.each do |row|
-        rows[count] = row["value"]
-        count += 1  
+        value = row["value"] unless row["value"].nil?
+        value = row[:value] unless row[:value].nil?
+        data << value 
       end
-      return rows
+      return data
      rescue => e
        couch_error(e)
      end
@@ -340,20 +342,20 @@ module Couchdb
     design_doc = doc[:design_doc]
     view = doc[:view]
     json_doc = doc[:json_doc]
- 
+    query_info = {:database => db_name, :design_doc => design_doc, :view => view}
     begin 
       if( key == nil)
-        docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key=nil,options) 
+        docs = find(query_info,auth_session,key=nil,options) 
       else
-        docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key,options) 
+        docs = find(query_info,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,key=nil,options) 
+        docs = find(query_info,auth_session,key=nil,options) 
       else
-        docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key,options) 
+        docs = find(query_info,auth_session,key,options) 
       end
    end
      return docs
@@ -588,7 +590,13 @@ module Couchdb
       couch_error(e)
     end  
   end
+  
+  def self.symbolize_keys(options)
+    return {symbolize_keys: true} if options[:symbolize_keys]
+    return {}
+  end
 
+  private_class_method :symbolize_keys
 
   class << self
     attr_accessor :address 

data/spec/admin_party/database_spec.rb

@@ -37,14 +37,19 @@ it "should create and view document doc" do
         	 :lastname =>'smith', 
        		 :phone => '202-234-1234',
         	 :email =>'james@mail.com',
-                  :age =>'34',
-                  :gender =>'male'}
+           :age =>'34',
+           :gender =>'male'}
   doc = {:database => 'friends', :doc_id => 'john', :data => data}
   Couchdb.create_doc doc
 
   doc = {:database => 'friends', :doc_id => 'john'}
   hash = Couchdb.view doc
   hash["_id"].should == 'john'
+  
+  #view doc and return symbolized keys
+  doc = {:database => 'friends', :doc_id => 'john'}
+  hash = Couchdb.view(doc,'', {symbolize_keys: true})
+  hash.should include(data)   
 end
 
 it "should count the lastnames named smith" do
@@ -227,8 +232,8 @@ it "should test finder options" do
   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}
+  data_c = {:firstname => 'john', :gender =>'male', :age => '28', :salary => '60000'}
+  doc = {:database => 'fishes', :doc_id => 'john', :data => data_c}
   Couchdb.create_doc doc
 
   data = {:firstname => 'peter', :gender =>'male', :age => '45', :salary => '78000'}
@@ -245,6 +250,10 @@ it "should test finder options" do
  h = hash[0]
  h["firstname"].should == "john"
  hash.length.should == 2
+ 
+  #return hash in symbolized keys for find_by_keys
+  hash = Couchdb.find_by_keys({:database => 'fishes', :keys => keys},'', options = {:limit => 2, :skip => 1, :symbolize_keys => true}) 
+  hash.first.should include(data_c)
   
   #create the design doc to be queryed in the test
   Couchdb.find_by({:database => 'fishes', :gender => 'male'})
@@ -258,13 +267,24 @@ it "should test finder options" do
   h = hash[0]
   h["firstname"].should == "john"
   hash.length.should == 2
+  
+  #return results in symbolized keys
+  hash = Couchdb.find view,'',key=nil, options = {:limit => 2, :skip => 1, :symbolize_keys => true}
+  hash.first.should include(data_c)
+  
+  #it should not return symbolized keys
+  hash = Couchdb.find view,'',key=nil, options = {:limit => 2, :skip => 1, :symbolize_keys => false}
+  hash.first.should_not include(data_c)
+  hash.first["firstname"].should == "john"  
 
  Couchdb.find_by({:database => 'fishes', :gender => 'male'},"",options = {:limit => 2, :skip => 1})
   h = hash[0]
   h["firstname"].should == "john"
   hash.length.should == 2
 
- 
+  #return symbolized results
+  hash = Couchdb.find_by({:database => 'fishes', :gender => 'male'},'',options = {:limit => 2, :skip => 1, :symbolize_keys => true})
+  hash.first.should include(data_c) 
 
  hash = Couchdb.find view,"",key='male', options = {:descending => true}
  h = hash[0]
@@ -338,6 +358,12 @@ it "should test finder options" do
    h0["firstname"].should == "john"
    h1["firstname"].should == "sam"
    hash.length.should == 2
+   
+   
+  #return results as symbolized keys
+  options = {:startkey => ["28","male"], :endkey => ["28","male"], :skip => 1,:symbolize_keys => true}
+  hash = Couchdb.find_on_fly(view,'',key=nil, options)
+  hash.first.should include(data_c)
 
 
  options = {:startkey => ["28","male"], :endkey => ["28","male"]}

data/spec/no_admin_party/database_spec.rb

@@ -39,17 +39,23 @@ it "should create a database add a finder method to it and then delete the datab
 it "should create and view document doc" do
   Couchdb.create('contacts',@@auth_session)
   data = {:firstname => 'John', 
-        	 :lastname =>'smith', 
-       		 :phone => '202-234-1234',
-        	 :email =>'james@mail.com',
-                  :age =>'34',
-                  :gender =>'male'}
+        	:lastname =>'smith', 
+       		:phone => '202-234-1234',
+        	:email =>'james@mail.com',
+          :age =>'34',
+          :gender =>'male'}
+          
   doc = {:database => 'contacts', :doc_id => 'john', :data => data}
   Couchdb.create_doc doc,@@auth_session
 
   doc = {:database => 'contacts', :doc_id => 'john'}
   hash = Couchdb.view doc,@@auth_session
   hash["_id"].should == 'john'
+  
+  #view doc and return symbolized keys
+  doc = {:database => 'contacts', :doc_id => 'john'}
+  hash = Couchdb.view(doc,@@auth_session, {symbolize_keys: true})
+  hash.should include(data)  
 end
 
 it "should count the lastnames named smith" do
@@ -233,8 +239,8 @@ it "should test finder options" do
   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}
+  data_c = {:firstname => 'john', :gender =>'male', :age => '28', :salary => '60000'}
+  doc = {:database => 'fishes', :doc_id => 'john', :data => data_c}
   Couchdb.create_doc doc,@@auth_session
 
   data = {:firstname => 'peter', :gender =>'male', :age => '45', :salary => '78000'}
@@ -248,9 +254,12 @@ it "should test finder options" do
 
  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.first["firstname"].should == "john"
  hash.length.should == 2
+ 
+  #return hash in symbolized keys for find_by_keys
+  hash = Couchdb.find_by_keys({:database => 'fishes', :keys => keys},@@auth_session, options = {:limit => 2, :skip => 1, :symbolize_keys => true}) 
+  hash.first.should include(data_c) 
   
   #create the design doc to be queryed in the test
   Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session)
@@ -261,16 +270,25 @@ it "should test finder options" do
             :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.first["firstname"].should == "john"
   hash.length.should == 2
+  
+  #return results in symbolized keys
+  hash = Couchdb.find view,@@auth_session,key=nil, options = {:limit => 2, :skip => 1, :symbolize_keys => true}
+  hash.first.should include(data_c)
+  
+  #it should not return symbolized keys
+  hash = Couchdb.find view,@@auth_session,key=nil, options = {:limit => 2, :skip => 1, :symbolize_keys => false}
+  hash.first.should_not include(data_c)
+  hash.first["firstname"].should == "john"
 
- Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session,options = {:limit => 2, :skip => 1})
-  h = hash[0]
-  h["firstname"].should == "john"
+  hash = Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session,options = {:limit => 2, :skip => 1})
+  hash.first["firstname"].should == "john"
   hash.length.should == 2
 
- 
+  #return symbolized results
+  hash = Couchdb.find_by({:database => 'fishes', :gender => 'male'},@@auth_session,options = {:limit => 2, :skip => 1, :symbolize_keys => true})
+  hash.first.should include(data_c)   
 
  hash = Couchdb.find view,@@auth_session,key='male', options = {:descending => true}
  h = hash[0]
@@ -344,7 +362,11 @@ it "should test finder options" do
    h0["firstname"].should == "john"
    h1["firstname"].should == "sam"
    hash.length.should == 2
-
+   
+   #return results as symbolized keys
+   options = {:startkey => ["28","male"], :endkey => ["28","male"], :skip => 1,:symbolize_keys => true}
+   hash = Couchdb.find_on_fly(view,@@auth_session,key=nil, options)
+   hash.first.should include(data_c)
 
  options = {:startkey => ["28","male"], :endkey => ["28","male"]}
 

data/spec/no_admin_party/non_admin_user_spec.rb

@@ -1,12 +1,15 @@
 require 'spec_base.rb'
 
+hash = Couchdb.login(username = 'obi',password ='trusted') 
+@@admin_auth_session =  hash["AuthSession"]
+
+user = { :username => "david", :password => "trusted", :roles => []}
+Couchdb.add_user(user, @@admin_auth_session)
+
 #a day in the life of the non-admin user
 hash = Couchdb.login(username = 'david',password ='trusted') 
 @@auth_session =  hash["AuthSession"]
 
-hash = Couchdb.login(username = 'obi',password ='trusted') 
-@@admin_auth_session =  hash["AuthSession"]
-
 #specs to ensure non-admin users function properly
 describe "non admin user" do
  it "should create a document, view, update it" do
@@ -55,7 +58,9 @@ it "should delete document" do
  lambda {Couchdb.view(doc,@@auth_session)}.should raise_error(CouchdbException,"CouchDB: Error - not_found. Reason - deleted")  
 end
 
-it "should delete the database" do
+it "should delete the database and user" do
+  doc = {:database => '_users', :doc_id => 'org.couchdb.user:david'}
+  Couchdb.delete_doc doc,@@admin_auth_session
   Couchdb.delete 'contacts',@@admin_auth_session
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leanback
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -208,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3337391598339047950
+      hash: 3937638598034080075
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: