couchbase 0.9.8 → 1.0.0

data/ext/couchbase_ext/extconf.rb

@@ -0,0 +1,102 @@
+# encoding: UTF-8
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+
+require 'mkmf'
+
+LIBDIR = Config::CONFIG['libdir']
+INCLUDEDIR = Config::CONFIG['includedir']
+
+HEADER_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/include',
+  # Then search /usr/local for people that installed from source
+  '/usr/local/include',
+  # Check the ruby install locations
+  INCLUDEDIR,
+  # Finally fall back to /usr
+  '/usr/include'
+]
+
+LIB_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/lib',
+  # Then search /usr/local for people that installed from source
+  '/usr/local/lib',
+  # Check the ruby install locations
+  LIBDIR,
+  # Finally fall back to /usr
+  '/usr/lib'
+]
+
+# For people using homebrew
+brew_prefix = `brew --prefix libevent 2> /dev/null`.chomp
+unless brew_prefix.empty?
+  LIB_DIRS.unshift File.join(brew_prefix, 'lib')
+  HEADER_DIRS.unshift File.join(brew_prefix, 'include')
+end
+
+HEADER_DIRS.delete_if{|d| !File.exists?(d)}
+LIB_DIRS.delete_if{|d| !File.exists?(d)}
+
+def define(macro, value = nil)
+  $defs.push("-D #{[macro.upcase, value].compact.join('=')}")
+end
+
+# it will find the libcouchbase likely. you can specify its path otherwise
+#
+#   ruby extconf.rb [--with-libcouchbase-include=<dir>] [--with-libcouchbase-lib=<dir>]
+#
+# or
+#
+#   ruby extconf.rb [--with-libcouchbase-dir=<dir>]
+#
+dir_config("libcouchbase", HEADER_DIRS, LIB_DIRS)
+
+if COMMON_HEADERS !~ /"ruby\.h"/
+  COMMON_HEADERS << %(#include "ruby.h"\n)
+end
+
+$CFLAGS << ' -std=c99 -Wall -Wextra '
+if ENV['DEBUG']
+  $CFLAGS << ' -O0 -ggdb3 -pedantic'
+end
+
+if try_compile(<<-SRC)
+  #include <stdarg.h>
+  int foo(int x, ...) {
+    va_list va;
+    va_start(va, x);
+    va_arg(va, int);
+    va_arg(va, char *);
+    va_arg(va, double);
+    return 0;
+  }
+  int main() {
+    return foo(10, "", 3.14);
+    return 0;
+  }
+  SRC
+  define("HAVE_STDARG_PROTOTYPES")
+end
+
+have_library("event", "event_init", "event.h") || abort
+have_library("couchbase", "libcouchbase_create", "libcouchbase/couchbase.h") || abort
+create_header("couchbase_config.h")
+create_makefile("couchbase_ext")

data/lib/couchbase.rb

@@ -1,5 +1,5 @@
 # Author:: Couchbase <info@couchbase.com>
-# Copyright:: 2011 Couchbase, Inc.
+# Copyright:: 2011, 2012 Couchbase, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,40 +15,30 @@
 # limitations under the License.
 #
 
-module Couchbase
-  autoload :Bucket,         'couchbase/bucket'
-  autoload :Couchdb,        'couchbase/couchdb'
-  autoload :Document,       'couchbase/document'
-  autoload :HttpStatus,     'couchbase/http_status'
-  autoload :Latch,          'couchbase/latch'
-  autoload :Memcached,      'couchbase/memcached'
-  autoload :Node,           'couchbase/node'
-  autoload :RestClient,     'couchbase/rest_client'
-  autoload :VERSION,        'couchbase/version'
-  autoload :View,           'couchbase/view'
-
-  # This error is raising when library detects that some operation
-  # doesn't implemented by the server. For example views API doesn't
-  # implemented by Membase 1.7.x
-  class NotImplemented < Exception; end
-
-  class ViewError < Exception
-    attr_reader :from, :reason
+require 'couchbase/version'
+require 'yajl/json_gem'
+require 'couchbase_ext'
+require 'couchbase/bucket'
 
-    def initialize(from, reason)
-      @from = from
-      @reason = reason
-      super("#{from}: #{reason}")
-    end
-  end
+# Couchbase ruby client
+module Couchbase
 
   class << self
     # The method +new+ initializes new Bucket instance with all arguments passed.
     #
-    # === Examples
-    #   Couchbase.new("http://localhost:8091/pools/default") #=> establish connection with couchbase default pool and default bucket
-    #   Couchbase.new("http://localhost:8091/pools/default", :bucket_name => 'blog') #=> select custom bucket
-    #   Couchbase.new("http://localhost:8091/pools/default", :bucket_name => 'blog', :bucket_password => 'secret') #=> specify password for bucket (and SASL auth for memcached client)
+    # @example Use default values for all options
+    #   Couchbase.new
+    #
+    # @example Establish connection with couchbase default pool and default bucket
+    #   Couchbase.new("http://localhost:8091/pools/default")
+    #
+    # @example Select custom bucket
+    #   Couchbase.new("http://localhost:8091/pools/default", :bucket => 'blog')
+    #
+    # @example Specify bucket credentials
+    #   Couchbase.new("http://localhost:8091/pools/default", :bucket => 'blog', :username => 'bucket', :password => 'secret')
+    #
+    # @return [Bucket] connection instance
     def new(*args)
       Bucket.new(*args)
     end

data/lib/couchbase/bucket.rb

@@ -1,5 +1,5 @@
 # Author:: Couchbase <info@couchbase.com>
-# Copyright:: 2011 Couchbase, Inc.
+# Copyright:: 2011, 2012 Couchbase, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,125 +15,56 @@
 # limitations under the License.
 #
 
-require 'uri'
-
 module Couchbase
-
-  # This class in charge of all stuff connected to communication with
-  # Couchbase. It includes CouchDB and Memcached APIs. Also it includes
-  # methods for HTTP transport from RestClient.
-
   class Bucket
-    include RestClient
-    include Couchdb
-    include Memcached
-
-    attr_accessor :pool_uri, :environment, :type, :nodes,
-      :streaming_uri, :name, :uri, :vbuckets
 
-    # Initializes connection using +pool_uri+ and optional
-    # +:bucket_name+ and +:bucket_password+ (for protected buckets). Bucket
-    # name will be used as a username for all authorizations (SASL for
-    # Memcached API and Basic for HTTP). It also accepts +:environment+
-    # parameter wich intended to let library know what mode it should
-    # use when it applicable (for example it skips/preserves design
-    # documents with 'dev_' prefix for CouchDB API). You can specify
-    # any string starting from 'dev' or 'test' to activate development
-    # mode.
+    # Reads a key's value from the server and yields it to a block. Replaces
+    # the key's value with the result of the block as long as the key hasn't
+    # been updated in the meantime, otherwise raises
+    # Couchbase::Error::KeyExists. CAS stands for "compare and swap", and
+    # avoids the need for manual key mutexing. Read more info here:
     #
-    # Also starts thread which will simultanuously listen for
-    # configuration update via +streaming_uri+. Server should push
-    # update notification about adding or removing nodes from cluster.
+    #   http://docs.couchbase.org/memcached-api/memcached-api-protocol-text_cas.html
     #
-    # Raises ArgumentError when it cannot find specified bucket in given
-    # pool.
-    def initialize(pool_uri, options = {})
-      @latch = Latch.new(:in_progress, :ready)
-      @name = options[:bucket_name] || "default"
-      @pool_uri = URI.parse(pool_uri)
-      @environment = if options[:environment].to_s =~ /^(dev|test)/
-                       :development
-                     else
-                       :production
-                     end
-      config = http_get("#{@pool_uri}/buckets").detect do |bucket|
-                 bucket['name'] == @name
-               end
-      unless config
-        raise ArgumentError,
-          "There no such bucket with name '#{@name}' in pool #{pool_uri}"
-      end
-      @uri = @pool_uri.merge(config['uri'])
-      @streaming_uri = @pool_uri.merge(config['streamingUri'])
-      # credentials is used to choose the bucket
-      if @name != "default"
-        @credentials = {:username => @name, :password => options[:bucket_password] || ''}
-      end
-      super
-
-      # Considering all initialization stuff completed and now we can
-      # start config listener
-      listen_for_config_changes
-
-      @latch.wait
-    end
-
-    # Select next node for work with Couchbase. Currently it makes sense
-    # only for couchdb API, because memcached client works using moxi.
-    def next_node
-      nodes.shuffle.first
-    end
-
-    # Perform configuration using configuration cache. It turn all URIs
-    # into full form (with schema, host and port).
+    # @param [String] key
     #
-    # You can override this method in included modules or descendants if
-    # you'd like to reconfigure them when new configuration arrives from
-    # server.
-    def setup(config)
-      @type = config['bucketType']
-      @nodes = config['nodes'].map do |node|
-        Node.new(node['status'],
-                 node['hostname'].split(':').first,
-                 node['ports'],
-                 node['couchApiBase'])
-      end
-      if @type == 'membase'
-        @vbuckets = config['vBucketServerMap']['vBucketMap']
-      end
-      super
-      @latch.toggle
-    end
-
-    private
-
-    # Run background thread to listen for configuration changes.
-    # Rewrites configuration for each update. Curl::Multi uses select()
-    # call when waiting for data, so is should be efficient use ruby
-    # threads here.
-    def listen_for_config_changes
-      Thread.new do
-        multi = Curl::Multi.new
-        multi.add(mk_curl(@streaming_uri.to_s))
-        multi.perform
-      end
-    end
-
-    def mk_curl(url)
-      Curl::Easy.new(url) do |curl|
-        curl.useragent = "couchbase-ruby-client/#{Couchbase::VERSION}"
-        if @credentials
-          curl.http_auth_types = :basic
-          curl.username = @credentials[:username]
-          curl.password = @credentials[:password]
-        end
-        curl.verbose = true if Kernel.respond_to?(:debugger)
-        curl.on_body do |data|
-          config = Yajl::Parser.parse(data)
-          setup(config) if config
-          data.bytesize
+    # @param [Hash] options the options for operation
+    # @option options [String] :ttl (self.default_ttl) the time to live of this key
+    # @option options [Symbol] :format (self.default_format) format of the value
+    # @option options [Fixnum] :flags (self.default_flags) flags for this key
+    #
+    # @yieldparam [Object, Result] value old value in synchronous mode and
+    #   +Result+ object in asynchronous mode.
+    # @yieldreturn [Object] new value.
+    #
+    # @raise [Couchbase::Errors:KeyExists] if the key was updated before the the
+    #   code in block has been completed (the CAS value has been changed).
+    #
+    # @example Implement append to JSON encoded value
+    #
+    #     c.default_format = :document
+    #     c.set("foo", {"bar" => 1})
+    #     c.cas("foo") do |val|
+    #       val["baz"] = 2
+    #       val
+    #     end
+    #     c.get("foo")      #=> {"bar" => 1, "baz" => 2}
+    #
+    # @return [Fixnum] the CAS of new value
+    def cas(key, options = {})
+      options = options.merge(:extended => true)
+      if async?
+        get(key, options) do |ret|
+          val = yield(ret) # get new value from caller
+          set(ret.key, val, :cas => ret.cas)
         end
+      else
+        val, flags, ver = get(key, options)
+        val = yield(val) # get new value from caller
+        set(key, val, :cas => ver)
       end
     end
+    alias :compare_and_swap :cas
+
   end
 end

data/lib/couchbase/version.rb

@@ -1,5 +1,5 @@
 # Author:: Couchbase <info@couchbase.com>
-# Copyright:: 2011 Couchbase, Inc.
+# Copyright:: 2011, 2012 Couchbase, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,6 +15,7 @@
 # limitations under the License.
 #
 
+# Couchbase ruby client
 module Couchbase
-  VERSION = "0.9.8"
+  VERSION = "1.0.0"
 end

data/tasks/benchmark.rake

@@ -0,0 +1,6 @@
+desc 'Run benchmarks and compare them to memcached and dalli gems'
+task :benchmark => [:clean, :compile] do
+  cd File.expand_path(File.join(__FILE__, '..', '..', 'test', 'profile')) do
+    sh "bundle install && bundle exec ruby benchmark.rb | tee benchmark-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}.log"
+  end
+end

data/tasks/compile.rake

@@ -0,0 +1,52 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+gem 'rake-compiler', '>= 0.7.5'
+require "rake/extensiontask"
+
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../../couchbase.gemspec', __FILE__)))
+end
+
+# Setup compile tasks.  Configuration can be passed via ENV.
+# Example:
+#  rake compile with_libcouchbase_include=/opt/couchbase/include
+#               with_libcouchbase_lib=/opt/couchbase/lib
+#
+# or
+#
+#  rake compile with_libcouchbase_dir=/opt/couchbase
+#
+Rake::ExtensionTask.new("couchbase_ext", gemspec) do |ext|
+  CLEAN.include "#{ext.lib_dir}/*.#{RbConfig::CONFIG['DLEXT']}"
+
+  ENV.each do |key, val|
+    next unless key =~ /\Awith_(\w+)\z/i
+    opt = $1.downcase.tr('_', '-')
+    if File.directory?(path = File.expand_path(val))
+      ext.config_options << "--with-#{opt}=#{path}"
+    else
+      warn "No such directory: #{opt}: #{path}"
+    end
+  end
+end
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/tasks/doc.rake

@@ -0,0 +1,27 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'rake/clean'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = %w(--protected --no-private)
+  t.files.push('-', 'README.markdown', 'HISTORY.markdown')
+end
+
+#CLOBBER << 'test/CouchbaseMock.jar'