em-couchbase 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/CouchbaseMock.jar

data/.yardopts

@@ -0,0 +1,4 @@
+--protected
+--no-private
+-
+README.markdown

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,7 @@
+## 0.1.0 / 2012-03-27
+
+* Client bootstrap
+* Handles cluster upgrades (adding/removing nodes)
+* Support GET and SET commands
+
+

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,17 @@
+# EXAMPLE
+
+Like any Deferrable eventmachine-based protocol implementation, using EM-Couchbase involves making calls and passing blocks that serve as callbacks when the call returns.
+
+    require 'em-couchbase'
+
+    EM.run do
+      couchbase = EM::Protocols::Couchbase.connect
+      couchbase.set "a", "foo" do |response|
+        if response.success?
+          couchbase.get "a" do |response|
+            puts response.inspect
+          end
+        end
+      end
+    end
+

data/Rakefile

@@ -0,0 +1,22 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 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 'bundler/gem_tasks'
+
+Dir['tasks/*.rake'].sort.each { |f| load f }
+
+task :default => [:clobber, :compile, :test]

data/em-couchbase.gemspec

@@ -0,0 +1,48 @@
+# -*- 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.
+#
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'em-couchbase/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'em-couchbase'
+  s.version     = EventMachine::Protocols::Couchbase::VERSION
+  s.author      = 'Couchbase'
+  s.email       = 'support@couchbase.com'
+  s.license     = 'ASL-2'
+  s.homepage    = 'http://couchbase.org'
+  s.summary     = %q{An EventMachine-based Couchbase ruby driver}
+  s.description = %q{The official client library built atop of EventMachine 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.extensions    = `git ls-files -- ext/**/extconf.rb`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'yajl-ruby', '~> 1.1.0'
+  # to use fixes from eventmachine master branch
+  s.add_runtime_dependency 'eventmachine-le', '~> 1.1.0'
+  s.add_runtime_dependency 'em-http-request', '~> 1.0.1'
+
+  s.add_development_dependency 'rake', '~> 0.8.7'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rdiscount'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency RUBY_VERSION =~ /^1\.9/ ? 'ruby-debug19' : 'ruby-debug'
+end

data/lib/em-couchbase/client.rb

@@ -0,0 +1,183 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 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.
+#
+
+module EventMachine
+  module Protocols
+
+    module Couchbase
+
+      class Client
+        include EM::Deferrable
+
+        attr_reader :nodes
+        attr_reader :config
+
+        def initialize
+          @opaque = 0
+          @nodes = []
+          @admin_ports = []
+          @packets = {}
+          @upgrade_queue = EM::Queue.new
+        end
+
+        # @param options [Hash]
+        # @option options [String] :hostname ("localhost")
+        # @option options [Fixnum] :port (8091)
+        # @option options [String] :pool ("default")
+        # @option options [String] :bucket ("default")
+        # @option options [String] :username (nil)
+        # @option options [String] :password (nil)
+        def connect(options = {})
+          @config_listener = ConfigurationListener.new
+          @config_listener.on_error do |listener, error|
+            if @admin_ports.empty?
+              @on_error.call(self, error) if @on_error
+            else
+              options = options.merge(@admin_ports.shuffle!.pop)
+              @config_listener.listen(options)
+            end
+          end
+          @config_listener.on_upgrade do |config|
+            @config = config
+            config.nodes.each_with_index do |nn, ii|
+              if nodes[ii] != nn
+                nodes[ii].close_connection if nodes[ii]
+                nodes[ii] = Node.connect(nn.merge(:client => self))
+              end
+            end
+            @admin_ports = nodes.map do |node|
+              host, port = node.admin.split(':')
+              {:hostname => host, :port => port}
+            end
+            do_retry = lambda do |payload|
+              opaque, packet = payload
+              key, handler, raw = packet.values_at(:key, :handler, :raw)
+              register_handler(opaque, key, handler)
+
+              vbucket = raw[6..7].unpack("n").first
+              if @config.vbucket_map_forward
+                @config.vbucket_map[vbucket] = @config.vbucket_map_forward[vbucket].dup
+              end
+              node = @nodes[@config.vbucket_map[vbucket][0]]
+
+              register_packet(opaque, raw)
+              node.callback do
+                node.send_data(raw)
+              end
+              @upgrade_queue.pop(&do_retry)
+            end
+            @upgrade_queue.pop(&do_retry)
+            succeed
+          end
+          @config_listener.listen(options)
+          self
+        end
+
+        def on_error(&callback)
+          @on_error = callback
+        end
+
+        def register_packet(opaque, packet)
+          if packet.respond_to?(:force_encoding)
+            packet.force_encoding(Encoding::BINARY)
+          end
+          (@packets[opaque] ||= {})[:raw] = packet
+        end
+
+        def register_handler(opaque, key, handler)
+          packet = (@packets[opaque] ||= {})
+          packet[:key] = key
+          packet[:handler] = handler
+        end
+
+        def retry(reason, opaque)
+          packet = @packets.delete(opaque)
+          if packet
+            case reason
+            when :not_my_vbucket
+              @upgrade_queue.push([opaque, packet])
+            end
+          end
+        end
+
+        def run_callback(opaque, result)
+          packet = @packets.delete(opaque)
+          key, handler = packet.values_at(:key, :handler)
+          if handler.respond_to?(:call)
+            result.key = key
+            handler.call(result)
+          end
+        end
+
+        # Locate node using vbucket distribution
+        # @return [Fixnum] server index
+        def locate(key)
+          digest = Couchbase::Util.crc32_hash(key.to_s)
+          mask = @config.vbucket_map.size - 1
+          vbucket = digest & mask
+          [vbucket, @nodes[@config.vbucket_map[vbucket][0]]]
+        end
+
+        def set(key, val, options = {}, &block)
+          callback do
+            opaque = opaque_inc
+            register_handler(opaque, key, block)
+            vbucket, node = locate(key)
+            node.callback do
+              node.set(opaque, vbucket, key, val, options)
+            end
+          end
+        end
+
+        def get(*keys, &block)
+          callback do
+            if keys.last.is_a?(Hash)
+              options = keys.last.pop
+            end
+            groups = keys.inject({}) do |acc, key|
+              opaque = opaque_inc
+              register_handler(opaque, key, block)
+              vbucket, node = locate(key)
+              acc[node] ||= []
+              acc[node] << [opaque, vbucket, key]
+              acc
+            end
+            groups.each do |node, tuple|
+              node.callback do
+                node.get(tuple, options)
+              end
+            end
+          end
+        end
+
+        protected
+
+        def unbind
+          nodes.each do |node|
+            nodes.disconnect
+          end
+        end
+
+        def opaque_inc
+          @opaque += 1
+          @opaque &= 0xffffffff # 32 bits
+        end
+
+      end
+    end
+  end
+end

data/lib/em-couchbase/configuration.rb

@@ -0,0 +1,139 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 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.
+#
+
+module EventMachine
+  module Protocols
+
+    module Couchbase
+
+      class Configuration
+        attr_reader :bucket_name
+        attr_reader :bucket_type
+        attr_reader :sasl_password
+        attr_reader :node_locator
+        attr_reader :nodes
+        attr_reader :hash_algorithm
+        attr_reader :num_replicas
+        attr_reader :vbucket_map
+        attr_reader :vbucket_map_forward
+
+        def initialize(attributes = {})
+          attributes.each do |k, v|
+            if respond_to?(k)
+              instance_variable_set("@#{k}", v)
+            end
+          end
+        end
+      end
+
+      class ConfigurationListener
+        attr_reader :config_stream
+        attr_reader :options
+
+        def initialize
+          @parser = Yajl::Parser.new
+          @parser.on_parse_complete = lambda do |object|
+            if @on_upgrade
+              config = build_config(object)
+              if config
+                @on_upgrade.call(config)
+              end
+            end
+          end
+        end
+
+        def on_upgrade(&callback)
+          @on_upgrade = callback
+        end
+
+        def on_error(&callback)
+          @on_error = callback
+          if @config_stream
+            @config_stream.errback(&callback)
+          end
+        end
+
+        def listen(options = {})
+          @options = {
+            :hostname => "localhost",
+            :port => 8091,
+            :pool => "default",
+            :bucket => "default"
+          }.merge(options)
+          params = {:head => {}}
+          (username, password) = auth = @options.values_at(:username, :password)
+          if username && password
+            params[:head][:authorization] = auth
+          end
+          uri = sprintf("http://%s:%d/pools/%s/bucketsStreaming/%s/",
+                        *@options.values_at(:hostname, :port, :pool, :bucket))
+          @config_stream = EM::HttpRequest.new(URI.parse(uri),
+                                               :inactivity_timeout => 0).get params
+          @config_stream.errback do |http|
+            @on_error.call(self, http.error) if @on_error && http.error
+          end
+          @config_stream.stream do |chunk|
+            @parser << chunk
+          end
+          @config_stream
+        end
+
+        def build_config(json)
+          return unless json.is_a?(Hash)
+
+          bucket_name = json.fetch("name")
+          bucket_type = json.fetch("bucketType")
+          sasl_password = json.fetch("saslPassword")
+          node_locator = json.fetch("nodeLocator")
+          if node_locator == "vbucket"
+            server_map = json.fetch("vBucketServerMap")
+            num_replicas = server_map.fetch("numReplicas")
+            hash_algorithm = server_map.fetch("hashAlgorithm")
+            vbucket_map = server_map.fetch("vBucketMap")
+            vbucket_map_forward = server_map["vBucketMapForward"]
+          end
+          nodes = json.fetch("nodes")
+          if nodes.empty?
+            raise ArgumentError, "empty list of nodes"
+          end
+          nodes = nodes.map do |node|
+            admin = node.fetch("hostname")
+            ports = node.fetch("ports")
+            {
+              :admin => admin,
+              :proxy => admin.sub(/:\d+$/, ":#{ports.fetch("proxy")}"),
+              :direct => admin.sub(/:\d+$/, ":#{ports.fetch("direct")}"),
+              :couch => node["couchApiBase"], # nil for 1.8.x series
+              :status => node.fetch("status"),
+              :version => node.fetch("version")
+            }
+          end.sort_by{|node| node[:direct]}
+          Configuration.new(:bucket_name => bucket_name,
+                            :bucket_type => bucket_type,
+                            :sasl_password => sasl_password,
+                            :node_locator => node_locator,
+                            :num_replicas => num_replicas,
+                            :hash_algorithm => hash_algorithm,
+                            :vbucket_map => vbucket_map,
+                            :vbucket_map_forward => vbucket_map_forward,
+                            :nodes => nodes)
+        end
+      end
+
+    end
+  end
+end