shoutbox-client 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Benjamin Krause
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+shoutbox-client
+===
+
+A simple Ruby client to manage your shoutbox (see https://github.com/benjaminkrause/shoutbox). 
+
+Examples
+---
+
+You can use it via ruby
+
+    ruby-1.9.2-p0 > ShoutboxClient.shout :name => "nightly-rake-task", :status => :red
+    true
+    
+or as a shell script
+
+    benjamin@Jiji % shout -n important-task -s red
+
+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
+    
+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
+
+The shell script accepts host and port parameters
+
+    benjamin@Jiji % shout -n important-task -s red -h shoutbox.moviepilot.com -p 80
+
+
+Contributing to shoutbox-client
+---
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---
+
+Copyright (c) 2011 Benjamin Krause. See LICENSE.txt for
+further details (will be added later).
+

data/bin/shout

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'shoutbox_client'
+
+Shoutbox::Shout.new

data/lib/shoutbox/configuration.rb

@@ -0,0 +1,36 @@
+module Shoutbox
+  class Configuration
+    attr_accessor :host, :port
+
+    def initialize
+      config_file_exists? ? read_config_file : default_config
+    end
+    
+    def config_file=( filename )
+      @config_file = filename
+      config_file_exists? ? read_config_file : default_config
+    end
+    
+    private
+    
+      def config_file_exists?
+        File.exists?(config_file)
+      end
+    
+      def config_file
+        @config_file || File.join(ENV['HOME'], '.shoutbox')
+      end
+    
+      def default_config
+        @host = 'localhost'
+        @port = 3000
+      end
+
+      def read_config_file
+        config_data = YAML::load_file(config_file)
+        @host = config_data["host"]
+        @port = config_data["port"]
+      end
+
+  end
+end

data/lib/shoutbox/shout.rb

@@ -0,0 +1,30 @@
+require 'trollop'
+
+module Shoutbox
+  class Shout
+    
+    def initialize
+      parse_options
+      do_it
+    end
+    
+    def parse_options
+      @conf = Trollop::options do
+        # banner = MPPerf.options_banner
+        opt :host,    "The hostname of the Shoutbox", :type => String
+        opt :port,    "The port of the Shoutbox",     :type => Integer
+        opt :name,    "", :type => String
+        opt :status,  "", :type => String
+      end
+
+      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]
+    end
+  end
+end

data/lib/shoutbox_client.rb

@@ -0,0 +1,24 @@
+require 'shoutbox/shout'
+require 'shoutbox/configuration'
+require 'net/http'
+require 'JSON'
+require 'yaml'
+
+class ShoutboxClient
+  
+  def self.configuration
+    @configuration ||= Shoutbox::Configuration.new
+  end
+  
+  def self.shout( options )
+    response = Net::HTTP.start(configuration.host, configuration.port) do |http|
+      req = Net::HTTP::Put.new('/status')
+      req['User-Agent']   = 'Ruby shoutbox-client'
+      req['Content-Type'] = 'application/json'
+      req['Accept']       = 'application/json'
+      req.body = { "group" => options[:group], "name" => options[:name], :status => options[:status].to_s }.to_json
+      http.request(req)
+    end
+    response.body == "OK"
+  end
+end

data/spec/shoutbox_client_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'tempfile'
+require 'JSON'
+
+describe "ShoutboxClient" do
+  context 'configuration' do
+    it 'should use the default configuration' do
+      ShoutboxClient.configuration.config_file = '/i/dont/exist'
+      ShoutboxClient.configuration.host.should == 'localhost'
+      ShoutboxClient.configuration.port.should == 3000
+    end
+    
+    it 'should use the values of the config file' do
+      tempfile = Tempfile.new( '.shoutbox' )
+      tempfile << { "host" => "example.com", "port" => 89 }.to_yaml
+      tempfile.close
+      ShoutboxClient.configuration.config_file = tempfile.path
+      ShoutboxClient.configuration.host.should == 'example.com'
+      ShoutboxClient.configuration.port.should == 89
+      ShoutboxClient.configuration.config_file = nil
+    end
+  end
+  
+  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\"}", 
+             :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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'webmock/rspec'
+require 'shoutbox_client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: shoutbox-client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Benjamin Krause
+autorequire: shoutbox_client
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 +01:00
+default_executable: shout
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id005
+description: " Simple Ruby Client to manage status on a node.js Shoutbox Server "
+email: bk@benjaminkrause.com
+executables: 
+- shout
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- bin/shout
+- lib/shoutbox/configuration.rb
+- lib/shoutbox/shout.rb
+- lib/shoutbox_client.rb
+- LICENSE.txt
+- README.md
+- spec/shoutbox_client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/benjaminkrause/shoutbox-client
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ruby client to publish shoutbox status updates
+test_files: 
+- spec/shoutbox_client_spec.rb
+- spec/spec_helper.rb