mail_to_hip_chat 0.0.1 → 0.1.0

data/README.md

@@ -1,10 +1,10 @@
           _
-         [_|          .             .       .                .                       .  
-     .-----|--,       |-. . ,-. ,-. |-. ,-. |-   ,-,-. ,-. . |    ," . . ,-. ,-. ,-. |  
-    /      | /_\_     | | | | | |   | | ,-| | -- | | | ,-| | | -- |- | | | | | | |-' |  
-    |       |__.-|    ' ' ' |-' `-' ' ' `-^ `'   ' ' ' `-^ ' `'   |  `-^ ' ' ' ' `-' `' 
-    |       |__\_|          |                                     '                     
-    '---,-,-;---'           '
+         [_|                      .    .        .               .       .  
+     .-----|--,       ,-,-. ,-. . |    |- ,-.   |-. . ,-.   ,-. |-. ,-. |- 
+    /      | /_\_     | | | ,-| | |    |  | |   | | | | |   |   | | ,-| |  
+    |       |__.-|    ' ' ' `-^ ' `'---`' `-'---' ' ' |-'---`-' ' ' `-^ `' 
+    |       |__\_|                                    |                    
+    '---,-,-;---'                                     '                    
         | |
         
 # Mail To HipChat
@@ -32,12 +32,14 @@ You will need an account on Heroku and admin access to your HipChat group.
         $ echo 'source "http://rubygems.org"' >> Gemfile
         $ echo 'gem "mail_to_hip_chat"' >> Gemfile
         $ bundle install
-        $ git commit -a -m "Getting down with bundler"
+        $ git add Gemfile Gemfile.lock
+        $ git commit -m "Getting down with bundler"
     
 3. Copy over the default config.ru.
 
         $ cp "`bundle show mail_to_hip_chat`/support/config.ru" .
-        $ git commit -a -m "Adding default config.ru"
+        $ git add config.ru
+        $ git commit -m "Adding default config.ru"
 
 4. Set up a new Heroku application with CloudMailIn and Piggyback SSL.
   
@@ -79,12 +81,27 @@ You will need an account on Heroku and admin access to your HipChat group.
 
 ## Hooking it up to Airbrake
 
-  Just add a new user to your project, set their email address to `CLOUDMAILIN_FORWARD_ADDRESS`, and watch the exceptions roll in. Then turn your face from God and weep in abject horror.
+Just add a new user to your project, set their email address to `CLOUDMAILIN_FORWARD_ADDRESS`, and watch the exceptions roll in. Then turn your face from God and weep in abject horror.
 
 ## Adding new message handlers
 
+See the included Airbrake handler for an example. Really, any object that has a `call` method that takes one argument can be used.
+
 ## FAQ
 
+* Can I use something besides CloudMailIn/Heroku?
+  
+    Most likely, yes. The code has only been tested using CloudMailIn and Heroku, but really, there's not that much tying it to that particular kind of setup, besides the CloudMailIn signature verification stuff in the Rack app.
+    
+* Could I say, feed it email using a `.forward` file?
+
+    Probably. The only part dependent on actually being a web app is the Rack application itself.
+    
+* How do your projects end up with such rad ASCII art?
+
+        $ figlist | xargs -I {} /bin/bash -c "figlet -f {} your_project_name"
+        $ open "http://google.com/search?q=something_related_to_your_project+ascii+art"
+        
 ## TODO
 
 * There are too many steps for initial setup. This needs to be cut down.

data/lib/mail_to_hip_chat/message_chute.rb

@@ -1,15 +1,22 @@
 require "hipchat-api"
 
 module MailToHipChat
+  # Helpers for building a message chute. A message chute is something that responds to #call, and returns true if it's 
+  # able to deliver the message off to HipChat. A chute can be something as simple as a Proc object. The ones this
+  # gem ship with are small classes that make use of this module.
   module MessageChute
-
-    def initialize(opts)
+    
+    # @param  [Hash] opts                   The options to create a message chute with
+    # @option opts   [Array, String] :rooms A room or an array of rooms to send messages to
+    def initialize_hipchat_opts(opts)
       @rooms       = Array(opts[:rooms])
       @hipchat_api = opts[:hipchat_api] || HipChat::API.new(opts[:api_token])
     end
     
   private
     
+    # @param [#to_s] from     The sender the message will show up as being from in HipChat
+    # @param [#to_s] message  The message to send
     def message_rooms(from, message)
       @rooms.each do |room_id| 
         @hipchat_api.rooms_message(room_id, from, message)

data/lib/mail_to_hip_chat/message_chutes/airbrake.rb

@@ -3,9 +3,14 @@ require "mustache"
 
 module MailToHipChat
   module MessageChutes
+    # Takes exception notification emails from Airbrake and sends them to the configured HipChat rooms.
     class Airbrake
       include MessageChute
       
+      def initialize(opts)
+        initialize_hipchat_opts(opts)
+      end
+      
       def call(params)
         return false unless process_message(params["plain"])
         true

data/lib/mail_to_hip_chat/message_chutes/test_email.rb

@@ -3,9 +3,15 @@ require "mustache"
 
 module MailToHipChat
   module MessageChutes
+    # Takes a test email and sends it to the configured HipChat rooms, to verify a deployment based on this library
+    # is working.
     class TestEmail
       include MessageChute
       
+      def initialize(opts)
+        initialize_hipchat_opts(opts)
+      end
+      
       def call(params)
         return false unless params["subject"] =~ /testing setup/i
         message = Mustache.render("Message:<br />{{message}}", :message => params["plain"])

data/lib/mail_to_hip_chat/version.rb

@@ -1,3 +1,3 @@
 module MailToHipChat
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/unit/message_chute_test.rb

@@ -4,7 +4,11 @@ require "mail_to_hip_chat/message_chute"
 class MessageChuteTest < Test::Unit::TestCase
   class TestMessageChute
     include MailToHipChat::MessageChute
-   
+    
+    def initialize(opts)
+      initialize_hipchat_opts(opts)
+    end
+    
     def call(params) 
       message_rooms(params[:sender], params[:message])
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_to_hip_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
-  requirement: &70117439062040 !ruby/object:Gem::Requirement
+  requirement: &70189061461960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70117439062040
+  version_requirements: *70189061461960
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70117439060540 !ruby/object:Gem::Requirement
+  requirement: &70189061461180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70117439060540
+  version_requirements: *70189061461180
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70117439059380 !ruby/object:Gem::Requirement
+  requirement: &70189061460620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70117439059380
+  version_requirements: *70189061460620
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70117439058140 !ruby/object:Gem::Requirement
+  requirement: &70189061459960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70117439058140
+  version_requirements: *70189061459960
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70117439056760 !ruby/object:Gem::Requirement
+  requirement: &70189061459240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *70117439056760
+  version_requirements: *70189061459240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70117439055600 !ruby/object:Gem::Requirement
+  requirement: &70189061458820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70117439055600
+  version_requirements: *70189061458820
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70117439051980 !ruby/object:Gem::Requirement
+  requirement: &70189061458100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70117439051980
+  version_requirements: *70189061458100
 - !ruby/object:Gem::Dependency
   name: hipchat-api
-  requirement: &70117439050780 !ruby/object:Gem::Requirement
+  requirement: &70189061457340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70117439050780
+  version_requirements: *70189061457340
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70117439049500 !ruby/object:Gem::Requirement
+  requirement: &70189061456700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: '0.99'
   type: :runtime
   prerelease: false
-  version_requirements: *70117439049500
+  version_requirements: *70189061456700
 description: Funnels email into HipChat using CloudMailIn
 email:
 - gabriel@gironda.org
@@ -158,12 +158,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -429079503967121235
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -429079503967121235
 requirements: []
 rubyforge_project: mail_to_hip_chat
 rubygems_version: 1.8.10