shoutbox-client 0.0.2 → 0.0.3

data/README.md

@@ -8,12 +8,12 @@ Examples
 
 You can use it via ruby
 
-    ruby-1.9.2-p0 > ShoutboxClient.shout :name => "nightly-rake-task", :status => :red
+    ruby-1.9.2-p0 > ShoutboxClient.shout :statusId => "nightly-rake-task", :status => :red
     true
     
 or as a shell script
 
-    benjamin@Jiji % shout -n important-task -s red
+    benjamin@Jiji % shout green important-task
 
 Configuration
 ---
@@ -33,7 +33,7 @@ Otherwise you can set the configuration manually via ruby
 
 The shell script accepts host and port parameters
 
-    benjamin@Jiji % shout -n important-task -s red -h shoutbox.moviepilot.com -p 80
+    benjamin@Jiji % shout red important-task -h shoutbox.moviepilot.com -p 80
 
 
 Contributing to shoutbox-client

data/lib/shoutbox/shout.rb

@@ -11,29 +11,32 @@ module Shoutbox
     def parse_options
       @conf = Trollop::options do
         banner <<-EOS
-        shout is a simple command line client to update your Shoutbox
+usage: shout <status> <statusId> [options]
 
-        Usage:
-               shout -n <name> -s <red|green>
-               
-        where [options] are:
+<status> must be one of red, green, remove
+<statusId> is any given id you can think of
+       
+shout allows the folling options:
         EOS
         
-        opt :host,    "The hostname of the Shoutbox", :type => String
-        opt :group,   "The group to use",             :type => String, :default => "default"
-        opt :port,    "The port of the Shoutbox",     :type => Integer
-        opt :name,    "", :type => String
-        opt :status,  "", :type => String
+        opt :host,    "The hostname of the Shoutbox",       :type => String
+        opt :port,    "The port of the Shoutbox",           :type => Integer
+        opt :group,   "The group to use",                   :type => String, :default => "default"
+        opt :name,    "The display name for the statusId",  :type => String
       end
+      
+      Trollop::die "provide <status> and <statusId>" if ARGV.size != 2
+      @conf[:status]   = ARGV.shift
+      Trollop::die "<status> must be one of 'green', 'red', 'destroy'" unless ShoutboxClient.valid_status?( @conf[:status] )
+      
+      @conf[:statusId] = ARGV.shift
 
-      Trollop::die :name,   "name must be given"        unless @conf[:name]
-      Trollop::die :status, "status must be given"      unless @conf[:status]
       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], :status => @conf[:status], :group => @conf[:group]
+      ShoutboxClient.shout :name => @conf[:name], :statusId => @conf[:statusId], :status => @conf[:status], :group => @conf[:group]
     end
   end
 end

data/lib/shoutbox_client.rb

@@ -5,20 +5,53 @@ require 'JSON'
 require 'yaml'
 
 class ShoutboxClient
+  VALID_STATUS = { 'red'      => :update,
+                   'green'    => :update,
+                   'destroy'  => :delete  }
+  
   
   def self.configuration
     @configuration ||= Shoutbox::Configuration.new
   end
   
   def self.shout( options )
+    if valid_status?( options[:status] )
+      VALID_STATUS[options[:status].to_s] == :update ? update_status( options ) : delete_status( options )
+    else
+      false
+    end
+  end
+  
+  def self.update_status( options )
     response = Net::HTTP.start(configuration.host, configuration.port) do |http|
-      req = Net::HTTP::Put.new('/status')
-      req['User-Agent']   = 'Ruby shoutbox-client'
+      req = Net::HTTP::Put.new( request_url(options) )
+      default_headers(req)
       req['Content-Type'] = 'application/json'
-      req['Accept']       = 'application/json'
-      req.body = { "group" => options[:group], "name" => options[:name], :status => options[:status].to_s }.to_json
+      req.body = { :status => options[:status].to_s }.to_json
+      http.request(req)
+    end
+    response.body == "OK"
+  end
+  
+  def self.delete_status( options )
+    response = Net::HTTP.start(configuration.host, configuration.port) do |http|
+      req = Net::HTTP::Delete.new( request_url(options) )
+      default_headers(req)
       http.request(req)
     end
     response.body == "OK"
   end
+
+  def self.default_headers( request )
+    request['User-Agent']   = 'Ruby shoutbox-client'
+    request['Accept']       = 'application/json'
+  end
+  
+  def self.request_url( options )
+    '/status/' + (options[:group] || 'default') + "/" + options[:statusId]
+  end
+  
+  def self.valid_status?( status )
+    VALID_STATUS.keys.include?( status.to_s )
+  end
 end

data/spec/shoutbox_client_spec.rb

@@ -23,12 +23,30 @@ describe "ShoutboxClient" do
   
   context 'http communication' do
     it 'should create a valid PUT request to the shoutbox' do
-      stub_request(:put, "http://localhost:3000/status").
-        with(:body    => "{\"group\":\"default\",\"name\":\"test_status\",\"status\":\"green\"}", 
+      stub_request(:put, "http://localhost:3000/status/my_group/test_status").
+        with(:body    => "{\"status\":\"green\"}", 
              :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
         to_return(:status => 200, :body => "OK", :headers => {})
 
-      ShoutboxClient.shout( :group => "default", :name => "test_status", :status => :green ).should == true
+      ShoutboxClient.shout( :group => "my_group", :statusId => "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/default/test_status").
+        with(:body    => "{\"status\":\"green\"}", 
+             :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        to_return(:status => 200, :body => "OK", :headers => {})
+
+      ShoutboxClient.shout( :statusId => "test_status", :status => :green ).should == true
+    end
+    
+    it 'should delete a status' do
+      stub_request(:delete, "http://localhost:3000/status/default/test_status").
+        with(:headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby shoutbox-client'}).
+        to_return(:status => 200, :body => "OK", :headers => {})
+      
+      ShoutboxClient.shout( :statusId => "test_status", :status => :destroy ).should == true
+    end
+    
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Benjamin Krause
@@ -87,6 +87,21 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
 description: " Simple Ruby Client to manage status on a node.js Shoutbox Server "
 email: bk@benjaminkrause.com
 executables: 
@@ -119,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2791319397029463430
+      hash: -425631808268583408
       segments: 
       - 0
       version: "0"