snitch 0.1.3 → 0.1.4

data/CHANGELOG.txt

@@ -1,9 +1,8 @@
-0.1.2 - 10/10/2007
+0.1.4 - 12/12/2007
+			* added email service (patch from Nolan Eakins)
+0.1.3 & 0.1.2 - 10/10/2007
 			* corrected dependencies
-			* TODO: make generator for config and post-commit files, allow optional passing of project name to snitch
-			
 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/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 John Nunemaker
+
+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/Manifest.txt

@@ -0,0 +1,31 @@
+CHANGELOG.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+bin/snitch
+lib/snitch.rb
+lib/snitch/base.rb
+lib/snitch/config.rb
+lib/snitch/exceptions.rb
+lib/snitch/patches/hash.rb
+lib/snitch/patches/tinder.rb
+lib/snitch/service.rb
+lib/snitch/services/campfire.rb
+lib/snitch/services/email.rb
+lib/snitch/services/twitter.rb
+lib/snitch/svnlook.rb
+lib/snitch/version.rb
+setup.rb
+test/test_helper.rb
+test/unit/base_test.rb
+test/unit/service_test.rb
+test/unit/services/campfire_test.rb
+test/unit/services/email_test.rb
+test/unit/services/twitter_test.rb
+test/unit/svnlook_test.rb
+website/css/common.css
+website/images/campfire.gif
+website/images/twitter.gif
+website/index.html

data/Rakefile

@@ -49,7 +49,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   #p.changes        - A description of the release's latest changes.
-  p.extra_deps = [['twitter', '0.2.0'], ['tinder', '0.1.4'], ['activesupport', '1.4.2']]
+  p.extra_deps = ['twitter', 'tinder', 'activesupport', 'tmail']
   #p.spec_extras    - A hash of extra values to set in the gemspec.
 end
 
@@ -75,4 +75,4 @@ task :check_version do
     puts "Please update your version.rb to match the release version, currently #{VERS}"
     exit
   end
-end
+end

data/TODO.txt

@@ -0,0 +1 @@
+* make generator for config and post-commit files, allow optional passing of project name to snitch

data/lib/snitch.rb

@@ -9,6 +9,7 @@ require 'snitch/patches/hash'
 require 'snitch/patches/tinder'
 require 'snitch/service'
 require 'snitch/services/campfire'
+require 'snitch/services/email'
 require 'snitch/services/twitter'
 require 'snitch/svnlook'
-require 'snitch/version'
+require 'snitch/version'

data/lib/snitch/config.rb

@@ -39,9 +39,21 @@ services:
   :twitter:
     :login: 
     :password: 
+  :email:
+   # You mail server settings:
+    :host:
+    :server: localhost
+    :port: 25
+   # Your login creds:
+    :login:
+    :password:
+    :method: :login
+   # Our email addresses:
+    :from: Snitch <root@localhost>
+    :to:
 EOF
         File.open(config_file_path, 'w') { |f| f.write snitch_config_tpl } unless File.exists?(config_file_path)
       end
     end
   end
-end
+end

data/lib/snitch/services/email.rb

@@ -0,0 +1,48 @@
+require 'snitch/service'
+require 'tmail'
+require 'net/smtp'
+
+module Snitch
+  module Services
+    class Email < Service
+      
+      # Sets the prefferred commit message length to <tt>:long</tt>
+      self.message_length = :long
+
+      def initialize(*args)
+        super(*args)
+      end
+      
+      # Sends the email
+      def tattle(message)
+        send_email(create_email(message))
+      end
+
+      def send_email(email)
+        email_opts = %W(server port host login password auth_method).collect { |attr| lookup(attr) }
+
+        Net::SMTP.start(*email_opts) do |smtp|
+          smtp.send_message(email.to_s, from, to)
+        end
+      end
+      
+      def create_email(message)
+        mail = TMail::Mail.new
+        mail.to = to
+        mail.from = from
+        mail.subject = message[0, message.index("\n") || message.length]
+        mail.date = Time.now
+        mail.set_content_type 'text', 'plain'
+        mail.body = message
+        mail
+      end
+
+      def lookup(var)
+        self.send(var)
+      rescue NameError
+        nil
+      end
+
+    end
+  end
+end

data/lib/snitch/svnlook.rb

@@ -26,10 +26,12 @@ module Snitch
       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/ or /some/path/to/cabin. Will grab the last 
+    # two folders in the path and remove any that are equal to "repos".
     def project
-      @project ||= repository.split('/')[-2]
+      # @project ||= repository.split('/')[-2]
+      @project ||= repository.split('/')[-2, 2].detect { |a| a != 'repos' }
     end
     
     # Returns the message entered with the committed revision

data/lib/snitch/version.rb

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

data/test/unit/services/email_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class EmailTest < Test::Unit::TestCase
+  def setup
+    @config = CONFIG[:services][:email]
+    @service = Snitch::Services::Email.new(@config)
+  end
+  
+  test 'should have attributes' do
+    assert_equal @config, @service.attributes
+  end
+  
+  test "should make the email's body the commit message"
+  
+  test "should set the To field to what's in the config"
+  
+  test "should set the From field with what's in the config"
+  
+  test "should connect to the server in the config"
+  
+  test "should connect on the port in the config"
+  
+  test "should login using the login and password config options"
+  
+  test "should use the authentication method from the config"
+  
+  test "should use the host from the config as the mail server's name"
+  
+  test "should tattle by sending the email"
+  
+end

data/website/css/common.css

@@ -0,0 +1,47 @@
+@media screen, projection {
+	/*
+	Copyright (c) 2007, Yahoo! Inc. All rights reserved.
+	Code licensed under the BSD License:
+	http://developer.yahoo.net/yui/license.txt
+	version: 2.2.0
+	*/
+	body {font:13px arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}select, input, textarea {font:99% arial,helvetica,clean,sans-serif;}pre, code {font:115% monospace;*font-size:100%;}body * {line-height:1.22em;}
+	body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}/*ol,ul {list-style:none;}*/caption,th {text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;}
+	/* end of yahoo reset and fonts */
+	
+	body 										{color:#333; background:#4b1a1a; line-height:1.3;}
+	p												{margin:0 0 20px;}
+	a												{color:#4b1a1a;}
+	a:hover									{text-decoration:none;}
+	strong									{font-weight:bold;}
+	em											{font-style:italics;}
+	h1,h2,h3,h4,h5,h6				{font-weight:bold;}
+	h1											{font-size:197%; margin:30px 0; color:#4b1a1a;}
+	h2											{font-size:174%; margin:20px 0; color:#b8111a;}
+	h3											{font-size:152%; margin:10px 0;}
+	h4											{font-size:129%; margin:10px 0;}
+	pre 										{background:#eee; padding:20px; border:1px solid #ccc; font-size:100%; overflow:auto;}
+	code										{font-size:100%; margin:0; padding:0;}
+	ul, ol									{margin:10px 0 10px 25px;}
+	ol li										{margin:0 0 10px;}
+
+
+
+
+
+	div#wrapper 							{background:#fff; width:560px; margin:0 auto; padding:20px; border:10px solid #bc8c46; border-width:0 10px;}
+	div#header								{position:relative; border-bottom:1px dotted; margin:0 0 10px; padding:0 0 10px;}
+	div#header p							{margin:0; padding:0;}
+	div#header h1							{margin:0; padding:0;}
+	ul#nav										{position:absolute; top:0; right:0; list-style:none; margin:0; padding:0;}
+	ul#nav li									{display:inline; padding:0 0 0 5px;}
+	ul#nav li a								{}
+	div#content								{}
+	div#footer								{margin:40px 0 0; border-top:1px dotted; padding:10px 0 0;}
+
+
+
+
+
+
+}

data/website/index.html

@@ -0,0 +1,87 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title>Snitch by John Nunemaker</title>
+	<link rel="stylesheet" href="css/common.css" type="text/css" />
+</head>
+<body>
+
+<div id="wrapper">
+	<div id="header">
+		<h1>Snitch</h1>
+		<p>Drop dead easy subversion commit notifications.</p>
+		
+		<ul id="nav">
+			<li><a href="snitch/">Docs</a></li>
+			<li><a href="http://rubyforge.org/projects/snitch/">Rubyforge Page</a></li>
+		</ul>
+	</div>
+	
+	<div id="content">
+		<p>Snitch is an subversion post-commit service integration helper. I just made that up. Subversion has a post-commit hook which is executed each time you commit a change to a repository. Snitch makes it really easy to hook into the post-commit and send the commit message along with the files changed to various services on the web. </p>
+
+		<p>Currently, snitch works with <a href="http://campfirenow.com">campfire</a> and <a href="http://twitter.com">twitter</a>. I'll be adding in SMS, email, some day but feel free to do it yourself and send me a patch.</p>
+		
+		<h2>Screenshots</h2>
+		<h3>Campfire</h3>
+		<p><img src="images/campfire.gif" alt="Campfire Snitch Screenshot" /></p>
+		<h3>Twitter</h3>
+		<p><img src="images/twitter.gif" alt="Twitter Snitch Screenshot" /></p>
+		
+		<h2>Installation</h2>
+
+		<ol>
+			<li>sudo gem install hpricot</li>
+			<li>sudo gem install twitter tinder snitch</li>
+			<li>
+				<p>Create a configuration file (default is /home/deploy/.snitch) that looks like the following (be sure to fill in all the values). Be sure that none of the tabs from below get stay in the config file. It gets parse by yaml so formatting is important.</p>
+
+		<pre><code># what is the location of svnlook 
+# you can find this on *nix boxes by typing: which svnlook
+svnlook: /usr/bin/svnlook
+
+# what services would you like to send commit messages to?
+services:
+  :campfire:
+    :subdomain: 
+    :login: 
+    :password: 
+    :room: Development
+  :twitter:
+    :login: 
+    :password: </code></pre>
+			</li>
+			<li>
+				<p>Create or edit the post-commit file inside your repository to look like the following. Be sure to edit the CONFIG_FILE variable to wherever you created your config file in step 3.</p>
+
+		<pre><code>#!/bin/sh
+REPOS="$1"
+REV="$2"
+CONFIG_FILE="/home/deploy/.snitch"
+
+snitch $REPOS $REV $CONFIG_FILE 2> /tmp/snitch</code></pre>
+			</li>
+		</ol>
+		
+		<h2>Support</h2>
+		<p>Please leave all support requests and suggestions at the <a href="http://groups.google.com/group/ruby-snitch-gem">google group</a>.</p>
+	</div>
+
+	<div id="footer">
+		<p>Created by <a href="http://addictedtonew.com/about/">John Nunemaker</a> (with ideas from <a href="http://90percentgravity.com">Bill Harle</a> and <a href="http://grundyhome.com">Chas Grundy</a>)</a></p>
+	</div>
+
+</div>
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript">
+	_uacct = "UA-85301-8";
+	urchinTracker();
+</script>
+
+<!-- 103bees.com 'bee' code v1.11 - please do not make any changes! -->
+<script type="text/javascript" src="http://103bees.com/bees/?bee=3672&amp;fid=5537"></script>
+<!-- 103bees.com 'bee' code -->
+</body>
+</html>

metadata

@@ -1,38 +1,72 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: snitch
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2007-10-23 00:00:00 -04:00
-summary: Makes tattling on your svn commits to other services simple
-require_paths: 
-- lib
-email: nunemaker@gmail.com
-homepage: http://snitch.rubyforge.org
-rubyforge_project: snitch
-description: Makes tattling on your svn commits to other services simple
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
+  version: 0.1.4
+platform: ""
 authors: 
 - John Nunemaker
-files: 
-- Rakefile
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tinder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Makes tattling on your svn commits to other services simple
+email: nunemaker@gmail.com
+executables: 
+- snitch
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.txt
+- Manifest.txt
 - README.txt
+- TODO.txt
+files: 
 - CHANGELOG.txt
-- setup.rb
+- MIT-LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO.txt
+- bin/snitch
 - lib/snitch.rb
 - lib/snitch/base.rb
 - lib/snitch/config.rb
@@ -41,59 +75,53 @@ files:
 - lib/snitch/patches/tinder.rb
 - lib/snitch/service.rb
 - lib/snitch/services/campfire.rb
+- lib/snitch/services/email.rb
 - lib/snitch/services/twitter.rb
 - lib/snitch/svnlook.rb
 - lib/snitch/version.rb
+- setup.rb
 - test/test_helper.rb
 - test/unit/base_test.rb
 - test/unit/service_test.rb
 - test/unit/services/campfire_test.rb
+- test/unit/services/email_test.rb
 - test/unit/services/twitter_test.rb
 - test/unit/svnlook_test.rb
-- bin/snitch
+- website/css/common.css
+- website/images/campfire.gif
+- website/images/twitter.gif
+- website/index.html
+has_rdoc: true
+homepage: http://snitch.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: snitch
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Makes tattling on your svn commits to other services simple
 test_files: 
 - test/unit/base_test.rb
 - test/unit/service_test.rb
 - test/unit/services/campfire_test.rb
+- test/unit/services/email_test.rb
 - test/unit/services/twitter_test.rb
 - test/unit/svnlook_test.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- README.txt
-- CHANGELOG.txt
-executables: 
-- snitch
-extensions: []
-
-requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: twitter
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.2.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: tinder
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.1.4
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 1.4.2
-    version: