wcc 1.0.0 → 1.1.0

data/README.md

@@ -41,7 +41,7 @@ For using wcc you need to specify some options:
 * either via the command line (see `wcc -h`)
 * or in a configuration file in [YAML](https://secure.wikimedia.org/wikipedia/en/wiki/YAML) format
 
-The location of the configuration file (usually called 'conf.yml' or something like this)
+The location of the configuration file (usually called 'conf.yml')
 can itself be given on command line as last argument. Each option has a hard-coded default
 (e.g. the configuration file name is assumed to be './conf.yml'). Command line options
 overwrite configuration file entries.
@@ -58,6 +58,24 @@ By default wcc only outputs ERROR and FATAL messages to avoid your cron daemon s
 It is recommended to place 'conf.yml' (and optionally the 'filter.d' and 'template.d') within
 a separate directory and use `cd` in cron entry.
 
+Upgrade
+-------
+
+If you want to update your wcc run:
+
+	gem update
+
+Then don't forget to run
+
+	wcc-upgrade
+
+in your '/my/conf' directory which interactively asks to overwrite local 'assets'
+like mail templates and filters with the original ones out of the gem (which you copied
+there using ´wcc-init´ at the beginning).
+
+NOTE: You should **make a backup** (especially of your **conf.yml**) of the '/my/conf'
+directory **before upgrading**.
+
 License
 -------
 

data/assets/conf.yml

@@ -2,6 +2,7 @@
 
 conf:
   from_addr: root@localhost
+#  # /var/tmp won't get ereased on restart!
 #  cache_dir: /var/tmp/wcc
 #  tag: wcc
 #  use_syslog: yes
@@ -11,6 +12,9 @@ conf:
 #    smtp:
 #      host: localhost
 #      port: 25
+# ...or for TESTING purposes:
+#  email:
+#    fake_file
 
 sites:
   - url: http://google.com/
@@ -19,11 +23,19 @@ sites:
       - mail2@example.com
     filters:
       - test
-      - arg-test: {number: 5}
+      - arg-test: {number: 5, hello: world}
+      - only_changes_of: {at_least: 4, t: lines}
+      # readable, isn't it?
   - url: https://my.secret.place/
     emails:
       - me@my.place
+    # only supports basic auth currently
     auth: {type: basic, username: me, password: secret}
   - url: http://your.cms.com/
     #emails: ...
+    # Don't add trailing newline just the pure bytes of your cookie
     cookie: file.cookie
+  - url: http://heavily.loaded.site/
+    # this will check at most every 30 minutes
+    # (or next time ´wcc´ gets called after 30mins passed)
+    check_interval: 30

data/assets/filter.d/arg-test.rb

@@ -1,8 +1,8 @@
 
-WCC::Filter.add 'arg-test' do |data,arguments|
+WCC::Filters.add 'arg-test' do |data,args|
 	puts "arg-test:"
-	puts "  #arguments = #{arguments.size}"
-	arguments.each do |arg|
+	puts "  #arguments = #{args.size}"
+	args.each do |arg|
 		puts "  - #{arg.inspect}"
 	end
 	true

data/assets/filter.d/only_changes_of.rb

@@ -0,0 +1,22 @@
+
+WCC::Filters.add 'only_changes_of' do |data,args|
+	case args['t'] || args['type']
+	when 'lines',nil
+		cmp_val = data.diff.nlinesc
+	when 'chars'
+		cmp_val = data.diff.ncharsc
+	when 'ins','insertions'
+		cmp_val = data.diff.ninsertions
+	when 'del','deletions'
+		cmp_val = data.diff.ndeletions
+	when 'hunks'
+		cmp_val = data.diff.nhunks
+	end
+	next (cmp_val >= args['at_least']) if args.key?('at_least')
+	next (cmp_val >  args['more_than']) if args.key?('more_than')
+	next (cmp_val <= args['at_most']) if args.key?('at_most')
+	next (cmp_val <  args['fewer_then']) if args.key?('fewer_than')
+	next (cmp_val == args['exactly']) if args.key?('exactly')
+	next (cmp_val != args['not_quite']) if args.key('not_quite')
+	true
+end

data/assets/filter.d/test.rb

@@ -1,4 +1,4 @@
 
-WCC::Filter.add 'test' do |data|
+WCC::Filters.add 'test' do |data|
 	true
 end

data/assets/template.d/mail-body.html.erb

@@ -87,6 +87,13 @@
 <% end %>
 			</ul>
 		</div>
+		<div>
+			nHunks: <%= data.diff.nhunks %>, 
+			nIns: <%= data.diff.ninsertions %>, 
+			nDel: <%= data.diff.ndeletions %>, 
+			nLinesC: <%= data.diff.nlinesc %>, 
+			nCharsC: <%= data.diff.ncharsc %>
+		</div>
 <% end %>
 	</body>
 </html>

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

@@ -4,4 +4,6 @@ Checked <%= data.site.uri.to_s %> the first time so no diff was possible.
 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/diff.rb

@@ -3,7 +3,8 @@ module WCC
 	# TODO: Handle tabs/trailing whitespace in output
 
 	class DiffItem
-		attr_accessor :status, :text, :hilite
+		attr_reader :status, :text
+		attr_accessor :hilite
 		
 		def initialize(line)
 			# parse line
@@ -125,6 +126,26 @@ module WCC
 			end
 		end
 		
+		def nhunks
+			@di.inject(0) { |sum,o| sum += (o.status == :range ? 1 : 0) }
+		end
+		
+		def ninsertions
+			@di.inject(0) { |sum,o| sum += (o.status == :ins ? 1 : 0) }
+		end
+		
+		def ndeletions
+			@di.inject(0) { |sum,o| sum += (o.status == :del ? 1 : 0) }
+		end
+		
+		def nlinesc
+			ninsertions + ndeletions
+		end
+		
+		def ncharsc
+			@di.inject(0) { |sum,o| sum += (o.hilite.nil? ? 0 : o.hilite.nitems) }
+		end
+		
 		def rchar
 			@di.map { |o| o.rchar }.join
 		end
@@ -151,7 +172,7 @@ module WCC
 		end
 		
 		def match(e)
-			# don't care - this is called "diff" ;-)
+			# don't care
 		end
 		
 		def discard_a(e)

data/lib/wcc/filter.rb

@@ -11,7 +11,7 @@ module WCC
 		def to_s; @id end
 	end
 
-	class Filter
+	class Filters
 		@@filters = {}
 		
 		def self.add(id, &block)

data/lib/wcc/mail.rb

@@ -41,6 +41,7 @@ module WCC
 	# does plain SMTP to host:port using [Net::SMTP].
 	class SmtpMailer
 		def initialize(host, port)
+			WCC.logger.info "Send mail via SMTP to #{@host}:#{@port}"
 			@host = host
 			@port = port
 		end
@@ -77,4 +78,36 @@ module WCC
 			WCC.logger.fatal "Cannot send mails via SMTP to #{@host}:#{@port} : #{$!.to_s}"
 		end
 	end
+	
+	# This "mailer" just dumps a mail's contents into eml files in the current
+	# working directory. This should be for TESTING ONLY as it doesn't
+	# take care of standards and stuff like that...
+	class FakeFileMailer
+		def initialize
+			WCC.logger.info "Write mail to eml-files in #{Dir.getwd}"
+		end
+		
+		def send(data, main, bodies, from, tos = [])
+			# generate a boundary that may be used for multipart
+			data.boundary = "frontier-#{data.site.id}"
+			# generate messages
+			msgs = {}
+			tos.each do |to|
+				data.bodies = {}
+				# eval all body templates
+				bodies.each do |name,template|
+					data.bodies[name] = template.result(binding)
+				end
+				# eval main template
+				msgs[to] = main.result(binding)
+			end
+			# dump mails to eml-files
+			i = 0
+			msgs.each do |to,msg|
+				filename = "#{Time.new.strftime('%Y%m%d-%H%M%S')} to_#{i}.eml"
+				File.open(filename, 'w') { |f| f.write(msg) }
+				i += 1
+			end
+		end
+	end
 end

data/lib/wcc/site.rb

@@ -1,15 +1,16 @@
 
 module WCC
 	class Site
-		attr_reader :uri, :emails, :filters, :auth, :cookie, :id
+		attr_reader :uri, :emails, :filters, :auth, :cookie, :check_interval, :id
 
-		def initialize(url, strip_html, emails, filters, auth, cookie)
+		def initialize(url, strip_html, emails, filters, auth, cookie, check_interval)
 			@uri = URI.parse(url)
 			@strip_html = strip_html
 			@emails = emails.is_a?(Array) ? emails : [emails]
 			@filters = filters.is_a?(Array) ? filters : [filters]
 			@auth = auth
 			@cookie = cookie
+			@check_interval = check_interval
 			@id = Digest::MD5.hexdigest(url.to_s)[0...8]
 			# invalid hashes are ""
 			load_hash

data/lib/wcc.rb

@@ -45,7 +45,7 @@ end
 
 module WCC
 
-	VERSION = "1.0.0"
+	VERSION = "1.1.0"
 
 	DIFF_TIME_FMT = '%Y-%m-%d %H:%M:%S %Z'
 	
@@ -154,6 +154,8 @@ module WCC
 						# yaml parser should provide an integer here
 						@options[:smtp_port] ||= yaml['email']['smtp']['port']
 					end
+				elsif yaml['email'] == 'fake_file'
+					@options[:mailer] = 'fake_file'
 				end
 			end
 			
@@ -183,7 +185,7 @@ module WCC
 			Dir[File.join(self[:filter_dir], '*.rb')].each { |file| require file }
 			
 			# attach --no-mails filter
-			WCC::Filter.add '--no-mails' do |data|
+			WCC::Filters.add '--no-mails' do |data|
 				!self[:nomails]
 			end
 		end
@@ -227,7 +229,8 @@ module WCC
 					yaml_site['emails'].map { |m| MailAddress.new(m) } || [],
 					frefs,
 					yaml_site['auth'] || {},
-					cookie)
+					cookie,
+					yaml_site['check_interval'] || 5)
 			end
 			
 			WCC.logger.debug @sites.length.to_s + (@sites.length == 1 ? ' site' : ' sites') + " loaded\n" +
@@ -242,6 +245,8 @@ module WCC
 			# smtp mailer
 			if Conf[:mailer] == 'smtp'
 				@mailer = SmtpMailer.new(Conf[:smtp_host], Conf[:smtp_port])
+			elsif Conf[:mailer] == 'fake_file'
+				@mailer = FakeFileMailer.new
 			end
 
 			@mailer
@@ -341,17 +346,18 @@ module WCC
 				diff = %x[diff -U 1 --label "#{old_label}" --label "#{new_label}" #{old_site_file.path} #{Conf.file(site.id + '.site')}]
 			end
 			
-			# HACK: there *was* an update but no notification is required
-			return false if not Filter.accept(diff, site.filters)
+			system("logger -t '#{Conf[:tag]}' 'Change at #{site.uri.to_s} (tag #{site.id}) detected'") if Conf[:syslog]
 			
+			# construct the data made available to filters and templates
 			data = OpenStruct.new
 			data.site = site
 			data.diff = diff.nil? ? nil : WCC::Differ.new(diff)
 			data.tag = Conf[:tag]
 			
-			Conf.mailer.send(data, @@mail_plain, @@mail_bodies, MailAddress.new(Conf[:from_mail]), site.emails)
+			# HACK: there *was* an update but no notification is required
+			return false if not Filters.accept(data, site.filters)
 			
-			system("logger -t '#{Conf[:tag]}' 'Change at #{site.uri.to_s} (tag #{site.id}) detected'") if Conf[:syslog]
+			Conf.mailer.send(data, @@mail_plain, @@mail_bodies, MailAddress.new(Conf[:from_mail]), site.emails)
 			
 			true
 		end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wcc
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Christian Nicolai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 Z
+date: 2011-10-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities
@@ -59,6 +59,7 @@ extra_rdoc_files:
 files: 
 - assets/conf.yml
 - assets/filter.d/arg-test.rb
+- assets/filter.d/only_changes_of.rb
 - assets/filter.d/test.rb
 - assets/template.d/mail.alt.erb
 - assets/template.d/mail-body.html.erb
@@ -78,7 +79,7 @@ files:
 homepage: https://github.com/cmur2/wcc
 licenses: 
 - Apache License Version 2.0
-post_install_message: 
+post_install_message: "NOTE: Remember to \xC2\xB4wcc-upgrade\xC2\xB4 your conf.yml directory!"
 rdoc_options: []
 
 require_paths: