knife-psearch 0.0.2

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/lib/chef/knife/psearch.rb

@@ -0,0 +1,63 @@
+# psearch.rb: A knife plugin for the Partial Search API
+#
+# Note that this is a Beta feature of Opscode Hosted Chef
+# and that it's interface may changed based on user feedback.
+#
+# This plugin is not yes officially supported by Opscode
+
+class Psearch < Chef::Knife
+  banner "knife psearch INDEX SEARCH NAME=DESIRED_KEY_PATH,[NAME=DESIRED_KEY_PATH]"
+
+  deps do
+    require 'chef/search/partial_search'
+  end
+
+  option :sort,
+  :short => "-o SORT",
+  :long => "--sort SORT",
+  :description => "The order to sort the results in",
+  :default => nil
+
+  option :start,
+  :short => "-b ROW",
+  :long => "--start ROW",
+  :description => "The row to start returning results at",
+  :default => 0,
+  :proc => lambda { |i| i.to_i }
+
+  option :rows,
+  :short => "-R INT",
+  :long => "--rows INT",
+  :description => "The number of rows to return",
+  :default => 1000,
+  :proc => lambda { |i| i.to_i }
+
+  option :attribute,
+  :short => "-a ATTR",
+  :long => "--attribute ATTR",
+  :description => "Show only one attribute"
+
+  def run
+    @index, @search, *@keys = @name_args
+    args_hash = {}
+    args_hash[:keys] = build_key_hash
+    args_hash[:sort] = config[:sort]
+    args_hash[:start] = config[:start]
+    args_hash[:rows] = config[:rows]
+    results = Chef::PartialSearch.new.search(@index, @search, args_hash)
+    ui.output ui.format_for_display(results.first)
+  end
+
+  def build_key_hash
+    key_hash = {}
+    specs = @keys.map { |i| i.split(",") }.flatten
+    specs.each do |spc|
+      name, value = spc.split("=")
+      key_hash[name] = value.split("_")
+    end
+    # This seems like a sane default.  The results without the name
+    # are usually not what we want.
+    key_hash["name"] = [ "name" ] unless key_hash.has_key?("name")
+    key_hash
+  end
+end

data/lib/chef/search/partial_search.rb

@@ -0,0 +1,147 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# 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.
+#
+
+require 'chef/config'
+require 'uri'
+require 'chef/rest'
+# These are needed so that JSON can inflate search results
+require 'chef/node'
+require 'chef/role'
+require 'chef/environment'
+require 'chef/data_bag'
+require 'chef/data_bag_item'
+
+class Chef
+  class PartialSearch
+
+    attr_accessor :rest
+
+    def initialize(url=nil)
+      @rest = ::Chef::REST.new(url || ::Chef::Config[:search_url])
+    end
+
+    # Search Solr for objects of a given type, for a given query. If you give
+    # it a block, it will handle the paging for you dynamically.
+    def search(type, query='*:*', args={}, &block)
+      raise ArgumentError, "Type must be a string or a symbol!" unless (type.kind_of?(String) || type.kind_of?(Symbol))
+
+      sort = args.include?(:sort) ? args[:sort] : 'X_CHEF_id_CHEF_X asc'
+      start = args.include?(:start) ? args[:start] : 0
+      rows = args.include?(:rows) ? args[:rows] : 1000
+      query_string = "search/#{type}?q=#{escape(query)}&sort=#{escape(sort)}&start=#{escape(start)}&rows=#{escape(rows)}"
+      if args[:keys]
+        response = @rest.post_rest(query_string, args[:keys])
+        response_rows = response['rows'].map { |row| row['data'] }
+      else
+        response = @rest.get_rest(query_string)
+        response_rows = response['rows']
+      end
+      if block
+        response_rows.each { |o| block.call(o) unless o.nil?}
+        unless (response["start"] + response_rows.length) >= response["total"]
+          nstart = response["start"] + rows
+          args_hash = {
+            :keys => args[:keys],
+            :sort => sort,
+            :start => nstart,
+            :rows => rows
+          }
+          search(type, query, args_hash, &block)  
+        end
+        true
+      else
+        [ response_rows, response["start"], response["total"] ]
+      end
+    end
+
+    def list_indexes
+      response = @rest.get_rest("search")
+    end
+
+    private
+      def escape(s)
+        s && URI.escape(s.to_s)
+      end
+  end
+end
+
+# partial_search(type, query, options, &block)
+#
+# Searches for nodes, roles, etc. and returns the results.  This method may
+# perform more than one search request, if there are a large number of results.
+#
+# ==== Parameters
+# * +type+: index type (:role, :node, :client, :environment, data bag name)
+# * +query+: SOLR query.  "*:*", "role:blah", "not role:blah", etc.  Defaults to '*:*'
+# * +options+: hash with options:
+# ** +:start+: First row to return (:start => 50, :rows => 100 means "return the
+#               50th through 150th result")
+# ** +:rows+: Number of rows to return.  Defaults to 1000.
+# ** +:sort+: a SOLR sort specification.  Defaults to 'X_CHEF_id_CHEF_X asc'.
+# ** +:keys+: partial search keys.  If this is not specified, the search will
+#             not be partial.
+#
+# ==== Returns
+#
+# This method returns an array of search results.  Partial search results will
+# be JSON hashes with the structure specified in the +keys+ option.  Other
+# results include +Chef::Node+, +Chef::Role+, +Chef::Client+, +Chef::Environment+,
+# +Chef::DataBag+ and +Chef::DataBagItem+ objects, depending on the search type.
+#
+# If a block is specified, the block will be called with each result instead of
+# returning an array.  This method will not block if it returns
+#
+# If start or row is specified, and no block is given, the result will be a
+# triple containing the list, the start and total:
+#
+#     [ [ row1, row2, ... ], start, total ]
+#
+# ==== Example
+#
+#     partial_search(:node, 'role:webserver',
+#                    keys: {
+#                      name: [ 'name' ],
+#                      ip: [ 'amazon', 'ip', 'public' ]
+#                    }
+#     ).each do |node|
+#       puts "#{node[:name]}: #{node[:ip]}"
+#     end
+#
+def partial_search(type, query='*:*', *args, &block)
+  # Support both the old (positional args) and new (hash args) styles of calling
+  if args.length == 1 && args[0].is_a?(Hash)
+    args_hash = args[0]
+  else
+    args_hash = {}
+    args_hash[:sort] = args[0] if args.length >= 1
+    args_hash[:start] = args[1] if args.length >= 2
+    args_hash[:rows] = args[2] if args.length >= 3
+  end
+  # If you pass a block, or have the start or rows arguments, do raw result parsing
+  if Kernel.block_given? || args_hash[:start] || args_hash[:rows]
+    Chef::PartialSearch.new.search(type, query, args_hash, &block)
+  # Otherwise, do the iteration for the end user
+  else
+    results = Array.new
+    Chef::PartialSearch.new.search(type, query, args_hash) do |o|
+      results << o
+    end
+    results
+  end
+end

data/lib/knife-psearch/version.rb

@@ -0,0 +1,3 @@
+module KnifePSearch
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: knife-psearch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Steven Danna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies: []
+description: Knife Plugin for Chef 11's Partial Search
+email: steve@opscode.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- lib/chef/knife/psearch.rb
+- lib/chef/search/partial_search.rb
+- lib/knife-psearch/version.rb
+homepage: http://wiki.opscode.com/display/chef
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Knife Plugin for Chef 11's Partial Search
+test_files: []