knife-saved_search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67bf6782d7514681f17b7090552c0a23985ad88b
+  data.tar.gz: f0b0cf1a2fd061e3d3723dd59f0d1ff183f55cf8
+SHA512:
+  metadata.gz: 6e1c2779df1f36a6f6cca586be033f5f77cf75e15fe885ec5419916fab3d2a4852dabfbd140a6e4a8c2ad65ec55eaaa4c31bcdcb013c3fe94ae5a65bfb07daa3
+  data.tar.gz: 6fc45856c5c22faa5c6368f4a3710f22a52c8cfa24b713b1d10b24f8be4a5dde34d2878360791929b68cf9adb0fffc792d1f62900bd4ebef88cf46d9f165ae3d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

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,94 @@
+# Knife::SavedSearch
+
+Proof of concept Knife plugin for managing and executing saved searches against
+a Chef server. As a proof of concept, it uses a data bag to store saved
+searches.
+
+## Installation
+
+Using [ChefDK](downloads.chef.io/chef-dk/), run:
+
+    chef gem install knife-saved_search
+
+## Usage
+
+By default a data bag named "saved-searches" is used to store searches. This
+can be set to something else by putting
+`knife[:saved_search_data_bag] = "my-data-bag-name"` in your .chef/config.rb.
+
+This data bag will be created if it does not exist when a saved search is first
+created.
+
+A saved search data bag item looks like:
+
+```json
+{
+  "id": "name-of-saved-search",
+  "index": "node", // The search index used
+  "description": "A description of the search",
+  "query": "*:* " // The search query string used
+}
+```
+
+### `knife saved search list`
+
+Lists names of all saved searches.
+
+### `knife saved search show NAME`
+
+Shows an individual saved search.
+
+### `knife saved search delete NAME`
+
+Deletes a saved search.
+
+### `knife saved search create NAME INDEX QUERY [DESCRIPTION]`
+
+Creates a saved search.
+
+### `knife saved search exec NAME`
+
+Executes a saved search and returns its results. Takes the same options as
+knife search.
+
+### `knife saved search update NAME INDEX QUERY [DESCRIPTION]`
+
+Update the properties of an existing saved search.
+
+## Development
+
+To use this plugin from the code in this repository:
+
+```bash
+ln -sf /path/to/knife-saved_search/lib/chef/knife/* ~/.chef/plugins/knife/
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/smith/knife-saved_search/fork )
+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 a new Pull Request
+
+## License
+
+Knife::SavedSearch - A Knife plugin for saved search on a Chef server
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Author:**          | Nathan L Smith (<smith@chef.io>)
+| **Copyright:**       | Copyright (c) 2015 Nathan L Smith
+| **License:**         | Apache License, Version 2.0
+
+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/Rakefile

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

data/knife-saved_search.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife/saved_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-saved_search"
+  spec.version       = Knife::SavedSearch::VERSION
+  spec.authors       = ["Nathan L Smith"]
+  spec.email         = ["smith@chef.io"]
+  spec.summary       = %q{Knife plugin for doing saved searches}
+  spec.description   = %q{Allows one to save searches against a Chef server and execute them later.}
+  spec.homepage      = "https://github.com/smith/knife-saved_search"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chef", ">= 12"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/chef/knife/saved_search_base.rb

@@ -0,0 +1,27 @@
+class Chef
+  class Knife
+    module SavedSearchBase
+      def self.included(includer)
+        includer.class_eval do
+          category "saved search"
+
+          deps do
+            require "chef/data_bag"
+            require "chef/data_bag_item"
+          end
+
+          option :saved_search_data_bag,
+            :short => "-D",
+            :long => "--data-bag",
+            :description => "Data bag to use for saved searches.",
+            :default => "saved-searches"
+        end
+      end
+
+      # The data bag to used for saved searches
+      def data_bag
+        config[:saved_search_data_bag]
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_create.rb

@@ -0,0 +1,41 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchCreate < Knife
+      include SavedSearchBase
+
+      banner "knife saved search create NAME INDEX QUERY [DESCRIPTION] (options)"
+
+      def run
+        if name_args.length < 3 || name_args.length > 4
+          show_usage
+          ui.fatal("You must specify a saved search name, index, and query, with an optional description")
+          exit 1
+        end
+
+        name, index, query, description = name_args
+
+        item = Chef::DataBagItem.from_hash(
+          "id" => name,
+          "index" => index,
+          "query" => query,
+          "description" => description
+        )
+        item.data_bag(data_bag)
+        rest.post_rest("data/#{data_bag}", item)
+        msg "Created saved_search[#{name}]"
+      rescue Net::HTTPServerException => e
+        if e.response.code.to_i == 404
+          warn "\"#{data_bag}\" data bag does not exist. Creating it."
+          rest.post("data", { "name" => data_bag })
+          ui.info("Created data_bag[#{data_bag}]")
+          retry
+        else
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_delete.rb

@@ -0,0 +1,24 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchDelete < Knife
+      include SavedSearchBase
+
+      banner "knife saved search delete NAME (options)"
+
+      def run
+        if name_args.length != 1
+          show_usage
+          ui.fatal("You must specify at least a saved search name")
+          exit 1
+        end
+
+        delete_object(Chef::DataBagItem, name_args[0], "saved_search") do
+          rest.delete_rest("data/#{data_bag}/#{name_args[0]}")
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_exec.rb

@@ -0,0 +1,36 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchExec < Knife
+      include SavedSearchBase
+
+      banner "knife saved search exec NAME (options)"
+
+      deps do
+        require "chef/knife/search"
+      end
+
+      # Use the same options as knife search, except "query"
+      Chef::Knife::Search.options.each do |key, value|
+        option key, value unless key == :query
+      end
+
+      def run
+        if name_args.length != 1
+          show_usage
+          ui.fatal("You must specify at least a saved search name")
+          exit 1
+        end
+
+        name = name_args[0]
+        item = Chef::DataBagItem.load(data_bag, name)
+
+        # Perform a knife search, but with our arguments and options
+        Chef::Knife.run(["search", item["index"], item["query"]] + ARGV[4..-1],
+                        options)
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_list.rb

@@ -0,0 +1,24 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchList < Knife
+      include SavedSearchBase
+
+      banner "knife saved search list (options)"
+
+      def run
+        list = Chef::DataBag.load(data_bag)
+      rescue Net::HTTPServerException => e
+        if e.response.code.to_i == 404
+          warn "\"#{data_bag}\" data bag does not exist. No saved searches could be found."
+        else
+          raise
+        end
+      ensure
+        output format_list_for_display(list || {})
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_show.rb

@@ -0,0 +1,24 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchShow < Knife
+      include SavedSearchBase
+
+      banner "knife saved search show NAME (options)"
+
+      def run
+        if name_args.length != 1
+          show_usage
+          ui.fatal("You must specify at least a saved search name")
+          exit 1
+        end
+
+        output format_for_display(
+          Chef::DataBagItem.load(data_bag, name_args[0]).raw_data
+        )
+      end
+    end
+  end
+end

data/lib/chef/knife/saved_search_update.rb

@@ -0,0 +1,29 @@
+require "chef/knife"
+require_relative "./saved_search_base"
+
+class Chef
+  class Knife
+    class SavedSearchUpdate < Knife
+      include SavedSearchBase
+
+      banner "knife saved search update NAME INDEX QUERY [DESCRIPTION] (options)"
+
+      def run
+        if name_args.length < 3 || name_args.length > 4
+          show_usage
+          ui.fatal("You must specify a saved search name, index, and query, with an optional description")
+          exit 1
+        end
+
+        name, index, query, description = name_args
+
+        item = Chef::DataBagItem.load(data_bag, name)
+        item["index"] = index
+        item["query"] = query
+        item["description"] = description if description
+        item.save
+        msg "Updated saved_search[#{name}]"
+      end
+    end
+  end
+end

data/lib/knife/saved_search/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module SavedSearch
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: knife-saved_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan L Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Allows one to save searches against a Chef server and execute them later.
+email:
+- smith@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- knife-saved_search.gemspec
+- lib/chef/knife/saved_search_base.rb
+- lib/chef/knife/saved_search_create.rb
+- lib/chef/knife/saved_search_delete.rb
+- lib/chef/knife/saved_search_exec.rb
+- lib/chef/knife/saved_search_list.rb
+- lib/chef/knife/saved_search_show.rb
+- lib/chef/knife/saved_search_update.rb
+- lib/knife/saved_search/version.rb
+homepage: https://github.com/smith/knife-saved_search
+licenses:
+- Apache-2.0
+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.2
+signing_key: 
+specification_version: 4
+summary: Knife plugin for doing saved searches
+test_files: []
+has_rdoc: