wcc-rss-notificator 0.1.0

data/README.md

@@ -0,0 +1,36 @@
+wcc-rss-notificator
+===================
+
+This adds Atom feed support to [wcc](https://github.com/cmur2/wcc) encapsulated
+in a separate gem.
+
+Note: Currently there is only one feed for all users/recipients.
+
+What you need to add to your conf.yml:
+
+	conf:
+	  [...]
+	  # enable rss plugin
+	  rss: {}
+	
+	recipients:
+	  [...]
+	  - me:
+	    [...]
+	    # write updates to Atom feed
+	    - rss:
+	        # wcc needs write permission on this file/directory:
+	        #file: <cache.d>/atom.xml
+	        # mandatory option! - this allows you to use different
+	        # (or same) databases for each recipient
+	        db_name: me
+	        # wcc will keep the N newest entries in your feed
+	        #num_keep: 1000
+	        feed:
+	          # mandatory option! - Note that this is *NOT* your feed's
+	          # url or something, this should be just an unique identifier:
+	          id: http://www.example.com/my-feed/
+	          #title: Your cool feed
+	          #subtitle: About things
+	          #link: # this now should be the feed's url
+	          #alternate_link: # this may be a websites url (favicon comes from here)

data/assets/template.d/rss-content.html.erb

@@ -0,0 +1,93 @@
+<style type="text/css">
+.msg {
+	font-size: 0.98em;
+}
+
+.diff {
+	font-size: 12px;
+	font-family: 'Bitstream Vera Sans Mono','Courier',monospace;
+}
+
+.diff ul {
+	list-style: none;
+	display: table;
+	padding: 0;
+	margin: 0.5em 0 0 0.5em;
+	border: 1px solid #CCCCCC;
+}
+
+.diff li {
+	padding: 0;
+	display: table-row;
+	margin: 0;
+	background: #f8f8ff;
+}
+
+.diff .new, .diff .old {
+	color: #999;
+}
+
+.diff .ins {
+	background: #dfd;
+}
+
+.diff .ins .x {
+	background: #8f8;
+	margin: 0;
+	padding: 0;
+}
+
+.diff .del {
+	background: #fdd;
+}
+
+.diff .del .x {
+	background: #faa;
+	margin: 0;
+	padding: 0;
+}
+
+.diff .range {
+	background: #eaf2f5;
+	color: #999;
+}
+
+.diff .other {
+}
+</style>
+
+<% if data.diff.nil? %>
+<div class="msg">
+	Checked <a href="<%= data.site.uri.to_s %>"><%= data.site.uri.to_s %></a> the first time so no diff was possible.
+</div>
+<% else %>
+<div class="msg">
+	Change at <a href="<%= data.site.uri.to_s %>"><%= data.site.uri.to_s %></a> - diff follows:
+</div>
+<div class="diff">
+	<ul>
+<% for o in data.diff.di %>
+<% if o.status == :new %>
+		<li class="new">+++<%= o.text %></li>
+<% elsif o.status == :old %>
+		<li class="old">---<%= o.text %></li>
+<% elsif o.status == :range %>
+		<li class="range">@@<%= o.text %></li>
+<% elsif o.status == :ins %>
+		<li class="ins">+&nbsp;<%= o.html_hilite_text('x').lstrip %></li>
+<% elsif o.status == :del %>
+		<li class="del">-&nbsp;<%= o.html_hilite_text('x').lstrip %></li>
+<% else %>
+		<li class="other">&nbsp;&nbsp;<%= o.text.substring(1).lstrip %></li>
+<% end %>
+<% 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 %>

data/assets/template.d/rss-title.plain.erb

@@ -0,0 +1 @@
+<%= data.site.uri.host %> changed

data/lib/wcc-rss-notificator.rb

@@ -0,0 +1,162 @@
+
+require 'rss/maker'
+require 'socket' # only for getting hostname
+require 'yaml'
+
+class RSSNotificator
+	@@tpl = {}
+	@@shutdown_hooks = []
+	
+	# TODO: can we hook into --clean?
+	
+	def initialize(opts)
+		@dirty = false
+		if opts.is_a?(Hash)
+			@file = opts['file'] || WCC::Conf.file("atom.xml")
+			@db_name = opts['db_name']
+			@num_keep = opts['num_keep'] || 1000
+			@feed = {}
+			if opts['feed'].is_a?(Hash)
+				@feed = {
+					:title => opts['feed']['title'] || "wcc Updates Feed - #{Socket.gethostname}",
+					:subtitle => opts['feed']['subtitle'] || "The newest changes to your watched sites.",
+					:link => opts['feed']['link'],
+					:alt_link => opts['feed']['alternate_link'],
+					:id => opts['feed']['id']
+				}
+			end
+			if @feed[:id].nil?
+				raise ArgumentError, "Missing atom feed ID!"
+			end
+			if @db_name.nil?
+				raise ArgumentError, "Missing db name for atom feed!"
+			end
+		else
+			raise ArgumentError, "No options given for 'rss:' way of a recipient! Need at least db name and feed id."
+		end
+		@@shutdown_hooks << self
+	end
+	
+	def get_feeddb
+		if @feeddb.nil?
+			feeddb_file = WCC::Conf.file("feed-db-#{@db_name}.yml")
+			WCC.logger.debug "Loading feed-db '#{@db_name}' from file '#{feeddb_file}'"
+			if not File.exists?(feeddb_file)
+				WCC.logger.warn "Feed-db '#{@db_name}' does not exist, will create it on save in '#{feeddb_file}'"
+				@feeddb = {'feed' => []}
+			else
+				# may be false if file is empty
+				@feeddb = YAML.load_file(feeddb_file)
+				if not @feeddb.is_a?(Hash)
+					WCC.logger.warn "Feed-db '#{@db_name}' is corrupt, will overwrite it on save"
+					@feeddb = {'feed' => []}
+				end
+			end
+		end
+		@feeddb
+	end
+	
+	def notify!(data)
+		title = self.class.get_tpl(:title, 'rss-title.plain.erb').result(binding)
+		# remove trailing whitespace introduced by template
+		title.strip!
+		content = self.class.get_tpl(:content, 'rss-content.html.erb').result(binding)
+		id = "#{@feed['id']}item/#{Time.now.to_f}"
+		
+		# append entries to class variable (not thread safe)
+		@dirty = true
+		feed = get_feeddb['feed']
+		feed.insert 0, {
+			'title' => title,
+			#'description' => '', # summary
+			'content' => content,
+			'link' => data.site.uri.to_s,
+			'id' => id,
+			'updated' => Time.now.to_s
+		}
+	end
+	
+	def shut_down
+		return unless @dirty
+		
+		WCC.logger.debug "Writing feed-db '#{@db_name}' to file"
+		
+		feeddb_file = WCC::Conf.file("feed-db-#{@db_name}.yml")
+		feeddb = get_feeddb
+		# auto-purge
+		feeddb['feed'] = feeddb['feed'].slice(0, @num_keep)
+		File.open(feeddb_file, 'w+') do |f| YAML.dump(feeddb, f) end
+		
+		WCC.logger.info "Generating feed '#{@file}'..."
+		
+		content = RSS::Maker.make('atom') do |m|
+			m.channel.title = @feed[:title]
+			m.channel.subtitle = @feed[:subtitle]
+			m.channel.author = "web change checker (aka wcc) #{WCC::VERSION}"
+			if not @feed[:link].nil?
+				m.channel.links.new_link do |li|
+					li.rel = "self"
+					li.type = "application/atom+xml"
+					li.href = @feed[:link]
+				end
+			end
+			if not @feed[:alternate_link].nil?
+				m.channel.links.new_link do |li|
+					li.rel = "alternate"
+					li.type = "text/html"
+					li.href = @feed[:alternate_link]
+				end
+			end
+			m.channel.id = @feed[:id]
+			m.channel.updated = Time.now.to_s
+			m.items.do_sort = true # sort items by date
+			
+			# feeddb-hash to atom
+			feeddb['feed'].each do |e|
+				m.items.new_item do |i|
+					i.title = e['title']
+					#i.description = e['description']
+					i.content.content = e['content']
+					i.content.type = "html"
+					i.author = "wcc"
+					if not e['link'].nil?
+						i.links.new_link do |li|
+							li.rel = "alternate"
+							li.type = "text/html"
+							li.href = e['link']
+						end
+					end
+					i.id = e['id']
+					i.updated = e['updated']
+				end
+			end
+		end
+		
+		File.open(@file, 'w+') do |f| f.write(content.to_s) end
+	end
+	
+	def self.parse_conf(conf); {} end
+	
+	def self.shut_down
+		@@shutdown_hooks.each do |s| s.shut_down end
+	end
+
+	def self.get_tpl(id, name)
+		if @@tpl[id].nil?
+			@@tpl[id] = WCC::Prog.load_template(name)
+			if @@tpl[id].nil?
+				src_path = Pathname.new(__FILE__) + "../../assets/template.d/#{name}"
+				t = File.open(src_path, 'r') { |f| f.read }
+				WCC::Prog.save_template(name, t)
+				# retry load
+				@@tpl[id] = WCC::Prog.load_template(name)
+			end
+			if @@tpl[id].nil?
+				@@tpl[id] = ERB.new("ERROR LOADING TEMPLATE '#{name}'!", 0, "<>")
+			end
+		end
+		@@tpl[id]
+	end
+end
+
+WCC::Notificators.map "rss", RSSNotificator

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: wcc-rss-notificator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christian Nicolai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-25 00:00:00 Z
+dependencies: []
+
+description: 
+email: chrnicolai@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- assets/template.d/rss-content.html.erb
+- assets/template.d/rss-title.plain.erb
+- lib/wcc-rss-notificator.rb
+- README.md
+homepage: https://github.com/cmur2/wcc-rss-notificator
+licenses: []
+
+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: wcc-rss-notificator
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: RSS feed notificator plugin for wcc
+test_files: []
+