couchwatcher 0.1.0 → 0.1.1

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gem "json", "> 1.1.5"
 gem "typhoeus", "~> 0.2"
+gem "thor", "~>0.14.0"
 
 group :development do
   gem "shoulda", ">= 0"

data/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
     rake (0.8.7)
     rcov (0.9.9)
     shoulda (2.11.3)
+    thor (0.14.6)
     typhoeus (0.2.4)
       mime-types
       mime-types
@@ -24,4 +25,5 @@ DEPENDENCIES
   json (> 1.1.5)
   rcov
   shoulda
+  thor (~> 0.14.0)
   typhoeus (~> 0.2)

data/README.rdoc

@@ -11,7 +11,7 @@ This gem provides a simple library to watch a couchdb database or specific docum
 
     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.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

data/Rakefile

@@ -24,6 +24,7 @@ Jeweler::Tasks.new do |gem|
 
   gem.add_dependency 'json', '> 1.1.5'
   gem.add_dependency 'typhoeus', '~>0.2'
+  gem.add_dependency 'thor', '~>0.14.0'
   gem.files.include 'lib/couchwatcher/database_listener.rb'
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/couchwatcher.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couchwatcher}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2011-06-19}
   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 = [
@@ -42,31 +42,37 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<thor>, ["~> 0.14.0"])
       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"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0.14.0"])
     else
       s.add_dependency(%q<json>, ["> 1.1.5"])
       s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_dependency(%q<thor>, ["~> 0.14.0"])
       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"])
+      s.add_dependency(%q<thor>, ["~> 0.14.0"])
     end
   else
     s.add_dependency(%q<json>, ["> 1.1.5"])
     s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+    s.add_dependency(%q<thor>, ["~> 0.14.0"])
     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"])
+    s.add_dependency(%q<thor>, ["~> 0.14.0"])
   end
 end
 

data/lib/couchwatcher.rb

@@ -1,12 +1,16 @@
 require 'typhoeus'
-
 require 'couchwatcher/database_listener'
 
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+
 module CouchWatcher
 
+  DEFAULT_POLLING_INTERVAL = 1
+
   class CouchWatcher
     def initialize()
       @database_listeners = {}
+      @verbose = true
     end
   
     def add_database_watcher(database_url, include_document, &callback_block)
@@ -17,7 +21,8 @@ module CouchWatcher
       database_listener(database_url).remove_database_callback(callback_object)
     end
     
-    def add_document_watcher(database_url, document_id, include_document, &callback_block)
+    def add_document_watcher(document_url, include_document, &callback_block)
+      database_url, document_id = extract_url_components(document_url)
       database_listener(database_url).add_document_callback(document_id, callback_block, include_document)
     end
       
@@ -25,12 +30,14 @@ module CouchWatcher
       database_listener(database_url).remove_document_callback(callback_object)
     end
     
-    def start_watching()
-      @database_listeners.each {|database_url, database_listener| database_listener.start_watching()}
+    def start_watching(verbose=true, polling_interval=nil)
+      polling_interval = DEFAULT_POLLING_INTERVAL if (polling_interval.nil? || polling_interval <= 0)
+      @verbose = verbose
+      @database_listeners.each {|database_url, database_listener| database_listener.start_watching(verbose, polling_interval)}
     end
     
     def stop_watching()
-      @database_listeners.each {|database_url, database_listener| database_listener.stop_watching()}
+      @database_listeners.each {|database_url, database_listener| database_listener.stop_watching(@verbose)}
     end
 
     private
@@ -45,6 +52,22 @@ module CouchWatcher
       
       return database_listener
     end
+
+    def extract_url_components(document_url)
+      url_elements = document_url.split('/')
+
+      # a special design type
+      if url_elements[url_elements.length-2].start_with?("_")
+        document_element = url_elements[url_elements.length-2]
+
+      # a normal document type
+      else
+        document_element = url_elements[url_elements.length-1]
+      end
+
+      url_elements = document_url.split(document_element)
+      return [url_elements[0].chomp("/"), (url_elements[1].nil? ? document_element : document_element + url_elements[1])]
+    end
     
   end
 end

data/lib/couchwatcher/database_listener.rb

@@ -1,33 +1,29 @@
 require 'json'
+require 'thor/shell/basic'
 
 module CouchWatcher
 
   class DatabaseListener
     
-    def initialize(database_url, polling_interval = 3)
+    # shortcut to say
+    def say(message, color=nil)
+      @shell ||= Thor::Shell::Basic.new
+      @shell.say message, color
+    end
+
+    def initialize(database_url)
       @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"
+        say "Error: cannot add callbacks to a running listener", :red
         return nil
       end
       
@@ -38,7 +34,7 @@ module CouchWatcher
     
     def remove_database_callback(database_callback)
       if !@thread.nil?
-        puts "Error: cannot remove callbacks from a running listener"
+        say "Error: cannot remove callbacks from a running listener", :red
         return
       end
 
@@ -47,7 +43,7 @@ module CouchWatcher
 
     def add_document_callback(document_id, callback_proc, include_document)
       if !@thread.nil?
-        puts "Error: cannot add callbacks to a running listener"
+        say "Error: cannot add callbacks to a running listener", :red
         return nil
       end
 
@@ -58,23 +54,38 @@ module CouchWatcher
     
     def remove_document_callback(document_callback)
       if !@thread.nil?
-        puts "Error: cannot remove callbacks from a running listener"
+        say "Error: cannot remove callbacks from a running listener", :red
         return
       end
 
       @document_callbacks.delete(document_callback)
     end
 
-    def start_watching
+    def start_watching(verbose, polling_interval)
       if !@thread.nil?
-        puts "Error: listener is already running listener"
+        say "Error: listener is already running listener", :red
         return
       end
 
-      puts "Database watching started for: #{@database_url}"
+      say "Database watching started for: #{@database_url}", :green if verbose
       @thread = Thread.new do
+        
+        # get the sequence
+        if @last_sequence.nil?
+          data = get_info()
+          if data.nil? || data["update_seq"].nil?
+            say "Error: the database cannnot be watched: #{@database_url}. Check that the couchdb is running, the database exists, and you have adequate permissions.", :red
+            return
+          end 
+
+          @last_sequence = data["update_seq"]
+        end
+
+        @connection_stopped = false
         while true
 
+          #puts "Checking heartbeat: #{@database_url} sequence: #{@last_sequence} connecte"
+
           # stopped the connection
           if @connection_stopped
             return 
@@ -82,17 +93,18 @@ module CouchWatcher
           # 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?)
-          
+                    
+            #puts "Checking heartbeat: #{@database_url} sequence: #{@last_sequence}"
+
             results.each do |result|
 
               document_id = result["id"]
               document_rev = result["changes"][0]["rev"]
               document = result["doc"]
             
+              # tell a change
+              say "Change detected in database: #{@database_url} document: #{document_id}", :green if verbose
+
               # call the database watchers
               @database_callbacks.each do |callback| 
                 if callback.include_document 
@@ -115,24 +127,22 @@ module CouchWatcher
             end
           end
         
-          sleep @polling_interval 
+          sleep polling_interval 
         end
       end
     end
 
-    def stop_watching
+    def stop_watching(verbose)
       if @thread.nil?
-        puts "Error: listener is is not running"
+        say "Error: cannot stop because listener is is not running", :red
         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}"
+      say "Database watching stopped for: #{@database_url}", :green if verbose
     end
     
     private

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couchwatcher
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kevin Malakoff
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-18 00:00:00 +02:00
+date: 2011-06-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,8 +50,24 @@ dependencies:
   version_requirements: *id002
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
+  name: thor
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -61,11 +77,11 @@ dependencies:
         - 0
         version: "0"
   name: shoulda
-  version_requirements: *id003
+  version_requirements: *id004
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,11 +93,11 @@ dependencies:
         - 0
         version: 1.0.0
   name: bundler
-  version_requirements: *id004
+  version_requirements: *id005
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -93,11 +109,11 @@ dependencies:
         - 2
         version: 1.6.2
   name: jeweler
-  version_requirements: *id005
+  version_requirements: *id006
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -107,11 +123,11 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  version_requirements: *id006
+  version_requirements: *id007
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
@@ -123,11 +139,11 @@ dependencies:
         - 5
         version: 1.1.5
   name: json
-  version_requirements: *id007
+  version_requirements: *id008
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -138,7 +154,23 @@ dependencies:
         - 2
         version: "0.2"
   name: typhoeus
-  version_requirements: *id008
+  version_requirements: *id009
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
+  name: thor
+  version_requirements: *id010
   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