couchbase 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA512: 
-  metadata.gz: 6e17257cd0c7c6e0d867ac56962ad7561b8a658bc3bb06b07d82a1c2e6047b0b032b4c1fc6b1e19d4c75762b37be3fca941f5691f74ada008feba7dffaa57ed8
-  data.tar.gz: c3283d9b48c266c38f53045841e6b191573f570fa05b6cb9fa13ac9046e24eaab599f38b7f5444bb2555f35a113b763e6813078d860201b90b32a93c9b49513f
-SHA1: 
-  metadata.gz: 3f5b7a5d5b5960a30be144f90b68a6a697cfd601
-  data.tar.gz: 58c37ac51144332757baecff17a3b1677d9ee6c8
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzUyYTFlYjFlYTg1MWQ3Y2E2YWViNmRjZTc3MTZmNzZjMDBkZThiZg==
+  data.tar.gz: !binary |-
+    ZGM2ZDgwNGI5NTE0YWZkODJkZTlmOWFlMWU3NWIzMzY4MTExNmE1YQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzFjNmM4ZDFkMGIyZDk0YzQ0ZGIzZDY0OGVlNGZhNjEwNDIyY2M0NDdlYTZj
+    MTIwZTRlMGQ1MWEzNzc0OTNlZTU1YjUzNjY5OTNlZTZjNDYxNTVkYzc1ZDBk
+    MzJiZWQ1M2Y2MmZiNDc3YzU1MGRiNWRlOTQ3ZTVmMDI3OTQ4OTk=
+  data.tar.gz: !binary |-
+    NDdkMTRhYjEyMDcxMmQ0MzY4ODM4Mjk1ZDY2NDZiZWM0YmYwNzQ4NzEyMjY2
+    OGQ0NzdmYTM4ZTQzNzczYjkxNWFlZTQ4NjIwZDdmMGUxYTRiYTE2OGVkNWFk
+    YWUzMjRlZGQ4NTUxY2NkNzFkYTBjODlhYzY3YWFiYTkwODY4ZWU=

data/README.markdown

@@ -8,10 +8,11 @@ are related libraries available:
 
 ## SUPPORT
 
-If you found an issue, please file it in our [JIRA][1]. Also you are
-always welcome on `#libcouchbase` channel at [freenode.net IRC servers][2].
+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].
 
-Documentation: [http://rdoc.info/gems/couchbase](http://rdoc.info/gems/couchbase)
+Documentation: [http://docs.couchbase.com/couchbase-sdk-ruby-1.3/](http://docs.couchbase.com/couchbase-sdk-ruby-1.3/)
+API Documentation: [http://www.couchbase.com/autodocs/](http://www.couchbase.com/autodocs/)
 
 ## INSTALL
 
@@ -39,7 +40,7 @@ your OS release:
     # Ubuntu 10.04 Lucid Lynx (Debian stable or testing)
     deb http://packages.couchbase.com/ubuntu lucid lucid/main
 
-Import Couchbase PGP key:
+Import the Couchbase PGP key:
 
     wget -O- http://packages.couchbase.com/ubuntu/couchbase.key | sudo apt-key add -
 
@@ -47,7 +48,7 @@ Then install them
 
     $ sudo apt-get update && sudo apt-get install libcouchbase-dev
 
-Again, if you need preview versions, just use another repositories in
+Again, if you need a preview of a future version, just use another repository in
 your `couchbase.list`
 
     # Ubuntu 11.10 Oneiric Ocelot (Debian unstable)
@@ -72,8 +73,8 @@ Then to install libcouchbase itself, run:
 
     $ sudo yum update && sudo yum install libcouchbase-devel
 
-We have preview repositories for RPMs too, use them if you need to try
-fresh version of couchbase gem:
+We have preview repositories for RPMs too, use them if you want to try
+the latest version of libcouchbase:
 
     [couchbase]
     name = Couchbase package repository
@@ -85,8 +86,8 @@ fresh version of couchbase gem:
 
 ### Windows
 
-There no additional dependencies for Windows systems. The gem carry
-prebuilt binary for it.
+There are no additional dependencies for Windows systems. The gem carries
+a prebuilt binary for it.
 
 ### Couchbase gem
 
@@ -96,12 +97,12 @@ Now install the couchbase gem itself
 
 ## USAGE
 
-First of all you need to load library:
+First, you need to load the library:
 
     require 'couchbase'
 
-There are several ways to establish new connection to Couchbase Server.
-By default it uses the `http://localhost:8091/pools/default/buckets/default`
+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".
@@ -122,13 +123,13 @@ 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 is more actual.
+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 handy method `Couchbase.bucket` which uses thread local
-storage to keep the reference to default connection. You can set the
+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'}
@@ -137,9 +138,9 @@ connection options via `Couchbase.connection_options`:
 
 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 the block to method and it
+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 event loop when you scheduled your operations:
+need to run the event loop once you've scheduled your operations:
 
     c = Couchbase.connect
     c.run do |conn|
@@ -155,7 +156,7 @@ The handlers could be nested
       end
     end
 
-The asynchronous callback receives instance of `Couchbase::Result` which
+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.
@@ -171,7 +172,7 @@ responds to several methods to figure out what was happened:
 
   * `cas`. The CAS version tag.
 
-  * `node`. Node address. It is used in flush and stats commands.
+  * `node`. Node address. This is used in the flush and stats commands.
 
   * `operation`. The symbol, representing an operation.
 
@@ -186,14 +187,14 @@ used. It can be set in following fashions:
     handler = lambda {|opcode, key, exc| }
     c.on_error = handler
 
-By default connection uses `:quiet` mode. This mean it won't raise
-exceptions when the given key is not exists:
+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 exception by passing `:quiet => false` when you
+You can turn on these exceptions by passing `:quiet => false` when you
 are instantiating the connection or change corresponding attribute:
 
     c.quiet = false
@@ -278,7 +279,7 @@ Hash-like syntax
 
 ### Add
 
-Add command will fail if the key already exists. It accepts the same
+The add command will fail if the key already exists. It accepts the same
 options as set command above.
 
     c.add("foo", "bar")
@@ -338,8 +339,10 @@ Couchbase::Error::DeltaBadval if the delta or value is not a number.
     c.incr("missing2", :create => true)     #=> 0
     c.incr("missing2", :create => true)     #=> 1
 
-Note that it isn't the same as increment/decrement in ruby, which is
-performed on client side with following `set` operation:
+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
@@ -469,9 +472,9 @@ To execute view you need to fetch it from design document `_design/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=[]>, ...]
 
-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
+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|
@@ -499,7 +502,7 @@ You can also use Enumerator to iterate view results
       acc
     end
 
-The Couchbase server could generate errors during view execution with
+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
@@ -569,6 +572,69 @@ choose from several asynchronous IO options:
           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)
+
+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
+
+
 [1]: http://couchbase.com/issues/browse/RCBC
 [2]: http://freenode.net/irc_servers.shtml
 [3]: http://www.couchbase.com/develop/c/current
@@ -578,4 +644,6 @@ choose from several asynchronous IO options:
 [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
 

data/RELEASE_NOTES.markdown

@@ -3,6 +3,32 @@
 This document is a list of user visible feature changes and important
 bugfixes. Do not forget to update this doc in every important patch.
 
+## 1.3.4 (2014-01-08)
+
+* [major] Build 64-bit versions of the extensions for Windows
+  platform. Also support ruby 2.0 and 2.1.
+
+* [minor] Update hacking section in README
+
+* [minor] Fix gemspec warnings regarding versions of the dependencies.
+  Now it honours semantic versioning and doesn't use strict versions.
+
+* [major] RCBC-151 Return CAS in extended mode for incr/decr
+
+* [minor] RCBC-150 Update list of options on `Cluster.create_bucket`.
+  Added new options: `:replica_index`, `:flush_enabled`,
+  `:parallel_db_and_view_compaction`.
+
+* [major] Allow retries on Couchbase::Bucket#cas collisions.  Now it
+  takes a `:retry` Fixnum option that specifies the maximum number of
+  times the method should retry the entire get/update/set operation
+  when a `Couchbase::Error::KeyExists` error is encountered due to a
+  concurrent update from another writer between its `#get` and `#set`
+  calls.
+
+* [major] MD5 and truncate ActiveSupport::Cache keys that are longer
+  than 250 characters.
+
 ## 1.3.3 (2013-09-12)
 
 * [major] RCBC-134 Allow application to use several connections with

data/Rakefile

@@ -15,8 +15,6 @@
 # limitations under the License.
 #
 
-require 'bundler/gem_tasks'
-
 Dir['tasks/*.rake'].sort.each { |f| load f }
 
 task :default => [:clobber, :compile, :test]

data/couchbase.gemspec

@@ -35,15 +35,15 @@ Gem::Specification.new do |s|
   s.extensions    = `git ls-files -- ext/**/extconf.rb`.split("\n")
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'yaji', '~> 0.3.2'
+  s.add_runtime_dependency 'yaji', '~> 0.3', '>= 0.3.2'
   s.add_runtime_dependency 'multi_json', '~> 1.0'
-  s.add_runtime_dependency 'connection_pool', '~> 1.0.0'
+  s.add_runtime_dependency 'connection_pool', '~> 1.0', '>= 1.0.0'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'minitest', '~> 5.0.4'
-  s.add_development_dependency 'rake-compiler', '>= 0.7.5'
-  s.add_development_dependency 'mini_portile'
-  s.add_development_dependency 'yajl-ruby', '~> 1.1.0'
+  s.add_development_dependency 'minitest', '~> 5.0', '>= 5.0.4'
+  s.add_development_dependency 'rake-compiler', '~> 0.7', '>= 0.7.5'
+  s.add_development_dependency 'mini_portile', '~> 0.5', '>= 0.5.2'
+  s.add_development_dependency 'yajl-ruby', '~> 1.1', '>= 1.1.0'
   s.add_development_dependency 'active_support'
   s.add_development_dependency 'eventmachine'
 end

data/ext/couchbase_ext/arithmetic.c

@@ -89,6 +89,7 @@ cb_bucket_arithmetic(int sign, int argc, VALUE *argv, VALUE self)
     params.cmd.arith.sign = sign;
     cb_params_build(&params);
     ctx = cb_context_alloc_common(bucket, proc, params.cmd.arith.num);
+    ctx->extended = params.cmd.arith.extended;
     err = lcb_arithmetic(bucket->handle, (const void *)ctx,
             params.cmd.arith.num, params.cmd.arith.ptr);
     cb_params_destroy(&params);

data/ext/couchbase_ext/bucket.c

@@ -338,7 +338,7 @@ do_connect(struct cb_bucket_st *bucket)
             ciops.v.v0.type = LCB_IO_OPS_SELECT;
 #ifdef _WIN32
         } else if (bucket->engine == cb_sym_iocp) {
-            ciops.v.v0.type = LCB_IO_OPS_IOCP;
+            ciops.v.v0.type = LCB_IO_OPS_WINIOCP;
 #endif
         } else if (bucket->engine == cb_sym_libev) {
             ciops.v.v0.type = LCB_IO_OPS_LIBEV;

data/ext/couchbase_ext/extconf.rb

@@ -46,8 +46,12 @@ end
 $CFLAGS << ' -std=c99 -Wall -Wextra '
 if ENV['DEBUG']
   $CFLAGS << ' -O0 -ggdb3 -pedantic '
+else
+  $CFLAGS << ' -O2'
+  $LDFLAGS << ' -Wl,--strip-debug' if RbConfig::CONFIG['target_os'] =~ /mingw32/
 end
 
+
 if RbConfig::CONFIG['target_os'] =~ /mingw32/
   dir_config("libcouchbase")
 else
@@ -97,6 +101,7 @@ else
   dir_config("libcouchbase", HEADER_DIRS, LIB_DIRS)
 end
 
+
 if COMMON_HEADERS !~ /"ruby\.h"/
   (COMMON_HEADERS ||= "") << %(\n#include "ruby.h"\n)
 end
@@ -126,6 +131,8 @@ def die(message)
   abort
 end
 
+install_notice = "You must install libcouchbase >= 2.1.3\nSee http://www.couchbase.com/communities/c/ for more details"
+
 unless try_compile(<<-SRC)
   #include <libcouchbase/couchbase.h>
   #include <stdio.h>
@@ -135,10 +142,11 @@ unless try_compile(<<-SRC)
     return 0;
   }
   SRC
-  die("You must install libcouchbase >= 2.1.3\nSee http://www.couchbase.com/communities/c/ for more details")
+  die(install_notice)
 end
 
-have_library("couchbase", "lcb_verify_compiler_setup", "libcouchbase/couchbase.h") # just to add -lcouchbase properly
+# just to add -lcouchbase properly
+have_library("couchbase", "lcb_verify_compiler_setup", "libcouchbase/couchbase.h") or die(install_notice)
 have_header("mach/mach_time.h")
 have_header("stdint.h") or die("Failed to locate stdint.h")
 have_header("sys/time.h")

data/ext/couchbase_ext/multithread_plugin.c

@@ -550,7 +550,7 @@ typedef fd_set rb_fdset_t;
 
 typedef struct loop_select_arg {
     rb_mt_loop *loop;
-    rb_fdset_t in, out;
+    rb_fdset_t in, out, exc;
 } ls_arg;
 
     static void
@@ -574,7 +574,7 @@ loop_run_select(VALUE argp)
 {
     ls_arg *args = (ls_arg*) argp;
     rb_mt_loop *loop = args->loop;
-    rb_fdset_t *in = NULL, *out = NULL;
+    rb_fdset_t *in = NULL, *out = NULL, *exc = NULL;
     struct timeval timeout;
     struct timeval *timeoutp = NULL;
     int result, max = 0;
@@ -598,21 +598,26 @@ loop_run_select(VALUE argp)
         uint32_t i;
         rb_fd_init(&args->in);
         rb_fd_init(&args->out);
+        rb_fd_init(&args->exc);
         for(i = 0; i < loop->events.count; i++) {
             rb_mt_socket_list *list = &loop->events.sockets[i];
-            if (list->flags & LCB_READ_EVENT) {
-                in = &args->in;
-                rb_fd_set(list->socket, in);
-            }
-            if (list->flags & LCB_WRITE_EVENT) {
-                out = &args->out;
-                rb_fd_set(list->socket, out);
+            if (list->flags != 0) {
+                if (list->flags & LCB_READ_EVENT) {
+                    in = &args->in;
+                    rb_fd_set(list->socket, in);
+                }
+                if (list->flags & LCB_WRITE_EVENT) {
+                    out = &args->out;
+                    rb_fd_set(list->socket, out);
+                }
+                exc = &args->exc;
+                rb_fd_set(list->socket, exc);
             }
         }
         max = events_max_fd(&loop->events) + 1;
     }
 
-    result = rb_thread_fd_select(max, in, out, NULL, timeoutp);
+    result = rb_thread_fd_select(max, in, out, exc, timeoutp);
 
     if (result < 0) {
         rb_sys_fail("rb_thread_fd_select");
@@ -636,6 +641,10 @@ loop_run_select(VALUE argp)
                 flags |= LCB_WRITE_EVENT;
                 result--;
             }
+            if (exc && rb_fd_isset(list->socket, exc)) {
+                flags = LCB_ERROR_EVENT | LCB_WRITE_EVENT;
+                result--;
+            }
             if (flags) {
                 loop_enque_events(&loop->callbacks, sock, flags);
             }