chef-helpers 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjNkNmNmOWZmMGEzN2UyNmJlMDE1ZWFlMTEzYmU0YTEzZmNkOTVhYw==
+  data.tar.gz: !binary |-
+    NWI5MmQxZDRjNmQ0NTc1MjNlMmFmNGQzZDQ5OWE0MWFlZTVlYWQ1Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTVhY2M5MzBkMzFlNjUzM2MxYjFjYzM0ZjY4NzFiNGZiNjY2OTg1NGVlNjg5
+    MzRhMTg2MWNhY2JlMDI3NGE4NzUwY2MwYTRiNjJmYTk4MjRkODA4NTU4MDZj
+    NTY2NGYzYTNjNDMyZWIyMGFjNDg0NTZjZTk1MzI4Y2I5YWNlZTc=
+  data.tar.gz: !binary |-
+    MDRlMDhmMmQyOGViNzgzZmRhM2JmODUwZjc0OGE0ZWI5YjU2YmU5MzA5MTBk
+    NDg1YjhhYjc0NjhlZDA5MmM2MTJjMzZmOWM5M2ZjMmI2NGUyNDM2MDBhOTNh
+    OTVhYTYxZTU0YzAzZDRjNWIyMTAxZWYzM2Y0ODFiY2NhNzczZmU=

data/README.md

@@ -4,26 +4,78 @@ This gem includes miscellaneous add-on helper methods for Opscode Chef.
 
 ## Installation
 
-To use helper methods in your Chef recipes, add `chef_gem
-'chef-helpers'` and `require 'chef-helpers'` in your recipes.
+To use helper methods in your Chef recipes, use following code in your
+recipe:
 
-To use methods locally in `knife exec` scripts or Knife plugins, add
-this line to your application's Gemfile:
+```ruby
+chef_gem 'chef-helpers'
+require 'chef-helpers'
+```
 
-    gem 'chef-helpers'
+To use the helpers locally in `knife exec` scripts or Knife plugins,
+just add the `chef-helpers` gem to your dependencies and `require 'chef-helpers'`.
 
-And then execute:
+## Usage
 
-    $ bundle
+Detailed documentation of the helper methods can be seen at
+http://rdoc.info/github/3ofcoins/chef-helpers/
 
-Or install it yourself as:
+### Finding existing templates and cookbook files
 
-    $ gem install chef-helpers
+The recipe DSL is extended with `ChefHelpers::HasSource` module that
+provides methods for checking which templates and cookbook files exist
+on the Chef server. Detailed docs are available at
+http://rdoc.info/github/3ofcoins/chef-helpers/ChefHelpers/HasSource
 
-## Usage
+### Chef::Node#allies
 
-Detailed documentation of the helper methods can be seen at
-http://rdoc.info/github/3ofcoins/chef-helpers/
+The `node.allies` method returns an array of node's *allies*.  These
+are: all nodes in the same environment (if the environment is not
+`_default`), plus nodes specified by `allies` attribute. The `allies`
+attribute - if set - should be an array of node names or node search
+queries; the named nodes and search results will be added to node's
+allies.
+
+This is mostly useful when defining firewall or other access rules, to
+easily limit access to insides of a cluster plus a handful of friendly
+machines.
+
+### Chef::Node#ip_for
+
+The `node.ip_for(other_node)` method decides, which IP address should
+the node use to contact the other node, and returns this IP as a
+string. It is particularly useful when your setup spans across cloud
+availability zones or different providers. At the moment only EC2 and
+nodes with public `ipaddress` are supported; suggestions are welcome.
+
+If both nodes are on EC2 and in the same region, then other node's
+`ec2.local_ipv4` attribute is used. Otherwise, if other node is a
+cloud instance, its `cloud_public.ipv4` attribute is used. Otherwise,
+other node's `ipaddress` is used.
+
+### JSONPath access to attributes
+
+The `Chef::Node` class is monkey-patched to allow easy deep access to
+the attributes using the
+[JSONPath](http://goessner.net/articles/JsonPath/) syntax:
+
+```
+chef > require 'chef-helpers'
+ => true 
+chef > node['$..name']
+ => ["portinari-2.local", "Java(TM) SE Runtime Environment", "Java HotSpot(TM) 64-Bit Server VM", "Darwin"] 
+chef > node['$.kernel.name']
+ => ["Darwin"] 
+```
+
+Regular access to attributes is preserved; JSONPath is used only when
+the attribute name starts with `$` character, or if a `JSONPath`
+instance is used for indexing.
+
+The [jsonpath gem](https://github.com/joshbuddy/jsonpath) is used for
+the implementation. While the original gem allows modification, it's
+not straightforward to achieve with Chef's attributes, so only reading
+attributes with JSONPath is supported.
 
 ## Contributing
 

data/chef-helpers.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = ChefHelpers::VERSION
 
   gem.add_dependency "chef"
+  gem.add_dependency "jsonpath"
 end

data/lib/chef-helpers/has_source.rb

@@ -67,9 +67,9 @@ module ChefHelpers
         end
       sources.find do |source|
         if source =~ /::/
-          src, ckbk = $`, $'
+          ckbk, src = $`, $'
         else
-          src, ckbk = source, cookbook_name
+          ckbk, src = cookbook_name, source
         end
         has_source?(src, segment, ckbk)
       end

data/lib/chef-helpers/node.rb

@@ -1,4 +1,5 @@
 require 'chef/node'
+require 'jsonpath'
 
 class Chef::Node
 
@@ -7,14 +8,14 @@ class Chef::Node
   # attribute. The `allies` attribute - if set - should be an array of
   # node names or node search queries; the named nodes and search
   # results will be added to node's allies.
-  # 
+  #
   # This is mostly useful when defining firewall or other access
   # rules, to easily limit access to insides of a cluster plus a
   # handful of friendly machines.
   #
   # @return [Array<Chef::Node>] Array of node's "allies".
   def allies
-    @allies ||= 
+    @allies ||=
       begin
         rv = []
         q =  Chef::Search::Query.new
@@ -30,12 +31,12 @@ class Chef::Node
   end
 
   # Find out, which IP should be used to contact with other node.
-  # 
+  #
   # If both nodes are on EC2 and in the same region, then other node's
   # `ec2.local_ipv4` attribute is used. Otherwise, if other node is a
   # cloud instance, its `cloud_public.ipv4` attribute is
   # used. Otherwise, other node's `ipaddress` is used.
-  # 
+  #
   # @note This method may return wrong IP with non-EC2 cloud
   #       providers, and can use some tweaking for such cases.
   # @param [Chef::Node] other_node Node, whose IP we need to know
@@ -51,4 +52,15 @@ class Chef::Node
       other_node['ipaddress']
     end
   end
+
+  # jsonpath access to node attributes
+  def brackets_with_jsonpath(key)
+    case key
+    when JsonPath then key.on(self.to_hash)
+    when /^\$/    then JsonPath.on(self.to_hash, key)
+    else               self.brackets_without_jsonpath(key)
+    end
+  end
+  alias_method :brackets_without_jsonpath, :[]
+  alias_method :[], :brackets_with_jsonpath
 end

data/lib/chef-helpers/version.rb

@@ -1,3 +1,3 @@
 module ChefHelpers
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: chef-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Maciej Pasternacki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,20 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  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
@@ -47,33 +58,26 @@ files:
 - lib/chef-helpers/version.rb
 homepage: https://github.com/3ofcoins/chef-helpers/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2272563809326156327
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2272563809326156327
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helper methods for Opscode Chef
 test_files: []
 has_rdoc: