leanback 0.1.6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+source "http://gemcutter.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+    gem "rest-client"
+    gem "yajl-ruby"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  remote: http://gemcutter.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.16)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+    yajl-ruby (0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rest-client
+  shoulda
+  yajl-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Obi Akubue, obi-akubue.org
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,111 @@
+= 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
+
+==Install
+
+ gem install leanback
+
+
+==Usage
+
+Require the leanback Gem
+ require 'leanback'
+ 
+Create a CouchDB database
+ Couchdb.create 'contacts'
+ # => {"ok"=>true}
+
+Delete a database
+ Couchdb.delete 'contacts'
+ # => {"ok"=>true} 
+
+Return a list of all Databases
+ Couchdb.all
+ # => ["maps", "inventory", "monitors", "contacts", "books"]
+
+Create a new document
+ data = {:firstname => 'Linda', 
+         :lastname =>'smith', 
+         :phone => '212-234-1234',
+         :email =>'john@mail.com'}
+
+ doc = {:database => 'contacts', :doc_id => 'Linda', :data => data}
+ Document.create doc
+ # => {"ok"=>true, "id"=>"Linda", "rev"=>"1-6f16274513f51e922ff1f745452a92b6"} 
+This will create a new document in the 'contacts' database, with document id 'Linda'.
+
+Lets edit that document to change the email address, phone number, and add a gender
+ data = {:firstname => 'Linda', 
+         :lastname =>'smith', 
+         :email => 'linda@mail.com',
+         :gender=>'female',
+         :phone =>'718-245-5611',
+         :_rev=>'1-6f16274513f51e922ff1f745452a92b6'}
+
+ doc = {:database => 'contacts', :doc_id => 'Linda', :data => data}
+ Document.edit doc
+ # => {"ok"=>true, "id"=>"Linda", "rev"=>"2-e813a0e902e3ac114400ff3959a2adde"}
+
+Delete the document
+ doc = {:database => 'contacts', :doc_id => 'Linda', :rev => '2-e813a0e902e3ac114400ff3959a2adde'}
+ Document.delete doc
+ # => {"ok"=>true, "id"=>"Linda", "rev"=>"3-48580d1806983b32cb03f114efb064e3"} 
+
+Retrieve all documents in a database
+ docs = Couchdb.docs_from 'contacts'  
+ docs.each do |d| 
+  puts d["_rev"]
+  puts d["_id"]    
+  puts d["firstname"]
+  puts d["lastname"]
+  puts d["email"] 
+  puts d["phone"]
+ end  
+
+Attempting to create a database that already exists
+ Couchdb.create 'contacts'
+ # => {"error"=>"file_exists", "reason"=>"The database could not be created, the file already exists."} 
+
+Attempting to delete a database that no longer exists
+ Couchdb.delete 'more_books'
+ # => {"error"=>"not_found", "reason"=>"missing"} 
+
+Most methods return a hash value unless otherwise specified. When a database transaction goes through successfully most methods will return a hash value # => {"ok" => true ...} and when something goes wrong it returns a hash value # => {"error" => ...}
+
+You can always check this value 
+ hash = Couchdb.delete 'schools'
+ puts hash.inspect
+
+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
+
+Copyright (c) 2011 Obi Akubue. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "leanback"
+  gem.homepage = "http://github.com/obi-a/leanback"
+  gem.license = "MIT"
+  gem.summary = %Q{lightweight Ruby interface to CouchDB}
+  gem.description = %Q{lightweight Ruby interface to CouchDB}
+  gem.email = "obioraakubue@yahoo.com"
+  gem.authors = ["Obi Akubue"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "leanback #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/lib/leanback.rb

@@ -0,0 +1,127 @@
+require 'rest_client'
+require 'yajl'
+
+module Document
+  
+  #create a document 
+  def self.create( doc)  
+      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}
+         hash = Yajl::Parser.parse(response.to_str)
+       rescue => e
+         hash = Yajl::Parser.parse(e.response.to_s)
+       end
+  end
+
+  #edit a document
+  def self.edit(doc)
+      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}
+         hash = Yajl::Parser.parse(response.to_str)
+       rescue => e
+         hash = Yajl::Parser.parse(e.response.to_s)
+      end
+  end
+
+ #delete a doc
+ def self.delete(doc)
+   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}
+      hash = Yajl::Parser.parse(response.to_str)
+    rescue => e
+     hash = Yajl::Parser.parse(e.response.to_s)
+    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)
+       set_address
+       begin
+         response = RestClient.put 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:content_type => :json}
+         hash = Yajl::Parser.parse(response.to_str)
+       rescue => e
+         hash = Yajl::Parser.parse(e.response.to_s)
+       end
+  end
+  
+
+ #delete a database
+ def self.delete(database_name)
+      set_address
+       begin
+         response = RestClient.delete 'http://' + @address + ':' + @port + '/' + URI.escape(database_name), {:content_type => :json}
+         hash = Yajl::Parser.parse(response.to_str)
+       rescue => e
+         hash = Yajl::Parser.parse(e.response.to_s)
+       end 
+ end
+
+ #return a list of all databases
+ def self.all
+      set_address
+       begin
+         response = RestClient.get 'http://' + @address + ':' + @port + '/_all_dbs', {:content_type => :json}
+         hash = Yajl::Parser.parse(response.to_str)
+       rescue => e
+           raise e
+       end
+ end
+
+ #return a list of all docs in the database
+def self.docs_from(database_name)
+  set_address
+  begin
+         response = RestClient.get 'http://' + @address + ':' + @port + '/' + URI.escape(database_name) + '/_all_docs?include_docs=true', {:content_type => :json}
+         hash = Yajl::Parser.parse(response.to_str)
+         rows = hash["rows"]
+         only_rows = []
+         count = 0 
+         rows.each do |row|
+            only_rows[count] = row["doc"]
+            count = count + 1
+          end
+        return only_rows
+  rescue => e
+     hash = Yajl::Parser.parse(e.response.to_s)
+  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

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'leanback' 
+
+class Test::Unit::TestCase
+end

data/test/test_leanback.rb

@@ -0,0 +1,85 @@
+path = File.expand_path(File.dirname(__FILE__))
+
+require path + "/helper.rb"
+
+class TestLeanback < Test::Unit::TestCase
+  #should "probably rename this file and start testing for real" do
+   # flunk "hey buddy, you should probably rename this file and start testing for real"
+  #end
+
+
+  should "create a database if it doesn't already exist" do
+	hash = Couchdb.create 'staff'
+	puts hash.inspect
+  end
+
+ should "create a database if it doesn't already exist" do
+	hash = Couchdb.create 'contacts'
+	puts hash.inspect
+  end
+
+  #should "return error message illegal database name" do
+ #	hash = Couchdb.create 'more books'
+#	puts hash.inspect
+ # end
+
+  should "return a display a list of all databases" do
+      databases = Couchdb.all
+        databases.each do |db_name| 
+           puts db_name
+        end
+   end
+
+   should "delete a database" do 
+       hash = Couchdb.delete 'staff'
+       puts hash.inspect
+   end
+
+  should "create a document" do 
+        data = {:firstname => 'Mary', :lastname =>'smith', :phone => '212-234-1234',:email =>'john@mail.com'}
+         doc = {:database => 'contacts', :doc_id => 'Mary', :data => data}
+         hash = Document.create doc
+         puts hash.inspect    
+  end
+
+ should "edit a document" do 
+         data = {:firstname => 'john', :lastname =>'smith', :email => 'john@mail.com',:gender=>'male', :_rev=>'2-e813a0e902e3ac114400ff3959a2adde'}
+         doc = {:database => 'contacts', :doc_id => 'john', :data => data}
+         hash = Document.edit doc
+         puts hash.inspect    
+  end
+
+   should "delete a document" do 
+         doc = {:database => 'contacts', :doc_id => 'john', :rev => '3-be02e80490f8e9e610d9a9e33d752316'}
+         hash = Document.delete doc
+         puts hash.inspect
+   end
+
+   should "display all documents in the database" do 
+      docs = Couchdb.docs_from 'monitors'
+       
+      docs.each do |d| 
+          puts d["_rev"]
+          puts d["_id"]    
+          puts d["every"]
+          puts d["monitor"]
+          puts d["url"] 
+          puts d["test"]
+          puts d["contact"]
+          puts d["via"]
+          puts d["notify_interval"]
+       end
+   end
+
+  should " switch to default bind address" do
+     Couchdb.address = nil
+     Couchdb.port = nil
+     Couchdb.all
+  end
+  
+end
+
+
+
+
+

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: leanback
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
+platform: ruby
+authors: 
+- Obi Akubue
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: lightweight Ruby interface to CouchDB
+email: obioraakubue@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/leanback.rb
+- test/helper.rb
+- test/test_leanback.rb
+has_rdoc: true
+homepage: http://github.com/obi-a/leanback
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 327802877
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: lightweight Ruby interface to CouchDB
+test_files: 
+- test/helper.rb
+- test/test_leanback.rb