protoncouch 1.0

data/README.md

@@ -0,0 +1,127 @@
+![ProtonCouch logo](http://i.8electrons.com/8protons/img/pc/protoncouch.png "ProtonCouch logo")
+
+#ProtonCouch
+
+It's a simple and efficient CouchDB client written on Ruby.
+
+Current solutions like CouchRest are too heavy and have strange behaviour (like raising error when Resource not found). Also they can't manage many databases.
+
+#How to use (real life examples from 8Protons' project)
+
+It's simple. Create an object like this:
+
+    require 'protons8/couch'
+    @couch = Protons8::Couch.new({ :account => 'http://user:password@127.0.0.1:5984/accounts', :activations => 'http://user:password@127.0.0.1:5984/email_activations'})
+
+Now you can query:
+
+**GET**
+
+    @couch.get(:account, 'test@test.com')
+
+**PUT (create document with id)**
+
+    @couch.save_with_id(db, id, document)
+
+**POST (create document with autogenerated id**
+
+    @couch.save(db, document)
+
+**Save or Update (Document exists? Update. No? Create a new one)**
+
+    @couch.save_or_update(db, id, document)
+
+**Simple DELETE**
+
+    @couch.delete(db, id)
+
+**DELETE with revision**
+
+    @couch.delete_rev(db, id, rev)
+
+**VIEW Example**
+Spec: view(db, view, params = {})
+
+    @couchdb.view(:accounts, 'accounts/login', { :key => ["login", "hashedpassword"] })
+
+#Methods (Asking the Right Questions)
+
+Every query wrapped by help class.
+
+Base methods are:
+
+- error?
+- no_error?
+- error_name
+- reason
+- not_found? = if CouchDB answered { "error": "not_found" }...
+- unauth?
+- conflict?
+- raw = raw document (hash)
+- attachments
+
+**GET methods**
+
+- id
+- rev
+- exists?
+
+**VIEW methods**
+
+- total_rows
+- offset
+- rows = get all rows
+- any?
+- empty? = no document found by criteria
+
+**PUT-POST-DELETE methods**
+
+- id = id of saved document
+- rev
+- ok? = is query okay?
+
+#Real life examples
+
+* Check unique of email
+
+    if  @couch.view(:account, "accounts/list_emails", { :key => email }).empty?
+
+* Save email activation code and check query
+
+    if @couch.save_or_update(:activation, email, { :code => @code }).ok?
+
+* Check email ectivation code
+
+    if @couch.view(:activation, 'email_activations/list_codes', { :key => params['code'] }).any?
+
+* User
+
+    user = @couch.save(:account, document)
+    if user.ok? and @couch.delete(:activation, document['email']).ok?
+
+
+#Enjoy!
+
+#License
+
+The MIT License
+
+Copyright (c) 2010 Anthony Sekatski <anthony@8protons.com>
+
+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/lib/protoncouch.rb

@@ -0,0 +1,195 @@
+require 'net/http'
+require 'json'
+require 'uri'
+require 'cgi'
+
+module Protons8
+	class ProtonCouch
+			#Initialization
+			def initialize(constrings)
+				@s = { }
+				#Construct our settings
+				constrings.each do |k,v|
+					#Get URI from value
+					uri = URI.parse(v)
+					#Fill a simple hash without Object (I've no idea why i do this :D)
+					@s[k] = { :host => uri.host, :port => uri.port, :path => uri.path, :user => uri.user, :password => uri.password }
+				end
+			end
+	
+			def info(db)
+				CouchResponse::Get.new request( db, Net::HTTP::Get.new("#{@s[db][:path]}/") )
+			end
+
+			def get(db, id, params = {})
+				CouchResponse::Get.new request( db, Net::HTTP::Get.new( "#{@s[db][:path]}/" + id + get_qs(params) ) )
+			end
+
+			def save(db, document)
+				req = Net::HTTP::Post.new( "#{@s[db][:path]}/" )
+				req["content-type"] = "application/json"
+		    req.body = document.to_json
+				CouchResponse::PutPostDelete.new request( db, req )
+			end
+
+			def save_with_id(db, id, document)
+				req = Net::HTTP::Put.new( "#{@s[db][:path]}/" + id )
+				req["content-type"] = "application/json"
+		    req.body = document.to_json
+				CouchResponse::PutPostDelete.new request( db, req )
+			end
+
+			def save_or_update(db, id, document)
+				response = self.get(db, id)
+				document['_rev'] = response.rev if response.exists?			
+				req = Net::HTTP::Put.new( "#{@s[db][:path]}/" + id )
+				req["content-type"] = "application/json"
+		    req.body = document.to_json
+				CouchResponse::PutPostDelete.new request( db, req )
+			end
+
+			def delete(db, id)
+				response = self.get(db, id)
+				rev = response.exists? ? response.rev : ''
+				CouchResponse::PutPostDelete.new request( db, Net::HTTP::Delete.new( "#{@s[db][:path]}/#{id}?rev=#{rev}") )
+			end
+
+		  def delete_rev(db, id, rev)
+		    CouchResponse::PutPostDelete.new request( db, Net::HTTP::Delete.new( "#{@s[db][:path]}/#{id}?rev=#{rev}") )
+		  end
+
+			def view(db, view, params = {})
+		 		CouchResponse::View.new request( db, Net::HTTP::Get.new("#{@s[db][:path]}/_design/#{view.split('/')[0]}/_view/#{view.split('/')[1]}" + get_qs(params) ) )
+			end
+
+			# Private methods - they are shy
+			private
+
+			# Do some request now!
+			def request(db, req)
+				#Create server
+				http = Net::HTTP.new @s[db][:host], @s[db][:port]
+				#Set auth rules
+				req.basic_auth @s[db][:user], @s[db][:password]
+				#Request!
+				JSON.parse(http.request(req).body)
+				#...
+				#Profit!
+			end
+
+			#Get query string from hash
+			def get_qs(params)
+				if params and not params.empty?
+					qs = params.collect do |k,v|
+					v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
+					"#{k}=#{CGI.escape(v.to_s)}"
+				end.join("&")
+					"?#{qs}"
+		    else
+					''
+				end
+			end #End of get_qs
+
+	#Several responses classes for convenience
+			class CouchResponse
+			
+				#Add several methods to all type of response
+				class BaseResponse
+					def initialize(hash)
+						@hash = hash
+					end
+
+					def error?
+						not @hash['error'].nil?
+					end
+
+					def no_error?
+						@hash['error'].nil?
+					end			
+
+					def error_name
+						@hash['error'] || 'No error'
+					end
+
+					def reason
+						@hash['error'] ? @hash['reason'] : 'No reason - everything ok'
+					end
+
+					def not_found?
+						@hash['error'] == 'not_found' ? true : false
+					end
+
+					def unauth?
+						@hash['error'] == 'unauthorized' ? true : false
+					end
+
+					def conflict?
+						@hash['error'] == 'conflict' ? true : false
+					end
+
+					def raw
+						@hash
+					end
+
+					def attachments
+						@hash['_attachments'] || nil
+					end
+
+					def attachment(id)
+						@hash['_attachments'] ? @hash['_attachments'][id] : nil
+					end
+				end #End of BaseResponse
+
+				class Get < BaseResponse	
+					def id
+						@hash['_id']
+					end
+
+					def rev
+						@hash['_rev']
+					end
+
+					def exists?
+						@hash['_id'] || false
+					end
+				end #End of Get
+
+				class View < BaseResponse
+					def total_rows
+						@hash['total_rows'] || nil
+					end
+			
+					def offset
+						@hash['offset'] || nil
+					end
+
+					def rows
+						@hash['rows'] || nil
+					end
+
+					def any?
+						@hash['rows'] ? (not @hash['rows'][0].nil?) : false
+					end
+
+					def empty?
+						@hash['rows'] ? @hash['rows'].empty? : false
+					end
+				end #End of View
+
+				class PutPostDelete < BaseResponse
+					def id
+						@hash['id']
+					end
+
+					def rev
+						@hash['rev']
+					end
+
+					def ok?
+						@hash['ok'] || false
+					end
+				end #End of PutPost
+			
+			end #End of CouchResponse
+		end
+end

data/license

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Anthony Sekatski <anthony@8protons.com>
+
+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/protoncouch.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name    = 'protoncouch'
+  s.version = '1.0'
+	s.description = "It's a simple and efficient CouchDB client written on Ruby. Current solutions like CouchRest are too heavy and have strange behaviour (like raising error when Resource not found). Also they can't manage many databases."
+  s.summary = 'ProtonCouch is the very simple and efficient CouchDB client. Awesome relax!'
+
+  s.author   = 'Anthony Sekatski'
+  s.email    = 'anthony@8protons.com'
+  s.homepage = 'http://github.com/8protons/protoncouch'
+
+  s.files = Dir['lib/protoncouch.rb', 'protoncouch.gemspec', 'README.md', 'license']
+
+	s.add_dependency('json', '>= 1.4.6')
+end
+
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: protoncouch
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Anthony Sekatski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+description: It's a simple and efficient CouchDB client written on Ruby. Current solutions like CouchRest are too heavy and have strange behaviour (like raising error when Resource not found). Also they can't manage many databases.
+email: anthony@8protons.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/protoncouch.rb
+- protoncouch.gemspec
+- README.md
+- license
+has_rdoc: true
+homepage: http://github.com/8protons/protoncouch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: ProtonCouch is the very simple and efficient CouchDB client. Awesome relax!
+test_files: []
+