added fetch functionality. no longer in alpha status.

Author: sethvargo

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 CustomInk
+Copyright (c) 2012 Seth Vargo and CustomInk, LCC
 
 MIT License
 

README.md

@@ -26,7 +26,7 @@ require 'chefspec'
 
 describe 'awesome_cookbook::default' do
   before do
-    Fauxhai.mock(url:'server01.example.com')
+    Fauxhai.fetch(host:'server01.example.com')
   end
 
   it 'should install awesome' do
@@ -78,12 +78,16 @@ The `node` block variable allows you to set any Ohai attribute on the mock that
 ### Fetching
 Alternatively, if you do not want to mock the data, Fauxhai provides a `fetch` mechanism for collecting "real" ohai data from a remote server or local file. Maybe you want to test against the fully-replicated environment for a front-facing server in your pool. Just pass in the `url` option instead of a `platform`:
 
+The `fetch` method supports all the same options as the Net-SSH command, such as `:user`, `:password`, `:key_file`, etc.
+
+The `fetch` method will cache the JSON file in a temporary path on your local machine. Similar to gems like VCR, this allows fauxhai to use the cached copy, making your test suite run faster. You can optionally force a cache miss by passing the `:force_cache_miss => true` option to the `fetch` initializer. **Because this is real data, there may be a security concern. Secure your laptop accordingly.**
+
 ```ruby
 require 'chefspec'
 
 describe 'awesome_cookbook::default' do
   before do
-    Fauxhai.mock(url:'server01.example.com')
+    Fauxhai.fetch(host:'server01.example.com')
   end
 
   it 'should install awesome' do
@@ -103,7 +107,7 @@ require 'chefspec'
 
 describe 'awesome_cookbook::default' do
   before do
-    Fauxhai.mock(url:'server01.example.com') do |node|
+    Fauxhai.fetch(host:'server01.example.com') do |node|
       node['languages']['ruby']['version'] = 'ree'
     end
   end

examples/chefspec.md

@@ -48,7 +48,7 @@ require 'chefspec'
 
 describe 'awesome_cookbook::default' do
   before do
-    Fauxhai.mock(url:'server01.example.com')
+    Fauxhai.fetch(host:'server01.example.com')
   end
 end
 ```
@@ -60,7 +60,7 @@ require 'chefspec'
 
 describe 'awesome_cookbook::default' do
   before do
-    Fauxhai.mock(url:'server01.example.com') do |node|
+    Fauxhai.fetch(host:'server01.example.com') do |node|
       node['languages']['ruby']['version'] = 'ree'
     end
   end

examples/rspec-chef.md

@@ -45,7 +45,7 @@ Fetching a Remote Box
 ---------------------
 ```ruby
 describe 'foo::bar' do
-  let(:json_attributes) { Fauxhai.mock(url:'server01.example.com' }
+  let(:json_attributes) { Fauxhai.fetch(host:'server01.example.com' }
 end
 ```
 
@@ -54,7 +54,7 @@ Fetching a Remote Box with custom Ruby Version
 ```ruby
 describe 'foo::bar' do
   let(:json_attributes) do
-    Fauxhai.mock(url:'server01.example.com') do |node|
+    Fauxhai.fetch(host:'server01.example.com') do |node|
       node['languages']['ruby']['version'] = 'ree'
     end
   end

fauxhai.gemspec

@@ -2,18 +2,19 @@ lib = File.expand_path('../lib', __FILE__)
 $:.unshift(lib) unless $:.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.version       = '0.0.2.alpha'
-  gem.authors       = ["Seth Vargo"]
-  gem.email         = ["[email protected]"]
+  gem.version       = '0.0.1'
+  gem.authors       = ['Seth Vargo']
+  gem.email         = ['[email protected]']
   gem.description   = %q{Easily mock out ohai data}
   gem.summary       = %q{Fauxhai provides an easy way to mock out your ohai data for testing with chefspec!}
-  gem.homepage      = ""
+  gem.homepage      = 'https://github.com/customink/fauxhai'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "fauxhai"
-  gem.require_paths = ["lib"]
+  gem.name          = 'fauxhai'
+  gem.require_paths = ['lib']
 
   gem.add_runtime_dependency 'chef'
+  gem.add_runtime_dependency 'net-ssh'
 end

lib/fauxhai.rb

@@ -1,12 +1,17 @@
 module Fauxhai
   require 'fauxhai/exception'
-  require 'fauxhai/mock'
+  require 'fauxhai/fetcher'
+  require 'fauxhai/mocker'
 
   def self.root
     @@root ||= File.expand_path('../../', __FILE__)
   end
 
   def self.mock(*args)
-    Fauxhai::Mock.new(*args)
+    Fauxhai::Mocker.new(*args)
+  end
+
+  def self.fetch(*args)
+    Fauxhai::Fetcher.new(*args)
   end
 end

lib/fauxhai/fetcher.rb

@@ -0,0 +1,78 @@
+require 'digest/sha1'
+require 'json'
+require 'net/ssh'
+
+module Fauxhai
+  class Fetcher
+    def initialize(options = {}, &override_attributes)
+      @options = options
+
+      if !force_cache_miss? && cached?
+        @data = cache
+      else
+        Net::SSH.start(host, user, @options) do |ssh|
+          @data = JSON.parse(ssh.exec!('ohai'))
+        end
+
+        # cache this data so we do not have to SSH again
+        File.open(cache_file, 'w+'){ |f| f.write(@data.to_json) }
+      end
+
+      yield(@data) if block_given?
+
+      if defined?(ChefSpec)
+        data = @data
+        ::ChefSpec::ChefRunner.send :define_method, :fake_ohai do |ohai|
+          data.each_pair do |attribute,value|
+            ohai[attribute] = value
+          end
+        end
+      end
+
+      @data
+    end
+
+    def cache
+      @cache ||= JSON.parse(File.read(cache_file))
+    end
+
+    def cached?
+      File.exists?(cache_file)
+    end
+
+    def cache_key
+      Digest::SHA2.hexdigest("#{user}@#{host}")
+    end
+
+    def cache_file
+      File.expand_path( File.join(Fauxhai.root, 'tmp', cache_key) )
+    end
+
+    def force_cache_miss?
+      @force_cache_miss ||= @options.delete(:force_cache_miss) || false
+    end
+
+    # Return the given `@data` attribute as a Ruby hash instead of a JSON object
+    #
+    # @return [Hash] the `@data` represented as a Ruby hash
+    def to_hash(*args)
+      @data.to_hash(*args)
+    end
+
+    def to_s
+      "#<Fauxhai::Fetcher @host=#{host}, @options=#{@options}>"
+    end
+
+    private
+    def host
+      @host ||= begin
+        raise ArgumentError, ':host is a required option for Fauxhai.fetch' unless @options[:host]
+        @options.delete(:host)
+      end
+    end
+
+    def user
+      @user ||= (@options.delete(:user) || ENV['USER'] || ENV['USERNAME']).chomp
+    end
+  end
+end

lib/fauxhai/mock.rb lib/fauxhai/mocker.rb

@@ -1,7 +1,7 @@
 require 'json'
 
 module Fauxhai
-  class Mock
+  class Mocker
     def initialize(options = {}, &override_attributes)
       @options = options