robut 0.4.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 216b7b1619326105ea953215d118ff0de9c123c8
+  data.tar.gz: 165a69435303dcee8ff52120603ab8ad5fab470c
+SHA512:
+  metadata.gz: bf580beaab936d1bf28439a988346f75dee589ff026d824a14abe00ddc59ecf9476b1c940dabd50fa1fed935ce58574aecf77b94a0ff41fd2e5ecb0bbb820bde
+  data.tar.gz: 76a4ac19315db0820c5cc69679888c38bfcef0e892b692b6c04016c9750477a3003874906fdcef5dea16ca937688d1de9d52ba85258713fe5ca2e56bbea6d4a1

data/.gitignore

@@ -1,6 +1,5 @@
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
 doc/*
 coverage/*

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
   # - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0
   # - jruby-18mode # JRuby in 1.8 mode
   # - jruby-19mode # JRuby in 1.9 mode
   # - rbx-18mode

data/Gemfile

@@ -9,6 +9,7 @@ group :test do
   gem 'webmock'
   gem 'time-warp'
   gem 'mocha'
+  gem 'rack-test'
 end
 
 group :plugin do

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    robut (0.5.0)
+      sinatra (~> 1.3)
+      xmpp4r (~> 0.5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    calc (1.0.0)
+    classifier (1.3.1)
+      stemmer (>= 1.0.0)
+    crack (0.1.8)
+    meme_generator (1.9)
+      nokogiri (~> 1.4)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.4.4)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    stemmer (1.0.1)
+    tilt (1.4.1)
+    time-warp (1.0.8)
+    twss (0.0.5)
+      classifier (= 1.3.1)
+    webmock (1.6.4)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+    xmpp4r (0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  calc
+  meme_generator
+  mocha
+  nokogiri
+  rack-test
+  rake
+  robut!
+  simplecov
+  time-warp
+  twss
+  webmock

data/README.rdoc

@@ -2,16 +2,6 @@
 
 The friendly plugin-enabled HipChat bot.
 
-== NOTE: Breaking backwards compatibility!
-
-A little while ago, HipChat changed the way their mention names
-work. Instead of just using the first name ('@robut'), they now use
-the full name ('@RobutTRobot'). Starting from v0.4.0, robut uses this
-new format by default. If you prefer the old style, you can set it in
-your Chatfile:
-
-  config.mention_name = 'robut'
-
 == Installation and usage
 
 Robut can be installed by running <tt>gem install robut</tt>. This
@@ -49,6 +39,13 @@ first parameter:
 
 The Chatfile is just ruby code. A simple example can be found here: Chatfile[https://github.com/justinweiss/robut/blob/master/examples/Chatfile]
 
+== Robut::Web
+
+You can run Robut as a rack application, which allows it to accept
+incoming post requests (e.g. Heroku deploy hooks, GitHub post-recieve hooks, etc.)
+that can send messages to all connected rooms. Have a look at
+config.ru[https://github.com/justinweiss/robut/blob/master/examples/config.ru] for an example.
+
 === Adding and configuring plugins
 
 Plugins are ruby classes, so enabling a plugin just requires requiring

data/Rakefile

@@ -1,5 +1,5 @@
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/bin/robut

@@ -7,3 +7,4 @@ require 'logger'
 load ARGV[0] || './Chatfile'
 
 Robut::Connection.new.connect
+loop { sleep 1 }

data/examples/config.ru

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require :default
+
+require 'robut'
+require 'ostruct'
+require 'logger'
+
+load './Chatfile'
+
+Robut::Web.set :connection, Robut::Connection.new.connect
+
+run Robut::Web

data/lib/robut.rb

@@ -5,4 +5,5 @@ module Robut
   autoload :PM, 'robut/pm'
   autoload :Connection, 'robut/connection'
   autoload :Storage, 'robut/storage'
+  autoload :Web, 'robut/web'
 end

data/lib/robut/connection.rb

@@ -85,14 +85,21 @@ class Robut::Connection
     self.roster = Jabber::Roster::Helper.new(client)
     roster.wait_for_roster
 
-    rooms = self.config.rooms.collect do |room_name|
+    self.rooms = self.config.rooms.collect do |room_name|
       Robut::Room.new(self, room_name).tap {|r| r.join }
     end
 
     personal_message = Robut::PM.new(self, rooms)
 
     trap_signals
-    loop { sleep 1 }
+    self
+  end
+
+  # Send a message to all rooms.
+  def reply(*args, &block)
+    self.rooms.each do |room|
+      room.reply(*args, &block)
+    end
   end
 
 private
@@ -111,4 +118,4 @@ private
       old_signal_callbacks[sig] = trap(sig) { signal_callback.call(sig) }
     end
   end
-end
+end

data/lib/robut/plugin.rb

@@ -40,6 +40,25 @@ module Robut::Plugin
     def matchers
       @matchers ||= []
     end
+
+    # Allows you to define http methods that this plugin should respond to.
+    # This is useful if you're want to accept generic post data for Robut to
+    # display in all rooms (e.g. Heroku deploy hooks, GitHub post receive
+    # hooks, etc).
+    #
+    #     http do
+    #       post '/heroku' do
+    #         payload = Hashie::Mash.new(params)
+    #         say "#{payload.user} deployed #{payload.head} to #{payload.app}", nil
+    #         halt 200
+    #       end
+    #     end
+    #
+    # The action is run in the context of a Sinatra app (+Robut::Web+). So
+    # anything that Sinatra provides is available within the block.
+    def http(&block)
+      Robut::Web.class_eval &block
+    end
   end
 
   class << self

data/lib/robut/version.rb

@@ -1,4 +1,4 @@
 module Robut # :nodoc:
   # Robut's version number.
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/robut/web.rb

@@ -0,0 +1,26 @@
+require 'sinatra/base'
+
+module Robut
+  class Web < Sinatra::Base
+    helpers do
+      # Say something to all connected rooms. Delegates to #reply
+      def say(*args)
+        reply(*args)
+      end
+
+      # Easy access to the current connection context.
+      def connection
+        settings.connection
+      end
+
+      # Delegates to Connection#reply
+      def reply(*args)
+        connection.reply(*args)
+      end
+    end
+
+    get '/' do
+      'ok'
+    end
+  end
+end

data/robut.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "xmpp4r", "~> 0.5.0"
+  s.add_dependency "sinatra", "~> 1.3"
 end

data/test/mocks/connection_mock.rb

@@ -2,9 +2,21 @@ require 'robut/storage/hash_store'
 
 class Robut::ConnectionMock < Robut::Connection
 
+  attr_accessor :messages
+
   def initialize(config = nil)
+    self.messages = []
     self.config = config || self.class.config
     self.store  = Robut::Storage::HashStore
     self.client = Jabber::Client.new ''
   end
+
+  def connect
+    self.rooms = []
+    self
+  end
+
+  def reply(message, to)
+    self.messages << [message, to]
+  end
 end

data/test/unit/web_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'rack/test'
+
+class WebTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Robut::Web
+  end
+
+  def setup
+    app.set :show_exceptions, false
+    app.set :raise_errors, true
+    app.set :connection, connection
+  end
+
+  def test_root
+    get '/'
+
+    assert last_response.ok?
+  end
+
+  def test_say
+    app.class_eval do
+      get '/test_say' do
+        say "Hello", nil
+        halt 200
+      end
+    end
+
+    get '/test_say'
+
+    assert_equal messages.first, ["Hello", nil]
+  end
+
+private
+
+  def messages
+    connection.messages
+  end
+
+  def connection
+    @connection ||= Robut::ConnectionMock.new.connect
+  end
+
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: robut
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Weiss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xmpp4r
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,11 +20,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: A simple plugin-enabled HipChat bot
 email:
 - justin@uberweiss.org
@@ -38,10 +49,12 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - README.rdoc
 - Rakefile
 - bin/robut
 - examples/Chatfile
+- examples/config.ru
 - lib/rexml_patches.rb
 - lib/robut.rb
 - lib/robut/connection.rb
@@ -70,6 +83,7 @@ files:
 - lib/robut/storage/hash_store.rb
 - lib/robut/storage/yaml_store.rb
 - lib/robut/version.rb
+- lib/robut/web.rb
 - robut.gemspec
 - test/fixtures/bad_location.xml
 - test/fixtures/las_vegas.xml
@@ -95,35 +109,29 @@ files:
 - test/unit/storage/hash_store_test.rb
 - test/unit/storage/yaml_store_test.rb
 - test/unit/storage/yaml_test.yml
+- test/unit/web_test.rb
 homepage: http://rdoc.info/github/justinweiss/robut/master/frames
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2804599532514623618
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2804599532514623618
 requirements: []
 rubyforge_project: robut
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple plugin-enabled HipChat bot
 test_files:
 - test/fixtures/bad_location.xml
@@ -150,3 +158,4 @@ test_files:
 - test/unit/storage/hash_store_test.rb
 - test/unit/storage/yaml_store_test.rb
 - test/unit/storage/yaml_test.yml
+- test/unit/web_test.rb