RubyGems - mattmatt-cijoe - Versions diffs - 0.1.2 - Mend

mattmatt-cijoe 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/.gitignore +2 -0
data/LICENSE +20 -0
data/README.markdown +147 -0
data/Rakefile +25 -0
data/VERSION +1 -0
data/bin/cijoe +49 -0
data/deps.rip +5 -0
data/examples/cijoe.ru +15 -0
data/examples/cijoed +53 -0
data/lib/cijoe.rb +180 -0
data/lib/cijoe/build.rb +49 -0
data/lib/cijoe/commit.rb +27 -0
data/lib/cijoe/config.rb +24 -0
data/lib/cijoe/email.rb +62 -0
data/lib/cijoe/public/octocat.png +0 -0
data/lib/cijoe/public/screen.css +212 -0
data/lib/cijoe/server.rb +77 -0
data/lib/cijoe/version.rb +3 -0
data/lib/cijoe/views/template.erb +64 -0
data/lib/mmmail.rb +286 -0
data/spec/email_spec.rb +60 -0
metadata +105 -0

data/lib/cijoe/version.rb ADDED

@@ -0,0 +1,3 @@
+class CIJoe
+  Version = "0.1.2"
+end

data/lib/cijoe/views/template.erb ADDED

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link href="<%= cijoe_root %>/screen.css" media="screen" rel="stylesheet" type="text/css" />
+    <title><%= h(joe.project) %>: CI Joe</title>
+  </head>
+  <body>
+    <div class="site">
+      <div class="title">
+        <a href="<%= cijoe_root %>/">CI Joe</a>
+        <span class="extra">because knowing is half the battle</span>
+      </div>
+      <div id="home">
+        <h1><a href="<%= joe.url %>"><%= joe.project %></a></h1>
+        <ul class="posts">
+          <% if joe.current_build %>
+            <li>
+              <span class="date"><%= pretty_time(joe.current_build.started_at) if joe.current_build %></span> &raquo;
+              <% if joe.current_build.sha %>
+                Building <a href="<%= joe.url %>/commits/<%= joe.current_build.sha %>"><%= joe.current_build.short_sha %></a> <small>(pid: <%= joe.pid %>)</small>
+              <% else %>
+                Build starting...
+              <% end %>
+            </li>
+          <% else %>
+            <li><form method="POST"><input type="submit" value="Build"/></form></li>
+          <% end %>
+          <% if joe.last_build %>
+            <li><span class="date"><%= pretty_time(joe.last_build.finished_at) %></span> &raquo; Built <a href="<%= joe.url %>/commits/<%= joe.last_build.sha %>"><%= joe.last_build.short_sha %></a> <span class="<%= joe.last_build.status %>">(<%= joe.last_build.status %>)</span></li>
+            <% if joe.last_build.failed? %>
+              <li><pre class="terminal"><code><%=ansi_color_codes h(joe.last_build.output) %></code></pre></li>
+            <% end %>
+          <% end %>
+        </ul>
+      </div>
+      <div class="footer">
+        <div class="contact">
+          <p>
+            <a href="http://github.com/defunkt/cijoe/tree/master#readme">Documentation</a><br/>
+            <a href="http://github.com/defunkt/cijoe">Source</a><br/>
+            <a href="http://github.com/defunkt/cijoe/issues">Issues</a><br/>
+            <a href="http://twitter.com/defunkt">Twitter</a>
+          </p>
+        </div>
+        <div class="contact">
+          <p>
+            Designed by <a href="http://tom.preston-werner.com/">Tom Preston-Werner</a><br/>
+            Influenced by <a href="http://integrityapp.com/">Integrity</a><br/>
+            Built with <a href="http://sinatrarb.com/">Sinatra</a><br/>
+            Keep it simple, Sam.
+          </p>
+        </div>
+        <div class="rss">
+          <a href="http://github.com/defunkt/cijoe">
+            <img src="<%= cijoe_root %>/octocat.png" alt="Octocat!" />
+          </a>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/mmmail.rb ADDED

@@ -0,0 +1,286 @@
+# this was taken from
+# http://github.com/lsegal/mmmail/
+require 'net/smtp'
+module MmMail
+  # General exception class when something goes wrong in MmMail
+  class TransportError < Exception; end
+  # Handles the transportation of a {Message} to its destination.
+  # Basic support for SMTP (through +Net::SMTP+) or +sendmail+.
+  #
+  # You can either pass a new {Transport::Config} object during transport or use
+  # the system wide {Transport::DefaultConfig} object.
+  #
+  # @example [To set transport to use sendmail]
+  #   MmMail::Transport::DefaultConfig.method = :sendmail
+  #   # Note you might need to point to sendmail if it's not in your PATH:
+  #   MmMail::Transport::DefaultConfig.sendmail_binary = '/path/to/sendmail'
+  #
+  # @example [To connect to your ISP SMTP server on 587]
+  #   MmMail::Transport::DefaultConfig.host = 'smtp.myisp.com'
+  #   MmMail::Transport::DefaultConfig.port = 587
+  #
+  # @see Transport::Config
+  # @see Transport::mail
+  class Transport
+    # Configuration class for a {Transport}
+    class Config
+      # Set/get the SMTP host/port information
+      attr_accessor :host, :port
+      # Set/get the authentication type (nil for none, :plain, :login or :cram_md5)
+      attr_accessor :auth_type
+      # Set/get the AUTH user/password when using SMTP transport.
+      attr_accessor :auth_user, :auth_pass
+      # Set/get the email method. Allowed values are +:smtp+ or +:sendmail+.
+      attr_accessor :method
+      # Set/get the location of the sendmail binary on the system
+      attr_accessor :sendmail_binary
+      # Creates a new Config object set to send via SMTP on
+      # localhost:25 with no authentication.
+      def initialize
+        @method = :smtp # :sendmail
+        @host = 'localhost'
+        @port = 25
+        @auth_type = nil # :plain, :login, :cram_md5
+        @auth_user = nil
+        @auth_pass = nil
+        @sendmail_binary = 'sendmail'
+      end
+    end
+    # The default system wide configuration used when no custom config
+    # object is provided to a Transport object. If you want to make global
+    # configuration changes, change the settings here.
+    DefaultConfig = Config.new
+    # Creates a new {Transport} object and sends an email.
+    #
+    # @see #mail
+    def self.mail(message, config = nil)
+      new(config).mail(message)
+    end
+    # Sets a {Config} object to use when sending mail
+    attr_accessor :config
+    # Creates a new Transport object to send emails with. To change
+    # settings to sendmail or use SMTP auth, set these in the {Config}
+    # object.
+    #
+    # @param [Config] a configuration to use
+    # @raise [ArgumentError] if config is not a {Config} object.
+    def initialize(config = nil)
+      if config && !config.is_a?(Config)
+        raise ArgumentError, "expected #{self.class}::Config"
+      end
+      @config = config || DefaultConfig
+    end
+    # Sends a {Message} object out as an email using the configuration
+    # set during initialization.
+    #
+    # @param [Message] message an email to send
+    # @raise [ArgumentError] if message is not a {Message} object
+    # @raise [TransportError] if message is not {Message#valid? valid}.
+    def mail(message)
+      unless Message === message
+        raise ArgumentError, "expected MmMail::Message, got #{message.class}"
+      end
+      raise TransportError, "invalid message" unless message.valid?
+      send("mail_#{config.method}", message)
+    end
+    # Sends a mail through Net::SMTP using the {#config} if
+    # any SMTP or hostname information is set.
+    #
+    # @param [#to_s] message the message to send
+    def mail_smtp(message)
+      Net::SMTP.start(config.host, config.port, 'localhost.localdomain',
+          config.auth_user, config.auth_pass, config.auth_type) do |smtp|
+        smtp.send_message(message.to_s, message.from, message.recipients_list)
+      end
+    end
+    # Sends a mail through sendmail using the {Config#sendmail_binary} as the
+    # location of the file.
+    #
+    # @param [#to_s] message the message to send
+    # @raise [TransportError] if a problem during execution occured
+    def mail_sendmail(message)
+      bin, err = config.sendmail_binary, ''
+      result = IO.popen("#{bin} -t 2>&1", "w+") do |io|
+        io.write(message.to_s)
+        io.close_write
+        err = io.read.chomp
+      end
+      raise TransportError, err if $? != 0
+    end
+  end
+  # A Message object representing an Email to be passed to a {Transport}.
+  class Message
+    # Creates a new message with associated fields.
+    #
+    # @example
+    #   MmMail::Message.new(:to => 'test@example.com', :body => 'hi')
+    #
+    # @param [Hash] opts the options to create a message with.
+    # @option opts [String] :from ('nobody@localhost') The email's From field
+    # @option opts [String] :subject ('') The email's Subject field
+    # @option opts [String] :body ('') The email's body (not a header)
+    # @option opts [String] :to (nil) The email's To field. List multiple recipients as
+    #   'a@b.c, b@c.d', not an array.
+    def initialize(opts = {})
+      defaults = {
+        :from => 'nobody@localhost',
+        :subject => '',
+        :body => ''
+      }
+      @headers = defaults.merge(opts)
+    end
+    # Allow access of fields by header name or symbolic representation
+    #
+    # @example
+    #   m[:x_message_id] = '1234'
+    #   m['X-Message-Id'] == '1234' # => true
+    #
+    # @param [String, Symbol] k the header or symbolic header value to lookup.
+    # @return [String] the value associated with the field
+    def [](k)     @headers[translate_header_to_sym(k)]     end
+    # Allow access of fields by header name or symbolic representation
+    #
+    # @example
+    #   m[:x_message_id] = '1234'
+    #   m['X-Message-Id'] == '1234' # => true
+    #
+    def []=(k, v) @headers[translate_header_to_sym(k)] = v end
+    # Override this method to allow any call to obj.meth or obj.meth= to
+    # set a header field on this object.
+    #
+    # @example [To set the field 'X-Message-Id']
+    #   m.x_message_id = '1234'
+    #   m.x_message_id == '1234' # => true
+    #
+    def method_missing(sym, *args)
+      if sym.to_s =~ /=$/
+        self[sym.to_s[0..-2].to_sym] = args.first
+      elsif @headers.has_key?(sym)
+        self[sym]
+      else
+        super
+      end
+    end
+    # Override this method to verify if a field has been set.
+    #
+    # @return [Boolean] whether the field was set (or if a regular method
+    #   is callable.)
+    def respond_to?(sym)
+      return true if super
+      @headers.has_key?(sym)
+    end
+    # Returns the message in its full form as expected by an SMTP server.
+    #
+    # @return [String] the email with headers followed by a body
+    def to_s
+      [headers, body].join("\n")
+    end
+    # Returns all the recipients in the To field.
+    #
+    # @example
+    #   m.to = 'a@b.c, b@c.d'
+    #   m.recipients_list # => ['a@b.c', 'b@c.d']
+    #
+    # @return [Array<String>] the emails in the To field of the message.
+    def recipients_list
+      to.split(/\s*,\s*/)
+    end
+    # Checks if the message is valid. Validity is based on
+    # having the From, To and Subject fields set. From and To
+    # must not be empty.
+    #
+    # @return [Boolean] whether or not the message is a valid e-mail
+    def valid?
+      [:from, :to].each do |field|
+        return false if !self[field] || self[field].empty?
+      end
+      self[:subject] ? true : false
+    end
+    private
+    # Returns the headers as the RFC822 string.
+    #
+    # @return [String] the headers in RFC822 format
+    def headers
+      @headers.reject {|k, v| k == :body }.map do |k, v|
+        translate_header_name(k) + ': ' + v + "\n"
+      end.join
+    end
+    # Translates a header from its symbolic representation to its
+    # RFC822 header name or the other way around. If you give in
+    # a header name (String) you will get a Symbol, and a Symbol
+    # if you give a String.
+    #
+    # @example
+    #   msg.translate_header_name(:x_message_id) # => 'X-Message-Id'
+    #   msg.translate_header_name('Content-Type') # => :content_type
+    #
+    # @param [String,Symbol] key the header name to translate
+    # @return [Symbol,String] the symbolic or header representation of
+    #   the symbol or header name.
+    # @raise [ArgumentError] if key is neither a String or Symbol
+    def translate_header_name(key)
+      case key
+      when String
+        key.downcase.tr('-', '_').to_sym
+      when Symbol
+        key.to_s.capitalize.gsub(/_(.)/) {|m| '-' + m[1].upcase }
+      else
+        raise ArgumentError, "invalid key type #{key.class}"
+      end
+    end
+    # Translates a header one-way to the symbolic representation.
+    #
+    # @param [String, Symbol] key any header or symbolic key
+    # @return [Symbol] the symbolic representation of the header name
+    # @see #translate_header_name
+    def translate_header_to_sym(key)
+      return key if Symbol === key
+      translate_header_name(key)
+    end
+  end
+  # Quickly send out an email.
+  #
+  # @example
+  #   MmMail.mail(:to => 'me@gmail.com', :body => 'hi!')
+  #
+  # @param [Hash] opts the hash used to construct the message
+  # @param [Transport::Config, nil] config the configuration object to use
+  #   during transport
+  # @see Transport#mail
+  def self.mail(opts = {}, config = nil)
+    Transport.mail(Message.new(opts), config)
+  end
+end

data/spec/email_spec.rb ADDED

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../lib/cijoe'
+require 'ostruct'
+describe CIJoe::Email do
+  describe "activate" do
+    it "should include Email into the Build class if the config is valid" do
+      CIJoe::Config.stub!(:email => stub(:to => 'build@housetrip.com', :user => 'joe', :pass => 'passwd', :host => 'mail.example.com'))
+      CIJoe::Email.activate
+      CIJoe::Build.ancestors.should include(CIJoe::Email)
+    end
+    it "should not include Email into the Build class if the config is not valid" do
+      CIJoe::Email.activate
+      CIJoe::Build.ancestors.should_not include(CIJoe::Email)
+    end
+  end
+  describe "notify" do
+    class TestBuild
+      include CIJoe::Email
+      def initialize(worked)
+        @worked = worked
+      end
+      def worked?
+        @worked
+      end
+      def failed?
+        !@worked
+      end
+      def commit
+        OpenStruct.new(:url => "github.com/commit/bha75as")
+      end
+    end
+    CIJoe::Config.class_eval do
+      def self.email
+        OpenStruct.new(
+          :to => 'build@housetrip.com'
+        )
+      end
+    end
+    it "should send an email if the build failed" do
+      MmMail.should_receive(:send).with(:to => 'build@housetrip.com', :from => 'build@housetrip.com', :subject => 'Build failed', :body => 'The commit github.com/commit/bha75as caused the build to fail.')
+      TestBuild.new(false).notify
+    end
+    it "should send no email if the build succeeded" do
+      MmMail.should_not_receive(:send)
+      TestBuild.new(true).notify
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mattmatt-cijoe
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Chris Wanstrath
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-12-22 00:00:00 +01:00
+default_executable: cijoe
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: choice
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: open4
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: CI Joe is a simple Continuous Integration server.
+email: chris@ozmm.org
+executables:
+- cijoe
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/cijoe
+- deps.rip
+- examples/cijoe.ru
+- examples/cijoed
+- lib/cijoe.rb
+- lib/cijoe/build.rb
+- lib/cijoe/commit.rb
+- lib/cijoe/config.rb
+- lib/cijoe/email.rb
+- lib/cijoe/public/octocat.png
+- lib/cijoe/public/screen.css
+- lib/cijoe/server.rb
+- lib/cijoe/version.rb
+- lib/cijoe/views/template.erb
+- lib/mmmail.rb
+- spec/email_spec.rb
+has_rdoc: true
+homepage: http://github.com/defunkt/cijoe
+licenses: []
+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:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: CI Joe is a simple Continuous Integration server.
+test_files:
+- spec/email_spec.rb