hipchat2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf3848491ea3b3b22a1c380891e8af9c924ea715
+  data.tar.gz: 6aab7c5a3e0f9311e01560cb8cef89897cef4a1e
+SHA512:
+  metadata.gz: dd3a0849a4f7b66a933a392369422672b547579eb158f65e966350ba4ec8f28a2615e3312130f6a5a12b1dc238a5b128456edd5b010d0dbdd064687cf44d3fd6
+  data.tar.gz: ce7fc985b3fa31593c79c57ddb82121447c756b83cdd0e645beee010f7f24266c7023fd3e07968e262052855c48473d05464ee16e0f5db6286e96a94f2ce900b

data/.document

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

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Mojo Tech
+Copyright (c) 2013 Dmitry Rybakov
+
+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,87 @@
+HipChat2 Wrapper
+===============
+
+A very basic wrapper for the HipChat HTTP API that uses hipchat API v2
+
+Usage
+-----
+
+```ruby
+client = HipChat2::Client.new(api_token)
+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')
+```
+
+Capistrano
+----------
+
+```ruby
+require 'hipchat/capistrano'
+
+set :hipchat_token, "<your token>"
+set :hipchat_room_name, "Your room"
+set :hipchat_announce, false # notify users
+set :hipchat_color, 'green' # finished deployment message color
+set :hipchat_failed_color, 'red' # cancelled deployment message color
+```
+
+### Who did it?
+
+To determine the user that is currently running the deploy, the
+capistrano tasks will look for the following:
+
+1.  The $HIPCHAT\_USER environment variable
+2.  The hipchat\_human capistrano var.
+3.  The git user.name var.
+4.  The \$USER environment variable.
+
+Rails 3 Rake Task
+-----------------
+
+Send a message using a rake task:
+
+    rake hipchat:send["hello world"]
+
+Options like the room, API token, user name and notification flag can be
+set in YAML.
+
+RAILS\_ROOT/config/hipchat.yml:
+
+```yaml
+token: <your token>
+room: Your room
+user: Your name” # Default to `whoami`
+notify: true # Defaults to false
+```
+
+Engine Yard
+-----------
+
+Use a [deploy hook][] to send messages from Engine Yard’s Cloud
+platform.
+
+RAILS\_ROOT/deploy/after\_restart.rb:
+
+```ruby
+on_app_master do
+ message = "Deploying revision #{revision[0…6]} to #{node[:environment][:name]}"
+ message += " " 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
+```
+
+Copyright
+---------
+
+Copyright © 2010 Mojo Tech. See LICENSE for details.
+Copyright © 2013 Dmitry Rybakov. See LICENSE for details.
+
+  [deploy hook]: http://bit.ly/qnbIkP

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hipchat"
+    gem.summary = %Q{Ruby library to interact with HipChat}
+    gem.description = %Q{Ruby library to interact with HipChat}
+    gem.email = "gems@mojotech.com"
+    gem.homepage = "http://github.com/mojotech/hipchat"
+    gem.authors = ["MojoTech"]
+    gem.add_dependency "httparty"
+    gem.add_development_dependency "rspec", "~> 2.0"
+    gem.add_development_dependency "rr", "~> 1.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hipchat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/hipchat2.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hipchat2"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["MojoTech", "Dmitry Rybakov"]
+  s.date = "2013-11-29"
+  s.description = "Ruby library to interact with HipChat"
+  s.email = "dmitry.rybakov@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "hipchat2.gemspec",
+    "lib/hipchat2.rb",
+    "lib/hipchat2/capistrano.rb",
+    "lib/hipchat2/chef.rb",
+    "lib/hipchat2/rails3_tasks.rb",
+    "lib/hipchat2/railtie.rb",
+    "spec/hipchat2_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/comandeo/hipchat"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby library to interact with HipChat"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<rr>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<rr>, ["~> 1.0"])
+  end
+end
+

data/lib/hipchat2/capistrano.rb

@@ -0,0 +1,95 @@
+require 'hipchat2'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :hipchat_send_notification, false
+  set :hipchat_with_migrations, false
+
+  namespace :hipchat do
+    task :set_client do
+      set :hipchat_client, HipChat2::Client.new(hipchat_token)
+    end
+
+    task :trigger_notification do
+      set :hipchat_send_notification, true
+    end
+
+    task :configure_for_migrations do
+      set :hipchat_with_migrations, true
+    end
+
+    task :notify_deploy_started do
+      if hipchat_send_notification
+        on_rollback do
+          send_options.merge!(:color => failed_message_color)
+          hipchat_client[hipchat_room_name].
+            send(deploy_user, "#{human} cancelled deployment of #{deployment_name} to #{env}.", send_options)
+        end
+
+        message = "#{human} is deploying #{deployment_name} to #{env}"
+        message << " (with migrations)" if hipchat_with_migrations
+        message << "."
+
+        hipchat_client[hipchat_room_name].send(deploy_user, message, send_options)
+      end
+    end
+
+    task :notify_deploy_finished do
+      hipchat_client[hipchat_room_name].
+        send(deploy_user, "#{human} finished deploying #{deployment_name} to #{env}.", send_options)
+    end
+
+    def send_options
+      return @send_options if defined?(@send_options)
+      @send_options = message_color ? {:color => message_color} : {}
+      @send_options.merge!(:notify => message_notification)
+      @send_options
+    end
+
+    def deployment_name
+      if branch
+        "#{application}/#{branch}"
+      else
+        application
+      end
+    end
+
+    def message_color
+      fetch(:hipchat_color, nil)
+    end
+
+    def failed_message_color
+      fetch(:hipchat_failed_color, "red")
+    end
+
+    def message_notification
+      fetch(:hipchat_announce, false)
+    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 "hipchat:notify_deploy_started", "hipchat:set_client"
+  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/hipchat2/chef.rb

@@ -0,0 +1,31 @@
+require 'hipchat2'
+
+#
+# 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 HipChat2
+  class NotifyRoom < Chef::Handler
+
+    def initialize(api_token, room_name, notify_users=false)
+      @api_token = api_token
+      @room_name = room_name
+      @notify_users = notify_users
+    end
+
+    def report
+      msg = "Failure on #{node.name}: #{run_status.formatted_exception}"
+
+      client = HipChat2::Client.new(@api_token)
+      client[@room_name].send('Chef', msg, :notify => @notify_users)
+    end
+  end
+end

data/lib/hipchat2/rails3_tasks.rb

@@ -0,0 +1,38 @@
+require 'hipchat2'
+
+namespace :hipchat do
+  desc "Sends a HipChat message as a particular user"
+  task :send do
+    required_options = [:message, :room, :token, :user]
+    config_file      = Rails.root.join 'config', 'hipchat.yml'
+
+    options = {
+      :message => ENV['MESSAGE'],
+      :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? }
+
+    if File.exists? config_file
+      options.reverse_merge! YAML.load_file(config_file).symbolize_keys
+    end
+
+    options.reverse_merge! system_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 = HipChat2::Client.new(options[:token])
+
+    client[options[:room]].send(options[:user], options[:message], :notify => options[:notify])
+  end
+end

data/lib/hipchat2/railtie.rb

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

data/lib/hipchat2.rb

@@ -0,0 +1,84 @@
+require 'httparty'
+require 'ostruct'
+
+require 'hipchat/railtie' if defined?(Rails::Railtie)
+
+module HipChat2
+  class UnknownRoom         < StandardError; end
+  class Unauthorized        < StandardError; end
+  class UnknownResponseCode < StandardError; end
+
+  class Client
+
+    def initialize(token)
+      @token = token
+    end
+
+    def [](name)
+      Room.new(@token, :room_id => name)
+    end
+
+  end
+
+  class Room < OpenStruct
+    include HTTParty
+
+    base_uri 'https://api.hipchat.com/v2/room'
+
+    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 = {})
+      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("/#{room_id}/notification",
+        :headers => { 'Content-type' => 'application/json' },
+        :query => { :auth_token => @token },
+        :body  => {
+          :message => message,
+          :notify  => options[:notify],
+          :color => options[:color]
+        }.to_json
+      )
+
+      case response.code
+      when 200, 204 then 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
+  end
+end

data/spec/hipchat2_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe HipChat2 do
+  subject { HipChat2::Client.new("blah") }
+
+  let(:room_name) { "Hipchat"}
+  let(:room) { subject[room_name] }
+
+  # Helper for mocking room message post requests
+  def mock_successful_send(from, message, options={})
+    options = {:color => 'yellow', :notify => false}.merge(options)
+    mock(HipChat2::Room).post("/#{room_name}/notification",
+
+        :headers => { 'Content-type' => 'application/json' },
+        :query => { :auth_token => 'blah' },
+        :body  => {
+          :message => message,
+          :notify  => options[:notify],
+          :color => options[:color]
+        }.to_json
+                            ) {
+      OpenStruct.new(:code => 200)
+    }
+  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 => true
+
+      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 "but fails when the room doesn't exist" do
+      mock(HipChat2::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.send "", "" }.should raise_error(HipChat2::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat2::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.send "", "" }.should raise_error(HipChat2::Unauthorized)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat2::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.send "", "" }.
+        should raise_error(HipChat2::UnknownResponseCode)
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hipchat2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- MojoTech
+- Dmitry Rybakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby library to interact with HipChat
+email: dmitry.rybakov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .document
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- hipchat2.gemspec
+- lib/hipchat2.rb
+- lib/hipchat2/capistrano.rb
+- lib/hipchat2/chef.rb
+- lib/hipchat2/rails3_tasks.rb
+- lib/hipchat2/railtie.rb
+- spec/hipchat2_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/comandeo/hipchat
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 3
+summary: Ruby library to interact with HipChat
+test_files: []
+has_rdoc: