couchbase 0.9.7

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in couchbase.gemspec
+gemspec

data/HISTORY.markdown

@@ -0,0 +1,50 @@
+=== 0.9.7 / 2011-10-04
+
+* Fix design doc removing
+* Fix 'set' method signature: add missing options argument
+* Rename gem to 'couchbase' for easy of use. The github project still
+  is 'couchbase-ruby-client'
+
+=== 0.9.6 / 2011-10-04
+
+* Fix bug with decoding multiget result
+* Allow create design documents from IO and String
+* Rename json format to document, and describe possible formats
+* Allow to handle errors in view result stream
+* Remove dependency on libyajl library: it bundled with yaji now
+* Update rake tasks: create zip- and tar-balls
+
+=== 0.9.5 / 2011-08-24
+
+* Update installation notes in README
+
+=== 0.9.4 / 2011-08-24
+
+* Use streaming json parser to iterate over view results
+* Update memcached gem dependency to v1.3
+* Proxy TOUCH command to memcached client
+* Fix minor bugs in RestClient and Document classes
+* Disable CouchDB API for nodes without 'couchApiBase' key provided.
+* Fix bug with unicode parsing in config listener
+* Add more unit tests
+
+=== 0.9.3 / 2011-07-29
+
+* Use Latch (via Mutex and ConditionVariable) to wait until initial
+  setup will be finished.
+* Update prefix for development views (from '$dev_' to 'dev_')
+
+=== 0.9.2 / 2011-07-29
+
+* Use zero TTL by default to store records forever
+* Update documentation
+* Sleep if setup isn't done
+
+
+=== 0.9.1 / 2011-07-25
+
+* Minor bugfix for RestClient initialization
+
+=== 0.9.0 / 2011-07-25
+
+* Initial public release

data/LICENSE

@@ -0,0 +1,201 @@
+                              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
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.markdown

@@ -0,0 +1,135 @@
+Couchbase Ruby Client
+=====================
+
+This is the official client library for use with Couchbase Server.
+
+INSTALL
+=======
+
+This gem depends on a couple of external libraries to work with JSON and
+HTTP. For JSON it uses [yajl-ruby][1] and [yaji][2] which are built atop
+of [yajl][3]. For HTTP iteraction it uses [curb][4], the curl bindings for
+ruby. To install it use your package manager. On debian you can install
+it, use `aptitude`:
+
+    $ sudo aptitude install libcurl3-dev
+
+After that you can install the gem via rubygems:
+
+    $ gem install couchbase
+
+USAGE
+=====
+
+First of all you need to load library:
+
+    require 'couchbase'
+
+To establish connection with couchbase you need to specify at least pool
+URI. Also you can choose custom bucket name and memcached SASL
+authentication and Couchbase REST API.
+
+    c = Couchbase.new("http://localhost:8091/pools/default")
+    c = Couchbase.new("http://localhost:8091/pools/default", :bucket_name => 'blog')
+    c = Couchbase.new("http://localhost:8091/pools/default",
+                      :bucket_name => 'blog', :bucket_password => 'secret')
+
+This gem supports memcached API accessible for [memcached][5] client
+with a bit syntax sugar:
+
+    c.set('password', 'secret')
+    c.get('password')             #=> "secret"
+    c['password'] = 'secret'
+    c['password']                 #=> "secret"
+    c['counter'] = 1              #=> 1
+    c['counter'] += 1             #=> 2
+    c['counter']                  #=> 2
+    c.increment('counter', 10)
+    c.flush
+
+But if you store structured data, they will be treated as documents and
+you can handle them in map/reduce function from CouchDB views. For
+example, store a couple of posts using memcached API:
+
+    c['biking'] = {:title => 'Biking',
+                   :body => 'I went to the the pet store earlier and brought home a little kitty...',
+                   :date => '2009/01/30 18:04:11'}
+    c['bought-a-cat'] = {:title => 'Biking',
+                         :body => 'My biggest hobby is mountainbiking. The other day...',
+                         :date => '2009/01/30 18:04:11'}
+    c['hello-world'] = {:title => 'Hello World',
+                        :body => 'Well hello and welcome to my new blog...',
+                        :date => '2009/01/15 15:52:20'}
+    c.all_docs.count    #=> 3
+
+Now let's create design doc with sample view and save it in file
+'blog.json':
+
+    {
+      "_id": "_design/blog",
+      "language": "javascript",
+      "views": {
+        "recent_posts": {
+          "map": "function(doc){if(doc.date && doc.title){emit(doc.date, doc.title);}}"
+        }
+      }
+    }
+
+This design document could be loaded into the database like this (also you can
+pass the ruby Hash or String with JSON encoded document):
+
+    c.save_design_doc(File.open('blog.json'))
+
+To execute view you need to fetch it from design document `_design/blog`:
+
+    blog = c.design_docs['blog']
+    blog.views                    #=> ["recent_posts"]
+    blog.recent_posts             #=> [#<Couchbase::Document:14244860 {"id"=>"hello-world", "key"=>"2009/01/15 15:52:20", "value"=>"Hello World"}>,...]
+
+Gem uses streaming parser to access view results so you can iterate them
+easily and if your code won't keep links to the documents GC might free
+them as soon as it decide they are unreachable, because parser doesn't
+store global JSON tree.
+
+    posts = blog.recent_posts.each do |doc|
+      # do something
+      # with doc object
+    end
+
+You can also use Enumerator to iterate view results
+
+    require 'date'
+    posts_by_date = Hash.new{|h,k| h[k] = []}
+    enum = c.all_docs.each  # request hasn't issued yet
+    enum.inject(posts_by_date) do |acc, doc|
+      acc[date] = Date.strptime(doc['date'], '%Y/%m/%d')
+      acc
+    end
+
+The Couchbase server could generate errors during view execution with
+`200 OK` and partial results. By default the library raises exception as
+soon as errors detected in the result stream, but you can define the
+callback `on_error` to intercept these errors and do something more
+useful.
+
+    view = blog.recent_posts
+    logger = Logger.new(STDOUT)
+
+    view.on_error do |from, reason|
+      logger.warn("#{view.inspect} received the error '#{reason}' from #{from}")
+    end
+
+    posts = view.each do |doc|
+      # do something
+      # with doc object
+    end
+
+Note that errors object in view results usually goes *after* the rows,
+so you will likely receive a number of view results successfully before
+the error is detected.
+
+[1]: https://github.com/brianmario/yajl-ruby/
+[2]: https://github.com/avsej/yaji/
+[3]: http://lloyd.github.com/yajl/
+[4]: https://rubygems.org/gems/curb/
+[5]: https://github.com/fauna/memcached/

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << "test" << "."
+  test.ruby_opts << "-rruby-debug" if ENV['DEBUG']
+  test.pattern = 'test/test_*.rb'
+  test.verbose = true
+end
+
+require 'rubygems/package_task'
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../couchbase.gemspec', __FILE__)))
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc 'Start an irb session and load the library.'
+task :console do
+  exec "irb -I lib -rcouchbase"
+end
+
+task :default => :test
+

data/couchbase.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'couchbase/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'couchbase'
+  s.version     = Couchbase::VERSION
+  s.author      = 'Couchbase'
+  s.email       = 'info@couchbase.com'
+  s.license     = 'ASL-2'
+  s.homepage    = 'http://couchbase.org'
+  s.summary     = %q{Couchbase ruby driver}
+  s.description = %q{The official client library for use with Couchbase Server.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'memcached', '~> 1.3'
+  s.add_runtime_dependency 'yajl-ruby', '~> 0.8.2'
+  s.add_runtime_dependency 'curb', '~> 0.7.15'
+  s.add_runtime_dependency 'yaji', '~> 0.0.9'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+end