timed_rest_for_chef 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,43 @@
+TimedRestForChef
+================
+
+This is a patching library to wrap REST calls in a
+timeout to prevent hung chef processes.
+
+Usage
+=====
+
+This library can be used in one of two ways:
+
+1. A cookbook recipe can load it via chef_gem
+2. The library can be required via the client.rb file
+
+The first method would have something like this in a recipe:
+
+```ruby
+chef_gem 'timed_rest_for_chef'
+require 'timed_rest_for_chef'
+```
+
+The downside of this method is that REST calls will not be wrapped
+until chef gets to that recipe. This means all previous calls could
+hang the chef process.
+
+Using the second method, the gem will need to be available to chef, 
+and a new line added to the client.rb file:
+
+```ruby
+# /etc/chef/client.rb
+require 'timed_rest_for_chef'
+...
+```
+
+Ensuring the gem is available to chef and that client.rb file has the
+proper require line can be automated via the chef-client cookbook with
+slight modifications.
+
+References:
+===========
+
+* Ticket: http://tickets.opscode.com/browse/CHEF-2944
+* chef-client cookbook: https://github.com/opscode-cookbooks/chef-client/pull/12 

data/lib/timed_rest_for_chef.rb

@@ -1,7 +1,10 @@
 require 'timeout'
 require 'chef/rest/rest_request'
 
+# Be optimistic for when this will get patched. We can release and
+# updated gem if it doesn't make it until a later version
 if(Gem::Version.new(Chef::VERSION) < Gem::Version.new('10.14.0'))
+  Chef::Log.info "*** Adding timeout wrapper around REST requests"
 
   # Custom timeout class to make it easy to log
   # this specific type of timeout

data/timed_rest_for_chef.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'timed_rest_for_chef'
-  s.version = '0.0.2'
+  s.version = '0.0.3'
   s.summary = 'Timed REST for Chef'
   s.author = 'Chris Roberts'
   s.email = 'chrisroberts.code@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timed_rest_for_chef
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: