couchbase-jruby-client 0.1.1

data/LICENSE.txt

@@ -0,0 +1,203 @@
+Copyright (c) 2013 Mike Evans
+
+                              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.md

@@ -0,0 +1,349 @@
+# Couchbase JRuby Client
+
+Attempt to recreate the ruby Couchbase client api in JRuby and the
+Couchbase Java SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'couchbase-jruby-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install couchbase-jruby-client
+
+## Caveat
+
+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.
+
+Ultimately hoping to get to 100% support of the couchbase-ruby-model gem.
+
+## Usage (Copied from couchbase-ruby-client)
+
+First of all you need to load 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`
+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".
+
+    c = Couchbase.connect
+
+This is equivalent to following forms:
+
+    c = Couchbase.connect("http://localhost:8091/pools/default/buckets/default")
+    c = Couchbase.connect("http://localhost:8091/pools/default")
+    c = Couchbase.connect("http://localhost:8091")
+    c = Couchbase.connect(:hostname => "localhost")
+    c = Couchbase.connect(:hostname => "localhost", :port => 8091)
+    c = Couchbase.connect(:pool => "default", :bucket => "default")
+
+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.
+
+    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
+connection options via `Couchbase.connection_options`:
+
+    Couchbase.connection_options = {:bucket => 'blog'}
+    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")
+    val, flags, cas = c.get("foo", :extended => true)
+
+Get and touch
+
+    val = c.get("foo", :ttl => 10)
+
+Get multiple values. In quiet mode will put `nil` values on missing
+positions:
+
+    vals = c.get("foo", "bar", "baz")
+    val_foo, val_bar, val_baz = c.get("foo", "bar", "baz")
+    c.run do
+      c.get("foo") do |ret|
+        ret.success?
+        ret.error
+        ret.key
+        ret.value
+        ret.flags
+        ret.cas
+      end
+    end
+
+Get multiple values with extended information. The result will
+represented by hash with tuples `[value, flags, cas]` as a value.
+
+    vals = c.get("foo", "bar", "baz", :extended => true)
+    vals.inspect    #=> {"baz"=>["3", 0, 4784582192793125888],
+                         "foo"=>["1", 0, 8835713818674332672],
+                         "bar"=>["2", 0, 10805929834096100352]}
+
+Hash-like syntax
+
+    c["foo"]
+    c["foo", "bar", "baz"]
+    c["foo", {:extended => true}]
+    c["foo", :extended => true]         # for ruby 1.9.x only
+
+### Touch
+
+    c.touch("foo")                      # use :default_ttl
+    c.touch("foo", 10)
+    c.touch("foo", :ttl => 10)
+    c.touch("foo" => 10, "bar" => 20)
+    c.touch("foo" => 10, "bar" => 20){|key, success|  }
+
+### Set
+
+    c.set("foo", "bar")
+    c.set("foo", "bar", :flags => 0x1000, :ttl => 30, :format => :plain)
+    c["foo"] = "bar"
+    c["foo", {:flags => 0x1000, :format => :plain}] = "bar"
+    c["foo", :flags => 0x1000] = "bar"          # for ruby 1.9.x only
+    c.set("foo", "bar", :cas => 8835713818674332672)
+    c.set("foo", "bar"){|cas, key, operation|  }
+
+### Add
+
+Add command will fail if the key already exists. It accepts the same
+options as set command above.
+
+    c.add("foo", "bar")
+    c.add("foo", "bar", :flags => 0x1000, :ttl => 30, :format => :plain)
+
+### Replace
+
+The replace command will fail if the key already exists. It accepts the same
+options as set command above.
+
+    c.replace("foo", "bar")
+
+### Prepend/Append
+
+These commands are meaningful when you are using the `:plain` value format,
+because the concatenation is performed by server which has no idea how
+to merge to JSON values or values in ruby Marshal format. You may receive
+an `Couchbase::Error::ValueFormat` error.
+
+    c.set("foo", "world")
+    c.append("foo", "!")
+    c.prepend("foo", "Hello, ")
+    c.get("foo")                    #=> "Hello, world!"
+
+### Increment/Decrement
+
+These commands increment the value assigned to the key. It will raise
+Couchbase::Error::DeltaBadval if the delta or value is not a number.
+
+    c.set("foo", 1)
+    c.incr("foo")                   #=> 2
+    c.incr("foo", :delta => 2)      #=> 4
+    c.incr("foo", 4)                #=> 8
+    c.incr("foo", -1)               #=> 7
+    c.incr("foo", -100)             #=> 0
+    c.run do
+      c.incr("foo") do |ret|
+        ret.success?
+        ret.value
+        ret.cas
+      end
+    end
+
+    c.set("foo", 10)
+    c.decr("foo", 1)                #=> 9
+    c.decr("foo", 100)              #=> 0
+    c.run do
+      c.decr("foo") do |ret|
+        ret.success?
+        ret.value
+        ret.cas
+      end
+    end
+
+    c.incr("missing1", :initial => 10)      #=> 10
+    c.incr("missing1", :initial => 10)      #=> 11
+    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:
+
+    c["foo"] = 10
+    c["foo"] -= 20                  #=> -10
+
+### Delete
+
+    c.delete("foo")
+    c.delete("foo", :cas => 8835713818674332672)
+    c.delete("foo", 8835713818674332672)
+    c.run do
+      c.delete do |ret|
+        ret.success?
+        ret.key
+      end
+    end
+
+### Flush
+
+Flush the items in the cluster.
+
+    c.flush
+    c.run do
+      c.flush do |ret|
+        ret.success?
+        ret.node
+      end
+    end
+
+### Stats
+
+Return statistics from each node in the cluster
+
+    c.stats
+    c.stats(:memory)
+    c.run do
+      c.stats do |ret|
+        ret.success?
+        ret.node
+        ret.key
+        ret.value
+      end
+    end
+
+The result is represented as a hash with the server node address as
+the key and stats as key-value pairs.
+
+    {
+      "threads"=>
+        {
+          "172.16.16.76:12008"=>"4",
+          "172.16.16.76:12000"=>"4",
+          # ...
+        },
+      "connection_structures"=>
+        {
+          "172.16.16.76:12008"=>"22",
+          "172.16.16.76:12000"=>"447",
+          # ...
+        },
+      "ep_max_txn_size"=>
+        {
+          "172.16.16.76:12008"=>"1000",
+          "172.16.16.76:12000"=>"1000",
+          # ...
+        },
+      # ...
+    }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/couchbase-jruby-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'couchbase/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'couchbase-jruby-client'
+  s.version       = Couchbase::VERSION
+  s.authors       = ['Mike Evans']
+  s.email         = ['mike@urlgonomics.com']
+  s.description   = %q{Couchbase JRuby driver}
+  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.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_development_dependency 'bundler',   '~> 1.3'
+  s.add_development_dependency 'rake'
+  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/callback.rb

@@ -0,0 +1,19 @@
+module Couchbase
+  module Async
+    class Callback
+      include Java::NetSpyMemcachedInternal::OperationCompletionListener
+
+      def initialize(operation, &callback)
+        @operation, @callback = operation, callback
+      end
+
+      def onComplete(future)
+        result = Couchbase::Result.new(operation: @operation, future: future)
+        @callback.call(result)
+      rescue Exception => e
+        result.error = e
+        return result
+      end
+    end
+  end
+end

data/lib/couchbase/async/queue.rb

@@ -0,0 +1,26 @@
+module Couchbase
+  module Async
+    class Queue
+
+      def initialize(bucket)
+        @bucket  = bucket
+        @futures = []
+      end
+
+      def add_future(future, options, &block)
+        @futures << [ future, options, block ]
+      end
+
+      def join
+        while future = @futures.pop
+          begin
+            future, options, callback = future
+            future.get
+            result = Couchbase::Result.new({ bucket: @bucket, future: future }.merge(options))
+            callback.call(result) unless callback.nil?
+          end
+        end
+      end
+    end
+  end
+end