rufus-jig 0.1.17 → 0.1.18

data/README.rdoc

@@ -71,6 +71,8 @@ posting...
 For the real thing : http://github.com/couchrest/couchrest
 There is also the excellent : http://github.com/langalex/couch_potato
 
+Warning : rufus-jig >= 0.1.18 is meant for CouchDB >= 0.11.
+
 The class Rufus::Jig::Couch provides a get/put/delete trio that is couch-oriented. Json encoding/decoding is automatically handled as well as
 
 put and delete return nil in case of success and true (conflict) or and exception else.
@@ -110,6 +112,23 @@ put and delete return nil in case of success and true (conflict) or and exceptio
 
 Warning : Patron, as of 0.4.5 is timing out when PUTting images.
 
+=== on_change
+
+Continuous feed with a 20s heartbeat :
+
+  db.on_change do |doc_id, deleted|
+    puts "doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}"
+  end
+  
+  db.on_change do |doc_id, deleted, doc|
+    puts "doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}"
+    p doc
+  end
+
+Please note the 3 param block, it includes the changed document (Note : this only work with CouchDB >= 0.11).
+
+This is a blocking method (one may want to wrap it in a thread).
+
 
 == rdoc
 

data/Rakefile

@@ -40,7 +40,7 @@ Jeweler::Tasks.new do |gem|
   gem.test_file = 'test/test.rb'
 
   gem.add_dependency 'rufus-lru'
-  gem.add_dependency 'rufus-json'
+  gem.add_dependency 'rufus-json', '>= 0.2.1'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'jeweler'

data/lib/rufus/jig/couch.rb

@@ -22,6 +22,9 @@
 # Made in Japan.
 #++
 
+require 'socket'
+  # for #on_change
+
 
 module Rufus::Jig
 
@@ -61,10 +64,10 @@ module Rufus::Jig
 
       pa = adjust(path)
 
-      if @opts[:re_put_ok] == false && payload['_rev']
-        rr = delete(path, payload['_rev'])
-        return rr unless rr.nil?
-      end
+      #if @opts[:re_put_ok] == false && payload['_rev']
+      #  rr = delete(path, payload['_rev'])
+      #  return rr unless rr.nil?
+      #end
 
       r = @http.put(pa, payload, :content_type => :json, :cache => false)
 
@@ -224,6 +227,49 @@ module Rufus::Jig
       @http.delete(path)
     end
 
+    # Watches the database for changes.
+    #
+    #   db.on_change do |doc_id, deleted|
+    #     puts "doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}"
+    #   end
+    #
+    #   db.on_change do |doc_id, deleted, doc|
+    #     puts "doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}"
+    #     p doc
+    #   end
+    #
+    # This is a blocking method. One might want to wrap it inside of a Thread.
+    #
+    # Note : doc inclusion (third parameter to the block) only works with
+    # CouchDB >= 0.11.
+    #
+    def on_change (opts={}, &block)
+
+      query = {
+        'feed' => 'continuous',
+        'heartbeat' => opts[:heartbeat] || 20_000 }
+      query['include_docs'] = true if block.arity > 2
+      query = query.map { |k, v| "#{k}=#{v}" }.join('&')
+
+      socket = TCPSocket.open(@http.host, @http.port)
+
+      socket.print("GET /#{path}/_changes?#{query} HTTP/1.1\r\n")
+      socket.print("User-Agent: rufus-jig #{Rufus::Jig::VERSION}\r\n")
+      socket.print("\r\n")
+
+      loop do
+        data = socket.gets
+        break if data.nil?
+        data = (Rufus::Json.decode(data) rescue nil)
+        next unless data.is_a?(Hash)
+        args = [ data['id'], (data['deleted'] == true) ]
+        args << data['doc'] if block.arity > 2
+        block.call(*args)
+      end
+
+      on_change(opts, &block) if opts[:reconnect]
+    end
+
     protected
 
     def adjust (path)

data/lib/rufus/jig/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Jig
-  VERSION = '0.1.17'
+  VERSION = '0.1.18'
 end
 end
 

data/rufus-jig.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-jig}
-  s.version = "0.1.17"
+  s.version = "0.1.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer"]
-  s.date = %q{2010-03-22}
+  s.date = %q{2010-05-11}
   s.description = %q{
     Json Interwebs Get.
 
@@ -48,6 +48,7 @@ Gem::Specification.new do |s|
      "test/ct_2_couchdb_options.rb",
      "test/ct_3_couchdb_views.rb",
      "test/ct_4_attachments.rb",
+     "test/ct_5_couchdb_continuous.rb",
      "test/server.rb",
      "test/test.rb",
      "test/to.sh",
@@ -77,7 +78,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
-      s.add_runtime_dependency(%q<rufus-json>, [">= 0"])
+      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.1"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
@@ -85,7 +86,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<em-http-request>, [">= 0"])
     else
       s.add_dependency(%q<rufus-lru>, [">= 0"])
-      s.add_dependency(%q<rufus-json>, [">= 0"])
+      s.add_dependency(%q<rufus-json>, [">= 0.2.1"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
@@ -94,7 +95,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<rufus-lru>, [">= 0"])
-    s.add_dependency(%q<rufus-json>, [">= 0"])
+    s.add_dependency(%q<rufus-json>, [">= 0.2.1"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/test/ct_1_couchdb.rb

@@ -100,7 +100,11 @@ class CtCouchDbTest < Test::Unit::TestCase
 
     r = @c.put(doc)
 
-    assert_not_nil @c.get('coffee1')['_rev']
+    assert_equal true, r
+    assert_nil @c.get('coffee1')
+
+    #assert_not_nil @c.get('coffee1')['_rev']
+      # CouchDB < 0.11
   end
 
   def test_get

data/test/ct_2_couchdb_options.rb

@@ -21,12 +21,15 @@ class CtCouchDbOptionsTest < Test::Unit::TestCase
     end
 
     h.put('/rufus_jig_test', '')
-    h.put('/rufus_jig_test/coffee1', '{"_id":"coffee1","type":"ristretto"}')
+    h.put('/rufus_jig_test/coffee2_0', '{"_id":"coffee2_0","type":"ristretto"}')
 
     h.close
 
     @c = Rufus::Jig::Couch.new(
-      '127.0.0.1', 5984, 'rufus_jig_test', :re_put_ok => false)
+      #'127.0.0.1', 5984, 'rufus_jig_test', :re_put_ok => false)
+      '127.0.0.1', 5984, 'rufus_jig_test')
+
+    # CouchDB >= 0.11 rendered re_put_ok useless
   end
 
   def teardown
@@ -36,10 +39,10 @@ class CtCouchDbOptionsTest < Test::Unit::TestCase
 
   def test_put_gone
 
-    doc = @c.get('coffee1')
+    doc = @c.get('coffee2_0')
     @c.delete(doc)
 
-    assert_nil @c.get('coffee1')
+    assert_nil @c.get('coffee2_0')
 
     doc['whatever'] = 'else'
 

data/test/ct_5_couchdb_continuous.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+#
+# testing rufus-jig
+#
+# Tue May 11 09:52:37 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'couch_base')
+
+
+class CtCouchDbContinuousTest < Test::Unit::TestCase
+
+  def setup
+
+    h = Rufus::Jig::Http.new('127.0.0.1', 5984)
+
+    begin
+      h.delete('/rufus_jig_test')
+    rescue Exception => e
+      #p e
+    end
+    h.put('/rufus_jig_test', '')
+    h.close
+
+    @c = Rufus::Jig::Couch.new('127.0.0.1', 5984, 'rufus_jig_test')
+  end
+
+  def teardown
+
+    @c.close
+  end
+
+  def test_on_change
+
+    stack = []
+
+    t = Thread.new do
+      @c.on_change { |doc_id, deleted| stack << doc_id }
+    end
+
+    @c.put('_id' => 'angel0', 'name' => 'samael')
+    @c.put('_id' => 'angel1', 'name' => 'raphael')
+
+    sleep 0.150
+    t.kill
+
+    assert_equal 2, stack.size
+  end
+
+  def test_on_change_include_docs
+
+    stack = []
+
+    Thread.abort_on_exception = true
+
+    t = Thread.new do
+      @c.on_change { |doc_id, deleted, doc| stack << doc }
+    end
+
+    @c.put('_id' => 'angel2', 'name' => 'samael')
+    @c.put('_id' => 'angel3', 'name' => 'ゆきひろ')
+
+    sleep 0.150
+    t.kill
+
+    assert_equal 'ゆきひろ', stack[1]['name']
+  end
+
+  def test_on_change_include_docs_with_deleted
+
+    stack = []
+
+    Thread.abort_on_exception = true
+
+    t = Thread.new do
+      @c.on_change { |doc_id, deleted, doc| stack << [ doc_id, deleted ] }
+    end
+
+    @c.put('_id' => 'angel4', 'name' => 'samael')
+    sleep 0.077
+    @c.delete(@c.get('angel4'))
+
+    sleep 0.154
+    t.kill
+
+    assert_equal [["angel4", false], ["angel4", true]], stack
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 17
-  version: 0.1.17
+  - 18
+  version: 0.1.18
 platform: ruby
 authors: 
 - John Mettraux
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-22 00:00:00 +09:00
+date: 2010-05-11 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,7 +39,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 2
+        - 1
+        version: 0.2.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -137,6 +139,7 @@ files:
 - test/ct_2_couchdb_options.rb
 - test/ct_3_couchdb_views.rb
 - test/ct_4_attachments.rb
+- test/ct_5_couchdb_continuous.rb
 - test/server.rb
 - test/test.rb
 - test/to.sh