knife-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 158d503433c25d5538023b080a366051098ad155
+  data.tar.gz: 4065edc3773299e2834ada16861d430d9c6250ac
+SHA512:
+  metadata.gz: 42f944444499e3dfe47f0f1d939343b59c706ebb91778537c3e93077437708b90e97b524cbef25230c8646ccb48bf3fee9fc85a6edc5573d76a7746db0a853f8
+  data.tar.gz: 2b646c315f0a6f055d2c45f49a8f3407eabe6c9dd808b6cf37626cb98fc2cca7a6b4b26874ead5ce474645b7cc9c94eafef31910887b8283e4e7ebd59a90c994

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'json', '1.8.1'
+
+gem 'ohai', '>= 6.0.0', '< 8.0.0'
+
+# Specify your gem's dependencies in knife-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Erik Hollensbe
+
+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,81 @@
+# Knife-API
+
+Decided to change the name of this gem from knife-dsl to knife-api because the gem exposes methods from knife, the 
+workhorse command line tool from the chef system and makes the methods available to ruby code. A library that lets 
+you drive a command line tool programmatically offers an API and is not a DSL.   
+
+A small library that lets you drive Chef's `knife` programmatically
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knife-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-api
+
+## Usage
+
+The main feature of this library is the ability to drive knife as a method call
+as opposed to an individual program. This has a number of benefits:
+
+* It's a lot faster
+* You can capture output
+* You're relying on code that has a contract to maintain compatible with Chef
+* Use knife plugins all you want without breaking your workflow
+* Optionally, Chef becomes constrained by a gemfile (as do the plugins you use)
+  and that constraint remains consistent.
+
+It provides two calls, `knife` and `knife_capture` that are injected into the
+top-level namespace automatically. Additionally, if you are using `rake`, it
+will detect this and make it available to rake's DSL as well.
+
+If you wish to use this code elsewhere, just `include Chef::Knife::API` into
+your classes/modules.
+
+Both commands take two argument-passing styles. Both use an array of strings to
+represent the ARGV passed to knife, but there is additionally a shorthand to
+make the actual subcommand stand out: if you supply a symbol or string with
+underscore-delimited subcommand names, it will automatically convert this for
+you. This allows you to visually distinguish a command from its arguments.
+
+knife-api allows the use of alternative Chef Configs via the `CHEF_CONFIG`
+environment variable.
+
+## Example
+
+Here's a `Rakefile` which lists nodes in one task, and in another, converts the
+node metadata supplied by `knife node show $x` to something suitable to display
+with `pp`. The practical applications of both tasks are pretty specious, but
+they're small and display the functionality.
+
+```ruby
+require 'knife/api'
+require 'pp'
+require 'json'
+
+task :list_nodes do
+  status = knife :node_list
+  fail if status > 0
+end
+
+task :show_node, :node_name do |task_name, args|
+  stdout, stderr, status = knife_capture :node_show, [args[:node_name], '-F', 'j']
+  fail if status > 0
+  pp JSON.load(stdout)
+end
+```
+
+## 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/knife-api.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife/api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "knife-api"
+  gem.version       = Chef::Knife::API::VERSION
+  gem.authors       = ["Erik Hollensbe", "Andy Glick"]
+  gem.email         = ["andyglick@gmailcom"]
+  gem.description   = %q{A small library that lets you drive Chef's 'knife' programmatically}
+  gem.summary       = %q{A small library that lets you drive Chef's 'knife' programmatically}
+  gem.homepage      = "https://github.com/andyglick/knife-api"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'chef', '>= 10.0', '< 12.0.0'
+  gem.add_development_dependency 'rake'
+end

data/lib/knife/api.rb

@@ -0,0 +1,63 @@
+require 'chef/application/knife'
+require 'knife/api/version'
+require 'stringio'
+
+module Chef::Knife::API
+  module Chef::Knife::API::Support
+    def self.run_knife(command, args)
+      unless command.kind_of?(Array)
+        command = command.to_s.split(/[\s_]+/)
+      end
+
+      command += args
+
+      if ENV["CHEF_CONFIG"]
+        command += ['-c', ENV["CHEF_CONFIG"]]
+      end
+
+      opts = Chef::Application::Knife.new.options
+      Chef::Knife.run(command, opts)
+      return 0
+    rescue SystemExit => e
+      return e.status
+    end
+  end
+
+  def knife(command, args=[])
+    Chef::Knife::API::Support.run_knife(command, args)
+  end
+
+  def knife_capture(command, args=[], input=nil)
+    null = Gem.win_platform? ? File.open('NUL:', 'r') : File.open('/dev/null', 'r')
+
+    warn = $VERBOSE 
+    $VERBOSE = nil
+    stderr, stdout, stdin = STDERR, STDOUT, STDIN
+
+    Object.const_set("STDERR", StringIO.new('', 'r+'))
+    Object.const_set("STDOUT", StringIO.new('', 'r+'))
+    Object.const_set("STDIN", input ? StringIO.new(input, 'r') : null)
+    $VERBOSE = warn
+
+    status = Chef::Knife::API::Support.run_knife(command, args)
+    return STDOUT.string, STDERR.string, status
+  ensure
+    warn = $VERBOSE 
+    $VERBOSE = nil
+    Object.const_set("STDERR", stderr)
+    Object.const_set("STDOUT", stdout)
+    Object.const_set("STDIN", stdin)
+    $VERBOSE = warn
+    null.close
+  end
+end
+
+class << eval("self", TOPLEVEL_BINDING)
+  include Chef::Knife::API
+end
+
+if defined? Rake::API
+  module Rake::API
+    include Chef::Knife::API
+  end
+end

data/lib/knife/api/version.rb

@@ -0,0 +1,7 @@
+class Chef
+  class Knife
+    module API
+      VERSION = "0.1.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: knife-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Erik Hollensbe
+- Andy Glick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small library that lets you drive Chef's 'knife' programmatically
+email:
+- andyglick@gmailcom
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knife-api.gemspec
+- lib/knife/api.rb
+- lib/knife/api/version.rb
+homepage: https://github.com/andyglick/knife-api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A small library that lets you drive Chef's 'knife' programmatically
+test_files: []