audrey2 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sven Aas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,87 @@
+= Audrey 2.0
+
+Audrey 2.0 is a gem for feed processing and aggregation. 
+
+== Please note: This should be considered an Alpha release
+
+The initial codebase is an adaptation of several other prototypes. It suffers from
+severe shortages of documentation and testing. Both are coming soon.
+
+== Installation
+
+gem install audrey2
+
+== Usage
+
+Audrey 2.0 installs a command-line script, feedme, which can be fed one or more recipes:
+
+feedme recipe [recipe2] [recipe3] ...
+
+Each recipe lists one or more feeds and identifies a theme to be used at output. When 
+feedme is run it aggregates the feeds according to the recipe and generates themed
+output. 
+
+== Requirements
+
+Audrey 2.0 depends on the feed_normalizer and haml gems. 
+
+== Configuration
+
+* A configuration file which is located by default at /etc/audrey2.conf. This location 
+can be overridden with the command line --config option. The configuration file is in
+YAML format and must at minimum include the following lines:
+  * recipes_folder:  ./recipes
+  * themes_folder:   ./themes
+* A recipes folder specified in the configuration file and containing at least one recipe. 
+* A themes folder specified in the configuration file and containing at leastone theme.
+
+== Recipes
+
+Each recipe is a YAML-format file located in the recipes folder specified in Audrey 2.0 config. 
+The filename must match the command line argument used when passing the recipe to the feedme
+command-line program. By convention recipe filenames omit an extension. 
+
+Each recipe must
+
+* List one or more feeds in an array of hashes formatted like this:
+
+feeds:
+ -
+  name: nytimes
+  url: http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml  
+ - 
+  name: bostonglobe
+  url: http://syndication.boston.com/topstories.xml
+
+* Identify a theme
+  
+theme: mytheme
+
+* Identify an output filename and path
+
+output_file: entries.html
+
+== Themes
+
+Themes are located in eponymous folders within the themes folder identified in Audrey 2.0 config.
+A theme folder must contain a single HAML template named entries.haml. This template is rendered 
+once for each entry in the feed aggregation. The rendered entries are concatenated and output at
+the path specified in the recipe.
+
+A theme folder may also contain a file named helpers.rb. When this file is present its code is
+loaded into the HAML rendering scope, making any methods defined within available during 
+rendering of entries.haml. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Sven Aas. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "audrey2"
+    gem.summary     = "Gem for feed processing and aggregation"
+    gem.description = "Gem for feed processing and aggregation"
+    gem.email       = "sven.aas@gmail.com"
+    gem.homepage    = "http://github.com/svenaas/audrey2"
+    gem.authors     = ["Sven Aas"]
+    gem.add_dependency "feed-normalizer", "~>1.5.2"
+    gem.add_dependency "haml", "~>3.0.13"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "audrey2 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/audrey2.conf.sample

@@ -0,0 +1,24 @@
+# Sample audrey2.conf
+
+# The default location for this file is /etc/audrey2/audrey2.conf, but an alternate location
+# may be specified with the --config command-line option.
+
+#
+# Folders for recipes and themes
+#
+# Suggested locations:
+#   /etc/audrey2/recipes
+#   /etc/audrey2/themes
+recipes_folder:  ./recipes
+themes_folder:   ./themes
+
+# User agent to impersonate when retrieving themes. Please use with discretion.
+#user_agent:      Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3 (.NET CLR 1.1.4322)
+
+#
+# Not yet implemented:
+#
+# email_errors_to: test@test.com
+# log_file:        /var/log/audrey2.log
+# log_level:       debug
+

data/audrey2.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{audrey2}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sven Aas"]
+  s.date = %q{2010-07-20}
+  s.default_executable = %q{feedme}
+  s.description = %q{Gem for feed processing and aggregation}
+  s.email = %q{sven.aas@gmail.com}
+  s.executables = ["feedme"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "audrey2.conf.sample",
+     "audrey2.gemspec",
+     "bin/feedme",
+     "lib/audrey2.rb"
+  ]
+  s.homepage = %q{http://github.com/svenaas/audrey2}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Gem for feed processing and aggregation}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<feed-normalizer>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<haml>, ["~> 3.0.13"])
+    else
+      s.add_dependency(%q<feed-normalizer>, ["~> 1.5.2"])
+      s.add_dependency(%q<haml>, ["~> 3.0.13"])
+    end
+  else
+    s.add_dependency(%q<feed-normalizer>, ["~> 1.5.2"])
+    s.add_dependency(%q<haml>, ["~> 3.0.13"])
+  end
+end
+

data/bin/feedme

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'audrey2'
+require 'optparse'
+
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: feedme [OPTIONS] recipes"
+  
+  options[:config] = '/etc/audrey2/audrey2.conf'
+  opts.on( '--config CONFIGFILE', "Location of config file", "(default: /etc/audrey2/audrey2.conf)" )  do |f|
+    options[:config] = f
+  end
+
+  opts.on_tail( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+begin 
+  opts.parse! ARGV
+  options
+rescue OptionParser::InvalidOption => e
+  $stderr.puts e
+  $stderr.puts opts
+  exit 1
+rescue OptionParser::MissingArgument => e
+  $stderr.puts e
+  $stderr.puts opts
+  exit 1
+end
+
+recipes = ARGV
+if recipes.length == 0
+  $stderr.puts "You must specify at least one recipe to feed me"
+  $stderr.puts opts
+  exit 1
+end
+
+audrey2 = Audrey2::Aggregator.new(options[:config])
+
+recipes.each { |recipe| audrey2.feed_me(recipe) }

data/lib/audrey2.rb

@@ -0,0 +1,169 @@
+require 'rubygems'
+require 'yaml'
+require 'feed-normalizer'
+require 'open-uri'
+require 'haml'
+
+module Audrey2 
+
+  class Aggregator
+    def initialize(configfile)
+      init_config(configfile)
+    end
+    
+    def feed_me(recipe_name)
+      # Load recipe and theme and make sure everything is in order
+      recipe = load_recipe(recipe_name)      
+      init_theme(recipe['theme'])      
+      output_file = recipe['output_file']
+      verify_output_file(output_file)
+      
+      # Download and parse the feeds
+      entry_sources = {}
+      feeds = recipe['feeds'].collect { |feed| parse_feed(feed, entry_sources) }
+            
+      # Aggregate and sort the entries
+      entries = []
+      feeds.each { |feed| entries += feed.entries }      
+      sort!(entries)       
+      
+      # Prepare template evaluation scope including any helper code defined in the theme
+      scope = Object.new            
+      scope.instance_eval(@helper_code) if @helper_code
+            
+      # Output the aggregated entries      
+      output = ''
+      engine ||= Haml::Engine.new(@entry_template)
+      
+      entries[0..@max_entries - 1].each do |entry| 
+        output << engine.render(scope, :entry => entry, :source => entry_sources[entry])
+      end
+      
+      File.open(output_file, 'w') { |f| f << output }      
+    end
+    
+  protected
+    def verify_output_file(output_file)
+      output_folder = File.dirname(output_file)
+      if ! File.exist? output_folder
+        $stderr.puts "ERROR: Output folder #{output_folder} does not exist." 
+        exit(1) 
+      elsif ! File.writable? output_folder
+        $stderr.puts "ERROR: Output folder #{output_folder} is not writable"
+        exit(1) 
+      end   
+      if File.exist?(output_file)
+        if ! File.writable? output_file
+          $stderr.puts "ERROR: Output file #{output_folder} is not writable"
+          exit(1) 
+        end
+      end
+    end
+    
+    def init_theme(theme)
+      theme_path = File.join(@themes_folder, theme)
+      if ! File.exist? theme_path
+        $stderr.puts "ERROR: Theme #{theme_path} does not exist." 
+        exit(1) 
+      elsif ! File.readable? theme_path
+        $stderr.puts "ERROR: Theme #{theme_path} is not readable"
+        exit(1) 
+      end   
+      
+      entry_template_file = File.join(@themes_folder, theme, 'entry.haml')
+      if ! File.exist? entry_template_file
+        $stderr.puts "ERROR: Theme #{theme} does not include an entry template (entry.haml)" 
+        exit(1) 
+      elsif ! File.readable? entry_template_file
+        $stderr.puts "ERROR: Entry template #{entry_template_file} is not readable"
+        exit(1) 
+      end            
+      @entry_template = File.read(entry_template_file)
+      
+      helper_file = File.join(@themes_folder, theme, 'helpers.rb')
+      @helper_code = nil
+      if File.exist? helper_file
+        if ! File.readable? helper_file
+          $stderr.puts "ERROR: Helper file #{helper_file} is not readable"
+          exit(1) 
+        end
+        @helper_code = File.open(helper_file) { |f| f.read }      
+      end      
+    end   
+  
+    # Uses the sort order specified in configuration 
+    def sort!(entries)
+      case @sort
+      when 'reverse-chronological'
+        entries.sort! {|a, b| b.date_published <=> a.date_published } # Reverse chronological        
+      end
+    end
+    
+    def parse_feed(feed, entry_sources)
+      remote_feed = nil
+      begin
+        remote_feed = open(feed['url'], "User-Agent" => @user_agent) 
+      rescue Exception => e    
+        raise "Exception occurred when opening feed #{feed['name']} at #{feed['url']}:\n\n" + e.to_s
+      end
+
+      parsed_feed = nil
+      begin
+        parsed_feed = FeedNormalizer::FeedNormalizer.parse remote_feed
+      rescue Exception => e    
+        raise "Exception occurred when parsing feed #{feed['name']} which was downloaded from #{feed['url']}:\n\n" + e.to_s 
+      end
+
+      parsed_feed.entries.each { |entry| entry_sources[entry] = feed }
+      
+      parsed_feed      
+    end
+    
+    def load_recipe(recipe)
+      recipefile = File.join(@recipes_folder, recipe)
+      if ! File.exist? recipefile
+        $stderr.puts "ERROR: Recipe #{recipefile} does not exist" 
+        exit(1) 
+      elsif ! File.readable? recipefile
+        $stderr.puts "ERROR: Recipe file #{recipefile} is not readable"
+        exit(1) 
+      end
+      YAML::load_file(recipefile)
+    end
+      
+    def init_config(configfile)
+      if ! File.exist? configfile
+        $stderr.puts "ERROR: Configuration file #{configfile} does not exist" 
+        exit(1) 
+      elsif ! File.readable? configfile
+        $stderr.puts "ERROR: Configuration file #{configfile} is not readable"
+        exit(1) 
+      end
+      
+      config = YAML::load_file(configfile)
+      
+      @recipes_folder = config['recipes_folder']
+      if ! File.exist? @recipes_folder
+        $stderr.puts "ERROR: Recipes folder #{@recipes_folder} does not exist" 
+        exit(1) 
+      elsif ! File.readable? @recipes_folder
+        $stderr.puts "ERROR: Recipes folder #{@recipes_folder} is not readable"
+        exit(1) 
+      end
+      
+      @themes_folder = config['themes_folder']
+      if ! File.exist? @themes_folder
+        $stderr.puts "ERROR: Themes folder #{@themes_folder} does not exist" 
+        exit(1) 
+      elsif ! File.readable? @themes_folder
+        $stderr.puts "ERROR: Themes folder #{@themes_folder} is not readable"
+        exit(1) 
+      end
+      
+      @user_agent = config['user_agent'] || 'Audrey 2.0 Feed Aggregator'
+      @max_entries = config['max_entries'] || 1000
+      @sort = config['sort'] || 'reverse-chronological'
+    end
+  end    
+    
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: audrey2
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sven Aas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 -04:00
+default_executable: feedme
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: feed-normalizer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 3
+        - 0
+        - 13
+        version: 3.0.13
+  type: :runtime
+  version_requirements: *id002
+description: Gem for feed processing and aggregation
+email: sven.aas@gmail.com
+executables: 
+- feedme
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- audrey2.conf.sample
+- audrey2.gemspec
+- bin/feedme
+- lib/audrey2.rb
+has_rdoc: true
+homepage: http://github.com/svenaas/audrey2
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Gem for feed processing and aggregation
+test_files: []
+