gem_watch 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009, Fabien Jakimowicz <fabien@jakimowicz.com>
+
+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,100 @@
+= GemWatch
+
+== DESCRIPTION
+GemWatch helps sysadmins to watch their systems to see if an update is available for installed gems. GemWatch can watch all installed gems or only specified gems. Results can be outputted to stdout or email(s) addresses.
+
+A cron task launching GemWatch with a configuration file can be used to launch checks every day.
+
+== SYNOPSIS
+
+=== Command line options
+  Checks options:
+      -u=<all|gem1, gem2, ...>         Precise what are the gems to check for the update.
+          --check-update-on
+
+  Email options:
+      -e=email1, email2, ...           Email address to send results.
+          --email-recipient
+      -s, --email-subject=subject      Subject used in the email.
+      -f, --email-from=email           Email's sender.
+
+  SMTP options:
+          --smtp-host=localhost        SMTP host to connect to send emails.
+          --smtp-port=25               SMTP port to connect to send emails.
+
+  General options:
+      -c, --config=config.yml          YAML configuration file. Overrides command line attributes.
+      -S, --stdout                     Display results on stdout instead of mailing them.
+      -h, --help                       Show this message
+
+=== Configuration file
+A yaml configuration file can be used to specify all options:
+
+  email:
+    recipients: admin@example.com
+    subject: Critical update !
+
+  smtp:
+    host: 127.0.0.1
+    port: 25
+
+  check:
+    update_on: super_security, rails
+
+=== Command line examples
+  $> gemwatch
+  
+  Those gems can be updated to their latest version:
+
+  Name                Local     Remote
+  =========================================
+  ZenTest             4.1.3     4.1.4
+  sqlite3-ruby        1.2.4     1.2.5
+  thor                0.9.9     0.11.5
+  fake_mechanize      0.0.0     0.0.1
+  rubyforge           1.0.3     1.0.4
+  net-ssh             2.0.11    2.0.13
+  hirb                0.2.4     0.2.5
+  ruby_parser         2.0.3     2.0.4
+  ruby2ruby           1.2.3     1.2.4
+  rmagick             2.10.0    2.11.0
+  hoe                 2.3.2     2.3.3
+  sexp_processor      3.0.2     3.0.3
+  nokogiri            1.3.2     1.3.3
+  RubyInline          3.8.2     3.8.3
+
+  $> gemwatch --check-update-on=rails
+
+  Nothing to report.
+
+
+== REQUIREMENTS
+
+* yaml gem
+
+== INSTALL
+  gem install gem_watch
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2009, Fabien Jakimowicz <fabien@jakimowicz.com>
+
+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/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gem_watch"
+    gem.summary = %Q{watch over outdated gems and send an email to notice admin.}
+    gem.description = %Q{GemWatch watches over outdated gems in your system and send an email to inform administrators about available update, like apticron on debian}
+    gem.email = "fabien@jakimowicz.com"
+    gem.homepage = "http://github.com/jakimowicz/gem_watch"
+    gem.authors = ["Fabien Jakimowicz"]
+    gem.rubyforge_project = "gemwatch"
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency 'yaml'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gem_watch #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/gemwatch

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "gem_watch/command"
+
+GemWatch::Command.new.run ARGV

data/lib/gem_watch/check.rb

@@ -0,0 +1,34 @@
+require "gem_watch"
+
+# Implements a check which will run some tests on one or multiple gems.
+# Negative results that need to be noticed are stored in the <tt>impacts</tt> hash.
+# This class implements basic behavior for check, specific test implementation
+# and interpretation is done in the children classes.
+class GemWatch::Check
+  # Stores the gem name to check on
+  attr_reader :gem_name
+  
+  # Hash to store which gem has failed check and why
+  attr_reader :impacts
+  
+  # Take a <tt>gem_name</tt> to check.
+  def initialize(gem_name = :all)
+    @gem_name = gem_name
+    @impacts = {}
+  end
+  
+  # Run check on <tt>gem_name</tt>.
+  def run
+    raise "Not implemented for this check."
+  end
+  
+  # Returns true if test was passed, false otherwise.
+  def passed?
+    @impacts.empty?
+  end
+
+  # Pretty displays of results (interpretation of <tt>impacts</tt>).
+  def results
+    @impacts.inspect
+  end
+end

data/lib/gem_watch/checks/update.rb

@@ -0,0 +1,34 @@
+require "rubygems"
+require "gem_watch/check"
+
+# Implements a simple check to assure that installed gem(s) are up to date.
+class GemWatch::Check::Update < GemWatch::Check
+  
+  # Check if specified gem(s) are up to date.
+  def run
+    if gem_name.to_s == 'all'
+      Gem::SourceIndex.from_installed_gems.outdated.each {|g| run_on g}
+    else
+      run_on gem_name
+    end
+  end
+  
+  # Displays a formated result with gem name, local and remote version.
+  def results
+    @impacts.collect do |name, (local_version, remote_version)|
+      "%-20s%-10s%s" % [name, local_version, remote_version]
+    end
+  end
+
+  private
+  def run_on(gem_name)
+    local = Gem::SourceIndex.from_installed_gems.find_name(gem_name).last
+
+    dep = Gem::Dependency.new local.name, ">= #{local.version}"
+    remotes = Gem::SpecFetcher.fetcher.fetch dep
+    remote = remotes.last.first
+    
+    @impacts[local.name] = [local.version, remote.version] if local.version != remote.version
+  end
+  
+end

data/lib/gem_watch/command.rb

@@ -0,0 +1,132 @@
+# Pure ruby requires
+require 'optparse'
+require 'net/smtp'
+
+# Gems
+require 'yaml'
+
+# Internal stuff
+require "gem_watch"
+require "gem_watch/command_options"
+
+# Command implements a command to be executed based on options.
+# It is directly used by the command line interface.
+class GemWatch::Command
+  def initialize
+    @options = GemWatch::CommandOptions.new
+  end
+  
+  # Run the command based on default options and given <tt>args</tt>.
+  def run(args = {})
+    parse_options args
+    gw = GemWatch.new(:update => @options.check_update_on)
+    gw.run_checks
+    if gw.passed?
+      say "Nothing to report."
+    else
+      say gw.results
+    end
+  end
+  
+  protected
+  # Based on options, display given <tt>str</tt> to stdout or to mail.
+  def say(str)
+    if @options.stdout or @options.email_recipients.empty?
+      puts str
+    else
+      send_email str
+    end
+  end
+  
+  # Send an email with given <tt>message</tt>.
+  def send_email(message)
+    email = <<-END_OF_MESSAGE
+From: GemWatch <#{@options.email_from}>
+To: %s
+Subject: #{@options.email_subject}
+
+#{message}
+END_OF_MESSAGE
+
+  	Net::SMTP.start(@options.smtp_host, @options.smtp_port) do |smtp|
+      @options.email_recipients.each do |recipient|
+  		  smtp.send_message email % recipient, @options.email_from, recipient
+		  end
+  	end
+  end
+  
+  # Parse given <tt>args</tt> with OptionParser to generate options.
+  def parse_options(args)
+    OptionParser.new do |opts|
+      opts.banner = "Usage: gemwatch [options]"
+      
+      opts.separator ""
+      opts.separator "Checks options:"
+      
+      opts.on "-u", "--check-update-on=<all|gem1, gem2, ...>", "Precise what are the gems to check for the update." do |gems|
+        @options.check_update_on = gems
+      end
+      
+      opts.separator ""
+      opts.separator "Email options:"
+      
+      opts.on "-e", "--email-recipient=email1, email2, ...", "Email address to send results." do |email|
+        @options.email_recipients = email
+        @options.stdout = false
+      end
+      
+      opts.on "-s", "--email-subject=subject", "Subject used in the email." do |subject|
+        @options.email_subject = subject
+      end
+      
+      opts.on "-f", "--email-from=email", "Email's sender." do |email|
+        @options.email_recipient = email.split(',').collect {|email| email.strip}
+        @options.stdout = false
+      end
+      
+      opts.separator ""
+      opts.separator "SMTP options:"
+      
+      opts.on "--smtp-host=localhost", "SMTP host to connect to send emails." do |host|
+        @options.smtp_host = host
+      end
+      
+      opts.on "--smtp-port=25", "SMTP port to connect to send emails." do |port|
+        @options.smtp_port = port
+      end
+      
+      opts.separator ""
+      opts.separator "General options:"
+      
+      opts.on "-c", "--config=config.yml", "YAML configuration file. Overrides command line attributes." do |config_file|
+        y = YAML.parse_file(config_file)
+        GemWatch::CommandOptions::Defaults.each_key do |key|
+          value = yaml_value(y, key.to_s)
+          @options.send("#{key}=", value) if value
+        end
+      end
+      
+      opts.on "-S", "--stdout", "Display results on stdout instead of mailing them." do
+        @options.stdout = true
+      end
+      
+      opts.on_tail "-h", "--help", "Show this message" do
+        puts opts
+        exit
+      end
+      
+      opts.parse!(args)
+    end
+  end
+  
+  # Given a <tt>yaml</tt> object and a <tt>key</tt> string, returns the value.
+  # If <tt>key</tt> contains an underscore character, it will consider each word between underscores as a subtree.
+  def yaml_value(yaml, key)
+    if key.include?('_')
+      first_key, sep, rest = key.partition('_')
+      yaml_value yaml[first_key], rest
+    else
+      yaml[key].value rescue nil
+    end
+  end
+end

data/lib/gem_watch/command_options.rb

@@ -0,0 +1,45 @@
+require "gem_watch"
+
+# Command options class for the command line interface. It is initialized with Defaults values.
+class GemWatch::CommandOptions
+  attr_accessor :smtp_host
+  attr_accessor :smtp_port
+
+  attr_accessor :email_recipients
+  attr_accessor :email_subject
+  attr_accessor :email_from
+
+  attr_accessor :stdout
+  attr_accessor :check_update_on
+  
+  # Defaults values for command line interface.
+  Defaults = {
+    # SMTP Part
+    :smtp_host  => 'localhost',
+    :smtp_port  => 25,
+    # Email part
+    :email_recipients => [],
+    :email_subject    => "GemWatch has found something to report",
+    :email_from       => "gemwatch@example.com",
+    # Checks part
+    :check_update_on => :all,
+    # General part
+    :stdout => true
+  }
+  
+  # Initialize a new object with Defaults values.
+  def initialize
+    Defaults.each {|key, value| send "#{key}=", value}
+  end
+  
+  # Overrides the default attr_accessor to split a string of multiple email addresses in a array.
+  def email_recipients=(recipients)
+    @email_recipients = case recipients.class.name
+    when 'Array'
+      recipients
+    when 'String'
+      recipients.split(',').collect {|email| email.strip}
+    end
+    @stdout = @email_recipients.empty?
+  end
+end

data/lib/gem_watch.rb

@@ -0,0 +1,48 @@
+# GemWatch regroups multiple checks and consolidates them in a pretty formated result.
+class GemWatch
+  # Update object to perform check on
+  attr_reader :update_on
+  
+  # Initialize a new GemWatch object using <tt>params</tt>.
+  # == params
+  # <tt>:update</tt>: accepts a String of coma separated gem names or directly an Array of gem string names.
+  def initialize(params = {})
+    @update_on  = case params[:update].class
+    when Array
+      params[:update]
+    when String
+      params[:update].split(',').collect {|s| s.strip}
+    else
+      [params[:update]]
+    end
+    
+    @update_on = @update_on.collect {|name| GemWatch::Check::Update.new name}    
+  end
+  
+  # Run all checks
+  def run_checks
+    @update_on.each {|check| check.run}
+  end
+  
+  # Returns true if all checks passed.
+  def passed?
+    @update_on.all? {|check| check.passed?}
+  end
+  
+  # Formated results.
+  def results
+    if @update_on.any? {|check| !check.passed?}
+      <<-EOS
+
+Those gems can be updated to their latest version:
+
+Name                Local     Remote
+=========================================
+#{@update_on.collect {|check| check.results}.join "\n"}
+
+      EOS
+    end
+  end
+end
+
+require "gem_watch/checks/update"

data/test/gem_watch_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GemWatchTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gem_watch'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: gem_watch
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fabien Jakimowicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 +02:00
+default_executable: gemwatch
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yaml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: GemWatch watches over outdated gems in your system and send an email to inform administrators about available update, like apticron on debian
+email: fabien@jakimowicz.com
+executables: 
+- gemwatch
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/gemwatch
+- lib/gem_watch.rb
+- lib/gem_watch/check.rb
+- lib/gem_watch/checks/update.rb
+- lib/gem_watch/command.rb
+- lib/gem_watch/command_options.rb
+- test/gem_watch_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jakimowicz/gem_watch
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gemwatch
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: watch over outdated gems and send an email to notice admin.
+test_files: 
+- test/gem_watch_test.rb
+- test/test_helper.rb