snitch 0.1.0 → 0.1.1

data/CHANGELOG.txt

@@ -0,0 +1,5 @@
+0.1.1 - 3/25/2007
+ * added documentation; the first release didn't have hardly any
+
+0.1.0 - 3/25/2007
+ * initial release of snitch

data/Rakefile

@@ -52,3 +52,13 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.extra_deps << %w[ twitter tinder activesupport ]
   #p.spec_extras    - A hash of extra values to set in the gemspec.
 end
+
+desc 'Publish HTML to RubyForge'
+task :publish_html do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/snitch/"
+  local_dir = 'html'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+  `rake publish_docs`
+end

data/lib/snitch.rb

@@ -1,3 +1,5 @@
+# This file simply includes the gems and snitch files needed.
+
 %w[uri yaml rubygems active_support].each { |x| require x }
 
 require 'snitch/base'

data/lib/snitch/base.rb

@@ -2,6 +2,13 @@ module Snitch
   class Base
     attr_reader :services, :config
     
+    # Creates a new instance of snitch from a repository path and a revision.
+    #
+    #   Snitch::Base.new('/var/www/apps/myapp/repos', 102)
+    #
+    # You must have a config file in order for this to work. You can optionally pass in the path to the config file. The default config_file is /home/deploy/.snitch
+    #
+    #   Snitch::Base.new('/var/www/apps/myapp/repos', 102, '/some/other/path/to/config')
     def initialize(repository, revision, config_file='/home/deploy/.snitch')
       Config.config_file_path = config_file unless config_file.nil?
       @config                 = Config::load
@@ -10,14 +17,26 @@ module Snitch
       @config[:services].each { |s, attrs| use(s, attrs) }
     end
     
+    # Obtains the commit message from the svnlook class. Takes either <tt>:long</tt> or <tt>:short</tt> as optional parameter. 
+    #   * <tt>:long</tt> is the full commit message along with a list of all changed files. 
+    #   * <tt>:short</tt> is a truncated version of the commit message that is less than 140 characters for twitter.
     def commit_message(which=:long)
       @svnlook_bin.to_s(which)
     end
     
+    # Adds a service to the services array from a string or symbol of the service name and a hash of attributes.
+    #
+    #   snitch = Snitch::Base.new('/var/www/apps/myapp/repos', 102)
+    #   snitch.use(:twitter, {:login => 'jnunemaker', :password => 'secret'})
     def use(s, attrs)
       @services << Service.new_from_name(s, attrs)
     end
     
+    # Sends the commit message to all the added services. The following code would tattle the commit message to twitter.
+    #
+    #   snitch = Snitch::Base.new('/var/www/apps/myapp/repos', 102)
+    #   snitch.use(:twitter, {:login => 'jnunemaker', :password => 'secret'})
+    #   snitch.tattle
     def tattle
       long  = commit_message(:long)
       short = commit_message(:short)

data/lib/snitch/config.rb

@@ -3,14 +3,17 @@ module Snitch
     @@snitch_config_path = '/home/deploy/.snitch'
     
     class << self
+      # Returns the path to the config file.
       def config_file_path
         @@snitch_config_path
       end
       
+      # Allows you to change the config file path. 
       def config_file_path=(new_path)
         @@snitch_config_path = new_path
       end
       
+      # Loads the config file. If the file does not exist, it creates it and fills in a blank template that only needs settings.
       def load
         begin
           config = YAML::load(open(@@snitch_config_path)).symbolize_keys!
@@ -20,6 +23,7 @@ module Snitch
         end
       end
       
+      # Creates a config file based on a template.
       def create
         snitch_config_tpl = <<EOF
 # what is the location of svnlook (you can find this on *nix boxes by typing `which svnlook`)

data/lib/snitch/service.rb

@@ -1,4 +1,5 @@
 module Snitch
+  # Service is the base class for all services. All services should inherit from this class.
   class Service
     attr_reader :base, :attributes
     
@@ -10,7 +11,10 @@ module Snitch
       # Don't allow changing the commit message from outside the class
       protected :message_length=
       
-      # Handy for creating a new instance of a service from the config file
+      # Handy for creating a new instance of a service from the config file. Simply pass in the service name and the attributes for the service and you get a new instance of the service.
+      #
+      #   Snitch::Service.new_from_name(:twitter, {:login => 'jnunemaker', :password => 'secret'})
+      #   # => #<Snitch::Services::Twitter:0x15a6508 @attributes={:login=>"jnunemaker", :password=>"secret"}>
       def new_from_name(s, attributes)
         service = "Snitch::Services::#{s.to_s.camelize}".constantize
         service.new(attributes)
@@ -21,6 +25,14 @@ module Snitch
       @attributes = attributes
     end
     
+    # Uses method missing to return the value of a key in the attributes hash.
+    # Allows for doing this...
+    #
+    #   service.login
+    #
+    # instead of this...
+    #
+    #   service.attributes[:login]
     def method_missing(method, *args, &block)
       if method.to_s =~ /=$/
         @attributes[method.to_s.chop] = args[0]

data/lib/snitch/services/campfire.rb

@@ -1,10 +1,13 @@
 require 'tinder'
 module Snitch
   module Services
+    # Allows for using tinder the unnofficial campfire api to paste a commit message into a campfire chatroom.
     class Campfire < Service
       
+      # Sets the prefferred commit message length to <tt>:long</tt>
       self.message_length = :long
       
+      # Logs into campfire and enters the room in the config file.
       def connection(force=false)
         if @campfire.nil? || force
           connection = ::Tinder::Campfire.new(subdomain)
@@ -15,6 +18,7 @@ module Snitch
         @campfire
       end
       
+      # Pastes a given message into a campfire room using the connection method.
       def tattle(message)
         connection.paste(message)
       end

data/lib/snitch/services/twitter.rb

@@ -1,15 +1,19 @@
 require 'twitter'
 module Snitch
   module Services
+    # Allows for using the twitter api to post a commit message update.
     class Twitter < Service
       
+      # Sets the prefferred commit message length to <tt>:short</tt>
       self.message_length = :short
       
+      # Logs into twitter.
       def connection(force=false)
         @twitter = ::Twitter::Base.new(login, password) if @twitter.nil? || force
         @twitter
       end
       
+      # Posts a given message to twitter using the connection method.
       def tattle(message)
         connection.update(message)
       end

data/lib/snitch/svnlook.rb

@@ -1,16 +1,12 @@
 module Snitch
-  # This is a wrapper around the svnlook command line utility. I saw someone
-  # else using it so I did. I haven't looked around for other options but I will
-  # as I'm not a fan of relying on command line stuff.
+  # This is a wrapper around the svnlook command line utility. I saw someone else using it so I did. I haven't looked around for other options but I will as I'm not a fan of relying on command line stuff. 
   #
   #   svnlook = Snitch::SvnLook.new('/var/www/apps/yourapp/repos/', 101)
   #   puts svnlook.author, svnlook.project # etc, etc, etc.
   # 
-  # The svnlook bin file defaults to /usr/bin/svnlook. To override the location
-  # of svnlook, just pass in a third parameter to the new method like so:
+  # The svnlook bin file defaults to /usr/bin/svnlook. To override the location of svnlook, just pass in a third parameter to the new method like so:
   #
   #   svnlook = Snitch::SvnLook.new('/var/www/apps/yourapp/repos/', 101, '/usr/local/bin/svnlook')
-  # 
   class SvnLook
     
     LOG_PREPEND = '\n-{2}'
@@ -25,17 +21,13 @@ module Snitch
     # Creates a few helper methods for looking at the subversion commit
     %w[changed date diff log].each { |m| define_method(m) { look m } }
     
-    # Does an svn look for the author of the commit.
-    # Can't be in the fancy meta programming above because
-    # it needs to get a newline chopped off
+    # Does an svn look for the author of the commit. Can't be in the fancy meta programming above because it needs to get a newline chopped off.
     def author
       look(:author).chop
     end
     
-    # Returns a best guess of the projects name.
-    # Assumes that most will be /some/path/to/cabin/repos/.
-    # Using the aforementioned path, this would return cabin
-    # as the project name.
+    # Returns a best guess of the projects name. Assumes that most will be /some/path/to/cabin/repos/.
+    # Using the aforementioned path, this would return cabin as the project name.
     def project
       @project ||= repository.split('/')[-2]
     end

data/lib/snitch/version.rb

@@ -2,7 +2,7 @@ module Snitch #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: snitch
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 date: 2007-03-25 00:00:00 -04:00
 summary: Makes tattling on your svn commits to other services simple
 require_paths: