knife-plugin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8effc33725ac6ccaab540256dcd6e3a30fe11b9c
+  data.tar.gz: 35031971ec229d330aa3bcc8aacb726768314513
+SHA512:
+  metadata.gz: ee07d5bf455e54d823b3dffe570203d542b5ffa44826f88a4098f5729d60cbf78a2a3a2179099c4d5256b92f56cb5ba3f5fade640f94d6734b1c0f1a77c167ab
+  data.tar.gz: 3d8108c06341d497a4755ac7b29b678d7266eada9f982b1957292657060045a04d141d8c84d78ce67c744a56ddcc0efe8af2871cf791f541f05e05aeedf60c2c

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,108 @@
+# Knife::Plugin
+
+Welcome to the knife plugin... plugin. This is a plugin for Chef's
+`knife` utility that is intended to aid in working with knife plugins.
+
+## Requirements
+
+This plugin should work in any Ruby environment where Chef itself
+works. If it does not, please file an issue.
+
+Reasonable effort is made to ensure compatibility with Ruby 1.8.7, but
+as that version is EOL, so I can't make any guarantees.
+
+It is against the design goals of this plugin to have external Ruby
+dependencies beyond the Ruby Standard Library.
+
+## Installation
+
+Install this plugin in the same Ruby environment as Chef and Knife.
+That is, use the `gem` binary that was used to install Chef. This may
+be different than the "system" `gem` binary. For example, on OS X with
+the Chef omnibus package:
+
+    $ /opt/chef/embedded/bin/gem install knife-plugin
+
+Ironically, this plugin includes an `install` sub-command for doing
+just that.
+
+## Usage
+
+This plugin provides sub-commands starting with `knife plugin`.
+
+### create
+
+The `create` sub-command generates a plugin scaffolding in
+`$HOME/.chef/plugins/knife`. It is intended to be very simple to get
+the minimal amount of scaffolding created for a new plugin. It is not
+in the scope of this sub-command to create a full Ruby project that
+could be distributed as a RubyGem. My assumption is someone who needs
+that functionality will know about `bundle gem` or similar generators.
+
+To create a new plugin:
+
+    knife plugin create wheels
+
+This will create `$HOME/.chef/plugins/knife/wheels.rb`.
+
+### install
+
+The `install` plugin will install another knife plugin packaged as a
+RubyGem, and available from the configured source(s) (usually
+rubygems.org) into the same Ruby environment where `knife` itself is.
+
+    knife plugin install knife-config
+    knife plugin install knife-ec2
+
+Depending on the configuration of the local machine, administrative
+privileges may be required, e.g. `sudo`.
+
+## Contributing
+
+For ideas on contributions, see the __Bugs__ list below, or check the
+issue tracker on this repository.
+
+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
+
+I'd prefer to keep the scope of this plugin fairly narrow, so it is
+small and uncomplicated. New features (additional commands) will be
+considered but I may encourage new, separate pugins be created
+instead.
+
+## Bugs
+
+There are no tests.
+
+The directory `create` plugin generates new plugins in is hardcoded.
+It should be configurable, or autodetect.
+
+The `create` plugin may benefit from better methods to make snake case
+or camelcase strings as long as they do not introduce additional
+dependencies outside of Ruby stdlib. See
+[#Requirements](#Requirements).
+
+The `install` plugin takes only the first argument to the plugin (the
+name of the RubyGem to install) and discards the rest. Since this is
+passed into the `gem` command, it shouldn't silently drop additional
+arguments.
+
+## License and Author
+
+- Author: Joshua Timberman (<joshua@getchef.com>)
+- Copyright (c) 2014, Chef Software, Inc. (<legal@getchef.com>)
+
+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.

data/lib/chef/knife/plugin_create.rb

@@ -0,0 +1,83 @@
+#
+# Author: Joshua Timberman <joshua@getchef.com>
+# Copyright: (c) 2012-2014, Joshua Timberman
+# Copyright: (c) 2014, Chef Software, Inc. <legal@getchef.com>
+#
+# 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/knife'
+
+module KnifePlugins
+  # namespaced for the knife plugin magic
+  class PluginCreate < Chef::Knife
+    deps do
+      require 'fileutils'
+    end
+
+    banner 'knife plugin create PLUGINNAME'
+
+    def run
+      class_name = plugin_class
+      # TODO: Make this location configurable
+      plugin_dir = File.join(ENV['HOME'], '.chef', 'plugins', 'knife')
+      file_name = File.join(plugin_dir, "#{plugin_file}.rb")
+      if ::File.exists?(file_name)
+        ui.info "Plugin #{class_name} may already exist at #{file_name}"
+      else
+        FileUtils.mkdir_p(plugin_dir)
+        file = ::File.open(file_name, 'w')
+        file.puts plugin_scaffold(plugin_class)
+        ui.info plugin_scaffold(plugin_class)
+      end
+    end
+
+    def plugin_class
+      # TODO: There exist methods for making snake case and camelcase
+      # strings, but I couldn't internet on a plane. :)
+      class_name = ''
+      if @name_args.length > 1
+        class_name = @name_args.map { |p| p.capitalize }.join
+      else
+        class_name = @name_args[0].capitalize
+      end
+      class_name
+    end
+
+    def plugin_file
+      @name_args.join('_').downcase
+    end
+
+    def plugin_scaffold(plugin_class)
+      scaffolding = <<-EOP
+# You should replace this comment with a license header
+# #{plugin_file}
+require 'chef/knife'
+
+module KnifePlugins
+  class #{plugin_class} < Chef::Knife
+    deps do
+
+    end
+
+    banner "knife "
+
+    def run
+
+    end
+  end
+end
+EOP
+      scaffolding
+    end
+  end
+end

data/lib/chef/knife/plugin_install.rb

@@ -0,0 +1,35 @@
+#
+# Author: Joshua Timberman <joshua@getchef.com>
+# Copyright: 2012, Joshua Timberman
+# Copyright: 2014, Chef Software, Inc. <legal@getchef.com>
+#
+# 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/knife'
+
+module KnifePlugins
+  # namespaced for the knife plugin magic
+  class PluginInstall < Chef::Knife
+    deps do
+      require 'chef/mixin/shell_out'
+      include Chef::Mixin::ShellOut
+    end
+
+    banner 'knife plugin install GEMNAME'
+
+    def run
+      knife_plugin = shell_out("#{Gem.bindir}/gem install #{name_args[0]}")
+      ui.info knife_plugin.stdout
+    end
+  end
+end

data/lib/knife-plugin.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Joshua Timberman <joshua@getchef.com>
+# Copyright:: (c) 2014, Chef Software, Inc. <legal@getchef.com>
+#
+# 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.
+
+# This contains the version. I suppose this could be a module, but why?
+class Knife
+  # maybe if it were a module, rubocop would be quiet...
+  class Plugin
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: knife-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Timberman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: 
+email: joshua@getchef.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/chef/knife/plugin_create.rb
+- lib/chef/knife/plugin_install.rb
+- lib/knife-plugin.rb
+homepage: http://github.com/jtimberman/knife-plugin
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Knife Plugin to work with other Knife Plugins
+test_files: []
+has_rdoc: true