shoutbox-client 0.0.15 → 0.1.0

data/README.md

@@ -8,12 +8,15 @@ Examples
 
 You can use it via ruby
 
-    ruby-1.9.2-p0 > ShoutboxClient.shout :statusId => "nightly-rake-task", :status => :red
+    ruby-1.9.2-p0 > ShoutboxClient.shout :name => "My Rake Task", :status => :red, :message => 'failed miserably' 
     true
+
+	ruby-1.9.2-p0 > ShoutboxClient.shout :name => "My Other Task", :status => :green, :expires_in => 1.hour
+	true
     
 or as a shell script
 
-    benjamin@Jiji % shout green important-task
+    benjamin@Jiji % shout green 'important task'
 
 Configuration
 ---
@@ -23,6 +26,8 @@ in YAML format, like this
 
     host: localhost
     port: 3001
+    auth_token: my-shoutbox-auth-token
+
     
 Otherwise you can set the configuration manually via ruby
 

data/lib/shoutbox/configuration.rb

@@ -1,6 +1,6 @@
 module Shoutbox
   class Configuration
-    attr_accessor :host, :port, :proxy_host, :proxy_port, :default_group
+    attr_accessor :host, :port, :proxy_host, :proxy_port, :default_group, :auth_token
 
     def initialize
       config_file_exists? ? read_config_file : default_config
@@ -25,6 +25,7 @@ module Shoutbox
         @host           = 'localhost'
         @port           = 3000
         @default_group  = 'default group'
+        @auth_token     = 'invalid-auth-token'
         @proxy_host     = nil
         @proxy_port     = nil
       end
@@ -34,6 +35,7 @@ module Shoutbox
         @host           = config_data["host"]
         @port           = config_data["port"]
         @default_group  = config_data["default_group"] || 'default group'
+        @auth_token     = config_data["auth_token"]
         @proxy_host     = config_data["proxy_host"]
         @proxy_port     = config_data["proxy_port"]
       end

data/lib/shoutbox/shout.rb

@@ -12,10 +12,10 @@ module Shoutbox
     def parse_options
       @conf = Trollop::options do
         banner <<-EOS
-usage: shout <subcommand> <statusId>
+usage: shout <subcommand> <name>
 
 <subcommand> must be one of red, green, remove
-<statusId> is any given string you can think of
+<name> is any given string you can think of
 
 If you want to delete a status, you must provide
 a message.
@@ -27,33 +27,34 @@ EOS
         opt :proxy_host,  "The proxy host to use",              :type => String
         opt :proxy_port,  "The proxy port to use",              :type => Integer
         opt :group,       "The group to use",                   :type => String
+        opt :expires_in,  "Number of seconds this status should expire in", :type => Integer
       end
 
-      @conf[:status]   = ARGV.shift
-      @conf[:statusId] = ARGV.shift
+      @conf[:status] = ARGV.shift
+      @conf[:name]   = ARGV.shift
+      @conf[:message] = ARGV.shift
       
       case @conf[:status]
         when "red"
-          @conf[:message] = ARGV.shift
-          Trollop::die "provide <statusId> and <message> when shouting red" if @conf[:message].to_s.empty?
+          Trollop::die "provide <name> and <message> when shouting red" if @conf[:message].to_s.empty?
         when "green"
           # noop
         when "yellow"
-          # noop
+          Trollop::die "provide <name> and <message> when shouting red" if @conf[:message].to_s.empty?
         when "remove"
           # noop
         else
           Trollop::die "unknown <subcommand> #{ @conf[:status] }"
       end
       
-      Trollop::die "provide <status> and <statusId>" unless @conf[:status] and @conf[:statusId]
+      Trollop::die "provide <status> and <name>" unless @conf[:status] and @conf[:name]
       
       ShoutboxClient.configuration.host = @conf[:host]  if     @conf[:host]
       ShoutboxClient.configuration.port = @conf[:port]  if     @conf[:port]
     end
     
     def do_it
-      ShoutboxClient.shout :name => @conf[:name], :statusId => @conf[:statusId], :status => @conf[:status], :group => @conf[:group], :message => @conf[:message]
+      ShoutboxClient.shout :name => @conf[:name], :status => @conf[:status], :group => @conf[:group], :message => @conf[:message], :expires_in => @conf[:expires_in]
     end
   end
 end

data/lib/shoutbox_client.rb

@@ -31,8 +31,9 @@ class ShoutboxClient
     response = Net::HTTP.Proxy(configuration.proxy_host, configuration.proxy_port).start(configuration.host, configuration.port) do |http|
       req = Net::HTTP::Put.new( request_url(options) )
       default_headers(req)
-      body_data = { :statusId => options[:statusId], :group => (options[:group] || configuration.default_group), :status => options[:status].to_s }
-      body_data[:message] = options[:message] if options[:message]
+      body_data = { :name => options[:name], :group => (options[:group] || configuration.default_group), :status => options[:status].to_s }
+      body_data[:message]    = options[:message]    if options[:message]
+      body_data[:expires_in] = options[:expires_in] if options[:expires_in]
       raise ArgumentError if (options[:status] == :red or options[:status] == :yellow) and body_data[:message].to_s.empty?
       req.body = body_data.to_json
       http.request(req)
@@ -43,7 +44,7 @@ class ShoutboxClient
   def self.delete_status( options )
     response = Net::HTTP.Proxy(configuration.proxy_host, configuration.proxy_port).start(configuration.host, configuration.port) do |http|
       req = Net::HTTP::Delete.new( request_url(options) )
-      req.body = { :statusId => options[:statusId], :group => (options[:group] || configuration.default_group) }.to_json
+      req.body = { :name => options[:name], :group => (options[:group] || configuration.default_group) }.to_json
       default_headers(req)
       http.request(req)
     end
@@ -51,9 +52,10 @@ class ShoutboxClient
   end
 
   def self.default_headers( request )
-    request['User-Agent']   = 'Ruby shoutbox-client'
-    request['Content-Type'] = 'application/json'
-    request['Accept']       = 'application/json'
+    request['User-Agent']             = 'Ruby shoutbox-client'
+    request['Content-Type']           = 'application/json'
+    request['Accept']                 = 'application/json'
+    request['X-Shoutbox-Auth-Token']  = configuration.auth_token
   end
   
   def self.request_url( options )

data/spec/shoutbox_client_spec.rb

@@ -12,11 +12,12 @@ describe "ShoutboxClient" do
       ShoutboxClient.configuration.config_file = '/i/dont/exist'
       ShoutboxClient.configuration.host.should == 'localhost'
       ShoutboxClient.configuration.port.should == 3000
+      ShoutboxClient.configuration.auth_token.should == 'invalid-auth-token'
     end
     
     it 'should use the values of the config file' do
       tempfile = Tempfile.new( '.shoutbox' )
-      tempfile << { "host" => "example.com", "port" => 89, "proxy_host" => "prx", "proxy_port" => 8080 }.to_yaml
+      tempfile << { "host" => "example.com", "port" => 89, "proxy_host" => "prx", "proxy_port" => 8080, "auth_token" => 'abc' }.to_yaml
       tempfile.close
       ShoutboxClient.configuration.config_file = tempfile.path
       ShoutboxClient.configuration.host.should == 'example.com'
@@ -24,6 +25,7 @@ describe "ShoutboxClient" do
       ShoutboxClient.configuration.proxy_host.should == "prx"
       ShoutboxClient.configuration.proxy_port.should == 8080
       ShoutboxClient.configuration.default_group.should == 'default group'
+      ShoutboxClient.configuration.auth_token.should == 'abc'
     end
     
     it 'should use the configured default group' do
@@ -39,75 +41,84 @@ describe "ShoutboxClient" do
     
     it 'should return false when it cant connect to the host' do
       ShoutboxClient.should_receive(:update_status).and_raise(Errno::ECONNREFUSED)
-      ShoutboxClient.shout( :group => "my_group", :statusId => "test_status", :status => :green ).should == false
+      ShoutboxClient.shout( :group => "my_group", :name => "test_status", :status => :green ).should == false
     end
     
     
     it 'should create a valid PUT request to the shoutbox' do
       stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"my_group\",\"status\":\"green\"}", 
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"my_group\",\"status\":\"green\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
 
-      ShoutboxClient.shout( :group => "my_group", :statusId => "test_status", :status => :green ).should == true
+      ShoutboxClient.shout( :group => "my_group", :name => "test_status", :status => :green ).should == true
     end
     
     it 'should create use group default if no group given' do
       stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"default group\",\"status\":\"green\"}", 
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\",\"status\":\"green\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
 
-      ShoutboxClient.shout( :statusId => "test_status", :status => :green ).should == true
+      ShoutboxClient.shout( :name => "test_status", :status => :green ).should == true
     end
 
     it 'should include a message when status is yellow and message is given' do
       stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"default group\",\"status\":\"yellow\",\"message\":\"This is what you should do now..\"}", 
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\",\"status\":\"yellow\",\"message\":\"This is what you should do now..\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
 
-      ShoutboxClient.shout( :statusId => "test_status", :status => :yellow, :message => "This is what you should do now.." ).should == true
+      ShoutboxClient.shout( :name => "test_status", :status => :yellow, :message => "This is what you should do now.." ).should == true
     end
     
     it 'should include a message when status is red' do
       stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"default group\",\"status\":\"red\",\"message\":\"This is what you should do now..\"}", 
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\",\"status\":\"red\",\"message\":\"This is what you should do now..\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
 
-      ShoutboxClient.shout( :statusId => "test_status", :status => :red, :message => "This is what you should do now.." ).should == true
+      ShoutboxClient.shout( :name => "test_status", :status => :red, :message => "This is what you should do now.." ).should == true
+    end
+
+    it 'should include an expiration time when given' do
+      stub_request(:put, "http://localhost:3000/status").
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\",\"status\":\"green\",\"expires_in\":3600}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
+        to_return(:status => 200, :body => "OK", :headers => {})
+
+      ShoutboxClient.shout( :name => "test_status", :status => :green, :expires_in => 3600 ).should == true
     end
     
     it 'should deny red update if message is missing' do
       lambda {
-        ShoutboxClient.shout( :statusId => "test_status", :status => :red )
+        ShoutboxClient.shout( :name => "test_status", :status => :red )
       }.should raise_error(ArgumentError)
     end
 
     it 'should deny yellow update if message is missing' do
       lambda {
-        ShoutboxClient.shout( :statusId => "test_status", :status => :yellow )
+        ShoutboxClient.shout( :name => "test_status", :status => :yellow )
       }.should raise_error(ArgumentError)
     end
 
     it 'should send optional status on green update' do
       stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"default group\",\"status\":\"green\",\"message\":\"everything's ok!\"}", 
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\",\"status\":\"green\",\"message\":\"everything's ok!\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
       lambda {
-        ShoutboxClient.shout( :statusId => "test_status", :status => :green, :message => "everything's ok!" )
+        ShoutboxClient.shout( :name => "test_status", :status => :green, :message => "everything's ok!" )
       }.should_not raise_error(ArgumentError)
     end
     
     it 'should delete a status' do
       stub_request(:delete, "http://localhost:3000/status").
-        with(:body    => "{\"statusId\":\"test_status\",\"group\":\"default group\"}",
-             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"default group\"}",
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client', 'X-Shoutbox-Auth-Token' => 'invalid-auth-token'}).
         to_return(:status => 200, :body => "OK", :headers => {})
       
-      ShoutboxClient.shout( :statusId => "test_status", :status => :remove ).should == true
+      ShoutboxClient.shout( :name => "test_status", :status => :remove ).should == true
     end
     
   end

metadata

@@ -2,7 +2,7 @@
 name: shoutbox-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.15
+  version: 0.1.0
 platform: ruby
 authors: 
 - Benjamin Krause
@@ -10,7 +10,7 @@ autorequire: shoutbox_client
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 +01:00
+date: 2011-04-04 00:00:00 +02:00
 default_executable: shout
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -225320292966696977
+      hash: 592437698402898647
       segments: 
       - 0
       version: "0"