wcc 2.0.3 → 2.1.0

data/assets/conf.yml

@@ -16,11 +16,6 @@ conf:
 #  email:
 #    fake_file:
 #      from: root@localhost
-#  # this allows wcc to send IM messages via
-#  # it's own jabber account
-#  jabber:
-#    jid: wcc@example.org/wcc
-#    password: s3cr3t
 
 # a recipient is like a user profile, it says in which ways wcc
 # might contact you and provides a central place where to change
@@ -28,7 +23,6 @@ conf:
 recipients:
   - me:
     - email: me@my.place
-    - jabber: me@jabber.org
   - my_friend:
     - email: mail@example.com
   # 'syslog' profile that notifies syslog on change

data/assets/filter.d/rel_changes_of.rb

@@ -3,7 +3,7 @@
 #       changes than the whole site had lines before.
 
 WCC::Filters.add 'rel_changes_of' do |data,args|
-	next true if data.diffnil?
+	next true if data.diff.nil?
 	case args['percent_of']
 	when 'all_lines',nil
 		percent = data.diff.nlinesc.to_f / data.site.content.count("\n").+(1).to_f * 100

data/lib/wcc.rb

@@ -19,7 +19,6 @@ require 'yaml'
 # ruby gem dependencies
 require 'diff-lcs'
 require 'htmlentities'
-require 'xmpp4r/client'
 
 # wcc
 require 'wcc/diff'
@@ -28,7 +27,6 @@ require 'wcc/mail'
 require 'wcc/site'
 require 'wcc/syslog'
 require 'wcc/version'
-require 'wcc/xmpp'
 
 class String
 	# Remove all HTML tags with at least one character name and
@@ -48,6 +46,26 @@ class String
 	end
 end
 
+class Hash
+	# Recursively merges the other hash into self while
+	# overwriting duplicate keys in self.
+	#
+	# @param [Hash] other the hash to get merged in
+	# @return [Hash] copy of self with other hash merged in
+	def recursive_merge(other)
+		copy = self.dup
+		other.keys.each do |k|
+			if other[k].is_a?(Hash) and self[k].is_a?(Hash)
+				copy[k] = copy[k].recursive_merge(other[k])
+			else
+				# ignore nils from other
+				copy[k] = other[k] unless other[k].nil?
+			end
+		end
+		copy
+	end
+end
+
 module WCC
 
 	DIFF_TIME_FMT = '%Y-%m-%d %H:%M:%S %Z'
@@ -134,21 +152,19 @@ module WCC
 			
 			# register standard notificators - these are already loaded
 			Notificators.map 'email', MailNotificator
-			Notificators.map 'jabber', XMPPNotificator
 			Notificators.map 'syslog', SyslogNotificator
 			
 			WCC.logger.debug "Load config from '#{self[:conf]}'"
 			
 			# may be false if file is empty
 			yaml = YAML.load_file(self[:conf])
+			
+			# inject dummy value {} for 'email' in 'conf' section to make the parser
+			# load MailNotificator and it's defaults even if the key is missing
+			# since email has always been the backbone of wcc
+			yaml = {'conf' => {'email' => {}}}.recursive_merge(yaml) if yaml.is_a?(Hash)
+			
 			if yaml.is_a?(Hash) and yaml['conf'].is_a?(Hash)
-				
-				# load MailNotificator and it's defaults even if the key is missing
-				# since email has always been the backbone of wcc
-				if not yaml['conf'].key?('email')
-					yaml['conf']['email'] = nil
-				end
-				
 				yaml['conf'].each do |key,val|
 					case key
 					when 'cache_dir'
@@ -470,9 +486,15 @@ module WCC
 			end
 		end
 		
+		# Attempts to read the named template file from template.d
+		# and converts it into ERB.
+		#
+		# @param [String] name file name of template file
+		# @return [ERB] the ERB template or nil when file not found
 		def self.load_template(name)
 			t_path = File.join(Conf[:template_dir], name)
 			if File.exists?(t_path)
+				WCC.logger.debug "Load template '#{name}'"
 				t = File.open(t_path, 'r') { |f| f.read }
 				# <> omit newline for lines starting with <% and ending in %>
 				return ERB.new(t, 0, "<>")
@@ -480,6 +502,23 @@ module WCC
 			nil
 		end
 		
+		# Attempts to write the given raw content to the named template file
+		# in template.d. This should be used to create initial template files on demand
+		# and will work only when file does not already exist.
+		#
+		# @param [String] name file name of template file
+		# @param [String] raw_content content that should be written to template file
+		def self.save_template(name, raw_content)
+			t_path = File.join(Conf[:template_dir], name)
+			if File.exists?(t_path)
+				WCC.logger.warn "Trying to save template '#{name}' which already exists!"
+				return
+			end
+			WCC.logger.info "Save template '#{name}' to #{t_path}"
+			File.open(t_path, 'w') { |f| f.write(raw_content) }
+		end
+		
+		# Central exit function, allows wcc a clean shutdown.
 		def self.exit(errno)
 			Kernel::exit errno
 		end

data/lib/wcc/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wcc
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 3
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors: 
 - Christian Nicolai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-05 00:00:00 Z
+date: 2011-11-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities
@@ -47,20 +47,6 @@ dependencies:
         version: "1.1"
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: xmpp4r
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
 description: wcc tracks changes of websites and notifies you by email and as of version 2.0 via XMPP/Jabber too.
 email: chrnicolai@gmail.com
 executables: 
@@ -84,7 +70,6 @@ files:
 - assets/template.d/mail-body.html.erb
 - assets/template.d/mail-body.plain.erb
 - assets/template.d/mail.plain.erb
-- assets/template.d/xmpp-body.plain.erb
 - bin/wcc
 - bin/wcc-init
 - bin/wcc-upgrade
@@ -95,7 +80,6 @@ files:
 - lib/wcc/site.rb
 - lib/wcc/syslog.rb
 - lib/wcc/version.rb
-- lib/wcc/xmpp.rb
 - lib/wcc.rb
 - LICENSE
 - README.md

data/assets/template.d/xmpp-body.plain.erb

@@ -1,9 +0,0 @@
-<% if data.diff.nil? %>
-Checked <%= data.site.uri.to_s %> the first time so no diff was possible.
-<% else %>
-Change at <%= data.site.uri.to_s %> - diff follows:
-
-<%= data.diff.to_s %>
-
-nHunks: <%= data.diff.nhunks %>, nIns: <%= data.diff.ninsertions %>, nDel: <%= data.diff.ndeletions %>, nLinesC: <%= data.diff.nlinesc %>, nCharsC: <%= data.diff.ncharsc %>
-<% end %>

data/lib/wcc/xmpp.rb

@@ -1,71 +0,0 @@
-
-module WCC
-	class XMPPNotificator
-		@@client = nil
-		@@template = nil
-		
-		def initialize(opts)
-			@jid = Jabber::JID.new(opts)
-		end
-		
-		def notify!(data)
-			# prepare message
-			subject = "[#{data.tag}] #{data.site.uri.host} changed"
-			body = self.class.get_template.result(binding)
-			m = Jabber::Message.new(@jid, body)
-			m.type = :normal
-			m.subject = subject
-			# send it
-			c = self.class.get_client
-			c.send(m) unless c.nil?
-		end
-		
-		def self.parse_conf(conf)
-			if conf.is_a?(Hash)
-				if conf['jid'].nil?
-					WCC.logger.fatal "Missing jabber ID!"
-					return {:xmpp_jid => nil}
-				elsif conf['password'].nil?
-					WCC.logger.fatal "Missing jabber password!"
-				else
-					return {
-						:xmpp_jid => Jabber::JID.new(conf['jid']),
-						:xmpp_password => conf['password']
-					}
-				end
-			end
-			# no defaults
-			{}
-		end
-		
-		def self.shut_down
-			if not @@client.nil?
-				#@@client.send(Jabber::Presence.new.set_type(:unavailable))
-				@@client.close
-			end
-		end
-		
-		def self.get_client
-			if @@client.nil? and not Conf[:xmpp_jid].nil?
-				@@client = Jabber::Client.new(Conf[:xmpp_jid])
-				@@client.connect
-				begin
-					@@client.auth(Conf[:xmpp_password])
-					@@client.send(Jabber::Presence.new.set_status('At your service every night.'))
-				rescue Jabber::ClientAuthenticationFailure => ex
-					WCC.logger.fatal "Wrong jabber password for #{Conf[:xmpp_jid]}!"
-					@@client.close
-					@@client = nil
-				end
-			end
-			@@client
-		end
-		
-		def self.get_template
-			if @@template.nil?
-				@@template = WCC::Prog.load_template('xmpp-body.plain.erb')
-			end
-			@@template
-		end
-	end
-end