couchbase-jruby-client 0.2.2-java → 1.0.4-java

data/lib/couchbase/view.rb

@@ -1,378 +1,88 @@
-# Author:: Couchbase <info@couchbase.com>
-# Copyright:: 2011 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 'base64'
-
 module Couchbase
-
-  module Error
-    class View < Base
-      attr_reader :from, :reason
-
-      def initialize(from, reason, prefix = "SERVER: ")
-        @from = from
-        @reason = reason
-        super("#{prefix}#{from}: #{reason}")
-      end
-    end
-
-    class HTTP < Base
-      attr_reader :type, :reason
-
-      def parse_body!
-        if @body
-          hash = MultiJson.load(@body)
-          if hash["errors"]
-            @type = :invalid_arguments
-            @reason = hash["errors"].values.join(" ")
-          else
-            @type = hash["error"]
-            @reason = hash["reason"]
-          end
-        end
-      rescue MultiJson::DecodeError
-        @type = @reason = nil
-      end
-
-      def to_s
-        str = super
-        if @type || @reason
-          str.sub(/ \(/, ": #{[@type, @reason].compact.join(": ")} (")
-        else
-          str
-        end
-      end
-    end
-  end
-
-  # This class implements Couchbase View execution
-  #
-  # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views.html
   class View
+    java_import com.couchbase.client.java.view.ViewQuery
+    java_import com.couchbase.client.java.document.json.JsonArray
+    java_import com.couchbase.client.java.document.RawJsonDocument
 
-    include Enumerable
-    include Constants
-
-    class ArrayWithTotalRows < Array # :nodoc:
-      attr_accessor :total_rows
-      alias total_entries total_rows
+    def initialize(design_doc, view, bucket)
+      @format = :json
+      @bucket = bucket.bucket
+      @view_query = ViewQuery.from(design_doc, view.to_s)
     end
 
-    attr_reader :params, :design_doc, :name
-
-    # Set up view endpoint and optional params
-    #
-    # @param [Couchbase::Bucket] bucket Connection object which
-    #   stores all info about how to make requests to Couchbase views.
-    #
-    # @param [String] endpoint Full Couchbase View URI.
-    #
-    # @param [Hash] params Optional parameter which will be passed to
-    #   {View#fetch}
-    #
-    def initialize(bucket, endpoint, params = {})
-      @bucket   = bucket
-      @endpoint = endpoint
-      @design_doc, @name = parse_endpoint(endpoint)
-      @wrapper_class = params.delete(:wrapper_class) || ViewRow
-      @params   = { connection_timeout: 75_000 }.merge(params)
-      unless @wrapper_class.respond_to?(:wrap)
-        raise ArgumentError, "wrapper class should respond to :wrap, check the options"
-      end
+    def key(key)
+      @view_query.key(convert_key(key))
+      self
     end
 
-    # Yields each document that was fetched by view. It doesn't instantiate
-    # all the results because of streaming JSON parser. Returns Enumerator
-    # unless block given.
-    #
-    # @param [Hash] params Params for Couchdb query. Some useful are:
-    #   :start_key, :start_key_doc_id, :descending. See {View#fetch}.
-    #
-    # @example Use each method with block
-    #
-    #   view.each do |doc|
-    #     # do something with doc
-    #   end
-    #
-    # @example Use Enumerator version
-    #
-    #   enum = view.each  # request hasn't issued yet
-    #   enum.map{|doc| doc.title.upcase}
-    #
-    # @example Pass options during view initialization
-    #
-    #   endpoint = "http://localhost:5984/default/_design/blog/_view/recent"
-    #   view = View.new(conn, endpoint, :descending => true)
-    #   view.each do |document|
-    #     # do something with document
-    #   end
-    #
-    def each(params = {})
-      return enum_for(:each, params) unless block_given?
-      fetch(params) { |doc| yield(doc) }
+    def keys(keys)
+      @view_query.keys(JsonArray.from(keys.to_java))
+      self
     end
 
-    def first(params = {})
-      params = params.merge(:limit => 1)
-      fetch(params).first
+    def start_key(key)
+      @view_query.start_key(convert_key(key))
+      self
     end
 
-    def take(n, params = {})
-      params = params.merge(:limit => n)
-      fetch(params)
+    def end_key(key)
+      @view_query.end_key(convert_key(key))
+      self
     end
 
-    # Registers callback function for handling error objects in view
-    # results stream.
-    #
-    # @yieldparam [String] from Location of the node where error occured
-    # @yieldparam [String] reason The reason message describing what
-    #   happened.
-    #
-    # @example Using +#on_error+ to log all errors in view result
-    #
-    #     # JSON-encoded view result
-    #     #
-    #     # {
-    #     #   "total_rows": 0,
-    #     #   "rows": [ ],
-    #     #   "errors": [
-    #     #     {
-    #     #       "from": "127.0.0.1:5984",
-    #     #       "reason": "Design document `_design/testfoobar` missing in database `test_db_b`."
-    #     #     },
-    #     #     {
-    #     #       "from": "http:// localhost:5984/_view_merge/",
-    #     #       "reason": "Design document `_design/testfoobar` missing in database `test_db_c`."
-    #     #     }
-    #     #   ]
-    #     # }
-    #
-    #     view.on_error do |from, reason|
-    #       logger.warn("#{view.inspect} received the error '#{reason}' from #{from}")
-    #     end
-    #     docs = view.fetch
-    #
-    # @example More concise example to just count errors
-    #
-    #     errcount = 0
-    #     view.on_error{|f,r| errcount += 1}.fetch
-    #
-    def on_error(&callback)
-      @on_error = callback
-      self  # enable call chains
+    def limit(num)
+      @view_query.limit(num)
+      self
     end
 
-    # Performs query to Couchbase view. This method will stream results if block
-    # given or return complete result set otherwise. In latter case it defines
-    # method +total_rows+ returning corresponding entry from
-    # Couchbase result object.
-    #
-    # @note Avoid using +$+ symbol as prefix for properties in your
-    #   documents, because server marks with it meta fields like flags and
-    #   expiration, therefore dollar prefix is some kind of reserved. It
-    #   won't hurt your application. Currently the {ViewRow}
-    #   class extracts +$flags+, +$cas+ and +$expiration+ properties from
-    #   the document and store them in {ViewRow#meta} hash.
-    #
-    # @param [Hash] params parameters for Couchbase query.
-    # @option params [true, false] :include_docs (false) Include the
-    #   full content of the documents in the return. Note that the document
-    #   is fetched from the in memory cache where it may have been changed
-    #   or even deleted. See also +:quiet+ parameter below to control error
-    #   reporting during fetch.
-    # @option params [true, false] :quiet (true) Do not raise error if
-    #   associated document not found in the memory. If the parameter +true+
-    #   will use +nil+ value instead.
-    # @option params [true, false] :descending (false) Return the documents
-    #   in descending by key order
-    # @option params [String, Fixnum, Hash, Array] :key Return only
-    #   documents that match the specified key. Will be JSON encoded.
-    # @option params [Array] :keys The same as +:key+, but will work for
-    #   set of keys. Will be JSON encoded.
-    # @option params [String, Fixnum, Hash, Array] :startkey Return
-    #   records starting with the specified key. +:start_key+ option should
-    #   also work here. Will be JSON encoded.
-    # @option params [String] :startkey_docid Document id to start with
-    #   (to allow pagination for duplicate startkeys). +:start_key_doc_id+
-    #   also should work.
-    # @option params [String, Fixnum, Hash, Array] :endkey Stop returning
-    #   records when the specified key is reached. +:end_key+ option should
-    #   also work here. Will be JSON encoded.
-    # @option params [String] :endkey_docid Last document id to include
-    #   in the output (to allow pagination for duplicate startkeys).
-    #   +:end_key_doc_id+ also should work.
-    # @option params [true, false] :inclusive_end (true) Specifies whether
-    #   the specified end key should be included in the result
-    # @option params [Fixnum] :limit Limit the number of documents in the
-    #   output.
-    # @option params [Fixnum] :skip Skip this number of records before
-    #   starting to return the results.
-    # @option params [String, Symbol] :on_error (:continue) Sets the
-    #   response in the event of an error. Supported values:
-    #   :continue:: Continue to generate view information in the event of an
-    #               error, including the error information in the view
-    #               response stream.
-    #   :stop::     Stop immediately when an error condition occurs. No
-    #               further view information will be returned.
-    # @option params [Fixnum] :connection_timeout (75000) Timeout before the
-    #   view request is dropped (milliseconds)
-    # @option params [true, false] :reduce (true) Use the reduction function
-    # @option params [true, false] :group (false) Group the results using
-    #   the reduce function to a group or single row.
-    # @option params [Fixnum] :group_level Specify the group level to be
-    #   used.
-    # @option params [String, Symbol, false] :stale (:update_after) Allow
-    #   the results from a stale view to be used. Supported values:
-    #   false::         Force a view update before returning data
-    #   :ok::           Allow stale views
-    #   :update_after:: Allow stale view, update view after it has been
-    #                   accessed
-    # @option params [Hash] :body Accepts the same parameters, except
-    #   +:body+ of course, but sends them in POST body instead of query
-    #   string. It could be useful for really large and complex parameters.
-    #
-    # @yieldparam [Couchbase::ViewRow] document
-    #
-    # @return [Array] with documents. There will be +total_entries+
-    #   method defined on this array if it's possible.
-    #
-    # @raise [Couchbase::Error::View] when +on_error+ callback is nil and
-    #   error object found in the result stream.
-    #
-    # @example Query +recent_posts+ view with key filter
-    #   doc.recent_posts(:body => {:keys => ["key1", "key2"]})
-    #
-    # @example Fetch second page of result set (splitted in 10 items per page)
-    #   page = 2
-    #   per_page = 10
-    #   doc.recent_posts(:skip => (page - 1) * per_page, :limit => per_page)
-    #
-    # @example Simple join using Map/Reduce
-    #   # Given the bucket with Posts(:id, :type, :title, :body) and
-    #   # Comments(:id, :type, :post_id, :author, :body). The map function
-    #   # below (in javascript) will build the View index called
-    #   # "recent_posts_with_comments" which will behave like left inner join.
-    #   #
-    #   #   function(doc) {
-    #   #     switch (doc.type) {
-    #   #       case "Post":
-    #   #         emit([doc.id, 0], null);
-    #   #         break;
-    #   #       case "Comment":
-    #   #         emit([doc.post_id, 1], null);
-    #   #         break;
-    #   #     }
-    #   #   }
-    #   #
-    #   post_id = 42
-    #   doc.recent_posts_with_comments(:start_key => [post_id, 0],
-    #                                  :end_key => [post_id, 1],
-    #                                  :include_docs => true)
-    def fetch(params = {})
-      params = @params.merge(params)
-      # quiet = params.fetch(:quiet, true)
-
-      view = @bucket.client.getView(@design_doc, @name)
-
-      query = Query.new(params)
-
-      request = @bucket.client.query(view, query.generate)
-
-      if block_given?
-        fetch_block(request, Proc.new)
-      else
-        fetch_array(request)
-      end
+    def skip(num)
+      @view_query.skip(num)
+      self
     end
 
-    # Method for fetching asynchronously all rows and passing array to callback
-    #
-    # Parameters are same as for {View#fetch} method, but callback is called for whole set for
-    # rows instead of one by each.
-    #
-    # @example
-    #   con.run do
-    #     doc.recent_posts.fetch_all do |posts|
-    #       do_something_with_all_posts(posts)
-    #     end
-    #   end
-    def fetch_all(params = {}, &block)
-      return fetch(params) unless @bucket.async?
-      raise ArgumentError, "Block needed for fetch_all in async mode" unless block
-
-      all = []
-      fetch(params) do |row|
-        all << row
-        if row.last?
-          @bucket.create_timer(0) { block.call(all) }
-        end
-      end
+    def group(group = true)
+      @view_query.group(group)
+      self
     end
 
-
-    # Returns a string containing a human-readable representation of the {View}
-    #
-    # @return [String]
-    def inspect
-      %(#<#{self.class.name}:#{self.object_id} @endpoint=#{@endpoint.inspect} @params=#{@params.inspect}>)
+    def group_level(level)
+      @view_query.group_level(level)
+      self
     end
 
-    private
-
-    def fetch_array(request)
-      docs = request.to_a.map { |data|
-        wrap_or_parse_data(data)
-      }
-      docs = ArrayWithTotalRows.new(docs)
-      docs.total_rows = request.size
-      docs
+    def reduce(reduce = true)
+      @view_query.reduce(reduce)
+      self
     end
 
-    def fetch_block(request, block)
-      request.each do |data|
-        doc = wrap_or_parse_data(data)
-        block.call(doc)
-      end
-      nil
+    def fresh
+      @view_query.stale(com.couchbase.client.java.view.Stale::FALSE)
+      self
     end
 
-    def wrap_or_parse_data(data)
-      if data.is_a? ViewRowReduced
-        data.value
-      else
-        @wrapper_class.wrap(@bucket, data)
+    def fetch
+      results = @bucket.query(@view_query)
+      {}.tap do |response|
+        results.each do |view_row|
+          if view_row.id.nil?
+            # Reduced view
+            return view_row.value
+          else
+            doc = view_row.document(RawJsonDocument.java_class)
+            response[view_row.id] = doc.nil? ? nil : Document.new(doc)
+          end
+        end
       end
     end
 
-    def send_error(*args)
-      if @on_error
-        @on_error.call(*args.take(2))
-      else
-        raise Error::View.new(*args)
-      end
-    end
+    private
 
-    def parse_endpoint(endpoint)
-      parts = endpoint.split('/')
-      if endpoint =~ /^_design/
-        [parts[1], parts[3]]
+    def convert_key(key)
+      case key
+      when Array
+        JsonArray.from(key.to_java)
       else
-        [parts[0], parts[2]]
+        key
       end
     end
   end

data/lib/couchbase.rb

@@ -15,38 +15,23 @@
 # limitations under the License.
 #
 
-unless RUBY_PLATFORM =~ /java/
-  fail "This gem is only compatible with a java-based ruby environment like JRuby."
-  exit 255
-end
+fail 'This gem is only compatible with JRuby.' unless RUBY_PLATFORM =~ /java/
 
-require 'java'
-require 'jars/commons-codec-1.5.jar'
-require 'jars/couchbase-client-1.3.2.jar'
-require 'jars/jettison-1.1.jar'
-require 'jars/httpcore-4.3.1.jar'
-require 'jars/httpcore-nio-4.3.1.jar'
-require 'jars/netty-3.5.5.Final.jar'
-require 'jars/spymemcached-2.10.5.jar'
+require 'jars/rxjava-1.0.8'
+require 'jars/rxjruby-0.0.1'
+require 'jars/couchbase-core-io-1.1.4'
+require 'jars/couchbase-java-client-2.1.4'
+require 'rx/lang/jruby/interop'
 require 'couchbase/version'
-require 'uri'
-require 'thread_safe'
-require 'couchbase/transcoder'
-require 'couchbase/async'
-require 'couchbase/operations'
 require 'couchbase/error'
-require 'couchbase/constants'
-require 'couchbase/utils'
+require 'couchbase/document'
+require 'couchbase/operations'
+require 'couchbase/cluster'
 require 'couchbase/bucket'
-require 'couchbase/view_row'
 require 'couchbase/view'
-require 'couchbase/result'
-require 'couchbase/cluster'
 require 'couchbase/design_doc'
+require 'couchbase/configuration'
 require 'couchbase/view'
-require 'couchbase/query'
-
-include Java
 
 at_exit do
   Couchbase.disconnect
@@ -55,131 +40,42 @@ end
 # Couchbase jruby client
 module Couchbase
 
-  @@buckets     = ThreadSafe::Cache.new
-  @@connections = ThreadSafe::Array.new
+  class ConfigurationError < Error::Base; end
 
-  class << self
+  module_function
 
-    # The method +connect+ initializes new Bucket instance with all arguments passed.
-    #
-    # @since 1.0.0
-    #
-    # @see Bucket#initialize
-    #
-    # @example Use default values for all options
-    #   Couchbase.connect
-    #
-    # @example Establish connection with couchbase default pool and default bucket
-    #   Couchbase.connect("http://localhost:8091/pools/default")
-    #
-    # @example Select custom bucket
-    #   Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog')
-    #
-    # @example Specify bucket credentials
-    #   Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog', :username => 'bucket', :password => 'secret')
-    #
-    # @example Use URL notation
-    #   Couchbase.connect("http://bucket:secret@localhost:8091/pools/default/buckets/blog")
-    #
-    # @return [Bucket] connection instance
-    def connect(*options)
-      bucket = Bucket.new(*(options.flatten))
-      @@connections << bucket
-      bucket
-    end
-    alias :new :connect
-
-    # Default connection options
-    #
-    # @since 1.1.0
-    #
-    # @example Using {Couchbase#connection_options} to change the bucket
-    #   Couchbase.connection_options = {:bucket => 'blog'}
-    #   Couchbase.bucket.name     #=> "blog"
-    #
-    # @return [Hash, String]
-    attr_reader :connection_options
+  @conn = Configuration.new
 
-    def connection_options=(options)
-      @connection_options = normalize_connection_options(options)
-    end
-
-    def normalize_connection_options(options)
-      Hash[ options.map { |k, v| [k.to_sym, v] } ]
-    end
+  def connection_options=(options)
+    fail ConfigurationError, 'Cannot reconfigure an already connected cluster.' if connected?
+    @conn = Configuration.new(options)
+  end
 
-    # The connection instance for current thread
-    #
-    # @since 1.1.0
-    #
-    # @see Couchbase.connection_options
-    #
-    # @example
-    #   Couchbase.bucket.set("foo", "bar")
-    #
-    # @example Set connection options using Hash
-    #   Couchbase.connection_options = {:node_list => ["example.com:8091"]}
-    #   Couchbase.bucket("slot1").set("foo", "bar")
-    #   Couchbase.bucket("slot1").bucket #=> "default"
-    #   Couchbase.connection_options[:bucket] = "test"
-    #   Couchbase.bucket("slot2").bucket #=> "test"
-    #
-    # @example Set connection options using URI
-    #   Couchbase.connection_options = "http://example.com:8091/pools"
-    #   Couchbase.bucket("slot1").set("foo", "bar")
-    #   Couchbase.bucket("slot1").bucket #=> "default"
-    #   Couchbase.connection_options = "http://example.com:8091/pools/buckets/test"
-    #   Couchbase.bucket("slot2").bucket #=> "test"
-    #
-    # @example Use named slots to keep a connection
-    #   Couchbase.connection_options = {
-    #     :node_list => ["example.com", "example.org"],
-    #     :bucket => "users"
-    #   }
-    #   Couchbase.bucket("users").set("john", {"balance" => 0})
-    #   Couchbase.connection_options[:bucket] = "orders"
-    #   Couchbase.bucket("other").set("john:1", {"products" => [42, 66]})
-    #
-    # @return [Bucket]
-    def bucket(name = nil)
-      name ||= case @connection_options
-               when Hash
-                 @connection_options[:bucket]
-               when String
-                 path = URI.parse(@connection_options).path
-                 path[%r(^(/pools/([A-Za-z0-9_.-]+)(/buckets/([A-Za-z0-9_.-]+))?)?), 3] || 'default'
-               else
-                 'default'
-               end
+  def connected?
+    @cluster
+  end
 
-      @@buckets[name] ||= connect(connection_options)
-    end
+  def disconnect
+    @cluster.disconnect if @cluster
+    @buckets = nil
+  end
 
-    # Set a connection instance for current thread
-    #
-    # @since 1.1.0
-    #
-    # @return [Bucket]
-    def bucket=(connection)
-      name = @connection_options && @connection_options[:bucket] || "default"
-      @@buckets[name] = connection
-    end
-    alias set_bucket bucket=
+  def cluster
+    @cluster ||= Cluster.new(@conn.hosts)
+  end
 
-    def connected?
-      !!@@buckets.empty?
-    end
+  def bucket(name = nil)
+    name ||= :default
+    buckets[name.to_sym]
+  end
 
-    def disconnect
-      @@buckets.each_pair do |bucket, connection|
-        connection.disconnect if connection.connected?
+  def buckets
+    @buckets ||= begin
+      {}.tap do |buckets|
+        @conn.buckets.each do |bucket|
+          buckets[bucket.name.to_sym] = cluster.open_bucket(bucket.name, bucket.password)
+        end
       end
-      @@connections.each do |connection|
-        connection.disconnect if connection.connected?
-      end
-      @@buckets     = ThreadSafe::Cache.new
-      @@connections = ThreadSafe::Array.new
     end
   end
 end
-

data/test/{test_cas.rb → helper.rb}

@@ -15,18 +15,23 @@
 # limitations under the License.
 #
 
-require File.join(File.dirname(__FILE__), 'setup')
+gem 'minitest'
+require 'coveralls'
+Coveralls.wear!
+require 'minitest'
+require 'minitest/autorun'
+require 'pry'
+require 'couchbase'
+require 'ostruct'
 
-class TestCas < Minitest::Test
+module Minitest
+  class Test
 
-  def test_compare_and_swap
-    cb.set(uniq_id, {"bar" => 1})
-    cb.cas(uniq_id) do |val|
-      val["baz"] = 2
-      val
+    def uniq_id(*suffixes)
+      test_id = [caller.first[/.*[` ](.*)'/, 1], suffixes].compact.join('_')
+      @ids ||= {}
+      @ids[test_id] ||= Time.now.to_f
+      [test_id, @ids[test_id]].join('_')
     end
-    val = cb.get(uniq_id)
-    expected = {"bar" => 1, "baz" => 2}
-    assert_equal expected, val
   end
 end