leanback 0.2.8 → 0.3.0

data/Changelog.rdoc

@@ -1,3 +1,15 @@
+=Leanback 0.3.0
+Nvember 20,2011
+* Added CouchDB Security features: working with admin and non-admin users, authentication, adding security objects to databases. See documentation for details.
+
+November 9,2011:-
+* Added support for couchDB configuration API. It's now possible to change/modify/delete any couchDB configuration settings with Leanback. README will soon be updated with details.
+  
+
+November 3, 2011:-
+* Changed all the syntax for working with documents (creating, editing, updating and deleting documents now use a new syntax) See README for the change. Document::Module has been removed, it's methods are now part of Couchdb::Module. 
+    
+
 =Leanback 0.2.7
 August 4, 2011:-
 * Added ability to Query a permanent view and create it on the fly from a json file, if it doesn't already exist and then return the values

data/Gemfile

@@ -13,4 +13,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem "rspec"
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: http://rubygems.org/
   remote: http://gemcutter.org/
   specs:
+    diff-lcs (1.1.2)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -12,6 +13,14 @@ GEM
     rcov (0.9.9)
     rest-client (1.6.1)
       mime-types (>= 1.16)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     shoulda (2.11.3)
     yajl-ruby (0.8.2)
 
@@ -23,5 +32,6 @@ DEPENDENCIES
   jeweler (~> 1.5.2)
   rcov
   rest-client
+  rspec
   shoulda
   yajl-ruby

data/README.md

@@ -0,0 +1,39 @@
+###Leanback
+
+Simple Ruby Interface to CouchDB. 
+
+This project is still under development. Not complete by any means. I made this Gem to use in my projects. I will expose more CouchDB features soon.
+
+##Goals
+* To create a simple Ruby Interface to CouchDB
+* Expose the features of CouchDB to the Ruby Lang., 
+* Use a minimalist Ruby DSL to access CouchDB
+* provide a very easy way to persist and retrieve data
+
+##Usage
+
+
+* [Leanback](http://www.whisperservers.com/leanback/leanback/)
+
+   + [Installation](http://www.whisperservers.com/leanback/leanback/installation/) 
+ 
+   + [Basic CouchDB Operations](http://www.whisperservers.com/leanback/basic-couchdb-operations/)
+
+   + Working with [CouchDB Views](http://www.whisperservers.com/leanback/design-documents-and-permanent-views/)
+
+   + [Error Handling](http://www.whisperservers.com/ragios/ragios-saint-ruby/status-reports/)
+   
+   + [CouchDB Configuration](http://www.whisperservers.com/leanback/couchdb-configuration/) 
+   
+   + [CouchDB Security](http://www.whisperservers.com/leanback/couchdb-security/) 
+   
+   + [CouchDB Bind_Address & Port](http://www.whisperservers.com/leanback/setting-the-bind_address-port/) 
+
+##License
+MIT License.
+
+##Copyright
+
+Copyright (c) 2011 Obi Akubue. 
+
+

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.3.0

data/leanback.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leanback}
-  s.version = "0.2.8"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Obi Akubue"]
-  s.date = %q{2011-09-14}
+  s.authors = [%q{Obi Akubue}]
+  s.date = %q{2011-11-21}
   s.description = %q{lightweight Ruby interface to CouchDB}
   s.email = %q{obioraakubue@yahoo.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -22,27 +22,36 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "leanback.gemspec",
     "lib/leanback.rb",
+    "spec/admin_party/database_spec.rb",
+    "spec/no_admin_party/database_spec.rb",
+    "spec/no_admin_party/non_admin_user_spec.rb",
+    "spec/spec_base.rb",
     "test/helper.rb",
+    "test/main.rb",
     "test/my_views.json",
     "test/test_leanback.rb"
   ]
   s.homepage = %q{http://github.com/obi-a/leanback}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{lightweight Ruby interface to CouchDB}
   s.test_files = [
+    "spec/admin_party/database_spec.rb",
+    "spec/no_admin_party/database_spec.rb",
+    "spec/no_admin_party/non_admin_user_spec.rb",
+    "spec/spec_base.rb",
     "test/helper.rb",
+    "test/main.rb",
     "test/test_leanback.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
@@ -52,6 +61,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<yajl-ruby>, [">= 0"])
@@ -59,6 +69,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<rest-client>, [">= 0"])
@@ -67,6 +78,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/lib/leanback.rb

@@ -9,18 +9,129 @@ class CouchdbException < RuntimeError
   end
 end
 
+module Couchdb
+
+#add a new user 
+def self.add_user(user, auth_session="")
+  o =  [('a'..'z'),('A'..'Z')].map{|i| i.to_a}.flatten;  
+  salt  =  (0..50).map{ o[rand(o.length)]  }.join; 
+  new_user = {:username => user[:username], :password => user[:password], :roles => user[:roles], :salt => salt}
+  create_user(new_user,auth_session)
+end
 
-module Document
+#create a new user 
+def self.create_user(user,auth_session= "")
+  password_sha = Digest::SHA1.hexdigest(user[:password] + user[:salt])              
   
-  #create a document 
-  def self.create( doc)  
+  user_hash = { :type => "user",
+                   :name => user[:username],
+                   :password_sha => password_sha,
+                   :salt => user[:salt],
+                   :roles => user[:roles]
+                  }
+   
+   str = Yajl::Encoder.encode(user_hash)
+   set_address
+   begin
+    response = RestClient.put 'http://' + @address + ':' + @port + '/_users/org.couchdb.user:' + URI.escape(user[:username]), str,{:cookies => {"AuthSession" => auth_session}}
+    hash = Yajl::Parser.parse(response.to_str)
+  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 security object
+def self.set_security(db_name, data,auth_session="")
+  security_data = Yajl::Encoder.encode(data)
+  set_address
+  begin
+  response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/_security/',security_data, {:cookies => {"AuthSession" => auth_session}}
+  hash = Yajl::Parser.parse(response.to_str)
+  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
+#get security object
+def self.get_security(db_name, auth_session="")
+ set_address
+ begin
+  response = RestClient.get 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/_security/', {:cookies => {"AuthSession" => auth_session}}
+  hash = Yajl::Parser.parse(response.to_str)
+  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
+
+
+#login to couchdb
+def self.login(username, password)
+  set_address
+  data = 'name=' + username + '&password=' + password
+  begin
+   response = RestClient.post 'http://' + @address + ':' + @port + '/_session/', data, {:content_type => 'application/x-www-form-urlencoded'}
+   response.cookies
+  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
+
+#couchdb configuration api
+def self.set_config(data,auth_session = "") 
+  section = data[:section]
+  key = data[:key] 
+  value = data[:value]
+  json_data = Yajl::Encoder.encode(value)
+  set_address
+  begin
+   response = RestClient.put 'http://' + @address + ':' + @port + '/_config/' + URI.escape(section) + '/' + URI.escape(key),json_data, {:cookies => {"AuthSession" => auth_session}}
+   hash = Yajl::Parser.parse(response.to_str)
+  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
+
+def self.delete_config(data,auth_session = "") 
+  section = data[:section]
+  key = data[:key] 
+  set_address
+  begin
+   response = RestClient.delete 'http://' + @address + ':' + @port + '/_config/' + URI.escape(section) + '/' + URI.escape(key), {:cookies => {"AuthSession" => auth_session}}
+   hash = Yajl::Parser.parse(response.to_str)
+  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
+
+
+def self.get_config(data,auth_session = "") 
+  section = data[:section]
+  key = data[:key] 
+  set_address
+  begin
+   response = RestClient.get 'http://' + @address + ':' + @port + '/_config/' + URI.escape(section) + '/' + URI.escape(key), {:cookies => {"AuthSession" => auth_session}}
+   hash = Yajl::Parser.parse(response.to_str)
+  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
+
+#create a document 
+  def self.create_doc( doc,auth_session = "")  
       db_name =  doc[:database]
       doc_id = doc[:doc_id]
       data = doc[:data]
       json_data = Yajl::Encoder.encode(data)
       set_address
       begin
-         response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/' + URI.escape(doc_id),json_data, {:content_type => :json, :accept => :json}
+         response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/' + URI.escape(doc_id),json_data, {:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
        rescue => e
          hash = Yajl::Parser.parse(e.response.to_s)
@@ -29,14 +140,14 @@ module Document
   end
 
   #edit a document
-  def self.edit(doc)
+  def self.edit_doc(doc,auth_session = "")
       db_name = doc[:database]
       doc_id = doc[:doc_id]
       data = doc[:data]
       json_data = Yajl::Encoder.encode(data)
       set_address
       begin
-        response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/' + URI.escape(doc_id), json_data, {:content_type => :json, :accept => :json}
+        response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(db_name) + '/' + URI.escape(doc_id), json_data, {:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
        rescue => e
          hash = Yajl::Parser.parse(e.response.to_s)
@@ -45,36 +156,36 @@ module Document
   end
 
  #update a doc
- def self.update (doc)
+ def self.update_doc(doc,auth_session = "")
       db_name = doc[:database]
       doc_id = doc[:doc_id]
       data = doc[:data]
       doc = {:database => db_name, :doc_id => doc_id}
-      options = Couchdb.view doc 
+      options = Couchdb.view doc,auth_session 
       options = options.merge(data)
       doc = {:database => db_name, :doc_id => doc_id, :data => options}
-      edit doc
+      edit_doc doc,auth_session
  end
 
 #delete document
- def self.delete(doc)  
+ def self.delete_doc(doc,auth_session = "")  
    db_name = doc[:database]
    doc_id = doc[:doc_id]
    doc = {:database => db_name, :doc_id => doc_id}
-   hash = Couchdb.view doc
+   hash = Couchdb.view doc,auth_session
    doc = {:database => db_name, :doc_id => doc_id, :rev => hash["_rev"]}
-   delete_rev doc
+   delete_rev(doc,auth_session)
  end
 
 
  #delete a doc by rev#
- def self.delete_rev(doc)
+ def self.delete_rev(doc,auth_session = "")
    db_name = doc[:database]
    doc_id = doc[:doc_id]
    rev = doc[:rev]
    set_address
    begin 
-    response = RestClient.delete 'http://' + @address + ':' + @port + '/' + URI.escape(db_name)  + '/' + URI.escape(doc_id) + '?rev=' + rev, {:content_type => :json}
+    response = RestClient.delete 'http://' + @address + ':' + @port + '/' + URI.escape(db_name)  + '/' + URI.escape(doc_id) + '?rev=' + rev, {:cookies => {"AuthSession" => auth_session}}
       hash = Yajl::Parser.parse(response.to_str)
     rescue => e
      hash = Yajl::Parser.parse(e.response.to_s)
@@ -82,24 +193,12 @@ module Document
     end
  end
 
-   class << self
-       attr_accessor :address 
-       attr_accessor :port 
-     def set_address
-      if @address == nil && port == nil
-         @address = '127.0.0.1'
-         @port = '5984'
-      end 
-     end
-  end
-end
 
-module Couchdb
   #create a database if one with the same name doesn't already exist
-  def self.create(database_name)
+  def self.create(database_name,auth_session = "")
        set_address
        begin
-         response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:content_type => :json}
+         response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:content_type => :json},{:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
        rescue => e
          hash = Yajl::Parser.parse(e.response.to_s)
@@ -108,10 +207,10 @@ module Couchdb
   end
 
  #delete a database
- def self.delete(database_name)
+ def self.delete(database_name,auth_session = "")
       set_address
        begin
-         response = RestClient.delete 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:content_type => :json}
+         response = RestClient.delete 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
        rescue => e
          hash = Yajl::Parser.parse(e.response.to_s)
@@ -120,10 +219,10 @@ module Couchdb
  end
 
  #return a list of all databases
- def self.all
+ def self.all(auth_session = "")
       set_address
        begin
-         response = RestClient.get 'http://' + @address + ':' + @port + '/_all_dbs', {:content_type => :json}
+         response = RestClient.get 'http://' + @address + ':' + @port + '/_all_dbs', {:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
        rescue => e
            raise e
@@ -131,12 +230,12 @@ module Couchdb
  end
 
 ##view a document 
-def self.view(doc)
+def self.view(doc,auth_session = "")
  set_address
  db_name = doc[:database]
  doc_id = doc[:doc_id]
   begin
-   response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/' + doc_id
+   response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/' + doc_id,{:cookies => {"AuthSession" => auth_session}}
    hash = Yajl::Parser.parse(response.to_str)
   rescue => e
    hash = Yajl::Parser.parse(e.response.to_s)
@@ -145,16 +244,16 @@ def self.view(doc)
 end
 
 #query a permanent view
-def self.find(doc,key=nil)
+def self.find(doc,auth_session = "",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
+     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name,{:cookies => {"AuthSession" => auth_session}}
     else
-     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + URI.escape('?key="' + key + '"')
+     response = RestClient.get 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name + '/_view/' + view_name + URI.escape('?key="' + key + '"'),{:cookies => {"AuthSession" => auth_session}}
     end
      hash = Yajl::Parser.parse(response.to_str)
      rows = hash["rows"]
@@ -172,7 +271,7 @@ def self.find(doc,key=nil)
 end
 
 #create a design document with views
-def self.create_design(doc)
+def self.create_design(doc,auth_session = "")
  set_address
  db_name = doc[:database]
  design_doc_name = doc[:design_doc]
@@ -188,7 +287,7 @@ def self.create_design(doc)
 
   begin
    
-   response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, str, {:content_type => :json, :accept => :json}
+   response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, str, {:cookies => {"AuthSession" => auth_session}}
     hash = Yajl::Parser.parse(response.to_str)
   rescue => e
     hash = Yajl::Parser.parse(e.response.to_s)
@@ -197,7 +296,7 @@ def self.create_design(doc)
 end
 
 #Query view, create view on fly if it dosen't already exist
-def self.find_on_fly(doc, key = nil)  
+def self.find_on_fly(doc,auth_session = "",key = nil)  
    db_name = doc[:database]
    design_doc = doc[:design_doc]
    view = doc[:view]
@@ -205,17 +304,17 @@ def self.find_on_fly(doc, key = nil)
  
    begin 
       if( key == nil)
-       docs = find(:database => db_name, :design_doc => design_doc, :view => view) 
+       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session) 
       else
-       docs = find({:database => db_name, :design_doc => design_doc, :view => view},key) 
+       docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key) 
       end
      rescue CouchdbException => e
         document = { :database => db_name, :design_doc => design_doc, :json_doc => json_doc}
-        create_design document  
+        create_design document,auth_session
         if( key == nil)
-          docs = find(:database => db_name, :design_doc => design_doc, :view => view) 
+          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session) 
         else
-          docs = find({:database => db_name, :design_doc => design_doc, :view => view},key) 
+          docs = find({:database => db_name, :design_doc => design_doc, :view => view},auth_session,key) 
         end
       end
     return docs
@@ -224,7 +323,7 @@ def self.find_on_fly(doc, key = nil)
 
 #add a finder method to the database
 #this creates a find by key method
-def self.add_finder(options)
+def self.add_finder(options,auth_session = "")
  set_address 
  db_name = options[:database]
  key = options[:key] 
@@ -243,7 +342,7 @@ def self.add_finder(options)
 }'
 
  begin  
-  response = RestClient.put 'http://' + @address + ':' + @port + '/' + db_name + '/_design/' + design_doc_name, view, {:content_type => :json, :accept => :json}
+  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]
@@ -251,7 +350,7 @@ def self.add_finder(options)
 end
 
 #find by key 
-def self.find_by(options)
+def self.find_by(options,auth_session = "")
  set_address 
  db_name = options[:database]
  index =  options.keys[1].to_s
@@ -261,21 +360,21 @@ def self.find_by(options)
  
  begin 
   view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
-  docs = find view,search_term
+  docs = find view,auth_session,search_term
  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)
-    docs = find view,search_term
+    add_finder({:database => db_name, :key => index},auth_session)
+    docs = find view,auth_session,search_term
  end
  return docs
 end
 
  #return a list of all docs in the database
-def self.docs_from(database_name)
+def self.docs_from(database_name,auth_session = "")
   set_address
   begin
-         response = RestClient.get 'http://' + @address + ':' + @port + '/' + URI.escape(database_name) + '/_all_docs?include_docs=true', {:content_type => :json}
+         response = RestClient.get 'http://' + @address + ':' + @port + '/' + URI.escape(database_name) + '/_all_docs?include_docs=true',{:cookies => {"AuthSession" => auth_session}}
          hash = Yajl::Parser.parse(response.to_str)
          rows = hash["rows"]
          count = 0 
@@ -294,9 +393,12 @@ end
  class << self
        attr_accessor :address 
        attr_accessor :port 
+
      def set_address()
-      if @address == nil && port == nil
+      if @address == nil 
          @address = '127.0.0.1'
+      end
+      if @port == nil
          @port = '5984'
       end 
      end