shoutbox-client 0.1.1 → 0.2.0

data/README.md

@@ -11,9 +11,14 @@ You can use it via ruby
     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
-    
+    ruby-1.9.2-p0 > ShoutboxClient.shout :name => "My Other Task", :status => :green, :expires_in => 1.hour
+    true
+
+if you want to set an explicit name to be displayed on your shoutbox, pass the option :display_name
+
+    ruby-1.9.2-p0 > ShoutboxClient.shout :name => "My Other Task", :status => :green, :expires_in => 1.hour, :display_name => 'TOLD YOU SO!'
+    true
+   
 or as a shell script
 
     benjamin@Jiji % shout green 'important task'
@@ -24,8 +29,7 @@ Configuration
 The shoutbox-client will look for a ~/.shoutbox config file with a hostname and portnumber
 in YAML format, like this
 
-    host: localhost
-    port: 3001
+    host: http://shoutbox.io
     auth_token: my-shoutbox-auth-token
 
     
@@ -33,12 +37,13 @@ Otherwise you can set the configuration manually via ruby
 
     ShoutboxClient.configuration.config_file = 'some/file'
     # or
-    ShoutboxClient.configuration.host = 'shoutbox.moviepilot.com'
-    ShoutboxClient.configuration.port = 80
+    ShoutboxClient.configuration.host = 'http://shoutbox.moviepilot.com:991'
 
 The shell script accepts host and port parameters
 
-    benjamin@Jiji % shout red important-task -h shoutbox.moviepilot.com -p 80
+    benjamin@Jiji % shout red important-task "failed!" -h "http://shoutbox.moviepilot.com"
+    
+Try shout --help for all the options
 
 
 Contributing to shoutbox-client

data/lib/shoutbox/shout.rb

@@ -28,10 +28,11 @@ shout remove db-export
 shout allows the folling options:
 EOS
         opt :host,        "The hostname of the Shoutbox",       :type => String
-        opt :port,        "The port of the Shoutbox",           :type => Integer
         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 :display,     "The display name",                   :type => String
+        opt :auth_token,  "The auth-token to use",              :type => String
         opt :expires_in,  "Number of seconds this status should expire in", :type => Integer
       end
 
@@ -54,12 +55,13 @@ EOS
       
       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]
+      ShoutboxClient.configuration.host       = @conf[:host]       if @conf[:host]
+      ShoutboxClient.configuration.port       = @conf[:port]       if @conf[:port]
+      ShoutboxClient.configuration.auth_token = @conf[:auth_token] if @conf[:auth_token]
     end
     
     def do_it
-      ShoutboxClient.shout :name => @conf[:name], :status => @conf[:status], :group => @conf[:group], :message => @conf[:message], :expires_in => @conf[:expires_in]
+      ShoutboxClient.shout :name => @conf[:name], :status => @conf[:status], :group => @conf[:group], :message => @conf[:message], :expires_in => @conf[:expires_in], :display_name => @conf[:display]
     end
   end
 end

data/lib/shoutbox_client.rb

@@ -32,8 +32,9 @@ class ShoutboxClient
       req = Net::HTTP::Put.new( request_url(options) )
       default_headers(req)
       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]
+      body_data[:message]      = options[:message]      if options[:message]
+      body_data[:expires_in]   = options[:expires_in]   if options[:expires_in]
+      body_data[:display_name] = options[:display_name] if options[:display_name]
       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)
@@ -73,4 +74,4 @@ class ShoutboxClient
   def self.valid_status?( status )
     VALID_STATUS.keys.include?( status.to_s )
   end
-end
+end

data/spec/shoutbox_client_spec.rb

@@ -79,6 +79,16 @@ describe "ShoutboxClient" do
       ShoutboxClient.shout( :name => "test_status", :status => :red, :message => "This is what you should do now.." ).should == true
     end
 
+    it 'should contain the display name when option given' do
+      stub_request(:put, "http://shoutbox.io/status").
+        with(:body    => "{\"name\":\"test_status\",\"group\":\"my_group\",\"status\":\"green\",\"display_name\":\"I TOLD YOU SO!\"}", 
+             :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", :name => "test_status", :status => :green, :display_name => 'I TOLD YOU SO!' ).should == true
+
+    end
+
     it 'should include an expiration time when given' do
       stub_request(:put, "http://shoutbox.io/status").
         with(:body    => "{\"name\":\"test_status\",\"group\":\"Home\",\"status\":\"green\",\"expires_in\":3600}", 

metadata

@@ -2,7 +2,7 @@
 name: shoutbox-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Benjamin Krause
@@ -10,7 +10,7 @@ autorequire: shoutbox_client
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 +02:00
+date: 2011-07-18 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: 4047158430543841235
+      hash: 2560211999808166080
       segments: 
       - 0
       version: "0"