couchchanges 0.2

data/README.md

@@ -0,0 +1,30 @@
+# couchchanges
+
+a ruby consumer for couchdb's _changes feed. eventmachine based.
+
+## example.rb
+
+    require "eventmachine"
+    require "couchchanges"
+
+    EventMachine.run {
+      couch = CouchChanges.new :url => "http://127.0.0.1:5984/my_db"
+
+      couch.change {|change|
+        puts "doc created, updated or deleted"
+      }
+      couch.update {|change|
+        puts "doc created or updated"
+      }
+      couch.delete {|change|
+        puts "doc deleted"
+      }
+
+      # if you don't specify a disconnect block, couchchanges will
+      # automatically reconnect to couchdb. normally you shouldn't
+      # care about the disconnect callback, but it can come in
+      # handy in tests etc.
+      couch.disconnect {|last_seq|
+        puts "disconnected from couch. last_seq: #{last_seq}"
+      }
+    }

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :test
+
+desc "run tests"
+task :test do
+  require "rake/runtest"
+  Rake.run_tests "test/test_*.rb"
+end

data/couchchanges.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = "couchchanges"
+  s.version     = "0.2"
+  s.date        = "2011-02-25"
+  s.summary     = "ruby consumer for couchdb's _changes api"
+  s.email       = "harry@vangberg.name"
+  s.homepage    = "http://github.com/ichverstehe/couchchanges"
+  s.description = "ruby consumer for couchdb's _changes api"
+  s.authors     = ["Harry Vangberg"]
+  s.files = [
+    "README.md",
+		"couchchanges.gemspec",
+    "Rakefile",
+		"lib/couchchanges.rb",
+  ]
+  s.test_files = Dir.glob("test/test_*.rb")
+
+  s.add_dependency "em-http-request", ">= 0.2.7"
+  s.add_dependency "json"
+
+  s.add_development_dependency "contest"
+  s.add_development_dependency "eventmachine"
+  s.add_development_dependency "couchrest"
+end
+

data/lib/couchchanges.rb

@@ -0,0 +1,87 @@
+require "em-http"
+require "uri"
+require "json"
+
+class CouchChanges
+  def initialize options={}
+    @options = options.dup
+    @uri = URI.parse(@options.delete(:url) + "/_changes")
+    @last_seq = 0
+  end
+
+  def change &block
+    block ? @change = block : @change
+  end
+
+  def update &block
+    block ? @update = block : @update
+  end
+
+  def delete &block
+    block ? @delete = block : @delete
+  end
+
+  def disconnect &block
+    block ? @disconnect = block : @disconnect
+  end
+
+  def listen
+    @http = http!
+    buffer = ""
+    @http.stream  {|chunk|
+      buffer += chunk
+      while line = buffer.slice!(/.+\r?\n/)
+        handle line
+      end
+    }
+    @http.errback { disconnected }
+    @http
+  end
+
+  # REFACTOR!
+  def http!
+    options = {
+      :timeout => 0,
+      :query   => @options.merge({:feed => "continuous"})
+    }
+    if @uri.user
+      options[:head] = {'authorization' => [@uri.user, @uri.password]}
+    end
+    
+    EM::HttpRequest.new(@uri.to_s).get(options)
+  end
+
+  def handle line
+    return if line.chomp.empty?
+
+    hash = JSON.parse(line)
+    if hash["last_seq"]
+      disconnected
+    else
+      hash["rev"] = hash.delete("changes")[0]["rev"]
+      @last_seq = hash["seq"]
+
+      callbacks hash
+    end
+  end
+
+  def disconnected
+    if @disconnect
+      @disconnect.call @last_seq
+    else
+      EM.add_timer(@options[:reconnect]) {
+        @options[:since] = @last_seq
+        listen
+      }
+    end
+  end
+
+  def callbacks hash
+    @change.call hash if @change
+    if hash["deleted"]
+      @delete.call hash if @delete
+    else
+      @update.call hash if @update
+    end
+  end
+end

data/test/test_changes.rb

@@ -0,0 +1,211 @@
+$:.unshift "lib"
+
+require "test/unit"
+require "contest"
+require "couchrest"
+require "eventmachine"
+
+require "couchchanges"
+
+COUCH    = "http://127.0.0.1:5984"
+DATABASE = "couchchanges-test"
+URL      = "#{COUCH}/#{DATABASE}"
+
+class TestCouchChanges < Test::Unit::TestCase
+  def changes options={}
+    EM.run {
+      c = CouchChanges.new({:url => URL, :reconnect => 0}.merge(options))
+      yield c
+      c.listen
+    }
+  end
+
+  def couch
+    @couch ||= CouchRest.new(COUCH)
+  end
+
+  def db
+    @db ||= couch.database(DATABASE)
+  end
+
+  setup do
+    db.recreate!
+    @doc = {"foo" => "bar"}
+    db.save_doc @doc
+  end
+
+  test "new document" do
+    changes do |c|
+      c.change {|c|
+        assert_equal @doc["_id"],  c["id"]
+        assert_equal @doc["_rev"], c["rev"]
+        EM.stop
+      }
+
+      c.update {|c|
+        assert_equal @doc["_id"],  c["id"]
+        assert_equal @doc["_rev"], c["rev"]
+        EM.stop
+      }
+
+      c.delete {|c| flunk "delete triggered"; EM.stop}
+    end
+  end
+
+  test "update document" do
+    @doc["new_key"] = "new value"
+    db.save_doc @doc
+
+    changes do |c|
+      c.update {|c|
+        assert_equal @doc["_id"],  c["id"]
+        assert_equal @doc["_rev"], c["rev"]
+        EM.stop
+      }
+
+      c.delete {|c| flunk "delete triggered"; EM.stop}
+    end
+  end
+
+  test "delete document" do
+    db.delete_doc @doc
+
+    changes do |c|
+      c.delete {|c|
+        assert c["deleted"]
+        assert_equal @doc["_id"],  c["id"]
+        EM.stop
+      }
+
+      c.update {|c| flunk "update triggered"; EM.stop}
+    end
+  end
+
+  test "line spanning multiple chunks (\\n)" do
+    EM.run {
+      c = CouchChanges.new(:url => URL)
+
+      c.delete {|c|
+        assert_equal "doc1", c["id"]
+        EM.stop
+      }
+      
+      listener = c.listen
+
+      listener.on_decoded_body_data "{\"seq\":129,\"i"
+      listener.on_decoded_body_data "d\":\"doc1\",\"changes\":[{\"rev\":\"6-9ed852183290a143552caf4df76dea87\"}],\"deleted\":true}\n"
+    }
+  end
+
+  test "multiple changes" do
+    doc2, doc3 = {}, {"doc" => 3}
+    db.save_doc doc2
+    db.save_doc doc3
+    db.delete_doc doc3
+
+    count = 0
+
+    changes do |c|
+      c.change {|c| count += 1 }
+      c.delete {|c|
+        assert_equal 3, count
+        EM.stop
+      }
+    end
+  end
+
+  test "since" do
+    seq = db.info["update_seq"]
+    doc2 = {}
+    db.save_doc doc2
+
+    changes :since => seq do |c|
+      c.change {|c|
+        assert c["rev"] > @doc["_rev"], "earlier revision"
+        assert_equal doc2["_id"], c["id"]
+        EM.stop
+      }
+    end
+  end
+
+  test "include_docs" do
+    changes :include_docs => true do |c|
+      c.update {|c|
+        assert_not_nil c["doc"]
+        assert_equal @doc["_id"],  c["doc"]["_id"]
+        assert_equal @doc["_rev"], c["doc"]["_rev"]
+        assert_equal @doc["foo"],  c["doc"]["foo"]
+        EM.stop
+      }
+    end
+  end
+
+  test "filter" do
+    db.save_doc({
+      "_id"     => "_design/app",
+      "filters" => {
+        "filtered" => "function(doc, req) { return doc.type === 'filtered' }"
+      }
+    })
+
+    filtered = {"type" => "filtered"}
+    other    = {"type" => "other"}
+    db.save_doc filtered
+    db.save_doc other
+
+    changes :filter => "app/filtered" do |c|
+
+      c.update {|c|
+        assert_equal filtered["_id"], c["id"]
+        EM.stop
+      }
+    end
+  end
+
+  test "heartbeat" do
+    changes :heartbeat => 100 do |c|
+      c.change {|c|
+        assert_equal @doc["_id"],  c["id"]
+        assert_equal @doc["_rev"], c["rev"]
+      }
+
+      EM.add_timer(0.2) { EM.stop }
+    end
+  end
+
+  test "with disconnect: invoke with last_seq" do
+    changes :timeout => 1 do |c|
+      c.disconnect {|last_seq|
+        assert_equal 1, last_seq
+        EM.stop
+      }
+      EM.add_timer(0.2) { flunk "should invoke disconnect handler" }
+    end
+  end
+
+  test "without disconnect: default to reconnect" do
+    counter = 0
+
+    changes :timeout => 100 do |c|
+      c.update {|c|
+        counter += 1
+        flunk "don't rerun all changes" if counter > 1
+      }
+      c.delete {|c| EM.stop}
+
+      EM.add_timer(0.2) {
+        db.delete_doc @doc
+      }
+      EM.add_timer(0.5) {
+        flunk "didn't reconnect"
+      }
+    end
+  end
+
+  test "don't modify passed in options hash" do
+    hash = {:url => "http://127.0.0.1:5984/foo"}
+    CouchChanges.new(hash)
+    
+    assert_equal({:url => "http://127.0.0.1:5984/foo"}, hash)
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: couchchanges
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Harry Vangberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-25 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 7
+        version: 0.2.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: ruby consumer for couchdb's _changes api
+email: harry@vangberg.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- couchchanges.gemspec
+- Rakefile
+- lib/couchchanges.rb
+- test/test_changes.rb
+has_rdoc: true
+homepage: http://github.com/ichverstehe/couchchanges
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ruby consumer for couchdb's _changes api
+test_files: 
+- test/test_changes.rb