rss-client 2.0.9

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007, 2008 Stoyan Zhekov
+
+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

@@ -0,0 +1,79 @@
+= RSSClient:  Fetching and parsing RSS feeds with easy
+
+== Download
+
+The latest version of rake can be found at
+
+* http://rubyforge.org/project/...
+
+
+== Installation
+
+=== Normal Installation
+
+You can install rake with the following command.
+
+  % ruby install.rb
+
+from its distribution directory.
+
+=== GEM Installation
+
+Download and install  rss-client with the following.
+
+   gem install --remote rss-client
+
+
+== Synopsis 
+
+   Fetching RSS feeds.
+
+
+== Examples
+
+   rssclient -q http://example.com/atom.xml
+   rssclient -r -f http://test:test@example.com/atom.xml
+   rssclient --verbose http://example.com/atom.xml
+   rssclient --giveup 20 -f http://example.com/atom.xml
+   rssclient --since 600 http://example.com/atom.xml
+   rssclient -f -p http://aa:bb@localhost:8088 http://example.com/atom.xml
+
+
+== Usage 
+
+   rssclient [options] feed_url
+
+=== Options
+
+  -h, --help          Displays help message
+  -V, --version       Display the version, then exit
+  -q, --quiet         Output as little as possible, overrides verbose
+  -v, --verbose       Verbose output
+  -p, --proxy         Use proxy (format http://user:pass@address:port )
+  -r, --raw           Use raw RSS fetch (no error code processing)
+  -g, --giveup        Giveup on fetching after timeout (seconds)
+  -f, --force         Force fresh feed fetch (no 304 code processing)
+  -s, --since         Only changes from {since} seconds ago
+
+
+== Credits
+
+[<b>Hiroshi Nakamura</b>] For the http-access2 library.
+
+[<b>Todd Werth</b>] For the ruby command-line application skeleton
+
+
+== License
+
+rss-client is available under an MIT-style license.
+
+:include: MIT-LICENSE
+
+
+== Other stuff
+
+Author::   Stoyan Zhekov <stoyan@gmail.com> 
+Requires:: Ruby 1.8.0 or later
+License::  Copyright (c) 2007, 2008 Stoyan Zhekov
+           Released under an MIT-style license.  See the MIT-LICENSE file
+           included in the distribution.

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+Gem::manage_gems
+
+require 'rake'
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+include FileUtils
+
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+
+NAME = "rss-client"
+
+RDOC_FILES = %w[
+  lib
+  README
+  MIT-LICENSE
+]
+
+RDOC_OPTS  = %w[
+  --line-numbers
+  --inline-source
+  --all
+  --quiet
+  --title RSSClient:\ Fetching\ and\ parsing\ RSS\ feeds\ with\ easy
+  --main README
+  --exclude "^(_darcs|.hg|.svn|spec|bin|pkg)/"
+]
+
+load 'rake_tasks/annotations.rake'
+
+spec = Gem::Specification.new do |s| 
+  s.name = NAME
+  s.version = "2.0.9"
+  s.author = "Stoyan Zhekov"
+  s.email = "stoyan@gmail.com"
+  s.rubyforge_project = NAME
+  s.homepage = "http://www.assembla.com/wiki/show/#{NAME}"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Fetching and parsing RSS feeds with easy"
+  s.files = (RDOC_FILES + %w[install.rb] + %w[Rakefile] + Dir["{bin,lib,rake_tasks,spec}/**/*"]).uniq
+  s.test_files = Dir['spec/spec_*.rb']
+  s.require_path = "lib"
+  s.bindir = "bin"
+  s.executables = ['rssclient']
+  s.default_executable = 'rssclient'
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+  s.rdoc_options = RDOC_OPTS
+  s.add_dependency("feed-normalizer", ">= 1.4.0")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+end
+
+desc "package and the gem"
+task :install do
+  name = "#{spec.name}-#{spec.version}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{spec.name}-#{spec.version}.gem}
+end
+
+desc "uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{spec.name}}
+end
+
+desc "generate rdoc"
+task :rdoc => [:clean] do
+  sh "rdoc #{(RDOC_OPTS + RDOC_FILES).join(' ')}"
+end
+
+desc "Run all the tests"
+task :test do
+  sh "specrb -Ilib:spec -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end
+ 
+task :default => "pkg/#{spec.name}-#{spec.version}.gem" do
+    puts "generated latest version"
+end

data/bin/rssclient

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+# == Synopsis 
+#   Fetching RSS feeds.
+#
+# == Examples
+#
+#     rssclient -q http://example.com/atom.xml
+#     rssclient -r -f http://test:test@example.com/atom.xml
+#     rssclient --verbose http://example.com/atom.xml
+#     rssclient --giveup 20 -f http://example.com/atom.xml
+#     rssclient --since 600 http://example.com/atom.xml
+#     rssclient -f -p http://aa:bb@localhost:8088 http://example.com/atom.xml
+#
+# == Usage 
+#   rssclient [options] feed_url
+#
+# == Options
+#   -h, --help          Displays help message
+#   -V, --version       Display the version, then exit
+#   -q, --quiet         Output as little as possible, overrides verbose
+#   -v, --verbose       Verbose output
+#   -p, --proxy         Use proxy (format http://user:pass@address:port )
+#   -r, --raw           Use raw RSS fetch (no error code processing)
+#   -g, --giveup        Giveup on fetching after timeout (seconds)
+#   -f, --force         Force fresh feed fetch (no 304 code processing)
+#   -s, --since         Only changes from {since} seconds ago
+#
+# == Author
+#   Stoyan Zhekov <stoyan@gmail.com>
+#
+# == Copyright
+#   Copyright (c) 2007 Stoyan Zhekov <stoyan@gmail.com>. Licensed under the MIT License:
+#   http://www.opensource.org/licenses/mit-license.php
+
+begin
+  require 'rss-client'
+rescue LoadError
+  require 'rubygems'
+  require 'rss-client'
+end
+
+require 'optparse' 
+require 'rdoc/usage'
+
+class App
+  VERSION = '2.0.9'
+
+  attr_reader :options
+
+  def initialize(arguments, stdin)
+    @arguments = arguments
+    @stdin = stdin
+
+    # Set defaults
+    @options = OpenStruct.new
+    @options.verbose = false
+    @options.quiet = false
+    @options.forceUpdate = false
+    @options.raw = false
+    @options.since = Time.new - (10*60) # only changes from 10 min ago
+    @options.giveup = 10                # giveup after 10 sec timeout
+    @options.proxy = nil
+  end
+
+  # Parse options, check arguments, then process the command
+  def run
+
+    if parsed_options? && arguments_valid? 
+
+      puts "Start at #{Time.new.to_s}\n\n" if @options.verbose
+
+      output_options if @options.verbose # [Optional]
+            
+      process_arguments            
+      process_command
+
+      puts "\nFinished at #{Time.new.to_s}" if @options.verbose
+
+    else
+      output_usage
+    end
+
+  end
+
+  protected
+
+    def parsed_options?
+
+      # Specify options
+      opts = OptionParser.new
+      opts.on('-V', '--version')    { output_version ; exit 0 }
+      opts.on('-h', '--help')       { output_help }
+      opts.on('-v', '--verbose')    { @options.verbose = true }  
+      opts.on('-q', '--quiet')      { @options.quiet = true }
+      opts.on('-r', '--raw')        { @options.raw = true }
+      opts.on('-f', '--force')      { @options.forceUpdate = true }
+      opts.on('-p', '--proxy PROXY') { |v| @options.proxy =  v }
+      opts.on('-g', '--giveup SEC') { |v| @options.giveup = v.to_i }
+      opts.on('-s', '--since SEC')  { |v| @options.since =  Time.new - v.to_i }
+
+      opts.parse!(@arguments) rescue return false
+
+      process_options
+      true      
+    end
+
+    # Performs post-parse processing on options
+    def process_options
+      @options.verbose = false if @options.quiet
+      @options.forceUpdate = true unless Time.parse(@options.since.to_s)
+    end
+
+    def output_options
+      puts "Options:\n"
+
+      @options.marshal_dump.each do |name, val|        
+        puts "  #{name} = #{val}"
+      end
+    end
+
+    # True if required arguments were provided
+    def arguments_valid?
+      # TO DO - implement some real logic here
+      true if @arguments.length == 1 
+    end
+
+    # Setup the arguments
+    def process_arguments
+      # TO DO - place in local vars, etc
+    end
+
+    def output_help
+      output_version
+      RDoc::usage() #exits app
+    end
+
+    def output_usage
+      RDoc::usage('usage') # gets usage from comments above
+    end
+
+    def output_version
+      puts "#{File.basename(__FILE__)} version #{VERSION}"
+    end
+
+    def process_command
+      feed = RSSFeed.new
+      if @options.raw
+        rss = feed.fetch_raw(@arguments[0], @options)
+      else	
+        rss = feed.fetch(@arguments[0], @options)
+      end					
+    end
+
+end
+
+# My Modules, Classes, etc
+
+class RSSFeed
+  include RSSClient
+
+  def fetch_raw(uri, options)
+    options.extra = Hash.new
+    options.extra["Connection"] = "close"
+    options.extra["User-Agent"] = "RSSClient/2.0.9"
+    # options.since is Time::
+    if not options.forceUpdate and options.since
+      time = Time.parse(options.since.to_s)
+      options.extra["If-Modified-Since"] = time.httpdate() if time
+    end  
+    begin
+      rss = get_url(uri, options)
+      if rss
+        puts "Status code: #{rss.status}"
+	puts "Headers:"
+	rss.header.dump.each do |h|
+	  puts "- " + h.to_s
+	end  
+      end	
+    rescue RuntimeError => error
+      puts "[E] #{error}"
+    end
+  end
+
+  def fetch(uri, options)
+    # always fetch fresh feed
+    rss = get_feed(uri, options)
+    puts "Status code: #{@rssc_raw.status}" if @rssc_raw
+    if rss && rss != "304"
+      puts "Title: #{rss.channel.title.to_s}"
+      puts "Description: #{rss.channel.description}" if rss.channel.description
+      puts "Link: #{rss.channel.urls.first}" if rss.channel.urls
+      puts "News:"
+      rss.entries.each do |i|
+        puts "- " + i.title.to_s
+      end
+    else
+      puts "[E] #{@rssc_error}" if @rssc_error
+      exit
+    end  
+  end
+end
+
+
+# Create and run the application
+app = App.new(ARGV, STDIN)
+app.run

data/install.rb

@@ -0,0 +1,84 @@
+require 'rbconfig'
+require 'find'
+require 'ftools'
+
+include Config
+
+$ruby = CONFIG['ruby_install_name']
+
+##
+# Install a binary file. We patch in on the way through to
+# insert a #! line. If this is a Unix install, we name
+# the command (for example) 'rssclient' and let the shebang line
+# handle running it. Under windows, we add a '.rb' extension
+# and let file associations to their stuff
+#
+
+def installBIN(from, opfile)
+
+  tmp_dir = nil
+  for t in [".", "/tmp", "c:/temp", $bindir]
+    stat = File.stat(t) rescue next
+    if stat.directory? and stat.writable?
+      tmp_dir = t
+      break
+    end
+  end
+
+  fail "Cannot find a temporary directory" unless tmp_dir
+  tmp_file = File.join(tmp_dir, "_tmp")
+    
+  File.open(from) do |ip|
+    File.open(tmp_file, "w") do |op|
+      ruby = File.join($realbindir, $ruby)
+      op.puts "#!#{ruby} -w"
+      op.write ip.read
+    end
+  end
+
+  opfile += ".rb" if CONFIG["target_os"] =~ /mswin/i
+  File::install(tmp_file, File.join($bindir, opfile), 0755, true)
+  File::unlink(tmp_file)
+end
+
+$sitedir = CONFIG["sitelibdir"]
+unless $sitedir
+  version = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+  $libdir = File.join(CONFIG["libdir"], "ruby", version)
+  $sitedir = $:.find {|x| x =~ /site_ruby/}
+  if !$sitedir
+    $sitedir = File.join($libdir, "site_ruby")
+  elsif $sitedir !~ Regexp.quote(version)
+    $sitedir = File.join($sitedir, version)
+  end
+end
+
+$bindir =  CONFIG["bindir"]
+
+$realbindir = $bindir
+
+bindir = CONFIG["bindir"]
+if (destdir = ENV['DESTDIR'])
+  $bindir  = destdir + $bindir
+  $sitedir = destdir + $sitedir
+  
+  File::makedirs($bindir)
+  File::makedirs($sitedir)
+end
+
+# The library files
+
+files = Dir.chdir('lib') { Dir['**/*.rb'] }
+
+for fn in files
+  fn_dir = File.dirname(fn)
+  target_dir = File.join($sitedir, fn_dir)
+  if ! File.exist?(target_dir)
+    File.makedirs(target_dir)
+  end
+  File::install(File.join('lib', fn), File.join($sitedir, fn), 0644, true)
+end
+
+# and the executable
+
+installBIN("bin/rssclient", "rssclient")