wcc 2.1.0 → 2.2.0

data/README.md

@@ -2,11 +2,11 @@ web change checker
 ==================
 
 This is a powerful ruby program to track changes of websites and get notified via mail on
-change with configurable scope of adresses per website. All mails contain a unified diff
+change with configurable scope of addresses per website. All mails contain a unified diff
 from old content to new content so minor changes produce only few lines of text even on large sites.
 
 Since version 2.0 wcc has a completely rewritten notification system so emails are now only *one*
-way to recieve notifications - the currently supported other are XMPP/Jabber and the Syslog.
+way to receive notifications - the currently supported other are XMPP/Jabber and the syslog.
 These changes are reflected in 'conf.yml' as well so take care of migrating it (that basically
 means to create a *recipients* section and update your site entries from *emails* to *notify*).
 

data/doc/Filters.md

@@ -8,23 +8,23 @@ to notify the user (by email) or not.
 These Proc blocks get registered using `Filter.add` with a given ID (a
 string, not a :symbol to prevent some problems).
 
-wcc provides an autoloading mechanism that loads all ruby files contained in
+wcc provides an auto-loading mechanism that loads all ruby files contained in
 a specific directory - the *filter.d* - via `require`.  The filter file
 should contain some bootstrap code that may rely only on the *Filter* class
 out of wcc:
 
 	Filter.add 'my_custom_id' do |data,arguments|
 	    # do your filter magic here
-		# and return a boolean
+		# and return a Boolean
 	end
 
 The format of the `data` may change over time, currently it's a string
-containing all lines separated by newline of the unified diff (raw from unix
+containing all lines separated by newline of the unified diff (raw from Unix
 diff).  The arguments are a - possibly empty - hash directly passed in from
-the configuration file to parameterize the filter (e.g. ignoring all diffs
+the configuration file to parametrize the filter (e.g. ignoring all diffs
 shorter than let's say 10 lines).
 
-The output of this filter should be boolean true or false, indicating that
+The output of this filter should be Boolean true or false, indicating that
 an email should be sent or not.
 
 In the configuration file a filter is referenced like this:

data/lib/wcc/mail.rb

@@ -84,9 +84,10 @@ module WCC
 						:smtp_port => conf['smtp']['port'] || 25
 					}
 				elsif conf['fake_file'].is_a?(Hash)
+					from_mail = MailAddress.new(conf['fake_file']['from'] || "#{Etc.getlogin}@localhost")
 					return {
 						:mailer => 'fake_file',
-						:from_mail => conf['fake_file']['from'] || "#{Etc.getlogin}@localhost"
+						:from_mail => from_mail
 					}
 				end
 			end

data/lib/wcc/site.rb

@@ -55,13 +55,25 @@ module WCC
 		end
 
 		def fetch
-			http = Net::HTTP.new(@uri.host, @uri.port)
-			if @uri.is_a?(URI::HTTPS)
-				http.use_ssl = true
-				http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			retrieve(@uri)
+		end
+
+		def fetch_redirect(new_uri)
+			retrieve(new_uri)
+		end
+
+		private
+
+		def retrieve(uri)
+			con = Net::HTTP.new(uri.host, uri.port)
+			if uri.is_a?(URI::HTTPS)
+				con.use_ssl = true
+				con.verify_mode = OpenSSL::SSL::VERIFY_NONE
 			end
-			http.start do |http|
-				req = Net::HTTP::Get.new(@uri.request_uri)
+			con.start do |http|
+				#http.open_timeout = 20
+				#http.read_timeout = 60
+				req = Net::HTTP::Get.new(uri.request_uri)
 				if @auth['type'] == 'basic'
 					WCC.logger.debug "Doing basic auth"
 					req.basic_auth(@auth['username'], @auth['password'])

data/lib/wcc/syslog.rb

@@ -1,11 +1,31 @@
 
 module WCC
 	class SyslogNotificator
-		def initialize
+
+		LEVELS = ['crit', 'emerg', 'alert', 'err', 'warning', 'notice', 'info', 'debug']
+
+		def initialize(opts)
+			if LEVELS.include?(opts)	
+				@prio = opts
+				@enable = true
+			else
+				@enable = false
+				raise ArgumentError, "The given priority '#{opts}' is not known, use one of: #{LEVELS.join(', ')}."
+			end
+			begin
+				# from ruby std lib
+				require 'syslog'
+			rescue LoadError
+				@enable = false
+				raise ArgumentError, "Won't log to syslog since your system does NOT support syslog!"
+			end
 		end
 		
+		# TODO: ERB template for syslog
 		def notify!(data)
-			system("logger -t '#{data.tag}' 'Change at #{data.site.uri.to_s} (tag #{data.site.id}) detected'")
+			Syslog.open(data.tag, Syslog::LOG_PID | Syslog::LOG_CONS) do |s|
+				s.send(@prio.to_sym, "Change at #{data.site.uri.to_s} (tag #{data.site.id}) detected")
+			end if @enable
 		end
 		
 		def self.parse_conf(conf); {} end

data/lib/wcc/version.rb

@@ -1,4 +1,4 @@
 
 module WCC
-	VERSION = "2.1.0"
+	VERSION = "2.2.0"
 end

data/lib/wcc.rb

@@ -104,7 +104,7 @@ module WCC
 				:cache_dir => '/var/tmp/wcc',
 				:tag => 'wcc',
 				:filter_dir => './filter.d',
-				:template_dir => './template.d',
+				:template_dir => './template.d'
 			}
 		end
 		
@@ -211,20 +211,9 @@ module WCC
 					yaml_rec[name].to_a.each do |yaml_way|
 						# TODO: find options and pass them to every notificator
 						if yaml_way.is_a?(Hash)
-							prim_key = yaml_way.keys.first # and only!
-							klass = Notificators.mappings[prim_key]
-							if klass.nil?
-								WCC.logger.error "Referenced notificator '#{prim_key}' not found!"
-							else
-								rec << klass.new(yaml_way[prim_key])
-							end
+							new_notificator(name, yaml_way.keys.first, yaml_way[yaml_way.keys.first], rec)
 						else
-							klass = Notificators.mappings[yaml_way]
-							if klass.nil?
-								WCC.logger.error "Referenced notificator '#{yaml_way}' not found!"
-							else
-								rec << klass.new
-							end
+							new_notificator(name, yaml_way, nil, rec)
 						end
 					end
 					@recipients[name] = rec
@@ -289,9 +278,26 @@ module WCC
 			return Conf.instance.recipients
 		end
 		
-		def self.file(path = nil) File.join(self[:cache_dir], path) end
+		def self.file(path = nil); File.join(self[:cache_dir], path) end
 		def self.simulate?; self[:simulate] end
 		def self.[](key); Conf.instance[key] end
+		
+		private
+		
+		def new_notificator(rec_name, not_name, opts, rec_out)
+			klass = Notificators.mappings[not_name]
+			if klass.nil?
+				WCC.logger.error "Referenced notificator '#{not_name}' not found!"
+				return
+			end
+			begin
+				if opts.nil?; rec_out << klass.new
+				else rec_out << klass.new(opts)
+				end
+			rescue => ex
+				WCC.logger.error "Recipient '#{rec_name}' not notifiable via '#{not_name}' (skip): #{ex}"
+			end
+		end
 	end
 	
 	class Notificators
@@ -346,8 +352,44 @@ module WCC
 				WCC.logger.error "Cannot connect to #{site.uri.to_s} : #{ex.to_s}"
 				return false
 			end
-			if not res.kind_of?(Net::HTTPOK)
+			if res.kind_of?(Net::HTTPOK)
+				# be happy!
+			elsif res.kind_of?(Net::HTTPMovedPermanently)
+				loc = res['Location']
+				if loc.nil?
+					WCC.logger.error "Site #{site.uri.to_s} moved permanently, skippong it - no new location given."
+				else
+					WCC.logger.error "Site #{site.uri.to_s} moved permanently to '#{loc}', skipping it - please update your conf.yml adequately!"
+				end
+				return false
+			elsif res.kind_of?(Net::HTTPSeeOther) or res.kind_of?(Net::HTTPTemporaryRedirect)
+				loc = URI.parse(res['Location'])
+				WCC.logger.warn "Redirect: requesting '#{loc.to_s}'"
+				res = site.fetch_redirect(loc)
+				if not res.kind_of?(Net::HTTPOK)
+					WCC.logger.error "Redirected site #{loc.to_s} returned #{res.code} code, skipping it."
+					WCC.logger.error "Headers: #{res.to_hash.inspect}"
+					return false
+				end
+			elsif res.kind_of?(Net::HTTPUnauthorized)
+				WCC.logger.error "Site #{site.uri.to_s} demands authentication for '#{res['www-authenticate']}', skipping it - consider using 'auth:' option in your conf.yml."
+				return false
+			elsif res.kind_of?(Net::HTTPNotFound)
+				WCC.logger.error "Site #{site.uri.to_s} not found, skipping it."
+				return false
+			elsif res.kind_of?(Net::HTTPForbidden)
+				WCC.logger.error "Site #{site.uri.to_s} forbids access, skipping it."
+				return false
+			elsif res.kind_of?(Net::HTTPInternalServerError)
+				WCC.logger.error "Site #{site.uri.to_s} has internal errors, skipping it."
+				return false
+			elsif res.kind_of?(Net::HTTPServiceUnavailable)
+				#retry_after = res['Retry-After']
+				WCC.logger.warn "Site #{site.uri.to_s} currently not available, skipping it."
+				return false
+			else
 				WCC.logger.error "Site #{site.uri.to_s} returned #{res.code} code, skipping it."
+				WCC.logger.error "Headers: #{res.to_hash.inspect}"
 				return false
 			end
 			

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wcc
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 2
-  - 1
+  - 2
   - 0
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Christian Nicolai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-09 00:00:00 Z
+date: 2011-11-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities