RubyGems - couchbase - Versions diffs - 1.3.15 → 3.0.0.alpha.5 - Mend

couchbase 1.3.15 → 3.0.0.alpha.5

Files changed (1498) hide show

data/.travis.yml DELETED

@@ -1,22 +0,0 @@
-before_install:
-  - sudo rm -rf /etc/apt/sources.list.d/couchdb-ppa-source.list
-  - sudo rm -rf /etc/apt/sources.list.d/mongodb.list
-  - sudo rm -rf /etc/apt/sources.list.d/datastax-source.list
-  - sudo rm -rf /etc/apt/sources.list.d/rabbitmq-source.list
-  - sudo rm -rf /etc/apt/sources.list.d/mapopa-source.list
-  - sudo rm -rf /etc/apt/sources.list.d/webupd8team-java-ppa-source.list
-  - sudo rm -rf /etc/apt/sources.list.d/maven3-ppa-source.list
-  - wget -O- http://packages.couchbase.com/ubuntu/couchbase.key | sudo apt-key add -
-  - echo deb http://packages.couchbase.com/snapshot/ubuntu oneiric oneiric/main | sudo tee /etc/apt/sources.list.d/couchbase.list
-  - sudo apt-get update
-  - sudo apt-get -y install libcouchbase2-dev
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ree
-notifications:
-  email:
-    - sergey@couchbase.com

data/CONTRIBUTING.markdown DELETED

@@ -1,75 +0,0 @@
-We've decided to use "gerrit" for our code review system, making it
-easier for all of us to contribute with code and comments.
-  1. Visit http://review.couchbase.org and "Register" for an account
-  2. Review http://review.couchbase.org/static/individual_agreement.html
-  3. Agree to agreement by visiting http://review.couchbase.org/#/settings/agreements
-  4. If you do not receive an email, please contact us
-  5. Check out the `couchbase-ruby-client` area http://review.couchbase.org/#/q/status:open+project:couchbase-ruby-client,n,z
-  6. Join us on IRC at #libcouchbase on Freenode :-)
-We normally don't go looking for stuff in gerrit, so you should add at
-least me `"Sergey Avseyev" <sergey.avseyev@gmail.com>` as a reviewer
-for your patch (and I'll know who else to add and add them for you).
-## Contributing Using Repo Tool
-Follow ["Uploading Changes" guide][1] on the site if you have some code to contribute.
-All you should need to set up your development environment should be:
-    ~ % mkdir couchbase-ruby
-    ~ % cd couchbase-ruby
-    ~/couchbase-ruby % repo init -u git://github.com/trondn/manifests.git -m ruby.xml
-    ~/couchbase-ruby % repo sync
-    ~/couchbase-ruby % repo start my-branch-name --all
-    ~/couchbase-ruby % make
-This will build the latest version of `libcouchbase`,
-`couchbase-ruby-client` and `couchbase-ruby-client` libraries. You must
-have a C and C++ compiler installed, automake, autoconf.
-If you have to make any changes just commit them before you upload
-them to gerrit with the following command:
-    ~/couchbase-ruby/client % repo upload
-You might experience a problem trying to upload the patches if you've
-selected a different login name at http://review.couchbase.org than
-your login name. Don't worry, all you need to do is to add the
-following to your ~/.gitconfig file:
-    [review "review.couchbase.org"]
-        username = YOURNAME
-## Contributing Using Plain Git
-If you not so familiar with repo tool and its workflow there is
-alternative way to do the same job. Lets assume you have installed
-couchbase gem and libcouchbase from official packages and would you to
-contribute to couchbase-client gem only. Then you just need to complete
-gerrit registration steps above and clone the source repository
-(remember the repository on github.com is just a mirror):
-    ~ % git clone ssh://YOURNAME@review.couchbase.org:29418/couchbase-ruby-client.git
-Install [`commit-msg` hook][2]:
-    ~/couchbase-ruby-client % scp -p -P 29418 YOURNAME@review.couchbase.org:hooks/commit-msg .git/hooks/
-Make your changes and upload them for review:
-    ~/couchbase-ruby-client % git commit
-    ~/couchbase-ruby-client % git push origin HEAD:refs/for/master
-If you need to fix or add something to your patch, do it and re-upload
-the changes (all you need is to keep `Change-Id:` line the same to
-allow gerrit to track the patch.
-    ~/couchbase-ruby-client % git commit --amend
-    ~/couchbase-ruby-client % git push origin HEAD:refs/for/master
-Happy hacking!
-[1]: http://review.couchbase.org/Documentation/user-upload.html
-[2]: http://review.couchbase.org/Documentation/user-changeid.html

data/LICENSE DELETED

@@ -1,201 +0,0 @@
-                              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/Makefile DELETED

@@ -1,3 +0,0 @@
-all:
-	$(MAKE) -C../.. ruby-client

data/README.markdown DELETED

@@ -1,592 +0,0 @@
-# Couchbase Ruby Client
-This is the official client library for use with Couchbase Server. There
-are related libraries available:
-* [couchbase-model][6] the ActiveModel implementation, git repository:
-  [https://github.com/couchbase/couchbase-ruby-model][7]
-## SUPPORT
-If you find an issue, please file it in our [JIRA][1]. Also you are
-always welcome on the `#libcouchbase` channel at [freenode.net IRC
-servers][2]. Checkout [library overview][overview] and [API
-documentation][api].
-## INSTALL
-This gem depends [libcouchbase][3]. In most cases installing
-libcouchbase doesn't take much effort. After that you can install the
-couchbase gem itself:
-    $ gem install couchbase
-The library verified with all major ruby versions: 1.8.7, 1.9.3, 2.0,
-2.1.
-## USAGE
-First, you need to load the library:
-    require 'couchbase'
-There are several ways to establish a new connection to Couchbase Server.
-By default it uses `http://localhost:8091/pools/default/buckets/default`
-as the endpoint. The client will automatically adjust configuration when
-the cluster will rebalance its nodes when nodes are added or deleted
-therefore this client is "smart".
-    c = Couchbase.connect
-This is equivalent to following forms:
-    c = Couchbase.connect("http://localhost:8091/pools/default/buckets/default")
-    c = Couchbase.connect("http://localhost:8091/pools/default")
-    c = Couchbase.connect("http://localhost:8091")
-    c = Couchbase.connect(:hostname => "localhost")
-    c = Couchbase.connect(:hostname => "localhost", :port => 8091)
-    c = Couchbase.connect(:pool => "default", :bucket => "default")
-The hash parameters take precedence on string URL.
-If you worry about state of your nodes or not sure what node is alive,
-you can pass the list of nodes and the library will iterate over it
-until finds the working one. From that moment it won't use **your**
-list, because node list from cluster config carries more detail.
-    c = Couchbase.connect(:bucket => "mybucket",
-                          :node_list => ['example.com:8091', example.net'])
-There is also a handy method `Couchbase.bucket` which uses thread local
-storage to keep a reference to a connection. You can set the
-connection options via `Couchbase.connection_options`:
-    Couchbase.connection_options = {:bucket => 'blog'}
-    Couchbase.bucket.name                   #=> "blog"
-    Couchbase.bucket.set("foo", "bar")      #=> 3289400178357895424
-The library supports both synchronous and asynchronous mode. In
-asynchronous mode all operations will return control to caller
-without blocking current thread. You can pass a block to the method and it
-will be called with result when the operation will be completed. You
-need to run the event loop once you've scheduled your operations:
-    c = Couchbase.connect
-    c.run do |conn|
-      conn.get("foo") {|ret| puts ret.value}
-      conn.set("bar", "baz")
-    end
-The handlers could be nested
-    c.run do |conn|
-      conn.get("foo") do |ret|
-        conn.incr(ret.value, :initial => 0)
-      end
-    end
-The asynchronous callback receives an instance of `Couchbase::Result` which
-responds to several methods to figure out what was happened:
-  * `success?`. Returns `true` if operation succed.
-  * `error`. Returns `nil` or exception object (subclass of
-    `Couchbase::Error::Base`) if something went wrong.
-  * `key`
-  * `value`
-  * `flags`
-  * `cas`. The CAS version tag.
-  * `node`. Node address. This is used in the flush and stats commands.
-  * `operation`. The symbol, representing an operation.
-To handle global errors in async mode `#on_error` callback should be
-used. It can be set in following fashions:
-    c.on_error do |opcode, key, exc|
-      # ...
-    end
-    handler = lambda {|opcode, key, exc| }
-    c.on_error = handler
-By default connections use `:quiet` mode. This mean it won't raise
-exceptions when the given key does not exist:
-    c.get("missing-key")            #=> nil
-It could be useful when you are trying to make you code a bit efficient
-by avoiding exception handling. (See `#add` and `#replace` operations).
-You can turn on these exceptions by passing `:quiet => false` when you
-are instantiating the connection or change corresponding attribute:
-    c.quiet = false
-    c.get("missing-key")                    #=> raise Couchbase::Error::NotFound
-    c.get("missing-key", :quiet => true)    #=> nil
-The library supports three different formats for representing values:
-* `:document` (default) format supports most of ruby types which could
-  be mapped to JSON data (hashes, arrays, string, numbers). A future
-  version will be able to run map/reduce queries on the values in the
-  document form (hashes)
-* `:plain` This format avoids any conversions to be applied to your
-  data, but your data should be passed as String. This is useful for
-  building custom algorithms or formats. For example to implement a set:
-  http://dustin.github.com/2011/02/17/memcached-set.html
-* `:marshal` Use this format if you'd like to transparently serialize your
-  ruby object with standard `Marshal.dump` and `Marshal.load` methods
-The couchbase API is the superset of [Memcached binary protocol][5], so
-you can use its operations.
-### Get
-    val = c.get("foo")
-    val, flags, cas = c.get("foo", :extended => true)
-Get and touch
-    val = c.get("foo", :ttl => 10)
-Get multiple values. In quiet mode will put `nil` values on missing
-positions:
-    vals = c.get("foo", "bar", "baz")
-    val_foo, val_bar, val_baz = c.get("foo", "bar", "baz")
-    c.run do
-      c.get("foo") do |ret|
-        ret.success?
-        ret.error
-        ret.key
-        ret.value
-        ret.flags
-        ret.cas
-      end
-    end
-Get multiple values with extended information. The result will
-represented by hash with tuples `[value, flags, cas]` as a value.
-    vals = c.get("foo", "bar", "baz", :extended => true)
-    vals.inspect    #=> {"baz"=>["3", 0, 4784582192793125888],
-                         "foo"=>["1", 0, 8835713818674332672],
-                         "bar"=>["2", 0, 10805929834096100352]}
-Hash-like syntax
-    c["foo"]
-    c["foo", "bar", "baz"]
-    c["foo", {:extended => true}]
-    c["foo", :extended => true]         # for ruby 1.9.x only
-### Touch
-    c.touch("foo")                      # use :default_ttl
-    c.touch("foo", 10)
-    c.touch("foo", :ttl => 10)
-    c.touch("foo" => 10, "bar" => 20)
-    c.touch("foo" => 10, "bar" => 20){|key, success|  }
-### Set
-    c.set("foo", "bar")
-    c.set("foo", "bar", :flags => 0x1000, :ttl => 30, :format => :plain)
-    c["foo"] = "bar"
-    c["foo", {:flags => 0x1000, :format => :plain}] = "bar"
-    c["foo", :flags => 0x1000] = "bar"          # for ruby 1.9.x only
-    c.set("foo", "bar", :cas => 8835713818674332672)
-    c.set("foo", "bar"){|cas, key, operation|  }
-### Add
-The add command will fail if the key already exists. It accepts the same
-options as set command above.
-    c.add("foo", "bar")
-    c.add("foo", "bar", :flags => 0x1000, :ttl => 30, :format => :plain)
-### Replace
-The replace command will fail if the key already exists. It accepts the same
-options as set command above.
-    c.replace("foo", "bar")
-### Prepend/Append
-These commands are meaningful when you are using the `:plain` value format,
-because the concatenation is performed by server which has no idea how
-to merge to JSON values or values in ruby Marshal format. You may receive
-an `Couchbase::Error::ValueFormat` error.
-    c.set("foo", "world")
-    c.append("foo", "!")
-    c.prepend("foo", "Hello, ")
-    c.get("foo")                    #=> "Hello, world!"
-### Increment/Decrement
-These commands increment the value assigned to the key. It will raise
-Couchbase::Error::DeltaBadval if the delta or value is not a number.
-    c.set("foo", 1)
-    c.incr("foo")                   #=> 2
-    c.incr("foo", :delta => 2)      #=> 4
-    c.incr("foo", 4)                #=> 8
-    c.incr("foo", -1)               #=> 7
-    c.incr("foo", -100)             #=> 0
-    c.run do
-      c.incr("foo") do |ret|
-        ret.success?
-        ret.value
-        ret.cas
-      end
-    end
-    c.set("foo", 10)
-    c.decr("foo", 1)                #=> 9
-    c.decr("foo", 100)              #=> 0
-    c.run do
-      c.decr("foo") do |ret|
-        ret.success?
-        ret.value
-        ret.cas
-      end
-    end
-    c.incr("missing1", :initial => 10)      #=> 10
-    c.incr("missing1", :initial => 10)      #=> 11
-    c.incr("missing2", :create => true)     #=> 0
-    c.incr("missing2", :create => true)     #=> 1
-Note that it isn't the same as increment/decrement in ruby. A
-Couchbase increment is atomic on a distributed system.  The
-Ruby incement could ovewrite intermediate values with multiple
-clients, as shown with following `set` operation:
-    c["foo"] = 10
-    c["foo"] -= 20                  #=> -10
-### Delete
-    c.delete("foo")
-    c.delete("foo", :cas => 8835713818674332672)
-    c.delete("foo", 8835713818674332672)
-    c.run do
-      c.delete do |ret|
-        ret.success?
-        ret.key
-      end
-    end
-### Flush
-Flush the items in the cluster.
-    c.flush
-    c.run do
-      c.flush do |ret|
-        ret.success?
-        ret.node
-      end
-    end
-### Stats
-Return statistics from each node in the cluster
-    c.stats
-    c.stats(:memory)
-    c.run do
-      c.stats do |ret|
-        ret.success?
-        ret.node
-        ret.key
-        ret.value
-      end
-    end
-The result is represented as a hash with the server node address as
-the key and stats as key-value pairs.
-    {
-      "threads"=>
-        {
-          "172.16.16.76:12008"=>"4",
-          "172.16.16.76:12000"=>"4",
-          # ...
-        },
-      "connection_structures"=>
-        {
-          "172.16.16.76:12008"=>"22",
-          "172.16.16.76:12000"=>"447",
-          # ...
-        },
-      "ep_max_txn_size"=>
-        {
-          "172.16.16.76:12008"=>"1000",
-          "172.16.16.76:12000"=>"1000",
-          # ...
-        },
-      # ...
-    }
-### Timers
-It is possible to create timers to implement general purpose timeouts.
-Note that timers are using microseconds for time intervals. For example,
-following examples increment the keys value five times with 0.5 second
-interval:
-    c.set("foo", 100)
-    n = 1
-    c.run do
-      c.create_periodic_timer(500000) do |tm|
-        c.incr("foo") do
-          if n == 5
-            tm.cancel
-          else
-            n += 1
-          end
-        end
-      end
-    end
-### Views (Map/Reduce queries)
-If you store structured data, they will be treated as documents and you
-can handle them in map/reduce function from Couchbase Views. For example,
-store a couple of posts using memcached API:
-    c['biking'] = {:title => 'Biking',
-                   :body => 'My biggest hobby is mountainbiking. The other day...',
-                   :date => '2009/01/30 18:04:11'}
-    c['bought-a-cat'] = {:title => 'Bought a Cat',
-                         :body => 'I went to the the pet store earlier and brought home a little kitty...',
-                         :date => '2009/01/30 20:04:11'}
-    c['hello-world'] = {:title => 'Hello World',
-                        :body => 'Well hello and welcome to my new blog...',
-                        :date => '2009/01/15 15:52:20'}
-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::ViewRow:9855800 @id="hello-world" @key="2009/01/15 15:52:20" @value="Hello World" @doc=nil @meta={} @views=[]>, ...]
-The gem uses a streaming parser to access view results so you can iterate them
-easily. If your code doesn't keep links to the documents the GC might free
-them as soon as it decides they are unreachable, because the parser doesn't
-store global JSON tree.
-    blog.recent_posts.each do |doc|
-      # do something
-      # with doc object
-      doc.key   # gives the key argument of the emit()
-      doc.value # gives the value argument of the emit()
-    end
-Load with documents
-    blog.recent_posts(:include_docs => true).each do |doc|
-      doc.doc       # gives the document which emitted the item
-      doc['date']   # gives the argument of the underlying document
-    end
-You can also use Enumerator to iterate view results
-    require 'date'
-    posts_by_date = Hash.new{|h,k| h[k] = []}
-    enum = c.recent_posts(:include_docs => true).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
-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(:include_docs => true)
-    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.
-## Engines
-As far as couchbase gem uses [libcouchbase][8] as the backend, you can
-choose from several asynchronous IO options:
-* `:default` this one is used by default and implemented as the part
-  of the ruby extensions (this mean you don't need any dependencies
-  apart from libcouchbase2-core and libcouchbase-dev to build and use
-  it). This engine honours ruby GVL, so when it comes to waiting for
-  IO operations from kernel it release the GVL allowing interpreter to
-  run your code. This technique isn't available on windows, but down't
-  worry `:default` engine still accessible and will pick up statically
-  linked on that platform `:libevent` engine.
-* `:libev` and `:libevent`, these two engines require installed
-  libcouchbase2-libev and libcouchbase2-libevent packages
-  correspondingly. Currently they aren't so friendly to GVL but still
-  useful.
-* `:eventmachine` engine. From version 1.2.2 it is possible to use
-  great [EventMachine][9] library as underlying IO backend and
-  integrate couchbase gem to your current asynchronous application.
-  This engine will be only accessible on the MRI ruby 1.9+. Checkout
-  simple example of usage:
-        require 'eventmachine'
-        require 'couchbase'
-        EM.epoll = true  if EM.epoll?
-        EM.kqueue = true  if EM.kqueue?
-        EM.run do
-          con = Couchbase.connect :engine => :eventmachine, :async => true
-          con.on_connect do |res|
-            puts "connected: #{res.inspect}"
-            if res.success?
-              con.set("emfoo", "bar") do |res|
-                puts "set: #{res.inspect}"
-                con.get("emfoo") do |res|
-                  puts "get: #{res.inspect}"
-                  EM.stop
-                end
-              end
-            else
-              EM.stop
-            end
-          end
-        end
-## HACKING
-Clone the repository. For starters, you can use github mirror, but
-make sure you have read and understand [CONTRIBUTING.markdown][10] if
-you are going to send us patches.
-    $ git clone git://github.com/couchbase/couchbase-ruby-client.git
-    $ cd couchbase-ruby-client
-Install all development dependencies. You can use any ruby version
-since 1.8.7, but make sure your changes work at least on major
-releases (1.8.7, 1.9.3, 2.0.0 and 2.1.0 at the moment):
-    $ gem install bundler
-    $ bundle install
-Don't forget to write the tests. You can find examples in the `tests/`
-directory. To run tests with a mock just compile extension and run the
-`test` task, it will download a test mock of couchbase cluster as a
-part of the process (the mock is generally slower, but easier to
-setup):
-    $ rake compile test
-If you have real Couchbase server installed somewhere, you can pass
-its address using environment variable `COUCHBASE_SERVER` like this:
-    $ COUCHBASE_SERVER=localhost:8091 rake compile test
-And finally, you can package the gem with your awesome changes. For
-UNIX-like systems a regular source-based package will be enough, so the
-command below will produce `pkg/couchbase-VERSION.gem`, where
-`VERSION` is the current version from file `lib/couchbase/version.rb`:
-    $ rake package
-The Windows operating system usually doesn't have a build environment
-installed. This is why we are cross-compiling blobs for Windows from
-UNIX-like boxes. To do it you need to install mingw and the
-[rake-compiler][11] and then build a variety of ruby versions currently
-supported on Windows. An example config looks like this:
-    $ rake-compiler update-config
-    Updating /home/avsej/.rake-compiler/config.yml
-    Found Ruby version 1.8.7 for platform i386-mingw32 (/home/avsej/.rake-compiler/ruby/i686-w64-mingw32/ruby-1.8.7-p374/lib/ruby/1.8/i386-mingw32/rbconfig.rb)
-    Found Ruby version 1.9.3 for platform i386-mingw32 (/home/avsej/.rake-compiler/ruby/i686-w64-mingw32/ruby-1.9.3-p448/lib/ruby/1.9.1/i386-mingw32/rbconfig.rb)
-    Found Ruby version 2.0.0 for platform i386-mingw32 (/home/avsej/.rake-compiler/ruby/i686-w64-mingw32/ruby-2.0.0-p247/lib/ruby/2.0.0/i386-mingw32/rbconfig.rb)
-    Found Ruby version 2.1.0 for platform i386-mingw32 (/home/avsej/.rake-compiler/ruby/i686-w64-mingw32/ruby-2.1.0/lib/ruby/2.1.0/i386-mingw32/rbconfig.rb)
-    Found Ruby version 1.9.3 for platform x64-mingw32 (/home/avsej/.rake-compiler/ruby/x86_64-w64-mingw32/ruby-1.9.3-p448/lib/ruby/1.9.1/x64-mingw32/rbconfig.rb)
-    Found Ruby version 2.0.0 for platform x64-mingw32 (/home/avsej/.rake-compiler/ruby/x86_64-w64-mingw32/ruby-2.0.0-p247/lib/ruby/2.0.0/x64-mingw32/rbconfig.rb)
-    Found Ruby version 2.1.0 for platform x64-mingw32 (/home/avsej/.rake-compiler/ruby/x86_64-w64-mingw32/ruby-2.1.0/lib/ruby/2.1.0/x64-mingw32/rbconfig.rb)
-To install all versions needed for `rake package:windows` use these
-commands:
-    $ rake-compiler cross-ruby HOST=i386-mingw32 VERSION=1.8.7-p374
-    $ rake-compiler cross-ruby HOST=i386-mingw32 VERSION=1.9.3-p448
-    $ rake-compiler cross-ruby HOST=i386-mingw32 VERSION=2.0.0-p247
-    $ rake-compiler cross-ruby HOST=i386-mingw32 VERSION=2.1.0
-    $ rake-compiler cross-ruby HOST=x64-mingw32 VERSION=1.9.3-p448
-    $ rake-compiler cross-ruby HOST=x64-mingw32 VERSION=2.0.0-p247
-    $ rake-compiler cross-ruby HOST=x64-mingw32 VERSION=2.1.0
-Before you build, check relevant ruby and libcouchbase versions in
-`tasks/compile.rake`. After that you can run the `package:windows`
-task and you will find all artifacts in `pkg/` directory:
-    $ rake package:windows
-    $ ls -1 pkg/*.gem
-    pkg/couchbase-1.3.4.gem
-    pkg/couchbase-1.3.4-x64-mingw32.gem
-    pkg/couchbase-1.3.4-x86-mingw32.gem
-[api]: http://www.couchbase.com/autodocs/couchbase-ruby-client-latest/index.html
-[overview]: http://docs.couchbase.com/couchbase-sdk-ruby-1.3/index.html
-[1]: http://couchbase.com/issues/browse/RCBC
-[2]: http://freenode.net/irc_servers.shtml
-[3]: http://docs.couchbase.com/developer/c-2.4/download-install.html
-[4]: https://github.com/mxcl/homebrew/pulls/avsej
-[5]: http://code.google.com/p/memcached/wiki/BinaryProtocolRevamped
-[6]: https://rubygems.org/gems/couchbase-model
-[7]: https://github.com/couchbase/couchbase-ruby-model
-[8]: http://www.couchbase.com/develop/c/current
-[9]: http://rubygems.org/gems/eventmachine
-[10]: https://github.com/couchbase/couchbase-ruby-client/blob/master/CONTRIBUTING.markdown
-[11]: https://github.com/luislavena/rake-compiler
-[rbenv]: https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x