Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


hipchat (2) Versions 0.4.0

LWRP for sending messages to HipChat rooms

cookbook 'hipchat', '~> 0.4.0', :supermarket
cookbook 'hipchat', '~> 0.4.0'
knife supermarket install hipchat
knife supermarket download hipchat
Quality 17%



This cookbook provides a hipchat_msg resource, making it easier for chef recipes to send messages to a chat room on Atlassian's HipChat service.


Should work on any platform where Chef runs. Tested on Ubuntu.


  • Chef version 11.10 or greater (JSON gem version conflicts)
  • Authentication token for an existing HipChat account.
  • 'hipchat' gem (automatically installed by this cookbook's default recipe).


  • speak - do it (the default)
  • nothing - don't do it


  • api_version - version of hipchat api to use. allowed values are 'v1' and 'v2' (defaults to 'v1').
  • room - the name of the room you would like to speak into (requied).
  • token - authentication token for your HipChat account (required). Please note that auth tokens are tied to api versions (e.g. v1 tokens will not work with v2 api).
  • nickname - the nickname to be used when speaking the message (required).
  • message - the message to speak. If a message is not specified, the name of the hipchat_msg resource is used.
  • notify - toggles whether or not users in the room should be notified by this message (defaults to true).
  • color - sets the color of the message in HipChat. Supported colors include: yellow, red, green, purple, or random (defaults to yellow).
  • failure_ok - toggles whether or not to catch the exception if an error is encountered connecting to HipChat (defaults to true).

Usage example

include_recipe 'hipchat'

hipchat_msg 'bad news' do
  room 'The Pod Bay'
  token '0xdedbeef0xdedbeef0xdedbeef'
  nickname 'HAL9000'
  message "Sorry Dave, I'm afraid I can't do that: #{some_error}"
  color 'red'

License and Author

Author:: Cameron Johnston

Copyright:: 2012, Cameron Johnston

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.



  • Support version 2 of HipChat's API, as well as private HipChat server URLs.
    • hipchat gem version updated to 1.2.0
    • Version 1 API is still the default but expect this to change in a future release.
  • test-kitchen suites now expect HIPCHAT_TEST_V1_TOKEN and HIPCHAT_TEST_V2_TOKEN environment variables


  • Extend handler to allow configuration of name, color and notification
  • Never actually published to the supermarket.


  • Added test-kitchen. Export HIPCHAT_TEST_ROOM and HIPCHAT_TEST_TOKEN env vars when running test-kitchen
  • Explicity installing httparty ~> 0.11.0 due to json gem conflicts introduced in newer versions


  • Now using chef_gem resource to install hipchat gem, instead of gem_package resource.


  • A git mishap necessitated the release of this version. No changes to code.


  • notify now defaults to true, fixed using resource name as message body when no message is specified


  • Adding support for specifying message color


  • First public release


Consider using HTMLEntities or similar to encode messages before sending them.

Collaborator Number Metric

0.4.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

0.4.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

0.4.0 failed this metric

FC064: Ensure issues_url is set in metadata: hipchat/metadata.rb:1
FC065: Ensure source_url is set in metadata: hipchat/metadata.rb:1
FC066: Ensure chef_version is set in metadata: hipchat/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: hipchat/metadata.rb:1
FC068: Ensure license is set in metadata: hipchat/metadata.rb:1
FC069: Ensure standardized license defined in metadata: hipchat/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: hipchat/resources/msg.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: hipchat/providers/msg.rb:24
FC121: Cookbook depends on cookbook made obsolete by Chef 14: hipchat/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric

0.4.0 passed this metric

Testing File Metric

0.4.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

0.4.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number