akdubya-cushion 0.5.1

data/LICENSE

@@ -0,0 +1,176 @@
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.rdoc

@@ -0,0 +1,226 @@
+= Cushion: A slim CouchDB client
+
+Cushion is a minimalist Ruby client for accessing CouchDB servers. Originally
+extracted from CouchRest (http://github.com/jchrist/couchrest), Cushion strips
+out the extras while supporting more native CouchDB commands.
+
+== Getting Started
+
+  # myapp.rb
+  require 'cushion'
+
+  db = Cushion.db!('http://127.0.0.1:5984/mydb')
+  db.save_doc("_id" => "abc", "foo" => "bar")
+  db.open_doc("abc")
+
+== Servers
+
+The server location defaults to http://127.0.0.1:5984, so you may omit the host
+when initializing a server if you are satisfied with the default.
+
+  Cushion.server
+  Cushion.server('http://myhost:6969')
+
+Display the server welcome message:
+
+  server.info
+
+Get a list of all databases on the server:
+
+  server.all_dbs
+
+Display any running tasks (such as replication):
+
+  server.active_tasks
+
+Get the server configuration hash:
+
+  server.config
+
+Set a configuration option:
+
+  server.set_config("mysection", "myoption", "myvalue")
+
+Restart the server:
+
+  server.restart
+
+Obtain server stats:
+
+  server.stats
+
+Replicate from a source database to a target database:
+
+  server.replicate("db1", "db2")
+  server.replicate("db1", "http://host2:5984/bar")
+
+Return a <tt>Cushion::Database</tt> without first creating it:
+
+  server.db("mydb")
+  server[:mydb]
+
+Create a database and return a <tt>Cushion::Database</tt>:
+
+  server.db!("mydb")
+
+== Databases
+
+Create a database directly from a url, or just return the database instance if
+it already exists:
+
+  Cushion.db!('http://127.0.0.1:5984/mydb')
+
+Compact a database, eliminating old document revisions:
+
+  db.compact
+
+Create and delete a database from an instance of <tt>Cushion::Database</tt>
+
+  db.create
+  db.delete
+
+Open a document:
+
+  db.open_doc("mydoc")
+
+Fetch all documents from a database:
+
+  db.all_docs
+
+Save a document. The +_id+ may be omitted on document creation:
+
+  db.save_doc("_id" => "abc", .. attributes ..)
+  db.save_doc(.. attributes ..)
+  ab.save_doc("_id" => "exists", "_rev" => "1234", .. attributes ..)
+
+Delete a document. Must include both an +id+ and a +rev+:
+
+  db.delete_doc("mydoc", "1234")
+
+Perform a bulk save/update/delete operation:
+
+  docs = [
+    { "_id" => "0", "_rev" => "123456", "_deleted" => true }, #=> Delete this doc
+    { "_id" => "1", "_rev" => "32486671", "foo" => "bar" },   #=> Update this doc
+    { "_id" => "2", "baz" => "bat" }                          #=> Create this doc
+  ]
+
+  db.bulk_docs(docs)
+
+Perform a bulk delete operation. This is a convenience method:
+
+  db.bulk_delete(some_docs)
+
+Purge document revisions from the database, effectively erasing history:
+
+  doc_revs = {
+    "1" => ["12345", "42836"],
+    "2" => ["572654"],
+    "3" => ["34462"]
+  }
+
+  db.purge(doc_revs)
+
+Copy or move a document to a new +id+. Specify a +dest_rev+ to overwrite an existing
+document:
+
+  db.copy_doc("doc1", "doc2")
+  db.copy_doc("doc1", "doc2", :dest_rev => "36452")
+  db.move_doc("doc1", "1234", "doc2")
+  db.move_doc("doc1", "1234", "doc2", :dest_rev => "37462")
+
+CouchDB can attach multiple files directly to documents, either as inline Base64
+encoded data or via a standalone attachment API.
+
+Open a document attachment. This will return an <tt>IO</tt> object:
+
+  temp = db.open_attachment("mydoc", "foo.txt")
+  temp.read
+
+Save an inline attachment to a document:
+
+  db.save_doc("_id" => "mydoc", "_attachments" => {
+    "foo.txt" => {
+      "content_type" => "text/plain",
+      "data" => "Hello World!"
+    }
+  })
+
+Save a standalone attachment to a saved document. Content type defaults to
+"application/octet-stream":
+
+  db.save_attachment("mydoc", "1234", "bar.txt", "somedata", :content_type => "text/plain")
+
+Delete a document attachment:
+
+  db.delete_attachment("mydoc", "1234", "foo.txt")
+
+Rename an attachment:
+
+  db.rename_attachment("mydoc", "1234", "baz.txt", "bat.txt")
+
+== Views
+
+Create a temporary view and run a query against it:
+
+  temp_view = { :map => "function(doc){emit(doc.status,null)}" }
+  db.temp_view(temp_view, :key => "verified")
+
+Run a query against a saved view:
+
+  db.view("people/by_first_name", :key => "gomer")
+
+Show and list functions:
+
+  db.show("examples", "people", "mydoc", :format => "xml")
+  db.list("examples", "browse-people", "people-by-name", :startkey => ["a"], :limit => 10)
+
+See http://wiki.apache.org/couchdb/Formatting_with_Show_and_List
+
+== External Processes
+
+Issue a request to a CouchDB external process, such as a full text indexing
+engine:
+
+  db.external(:get, 'search/foo', :query => { 'foo' => 'bar' })
+
+== Content Negotiation
+
+All commands except for +show+ and +list+ return parsed JSON by default, but in some
+cases it is useful to return the raw response from CouchDB. Simply set the correct
+HTTP headers to request an alternate format:
+
+  db.all_docs :headers => { :accept => "text/plain" }
+
+Some commands accept a headers hash as the last parameter, allowing you to omit
+the explicit headers key like so:
+
+  db.info :accept => "text/plain"
+
+== Cushion::Document
+
+<tt>Cushion::Document</tt> provides a light wrapper for working directly with
+individual documents.
+
+Create a document:
+
+  Cushion::Document.use_database(db)
+  doc = Cushion::Document.new("foo" => "bar")
+  doc.save
+
+Open a document and return an instance of <tt>Cushion::Document</tt>:
+
+  db.doc("mydoc")
+  doc["_foo"] = "bar"
+  doc.save
+
+Copy a document:
+
+  doc.copy("mydoc2")
+
+Work with document attachments:
+
+  doc.open_attachment("foo.txt")
+  doc.save_attachment("bar.txt", "somedata", :content_type => "text/plain")
+  doc.delete_attachment("bar.txt")
+  doc.rename_attachment("foo.txt", "newfoo.txt")

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+require File.join(File.expand_path(File.dirname(__FILE__)),'lib','cushion')
+
+task :default => [:test]
+task :spec => :test
+
+name = 'cushion'
+version = Cushion::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = name
+  s.version = version
+  s.summary = "A slim CouchDB client."
+  s.description = "A slim CouchDB client."
+  s.author = "Aleksander Williams"
+  s.email = "alekswilliams@earthlink.net"
+  s.homepage = "http://github.com/akdubya/cushion"
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.files = %w(Rakefile README.rdoc LICENSE) + Dir.glob("{lib,spec}/**/*")
+  s.require_path = "lib"
+  s.add_dependency("rest-client", ">= 0.9")
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+desc "Install as a system gem"
+task :install => [ :package ] do
+  sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+desc "Uninstall as a system gem"
+task :uninstall => [ :clean ] do
+  sh %{sudo gem uninstall #{name}}
+end
+
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{name}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'rdoc'
+  t.title = "Cushion: A slim CouchDB client"
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.rdoc')
+  t.rdoc_files.include('lib/cushion.rb')
+  t.rdoc_files.include('lib/cushion/*.rb')
+end