hipchat-chef 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDQwMGJiNGJkYzFmMTA3YTIxY2NlYmNhNzUzZDBiOTRmYWEzN2FkZg==
+  data.tar.gz: !binary |-
+    ZGQxNmUwM2Q3NTAyOWNlYzg1MWE3ZmE4MjI4NWQ0ZjdkYzdmOTcyMg==
+SHA512:
+  metadata.gz: !binary |-
+    YmRkMjg2YWIyM2JkZWU0OWE3NDMxYjM1YmJiMWI5Y2EzMDdhZjc0MGE5ZDc1
+    ZDEyZjUzYTExOTk0ODJjMWNjMTZkZDAxZGVkNDYwNGVmZTMxYjA2NWE1ZTBj
+    ZTQ4NjdmOTk4MzgwNjBlZmJhYjI3MzMzNjAzZGEwMjBjYmQxYTA=
+  data.tar.gz: !binary |-
+    ZDFmY2M1N2I1MzY1ZTJjMDdkZmRmODY5OGIwZDhhMDE1ODI4OTE0NzE0NjY2
+    NmZmMzJmMTExMTZjZWIwN2YzNDJhODdiMmE2ZThmNGFjMmMyZTI2NTlmMjc2
+    YzBiNTM4ZWRlYWMzZjYzOTgyZGRkYWQyY2Q3ZDJkMmZmOGM2NDg=

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+/Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+## PROJECT::SPECIFIC

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hipchat.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Atlassian
+
+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.textile

@@ -0,0 +1,98 @@
+h1. HipChat Wrapper
+
+A very basic wrapper for the HipChat HTTP API.
+
+h2. Build Status
+
+"!https://travis-ci.org/hipchat/hipchat-rb.png!":https://travis-ci.org/hipchat/hipchat-rb
+
+h2. Requirements
+* Ruby 1.9.3 or higher
+* HipChat Account, sign up "here!":https://hipchat.com/
+
+h2. Usage
+
+bc.. client = HipChat::Client.new(api_token)
+# 'username' is the name for which the message will be presented as from
+client['my room'].send('username', 'I talk')
+
+# Send notifications to users (default false)
+client['my room'].send('username', 'I quit!', :notify => true)
+
+# Color it red. or "yellow", "green", "purple", "random" (default "yellow")
+client['my room'].send('username', 'Build failed!', :color => 'red')
+
+# Have your message rendered as text in HipChat (see https://www.hipchat.com/docs/api/method/rooms/message)
+client['my room'].send('username', '@coworker Build faild!', :message_format => 'text')
+
+# Update the topic of a room in HipChat (see https://www.hipchat.com/docs/api/method/rooms/topic)
+client['my room'].topic('Free Ice Cream in the kitchen')
+
+# Change the from field for a topic update (default "API")
+client['my room'].topic('Weekely sales: $10,000', :from => 'Sales Team')
+
+# Get history from a room
+client['my room'].history()
+
+# Get history for a date in time with a particular timezone (default is latest 75 messages, timezone default is 'UTC')
+client['my room'].history(:date => '2010-11-19', :timezone => 'PST')
+
+
+h2. Capistrano
+
+bc.. require 'hipchat/capistrano'
+
+set :hipchat_token, "<your token>"
+set :hipchat_room_name, "Your room" # If you pass an array such as ["room_a", "room_b"] you can send announcements to multiple rooms.
+set :hipchat_announce, false # notify users
+set :hipchat_color, 'yellow' #normal message color
+set :hipchat_success_color, 'green' #finished deployment message color
+set :hipchat_failed_color, 'red' #cancelled deployment message color
+set :hipchat_message_format, 'text' # Sets the deployment message format, see https://www.hipchat.com/docs/api/method/rooms/message
+
+h3. Who did it?
+
+To determine the user that is currently running the deploy, the capistrano tasks will look for the following:
+
+# The $HIPCHAT_USER environment variable
+# The hipchat_human capistrano var.
+# The git user.name var.
+# The $USER environment variable.
+
+h2. Rails 3 Rake Task
+
+Send a message using a rake task:
+
+bc. rake hipchat:send["hello world"]
+
+or
+
+bc. rake hipchat:send MESSAGE="hello world"
+
+Options like the room, API token, user name and notification flag can be set in YAML.
+
+RAILS_ROOT/config/hipchat.yml:
+
+bc.. token: "<your token>"
+room: "Your room"
+user: "Your name" # Default to `whoami`
+notify: true # Defaults to false
+
+h2. Engine Yard
+
+Use a "deploy hook":http://bit.ly/qnbIkP to send messages from Engine Yard's Cloud platform.
+
+RAILS_ROOT/deploy/after_restart.rb:
+
+bc.. on_app_master do
+  message  = "Deploying revision #{revision[0...6]} to #{node[:environment][:name]}"
+  message += " (with migrations)" if migrate?
+  message += "."
+
+  # Send a message via rake task assuming a hipchat.yml in your config like above
+  run "cd #{release_path} && bundle exec rake hipchat:send MESSAGE='#{message}'"
+end
+
+h2. Copyright
+
+Copyright (c) 2012 Atlassian. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '-c -fd'
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = HipChat::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hipchat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/hipchat-chef.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hipchat-chef/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hipchat-chef"
+  spec.version       = HipChat::VERSION
+  spec.authors       = ["HipChat/Atlassian"]
+  spec.email         = ["support@hipchat.com"]
+  spec.description   = %q{Ruby library to interact with HipChat}
+  spec.summary       = %q{Ruby library to interact with HipChat}
+  spec.homepage      = "https://github.com/hipchat/hipchat-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rr"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'rdoc', '> 2.4.2'
+end

data/lib/hipchat-chef.rb

@@ -0,0 +1,188 @@
+require 'httparty'
+require 'ostruct'
+
+require 'hipchat-chef/railtie' if defined?(Rails::Railtie)
+require "hipchat-chef/version"
+
+module HipChat
+  class UnknownRoom         < StandardError; end
+  class Unauthorized        < StandardError; end
+  class UnknownResponseCode < StandardError; end
+  class UsernameTooLong < StandardError; end
+
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.hipchat.com/v1/rooms'
+    format :json
+
+    def initialize(token, options={})
+      @token = token
+
+      http_proxy = options[:http_proxy] || ENV['http_proxy']
+      setup_proxy(http_proxy) if http_proxy
+    end
+
+    def rooms
+      @rooms ||= self.class.get("/list", :query => {:auth_token => @token})['rooms'].
+        map { |r| Room.new(@token, r) }
+    end
+
+    def [](name)
+      Room.new(@token, :room_id => name)
+    end
+
+    private
+    def setup_proxy(proxy_url)
+      proxy_url = URI.parse(proxy_url)
+
+      self.class.http_proxy(proxy_url.host, proxy_url.port,
+                            proxy_url.user, proxy_url.password)
+      HipChat::Room.http_proxy(proxy_url.host, proxy_url.port,
+                               proxy_url.user, proxy_url.password)
+    end
+  end
+
+  class Room < OpenStruct
+    include HTTParty
+
+    base_uri 'https://api.hipchat.com/v1/rooms'
+
+    def initialize(token, params)
+      @token = token
+
+      super(params)
+    end
+
+    # Send a message to this room.
+    #
+    # Usage:
+    #
+    #   # Default
+    #   send 'nickname', 'some message'
+    #
+    #   # Notify users and color the message red
+    #   send 'nickname', 'some message', :notify => true, :color => 'red'
+    #
+    #   # Notify users (deprecated)
+    #   send 'nickname', 'some message', true
+    #
+    # Options:
+    #
+    # +color+::  "yellow", "red", "green", "purple", or "random"
+    #            (default "yellow")
+    # +notify+:: true or false
+    #            (default false)
+    def send(from, message, options_or_notify = {})
+      if from.length > 15
+        raise UsernameTooLong, "Username #{from} is `#{from.length} characters long. Limit is 15'"
+      end
+      options = if options_or_notify == true or options_or_notify == false
+        warn "DEPRECATED: Specify notify flag as an option (e.g., :notify => true)"
+        { :notify => options_or_notify }
+      else
+        options_or_notify || {}
+      end
+
+      options = { :color => 'yellow', :notify => false }.merge options
+
+      response = self.class.post('/message',
+        :query => { :auth_token => @token },
+        :body  => {
+          :room_id        => room_id,
+          :from           => from,
+          :message        => message,
+          :message_format => options[:message_format] || 'html',
+          :color          => options[:color],
+          :notify         => options[:notify] ? 1 : 0
+        }
+      )
+
+      case response.code
+      when 200; true
+      when 404
+        raise UnknownRoom,  "Unknown room: `#{room_id}'"
+      when 401
+        raise Unauthorized, "Access denied to room `#{room_id}'"
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
+      end
+    end
+
+    # Change this room's topic
+    #
+    # Usage:
+    #
+    #   # Default
+    #   topic 'my awesome topic'
+    #
+    # Options:
+    #
+    # +from+::  the name of the person changing the topic
+    #            (default "API")
+    def topic(new_topic, options = {})
+
+      options = { :from => 'API' }.merge options
+
+      response = self.class.post('/topic',
+        :query => { :auth_token => @token },
+        :body  => {
+          :room_id        => room_id,
+          :from           => options[:from],
+          :topic          => new_topic
+        }
+      )
+
+      case response.code
+      when 200; true
+      when 404
+        raise UnknownRoom,  "Unknown room: `#{room_id}'"
+      when 401
+        raise Unauthorized, "Access denied to room `#{room_id}'"
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
+      end
+    end
+
+    # Pull this room's history
+    #
+    # Usage
+    #
+    #   # Default
+    #
+    #
+    # Options
+    #
+    # +date+::     Whether to return a specific day (YYYY-MM-DD format) or recent
+    #                (default "recent")
+    # +timezone+:: Your timezone.  Supported timezones are at: https://www.hipchat.com/docs/api/timezones
+    #                (default "UTC")
+    # +format+::   Format to retrieve the history in.  Valid options are JSON and XML
+    #                (default "JSON")
+    def history(options = {})
+
+      options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge options
+
+      response = self.class.get('/history',
+        :query => {
+          :room_id    => room_id,
+          :date       => options[:date],
+          :timezone   => options[:timezone],
+          :format     => options[:format],
+          :auth_token => @token,
+        }
+      )
+
+      case response.code
+      when 200
+        response.body
+      when 404
+        raise UnknownRoom,  "Unknown room: `#{room_id}'"
+      when 401
+        raise Unauthorized, "Access denied to room `#{room_id}'"
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
+      end
+    end
+  end
+end

data/lib/hipchat-chef/capistrano.rb

@@ -0,0 +1,131 @@
+require 'hipchat-chef'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :hipchat_send_notification, false
+  set :hipchat_with_migrations, ''
+
+  namespace :hipchat do
+    task :trigger_notification do
+      set :hipchat_send_notification, true if !dry_run
+    end
+
+    task :configure_for_migrations do
+      set :hipchat_with_migrations, ' (with migrations)'
+    end
+
+    task :notify_deploy_started do
+      if hipchat_send_notification
+
+        environment_string = env
+        if self.respond_to?(:stage)
+          environment_string = "#{stage} (#{env})"
+        end
+
+        on_rollback do
+          send_options.merge!(:color => failed_message_color)
+          send("#{human} cancelled deployment of #{deployment_name} to #{environment_string}.", send_options)
+        end
+
+        send("#{human} is deploying #{deployment_name} to #{environment_string}#{fetch(:hipchat_with_migrations, '')}.", send_options)
+      end
+    end
+
+    task :notify_deploy_finished do
+      if hipchat_send_notification
+        send_options.merge!(:color => success_message_color)
+
+        environment_string = env
+        if self.respond_to?(:stage)
+          environment_string = "#{stage} (#{env})"
+        end
+
+        send("#{human} finished deploying #{deployment_name} to #{environment_string}#{fetch(:hipchat_with_migrations, '')}.", send_options)
+      end
+    end
+
+    def send_options
+      return @send_options if defined?(@send_options)
+      @send_options = message_format ? {:message_format => message_format } : {}
+      @send_options.merge!(:notify => message_notification)
+      @send_options.merge!(:color => message_color)
+      @send_options
+    end
+
+    def send(message, options)
+      set :hipchat_client, HipChat::Client.new(hipchat_token) if fetch(:hipchat_client, nil).nil?
+
+      if hipchat_room_name.is_a?(String)
+        rooms = [hipchat_room_name]
+      elsif hipchat_room_name.is_a?(Symbol)
+        rooms = [hipchat_room_name.to_s]
+      else
+        rooms = hipchat_room_name
+      end
+
+      rooms.each { |room|
+        begin
+          hipchat_client[room].send(deploy_user, message, options)
+        rescue => e
+          puts e.message
+          puts e.backtrace
+        end
+      }
+    end
+
+    def deployment_name
+      if fetch(:branch, nil)
+        name = "#{application}/#{branch}"
+        name += " (revision #{real_revision[0..7]})" if real_revision
+        name
+      else
+        application
+      end
+    end
+
+    def message_color
+      fetch(:hipchat_color, nil)
+    end
+
+    def success_message_color
+      fetch(:hipchat_success_color, "green")
+    end
+
+    def failed_message_color
+      fetch(:hipchat_failed_color, "red")
+    end
+
+    def message_notification
+      fetch(:hipchat_announce, false)
+    end
+
+    def message_format
+      fetch(:hipchat_message_format, "html")
+    end
+
+    def deploy_user
+      fetch(:hipchat_deploy_user, "Deploy")
+    end
+
+    def human
+      ENV['HIPCHAT_USER'] ||
+        fetch(:hipchat_human,
+              if (u = %x{git config user.name}.strip) != ""
+                u
+              elsif (u = ENV['USER']) != ""
+                u
+              else
+                "Someone"
+              end)
+    end
+
+    def env
+      fetch(:hipchat_env, fetch(:rack_env, fetch(:rails_env, "production")))
+    end
+  end
+
+  before "deploy", "hipchat:trigger_notification"
+  before "deploy:migrations", "hipchat:trigger_notification", "hipchat:configure_for_migrations"
+  before "deploy:update_code", "hipchat:notify_deploy_started"
+  after  "deploy", "hipchat:notify_deploy_finished"
+  after  "deploy:migrations", "hipchat:notify_deploy_finished"
+end

data/lib/hipchat-chef/chef.rb

@@ -0,0 +1,55 @@
+require 'hipchat-chef'
+
+#
+# Provides a Chef exception handler so you can send information about
+# chef-client failures to a HipChat room.
+#
+# Docs: http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
+#
+# Install - add the following to your client.rb:
+#   require 'hipchat/chef'
+#   hipchat_handler = HipChat::NotifyRoom.new("<api token>", "<room name>")
+#   exception_handlers << hipchat_handler
+#
+
+module HipChat
+  class NotifyRoom < Chef::Handler
+
+    def initialize(api_token, room_name, notify_users=false, report_success=false, excluded_envs=[], override_colors={})
+      @api_token = api_token
+      @room_name = room_name
+      @notify_users = notify_users
+      @report_success = report_success
+      @excluded_envs = excluded_envs
+      @override_colors = override_colors
+    end
+
+    def report
+      unless @excluded_envs.include?(node.chef_environment)
+        msg = if run_status.failed? then "Failure on \"<b>#{node.name}</b>\" (<b>#{node.chef_environment}</b>, <b>#{node['ipaddress']}</b>):\n#{run_status.formatted_exception}"
+              elsif run_status.success? && @report_success
+                "Chef run on \"#{node.name}\" completed in #{run_status.elapsed_time.round(2)} seconds"
+              else nil
+              end
+
+        @override_colors.default_proc = proc do |h, k|
+          case k
+            when String then sym = k.to_sym; h[sym] if h.key?(sym)
+            when Symbol then str = k.to_s; h[str] if h.key?(str)
+          end
+        end
+
+        color = if run_status.success?
+                  @override_colors[:success].to_s || 'green'
+                else
+                  @override_colors[:failure].to_s || 'red'
+                end
+
+        if msg
+          client = HipChat::Client.new(@api_token)
+          client[@room_name].send('Chef', msg, :notify => @notify_users, :color => color)
+        end
+      end
+    end
+  end
+end

data/lib/hipchat-chef/rails3_tasks.rb

@@ -0,0 +1,44 @@
+require 'hipchat-chef'
+
+namespace :hipchat do
+  desc "Sends a HipChat message as a particular user"
+  task :send, [:message] do |t, args|
+    required_options = [:message, :room, :token, :user]
+    config_file      = Rails.root.join 'config', 'hipchat.yml'
+
+    options = {
+      :message        => ENV['MESSAGE'],
+      :message_format => ENV['MESSAGE_FORMAT'],
+      :user           => ENV['HIPCHAT_USER'],
+      :notify         => ENV['NOTIFY'],
+      :room           => ENV['ROOM'],
+      :token          => ENV['TOKEN']
+    }.reject { |k, v| v.blank? }
+
+    system_options = {
+      :user    => ENV['USER']
+    }.reject { |k, v| v.blank? }
+
+    argument_options = {
+      :message => args.message
+    }.reject { |k, v| v.blank? }
+
+    if File.exists? config_file
+      options.reverse_merge! YAML.load_file(config_file).symbolize_keys
+    end
+
+    options.reverse_merge! system_options
+    options.merge! argument_options
+
+    options[:notify] = options[:notify].to_s != 'false'
+
+    if (missing_options = required_options - options.keys).size > 0
+      puts "HipChat needs #{missing_options.to_sentence} to send!"
+      exit
+    end
+
+    client = HipChat::Client.new(options[:token])
+
+    client[options[:room]].send(options[:user], options[:message], :notify => options[:notify])
+  end
+end

data/lib/hipchat-chef/railtie.rb

@@ -0,0 +1,9 @@
+require 'hipchat-chef'
+
+module HipChat
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'hipchat/rails3_tasks'
+    end
+  end
+end

data/lib/hipchat-chef/version.rb

@@ -0,0 +1,3 @@
+module HipChat
+  VERSION = "0.0.5"
+end

data/spec/example/history.json

@@ -0,0 +1,36 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "messages": [
+    {
+      "date": "2010-11-19T15:48:19-0800",
+      "from": {
+        "name": "Garret Heaton",
+        "user_id": 10
+      },
+      "message": "Good morning! This is a regular message."
+    },
+    {
+      "date": "2010-11-19T15:49:44-0800",
+      "from": {
+        "name": "Garret Heaton",
+        "user_id": 10
+      },
+      "file": {
+        "name": "Screenshot.png",
+        "size": 141909,
+        "url": "http:\/\/uploads.hipchat.com\/xxx\/Screenshot.png"
+      },
+      "message": "This is a file upload"
+    },
+    {
+      "date": "2010-11-19T16:13:40-0800",
+      "from": {
+        "name": "Deploy Bot",
+        "user_id": "api"
+      },
+      "message": "This message is sent via the API so the user_id is 'api'."
+    }
+  ]
+}

data/spec/hipchat_spec.rb

@@ -0,0 +1,209 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe HipChat do
+  subject { HipChat::Client.new("blah") }
+
+  let(:room) { subject["Hipchat"] }
+
+  # Helper for mocking room message post requests
+  def mock_successful_send(from, message, options={})
+    options = {:color => 'yellow', :notify => 0, :message_format => 'html'}.merge(options)
+    mock(HipChat::Room).post("/message",
+                             :query => {:auth_token => "blah"},
+                             :body  => {:room_id => "Hipchat",
+                                        :from    => "Dude",
+                                        :message => "Hello world",
+                                        :message_format => options[:message_format],
+                                        :color   => options[:color],
+                                        :notify  => options[:notify]}) {
+      OpenStruct.new(:code => 200)
+    }
+  end
+
+  def mock_successful_topic_change(topic, options={})
+    options = {:from => 'API'}.merge(options)
+    mock(HipChat::Room).post("/topic",
+                             :query => {:auth_token => "blah"},
+                             :body  => {:room_id => "Hipchat",
+                                        :from    => options[:from],
+                                        :topic   => "Nice topic" } ) {
+      OpenStruct.new(:code => 200)
+    }
+  end
+
+  def mock_successful_history(options={})
+    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge(options)
+    canned_response = File.new File.expand_path(File.dirname(__FILE__) + '/example/history.json')
+    stub_request(:get, "https://api.hipchat.com/v1/rooms/history").with(:query => {:auth_token => "blah",
+                                   :room_id    => "Hipchat",
+                                   :date       => options[:date],
+                                   :timezone   => options[:timezone],
+                                   :format     => options[:format]}).to_return(canned_response)
+  end
+
+  describe "#history" do
+    it "is successful without custom options" do
+      mock_successful_history()
+
+      room.history().should be_true
+    end
+
+    it "is successful with custom options" do
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19')
+      room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19').should be_true
+    end
+
+    it "fails when the room doen't exist" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.history }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "fails when we're not allowed to do so" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.history }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "fails if we get an unknown response code" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.history }.
+        should raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
+  describe "#topic" do
+    it "is successful without custom options" do
+      mock_successful_topic_change("Nice topic")
+
+      room.topic("Nice topic").should be_true
+    end
+
+    it "is successful with a custom from" do
+      mock_successful_topic_change("Nice topic", :from => "Me")
+
+      room.topic("Nice topic", :from => "Me").should be_true
+    end
+
+    it "fails when the room doesn't exist" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.topic "" }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "fails when we're not allowed to do so" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.topic "" }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "fails if we get an unknown response code" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.topic "" }.
+        should raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
+  describe "sends a message to a room" do
+    it "successfully without custom options" do
+      mock_successful_send 'Dude', 'Hello world'
+
+      room.send("Dude", "Hello world").should be_true
+    end
+
+    it "successfully with notifications on as option" do
+      mock_successful_send 'Dude', 'Hello world', :notify => 1
+
+      room.send("Dude", "Hello world", :notify => true).should be_true
+    end
+
+    it "successfully with custom color" do
+      mock_successful_send 'Dude', 'Hello world', :color => 'red'
+
+      room.send("Dude", "Hello world", :color => 'red').should be_true
+    end
+
+    it "successfully with text message_format" do
+      mock_successful_send 'Dude', 'Hello world', :message_format => 'text'
+
+      room.send("Dude", "Hello world", :message_format => 'text').should be_true
+    end
+
+    it "but fails when the room doesn't exist" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.send "", "" }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.send "", "" }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if the username is more than 15 chars" do
+      lambda { room.send "a very long username here", "a message" }.should raise_error(HipChat::UsernameTooLong)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.send "", "" }.
+        should raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
+  describe 'http_proxy' do
+    let(:proxy_user) { 'proxy_user' }
+    let(:proxy_pass) { 'proxy_pass' }
+    let(:proxy_host) { 'proxy.example.com' }
+    let(:proxy_port) { 2649 }
+    let(:proxy_url) { "http://#{proxy_user}:#{proxy_pass}@#{proxy_host}:#{proxy_port}" }
+
+    context 'specified by option of constructor' do
+      before do
+        HipChat::Client.new("blah", :http_proxy => proxy_url)
+      end
+
+      subject { HipChat::Client.default_options }
+
+      specify "Client's proxy settings should be changed" do
+        expect(subject[:http_proxyaddr]).to eql(proxy_host)
+        expect(subject[:http_proxyport]).to eql(proxy_port)
+        expect(subject[:http_proxyuser]).to eql(proxy_user)
+        expect(subject[:http_proxypass]).to eql(proxy_pass)
+      end
+
+      describe "Room class's proxy" do
+        subject { HipChat::Room.default_options }
+
+        specify "proxy settings should be changed" do
+          expect(subject[:http_proxyaddr]).to eql(proxy_host)
+          expect(subject[:http_proxyport]).to eql(proxy_port)
+          expect(subject[:http_proxyuser]).to eql(proxy_user)
+          expect(subject[:http_proxypass]).to eql(proxy_pass)
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hipchat-chef'
+require 'rspec'
+require 'rspec/autorun'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: hipchat-chef
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- HipChat/Atlassian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+description: Ruby library to interact with HipChat
+email:
+- support@hipchat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- hipchat-chef.gemspec
+- lib/hipchat-chef.rb
+- lib/hipchat-chef/capistrano.rb
+- lib/hipchat-chef/chef.rb
+- lib/hipchat-chef/rails3_tasks.rb
+- lib/hipchat-chef/railtie.rb
+- lib/hipchat-chef/version.rb
+- spec/example/history.json
+- spec/hipchat_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/hipchat/hipchat-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby library to interact with HipChat
+test_files:
+- spec/example/history.json
+- spec/hipchat_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb