couchwatcher 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "json", "> 1.1.5"
+gem "typhoeus", "~> 0.2"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.2)
+    mime-types (1.16)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    typhoeus (0.2.4)
+      mime-types
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  json (> 1.1.5)
+  rcov
+  shoulda
+  typhoeus (~> 0.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kevin Malakoff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= couchwatcher
+
+This gem provides a simple library to watch a couchdb database or specific documents and to receive notifications when they change.
+
+  Install:
+    gem install couchwatcher
+
+  Usage:
+  
+    require 'couchwatcher'
+
+    couch_watcher = CouchWatcher::CouchWatcher.new()
+    couch_watcher.add_database_watcher('http://localhost:5984/my_database', true) {|url, id, rev, doc| puts("DATABASE: Changes detected at: #{url} id: #{id} and rev: #{rev}. \n For document: #{doc.inspect}")}
+    couch_watcher.add_document_watcher('http://localhost:5984/my_database', '_design/mydocument', true) {|url, id, rev, doc| puts("DOCUMENT: Changes detected at: #{url} id: #{id} and rev: #{rev}. \n For document: #{doc.inspect}")}
+    couch_watcher.start_watching()
+
+== Contributing to couchwatcher
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kevin Malakoff. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "couchwatcher"
+  gem.homepage = "http://github.com/kmalakoff/couchwatcher-gem"
+  gem.license = "MIT"
+  gem.summary = %Q{Couch document uploading utility}
+  gem.description = %Q{This gem provides a simple library to watch a couchdb database or specific documents and to receieve notifications when they change.}
+  gem.email = "xmann.intl@gmail.com"
+  gem.authors = ["Kevin Malakoff"]
+
+  gem.add_dependency 'json', '> 1.1.5'
+  gem.add_dependency 'typhoeus', '~>0.2'
+  gem.files.include 'lib/couchwatcher/database_listener.rb'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "couchwatcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/couchwatcher.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{couchwatcher}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Malakoff"]
+  s.date = %q{2011-06-18}
+  s.description = %q{This gem provides a simple library to watch a couchdb database or specific documents and to receieve notifications when they change.}
+  s.email = %q{xmann.intl@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "couchwatcher.gemspec",
+    "lib/couchwatcher.rb",
+    "lib/couchwatcher/database_listener.rb",
+    "test/helper.rb",
+    "test/test_couchwatcher.rb"
+  ]
+  s.homepage = %q{http://github.com/kmalakoff/couchwatcher-gem}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Couch document uploading utility}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, ["> 1.1.5"])
+      s.add_runtime_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, ["> 1.1.5"])
+      s.add_runtime_dependency(%q<typhoeus>, ["~> 0.2"])
+    else
+      s.add_dependency(%q<json>, ["> 1.1.5"])
+      s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<json>, ["> 1.1.5"])
+      s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+    end
+  else
+    s.add_dependency(%q<json>, ["> 1.1.5"])
+    s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<json>, ["> 1.1.5"])
+    s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+  end
+end
+

data/lib/couchwatcher/database_listener.rb

@@ -0,0 +1,160 @@
+require 'json'
+
+module CouchWatcher
+
+  class DatabaseListener
+    
+    def initialize(database_url, polling_interval = 3)
+      @database_url = database_url
+      @polling_interval = polling_interval
+      @last_sequence = nil
+      @connection_stopped = false
+      @thread = nil
+      @DatabaseCallback = Struct.new(:callback_proc, :include_document) 
+      @database_callbacks = []
+      @DocumentCallback = Struct.new(:document_id, :callback_proc, :include_document) 
+      @document_callbacks = []
+      
+      data = get_info()
+      if data.nil?
+        puts "Error: the database cannnot be watched: #{@database_url}. Check that the couchdb is running, the database exists, and you have adequate permissions."
+        @connection_stopped = true
+        return
+      end 
+
+      @last_sequence = data["update_seq"]
+    end
+
+    def add_database_callback(callback_proc, include_document)
+      if !@thread.nil?
+        puts "Error: cannot add callbacks to a running listener"
+        return nil
+      end
+      
+      database_callback = @DatabaseCallback.new(callback_proc, include_document)
+      @database_callbacks << database_callback
+      return database_callback
+    end
+    
+    def remove_database_callback(database_callback)
+      if !@thread.nil?
+        puts "Error: cannot remove callbacks from a running listener"
+        return
+      end
+
+      @database_callbacks.delete(database_callback)
+    end
+
+    def add_document_callback(document_id, callback_proc, include_document)
+      if !@thread.nil?
+        puts "Error: cannot add callbacks to a running listener"
+        return nil
+      end
+
+      document_callback = @DocumentCallback.new(document_id, callback_proc, include_document)
+      @document_callbacks << document_callback
+      return document_callback
+    end
+    
+    def remove_document_callback(document_callback)
+      if !@thread.nil?
+        puts "Error: cannot remove callbacks from a running listener"
+        return
+      end
+
+      @document_callbacks.delete(document_callback)
+    end
+
+    def start_watching
+      if !@thread.nil?
+        puts "Error: listener is already running listener"
+        return
+      end
+
+      puts "Database watching started for: #{@database_url}"
+      @thread = Thread.new do
+        while true
+
+          # stopped the connection
+          if @connection_stopped
+            return 
+
+          # the sequence number has been returned so start polling
+          elsif @last_sequence
+            results = get_changes()
+          
+            # print a message
+#            puts "Get changes heartbeat"
+            puts "Change detected in database: #{@database_url}" if (results && !results.empty?)
+          
+            results.each do |result|
+
+              document_id = result["id"]
+              document_rev = result["changes"][0]["rev"]
+              document = result["doc"]
+            
+              # call the database watchers
+              @database_callbacks.each do |callback| 
+                if callback.include_document 
+                  callback.callback_proc.call(@database_url, document_id, document_rev, document)
+                else
+                  callback.callback_proc.call(@database_url, document_id, document_rev)
+                end
+              end
+
+              # call the document watchers
+              @document_callbacks.each do |callback| 
+                if (callback.document_id==document_id)
+                  if callback.include_document 
+                    callback.callback_proc.call(@database_url, document_id, document_rev, document)
+                  else
+                    callback.callback_proc.call(@database_url, document_id, document_rev)
+                  end
+                end
+              end
+            end
+          end
+        
+          sleep @polling_interval 
+        end
+      end
+    end
+
+    def stop_watching
+      if @thread.nil?
+        puts "Error: listener is is not running"
+        return
+      end
+
+      # give the thread time to finish
+      @connection_stopped = true
+      sleep @polling_interval + 2
+
+      @thread.kill
+      @thread = nil
+      puts "Database watching stopped for: #{@database_url}"
+    end
+    
+    private
+    
+    def get_info
+#      puts "GET #{@database_url + "/"}"
+      response = Typhoeus::Request.get(@database_url + "/")
+#      puts "Response: #{response.code} #{JSON.parse(response.body).inspect}"
+      json = response.code == 200 ? JSON.parse(response.body) : nil
+    end
+
+    def get_changes
+#      puts "GET #{@database_url + "/_changes?since=#{@last_sequence}"}"
+      response = Typhoeus::Request.get(@database_url + "/_changes?since=#{@last_sequence}&include_docs=true")
+#      puts "Response: #{response.code} #{JSON.parse(response.body).inspect}"
+      json = response.code == 200 ? JSON.parse(response.body) : nil
+      if !json.nil?
+        @last_sequence = json["last_seq"]
+        return json["results"]
+      end
+
+    end
+
+  end
+end

data/lib/couchwatcher.rb

@@ -0,0 +1,50 @@
+require 'typhoeus'
+
+require 'couchwatcher/database_listener'
+
+module CouchWatcher
+
+  class CouchWatcher
+    def initialize()
+      @database_listeners = {}
+    end
+  
+    def add_database_watcher(database_url, include_document, &callback_block)
+      database_listener(database_url).add_database_callback(callback_block, include_document)
+    end
+    
+    def remove_database_watcher(callback_object)
+      database_listener(database_url).remove_database_callback(callback_object)
+    end
+    
+    def add_document_watcher(database_url, document_id, include_document, &callback_block)
+      database_listener(database_url).add_document_callback(document_id, callback_block, include_document)
+    end
+      
+    def remove_document_watcher(callback_object)
+      database_listener(database_url).remove_document_callback(callback_object)
+    end
+    
+    def start_watching()
+      @database_listeners.each {|database_url, database_listener| database_listener.start_watching()}
+    end
+    
+    def stop_watching()
+      @database_listeners.each {|database_url, database_listener| database_listener.stop_watching()}
+    end
+
+    private
+    
+    def database_listener(database_url)
+      # not yet listening, create a new listener
+      database_listener = @database_listeners[database_url]
+      if database_listener.nil?
+        database_listener = ::CouchWatcher::DatabaseListener.new(database_url)
+        @database_listeners[database_url] = database_listener
+      end
+      
+      return database_listener
+    end
+    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'couchwatcher'
+
+class Test::Unit::TestCase
+end

data/test/test_couchwatcher.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCouchwatcher < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification 
+name: couchwatcher
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kevin Malakoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 1
+        - 5
+        version: 1.1.5
+  name: json
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  name: typhoeus
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: jeweler
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 1
+        - 5
+        version: 1.1.5
+  name: json
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  name: typhoeus
+  version_requirements: *id008
+  prerelease: false
+description: This gem provides a simple library to watch a couchdb database or specific documents and to receieve notifications when they change.
+email: xmann.intl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- couchwatcher.gemspec
+- lib/couchwatcher.rb
+- lib/couchwatcher/database_listener.rb
+- test/helper.rb
+- test/test_couchwatcher.rb
+has_rdoc: true
+homepage: http://github.com/kmalakoff/couchwatcher-gem
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Couch document uploading utility
+test_files: []
+