couchbase-jruby-client 0.1.0-java → 0.1.5-java

data/README.md

@@ -1,6 +1,6 @@
-# Couchbase::Jruby::Client
+# Couchbase JRuby Client
 
-Attempt to recreate the ruby Couchbase cient api in Jruby and the
+Attempt to recreate the ruby Couchbase client api in JRuby and the
 Couchbase Java SDK.
 
 ## Installation
@@ -19,12 +19,17 @@ Or install it yourself as:
 
 ## Caveat
 
-Please consider this project a very incomplete "alpha" version at best.
-Most of your typical operations such as connecting to a Couchbase cluster, storing
-and retrieving documents are working, though I'm currently skeptical on the performance
-compared to the native Java SDK without this wrapper.
+Please consider this project a very incomplete "alpha" version at best. I'm getting close
+to full coverage, though there are still some missing features.  In fact, as I've gotten
+more familiar with the differences between the native ruby api and the java, there are
+definitely some features that don't make sense to implement.
 
-## Usage (Copied from )
+Ultimately hoping to get to 100% support of the couchbase-ruby-model gem.
+
+## Usage
+
+See https://github.com/couchbase/couchbase-ruby-client for usage instructions as
+they are largely the same. Important bits copied below:
 
 First of all you need to load library:
 
@@ -65,89 +70,6 @@ connection options via `Couchbase.connection_options`:
     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 the block to 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:
-
-    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 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. It is used in 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 connection uses `:quiet` mode. This mean it won't raise
-exceptions when the given key is not exists:
-
-    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
-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")

data/couchbase-jruby-client.gemspec

@@ -12,19 +12,19 @@ Gem::Specification.new do |s|
   s.summary       = %q{The unofficial jruby client library for use with Couchbase Server.}
   s.homepage      = 'https://github.com/mje113/couchbase-jruby-client'
   s.license       = 'Apache'
-  s.platform      = Gem::Platform::JAVA
+  s.platform      = 'java'
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'multi_json',   '~> 1.0'
-  s.add_runtime_dependency 'atomic',       '~> 1.1.14'
+  s.add_runtime_dependency 'multi_json',    '~> 1.0'
+  s.add_runtime_dependency 'thread_safe',   '~> 0.1.2'
 
-  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'bundler',   '~> 1.3'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'minitest', '~> 5.0.4'
+  s.add_development_dependency 'minitest',  '~> 5.0.4'
+  s.add_development_dependency 'jrjackson', '~> 0.2.3'
   s.add_development_dependency 'active_support'
-  s.add_development_dependency 'pry'
 end

data/lib/couchbase/async.rb

@@ -1,3 +1,20 @@
+# Author:: Mike Evans <mike@urlgonomics.com>
+# Copyright:: 2013 Urlgonomics LLC.
+# 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 'couchbase/async/callback'
 require 'couchbase/async/queue'
 
@@ -128,6 +145,7 @@ module Couchbase
       else
         register_callback(future, &block)
       end
+      future
     end
 
     def register_callback(future, &block)

data/lib/couchbase/bucket.rb

@@ -1,31 +1,74 @@
-require 'pry'
+# Author:: Mike Evans <mike@urlgonomics.com>
+# Copyright:: 2013 Urlgonomics LLC.
+# 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 Couchbase
 
   class Bucket
 
-    import java.io.IOException
-    import java.net.SocketAddress
-    import java.net.URI
-    import java.net.URISyntaxException
-    import java.util.ArrayList
-    import java.util.LinkedList
-    import java.util.List
-    import java.util.concurrent.Future
-    import java.util.concurrent.TimeUnit
-    import com.couchbase.client.CouchbaseClient
-    import com.couchbase.client.CouchbaseConnectionFactory
-    import com.couchbase.client.protocol.views.Query
+    java_import java.io.IOException
+    java_import java.net.SocketAddress
+    java_import java.net.URI
+    java_import java.net.URISyntaxException
+    java_import java.util.ArrayList
+    java_import java.util.LinkedList
+    java_import java.util.List
+    java_import java.util.concurrent.Future
+    java_import java.util.concurrent.TimeUnit
+    java_import com.couchbase.client.CouchbaseClient
+    java_import com.couchbase.client.CouchbaseConnectionFactory
+    java_import com.couchbase.client.CouchbaseConnectionFactoryBuilder
 
     include Couchbase::Operations
     include Couchbase::Async
 
     attr_accessor :quiet, :hostname, :port, :pool, :bucket, :username,
-                  :password, :default_ttl, :timeout,
+                  :password, :default_ttl, :timeout, :default_format,
                   :default_arithmetic_init, :transcoder
 
     attr_reader :client, :key_prefix, :default_format
 
+    DEFAULT_OPTIONS = {
+      type:                      nil,
+      quiet:                     false,
+      hostname:                  'localhost',
+      port:                      8091,
+      pool:                      'default',
+      bucket:                    'default',
+      password:                  '',
+      engine:                    nil,
+      default_ttl:               0,
+      async:                     false,
+      default_arithmetic_init:   0,
+      default_flags:             0,
+      default_format:            :document,
+      default_observe_timeout:   2_500_000,
+      on_error:                  nil,
+      on_connect:                nil,
+      timeout:                   0,
+      environment:               nil,
+      key_prefix:                nil,
+      node_list:                 nil,
+      destroying:                0,
+      connected:                 0,
+      on_connect_proc:           nil,
+      async_disconnect_hook_set: 0,
+      connected:                 false
+    }.freeze
+
     # Initialize new Bucket.
     #
     # @since 1.0.0
@@ -119,63 +162,30 @@ module Couchbase
     # @return [Bucket]
     #
     def initialize(url = nil, options = {})
-      default_options = {
-        type:                      nil,
-        quiet:                     false,
-        hostname:                  'localhost',
-        port:                      8091,
-        pool:                      'default',
-        bucket:                    'default',
-        password:                  '',
-        engine:                    nil,
-        default_ttl:               0,
-        async:                     false,
-        default_arithmetic_init:   0,
-        default_flags:             0,
-        default_format:            :document,
-        default_observe_timeout:   2500000,
-        on_error:                  nil,
-        on_connect:                nil,
-        timeout:                   0,
-        environment:               nil,
-        key_prefix:                nil,
-        node_list:                 nil,
-        destroying:                0,
-        connected:                 0,
-        on_connect_proc:           nil,
-        async_disconnect_hook_set: 0,
-        connected:                 false
-      }
-
       url_options = if url.is_a? String
-                      raise ArgumentError.new unless url =~ /^http:\/\//
-
+                      fail ArgumentError.new unless url =~ /^http:\/\//
                       uri = URI.new(url)
-
-                      {
-                        host: uri.host,
-                        port: uri.port,
-                      }.merge(path_to_pool_and_bucket(uri.path))
+                      { hostname: uri.host, port: uri.port }.
+                        merge(path_to_pool_and_bucket(uri.path))
                     elsif url.nil?
                       {}
                     else
                       url
                     end
 
-      connection_options = default_options.merge(options).merge(url_options)
+      options = Couchbase.normalize_connection_options(options)
+
+      connection_options = DEFAULT_OPTIONS.merge(url_options).merge(options)
 
       connection_options.each_pair do |key, value|
         instance_variable_set("@#{key}", value)
       end
 
-      @transcoder = case @default_format
-                    when :document
-                      Transcoder::Document
-                    when :marshal
-                      Transcoder::Marshal
-                    when :plain
-                      Transcoder::Plain
-                    end
+      @transcoders = {
+        document: Transcoder::Document.new,
+        marshal:  Transcoder::Marshal.new,
+        plain:    Transcoder::Plain.new
+      }
 
       connect unless async?
     end
@@ -189,9 +199,6 @@ module Couchbase
     end
 
     def connect
-      # TODO: doesn't work
-      ObjectSpace.define_finalizer(self, -> conn { conn.disconnect })
-
       uris = if @node_list
                Array(@node_list).map { |n| URI.new(n) }
              else
@@ -199,14 +206,15 @@ module Couchbase
              end
 
       begin
-        @connection_factory = CouchbaseConnectionFactory.new(uris, bucket.to_java_string, password.to_java_string)
-        @client = CouchbaseClient.new(@connection_factory)
+        builder = CouchbaseConnectionFactoryBuilder.new
+        builder.setTranscoder(transcoder)
+        connection_factory = builder.buildCouchbaseConnection(uris, bucket.to_java_string, password.to_java_string)
+        @client = CouchbaseClient.new(connection_factory)
         @connected = true
-      rescue Java::ComCouchbaseClientVbucket::ConfigurationException #,
-             #Java::Io::IOException
-        raise Couchbase::Error::Auth.new
+      rescue Java::ComCouchbaseClientVbucket::ConfigurationException
+        fail Couchbase::Error::Auth, 'Couchbase configurations are incorrect.'
       rescue java.net.ConnectException => e
-        raise Couchbase::Error::Connect.new
+        fail Couchbase::Error::Connect
       end
 
       self
@@ -236,10 +244,14 @@ module Couchbase
         @connection_factory = nil
         @connected = false
       else
-        raise Couchbase::Error::Connect.new
+        fail Couchbase::Error::Connect
       end
     end
 
+    def transcoder
+      @transcoders[@default_format]
+    end
+
     def on_connect(&block)
       @on_connect = block
     end
@@ -248,6 +260,14 @@ module Couchbase
       @on_error = block
     end
 
+    def version
+      {}.tap do |hash|
+        @client.getVersions.to_hash.each_pair do |ip, ver|
+          hash[ip.to_s] = ver
+        end
+      end
+    end
+
     # Compare and swap value.
     #
     # @since 1.0.0
@@ -313,126 +333,16 @@ module Couchbase
         block = Proc.new
         get(key) do |ret|
           val = block.call(ret) # get new value from caller
-          set(ret.key, val, options.merge(:cas => ret.cas, :flags => ret.flags), &block)
+          set(ret.key, val, options.merge(:cas => ret.cas, &block))
         end
       else
         val, flags, ver = get(key, :extended => true)
         val = yield(val) # get new value from caller
-        set(key, val, options.merge(:cas => ver, :flags => flags))
+        set(key, val, options.merge(:cas => ver))
       end
     end
     alias :compare_and_swap :cas
 
-    # Fetch design docs stored in current bucket
-    #
-    # @since 1.2.0
-    #
-    # @return [Hash]
-    def design_docs
-      req = make_http_request("/pools/default/buckets/#{bucket}/ddocs",
-                              :type => :management, :extended => true)
-      docmap = {}
-      req.on_body do |body|
-        res = MultiJson.load(body.value)
-        res["rows"].each do |obj|
-          if obj['doc']
-            obj['doc']['value'] = obj['doc'].delete('json')
-          end
-          doc = DesignDoc.wrap(self, obj)
-          key = doc.id.sub(/^_design\//, '')
-          next if self.environment == :production && key =~ /dev_/
-            docmap[key] = doc
-        end
-        yield(docmap) if block_given?
-      end
-      req.continue
-      async? ? nil : docmap
-    end
-
-    # Update or create design doc with supplied views
-    #
-    # @since 1.2.0
-    #
-    # @param [Hash, IO, String] data The source object containing JSON
-    #   encoded design document. It must have +_id+ key set, this key
-    #   should start with +_design/+.
-    #
-    # @return [true, false]
-    def save_design_doc(data)
-      attrs = case data
-              when String
-                MultiJson.load(data)
-              when IO
-                MultiJson.load(data.read)
-              when Hash
-                data
-              else
-                raise ArgumentError, "Document should be Hash, String or IO instance"
-              end
-      rv = nil
-      id = attrs.delete('_id').to_s
-      attrs['language'] ||= 'javascript'
-      if id !~ /\A_design\//
-        rv = Result.new(:operation => :http_request,
-                        :key => id,
-                        :error => ArgumentError.new("'_id' key must be set and start with '_design/'."))
-        yield rv if block_given?
-        raise rv.error unless async?
-      end
-      req = make_http_request(id, :body => MultiJson.dump(attrs),
-                              :method => :put, :extended => true)
-      req.on_body do |res|
-        rv = res
-        val = MultiJson.load(res.value)
-        if block_given?
-          if res.success? && val['error']
-            res.error = Error::View.new("save_design_doc", val['error'])
-          end
-          yield(res)
-        end
-      end
-      req.continue
-      unless async?
-        rv.success? or raise res.error
-      end
-    end
-
-    # Delete design doc with given id and revision.
-    #
-    # @since 1.2.0
-    #
-    # @param [String] id Design document id. It might have '_design/'
-    #   prefix.
-    #
-    # @param [String] rev Document revision. It uses latest revision if
-    #   +rev+ parameter is nil.
-    #
-    # @return [true, false]
-    def delete_design_doc(id, rev = nil)
-      ddoc = design_docs[id.sub(/^_design\//, '')]
-      unless ddoc
-        yield nil if block_given?
-        return nil
-      end
-      path = Utils.build_query(ddoc.id, :rev => rev || ddoc.meta['rev'])
-      req = make_http_request(path, :method => :delete, :extended => true)
-      rv = nil
-      req.on_body do |res|
-        rv = res
-        val = MultiJson.load(res.value)
-        if block_given?
-          if res.success? && val['error']
-            res.error = Error::View.new("delete_design_doc", val['error'])
-          end
-          yield(res)
-        end
-      end
-      req.continue
-      unless async?
-        rv.success? or raise res.error
-      end
-    end
-
     # Delete contents of the bucket
     #
     # @see http://www.couchbase.com/docs/couchbase-manual-2.0/restapi-flushing-bucket.html

data/lib/couchbase/constants.rb

@@ -1,3 +1,20 @@
+# 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.
+#
+
 module Couchbase
   module Constants # :nodoc:
     S_ID = 'id'.freeze

data/lib/couchbase/design_doc.rb

@@ -0,0 +1,83 @@
+# Author:: Mike Evans <mike@urlgonomics.com>
+# Copyright:: 2013 Urlgonomics LLC.
+# 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 Couchbase
+  class DesignDoc < ViewRow
+
+    # It isn't allowed to change design document ID after
+    # initialization
+    undef id=
+
+    def initialize(bucket, doc)
+      @all_views = {}
+      @bucket    = bucket
+      @name      = doc.name
+      @views     = doc.views
+      @spatial   = doc.spatial_views
+      @doc       = {}
+      @views.each   { |view| @all_views[view.name] = "#{@name}/_view/#{view.name}" }
+      @spatial.each { |view| @all_views[view.name] = "#{@name}/_spatial/#{view.name}" }
+    end
+
+    def method_missing(meth, *args)
+      if path = @all_views[meth.to_s]
+        View.new(@bucket, path, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(meth, *args)
+      @all_views[meth.to_s] || super
+    end
+
+    # The list of views defined or empty array
+    #
+    # @since 1.2.1
+    #
+    # @return [Array<View>]
+    attr_accessor :views
+
+    # The list of spatial views defined or empty array
+    #
+    # @since 1.2.1
+    #
+    # @return [Array<View>]
+    attr_accessor :spatial
+
+    # Check if the document has views defines
+    #
+    # @since 1.2.1
+    #
+    # @see DesignDoc#views
+    #
+    # @return [true, false] +true+ if the document have views
+    def has_views?
+      !@views.empty?
+    end
+
+    def inspect
+      desc = "#<#{self.class.name}:#{self.object_id}"
+      [:@id, :@views, :@spatial].each do |iv|
+        desc << " #{iv}=#{instance_variable_get(iv).inspect}"
+      end
+      desc << ">"
+      desc
+    end
+
+  end
+end

data/lib/couchbase/error.rb

@@ -1,7 +1,32 @@
+# Author:: Mike Evans <mike@urlgonomics.com>
+# Copyright:: 2013 Urlgonomics LLC.
+# 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 Couchbase
   module Error
     class Base < Exception
+      attr_accessor :cas, :error, :inner_exception, :key, :operation, :status
+
+      def to_s
+        if inner_exception
+          inner_exception.to_s
+        else
+          super
+        end
+      end
     end
 
     class Connect < Base
@@ -24,5 +49,11 @@ module Couchbase
 
     class ValueFormat < Base
     end
+
+    class TemporaryFail < Base
+    end
+
+    class NotStored < Base
+    end
   end
 end