searchef 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchef.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fletcher Nichol
+
+MIT License
+
+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,55 @@
+# Searchef
+
+Stub your Chef searches with pre-canned responses. Good for use when unit
+testing or dummying out a Chef run that uses search calls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'searchef'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install searchef
+
+## Usage
+
+Require the library and include the `Searchef::API` module for convenience:
+
+```ruby
+require 'searchef'
+
+include Searchef::API
+```
+
+```ruby
+# stub search for all nodes with the `web_node` role in their run list
+stub_search(:node, "roles:web_node").to_return([
+  node_stub("web1.example.com"),
+  node_stub("web2.example.com")
+])
+
+require 'chef/search/query'
+
+# if running in pry, let's set a node name for signing requests
+Chef::Config[:node_name] = "durr"
+
+# run the search
+query = Chef::Search::Query.new
+query.search(:node, "roles:web_node")
+
+# => [[node[web1.example.com], node[web2.example.com]], 0, 2]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/searchef.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'searchef/api'
+require 'searchef/node_stub_creator'
+require 'searchef/search_stub'
+require "searchef/version"
+
+module Searchef
+end

data/lib/searchef/api.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Searchef
+
+  module API
+
+    extend self
+
+    def stub_search(type, query = nil, sort = nil, start = nil, rows = nil, &block)
+      SearchStub.new(type, query, sort, start, rows)
+    end
+
+    def node_stub(name, options = {}, &block)
+      NodeStubCreator.new(name, options, &block).create
+    end
+  end
+end

data/lib/searchef/node_stub_creator.rb

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'chef/platform'
+require 'chef/node'
+require 'fauxhai'
+
+module Searchef
+
+  class NodeStubCreator
+
+    def initialize(name, options = {}, &block)
+      @name       = name
+      @attrs      = options[:attrs] || Hash.new
+      @ohai       = options[:ohai] || Hash.new
+      @platform   = options[:platform] || "ubuntu"
+      @version    = options[:version] || "12.04"
+      @node_block = block if block_given?
+    end
+
+    def create
+      node = Chef::Node.new
+      node.name(name)
+      node.consume_external_attrs(ohai_data, attr_data)
+      node.instance_eval(&node_block) unless node_block.nil?
+      node
+    end
+
+    private
+
+    attr_reader :name, :attrs, :ohai, :platform, :version, :node_block
+
+    def ohai_data
+      fauxhai = Fauxhai.mock(:platform => platform, :version => version).data
+      Mash.new(fauxhai.merge(ohai))
+    end
+
+    def attr_data
+      Mash.new(attrs)
+    end
+  end
+end

data/lib/searchef/search_stub.rb

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'webmock'
+require 'uri'
+
+module Searchef
+
+  class SearchStub
+
+    include WebMock::API
+
+    def initialize(type, query, sort, start, rows)
+      @type = type
+      @params = Hash.new
+      @params["q"]      = query       if query
+      @params["sort"]   = sort        if sort
+      @params["start"]  = start.to_s  if start
+      @params["rows"]   = rows.to_s   if rows
+    end
+
+    def to_return(objects)
+      stub_request(:get, %r{/search/#{type}}).
+        with(:query => hash_including(params)).
+        to_return(:headers => response_headers, :body => response_body(objects))
+    end
+
+    private
+
+    attr_reader :type, :params
+
+    def escape(string)
+      string && URI.escape(string.to_s)
+    end
+
+    def response_headers
+      { 'Content-Type' => 'application/json; charset=utf-8' }
+    end
+
+    def response_body(objects)
+      # calling Arrray(objects) converts Chef::Node to an Array of attributes
+      # which is not what we want
+      objects = [objects] unless objects.is_a?(Array)
+
+      response = Hash.new
+      response["rows"] = objects
+      response["total"] = response["rows"].length
+      response["start"] = 0
+      response.to_json
+    end
+  end
+end

data/lib/searchef/version.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Searchef
+  VERSION = "0.1.0"
+end

data/searchef.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'searchef/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "searchef"
+  gem.version       = Searchef::VERSION
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.description   = %q{Stub Chef Search!}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/fnichol/searchef"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = []
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'chef'
+  gem.add_runtime_dependency 'webmock'
+  gem.add_runtime_dependency 'fauxhai'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: searchef
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Fletcher Nichol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fauxhai
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stub Chef Search!
+email:
+- fnichol@nichol.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/searchef.rb
+- lib/searchef/api.rb
+- lib/searchef/node_stub_creator.rb
+- lib/searchef/search_stub.rb
+- lib/searchef/version.rb
+- searchef.gemspec
+homepage: https://github.com/fnichol/searchef
+licenses: []
+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: 2900810078172785449
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2900810078172785449
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stub Chef Search!
+test_files: []