chef-api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb1855e2b759c9728d8bb855286295c5051174a
-  data.tar.gz: e04becfd2a2fdbac4bfa2420810f4cedace3c4f4
+  metadata.gz: 89bca373e08eb29df75521fe78473fb1a566e9af
+  data.tar.gz: 4565d8fa17cfe68bbe4d204045a5f5d114ff5f92
 SHA512:
-  metadata.gz: f6bfa54343067d1ebe47610970206ed7c55701e01d942a4774fb1e1645a7d289bfc965975ad2b4d25ba468b5da6091ee8c94b2e21c86a46f88cdae74136cf2ee
-  data.tar.gz: 5bbfff5db04efb34eb49977bc62e89bdb3c21ba97c58194e5fb3b00aee44b271be2f33ef25919fea8db55376464bc52b39b0888f47745ee0ac6b19b3897538c7
+  metadata.gz: ee5206c83877648adfda095c52d688b46fd1e4a46b7745c8e9cfdf3db8e6ed4f014d353fb91e6dc38549671ff5acaa6632ee6da1edabc0b9aba9dfd77db3c0f1
+  data.tar.gz: 46561de5a2908f9cd2dbe6781de8c67b9b625153aad5a964b532337ea775efef99408176913e9dd6d31d7440ea7c36a74bef53b725fce019f98b412ba8924078

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
 
 # Don't install local development gems on Travis, use parallel gem downloads
 bundler_args: --without development --jobs 7

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 ChefAPI Changelog
 =================
 
+
+v0.3.0 (2014-06-18)
+-------------------
+- Add search functionality
+- Add partial search
+- Update testing harness
+
+
 v0.2.1 (2014-04-17)
 -------------------
 - Fix a series of typographical errors

data/Gemfile

@@ -6,7 +6,7 @@ group :development do
 end
 
 group :test do
-  gem 'chef-zero', '~> 2.0'
-  gem 'rake',      '~> 10.1'
-  gem 'rspec',     '~> 2.14'
+  gem 'chef-zero', '~> 2.0.0'
+  gem 'rake',      '~> 10.3'
+  gem 'rspec',     '~> 3.0'
 end

data/README.md

@@ -1,6 +1,12 @@
 ChefAPI Client
 ==============
-[![Build Status](https://secure.travis-ci.org/sethvargo/chef-api.png?branch=master)](http://travis-ci.org/sethvargo/chef-api)
+[![Gem Version](http://img.shields.io/gem/v/chef-api.svg)][gem]
+[![Build Status](http://img.shields.io/travis/sethvargo/chef-api.svg)][travis]
+[![Gittip](http://img.shields.io/gittip/sethvargo.svg)][gittip]
+
+[gem]: https://rubygems.org/gems/chef-api
+[travis]: http://travis-ci.org/sethvargo/chef-api
+[gittip]: https://www.gittip.com/sethvargo
 
 **ChefAPI is currently in rapid development!** You should not consider this API stable until the official 1.0.0 release.
 
@@ -266,6 +272,27 @@ client = Client.from_file('~/.chef/bacon.pem') #=> #<Resource::Client name: "bac
 ```
 
 
+Searching
+---------
+ChefAPI employs both search and partial search functionality.
+
+```ruby
+# Using regular search
+results = Search.query(:node, '*:*', start: 1)
+results.total #=> 5_000
+results.rows.each do |result|
+  puts result
+end
+
+# Using partial search
+results = PartialSearch.query(:node, { data: ['fqdn'] }, start: 1)
+results.total #=> 2
+results.rows.each do |result|
+  puts result
+end
+```
+
+
 FAQ
 ---
 **Q: How is this different than [Ridley](https://github.com/RiotGames/ridley)?**<br>

data/lib/chef-api/connection.rb

@@ -37,14 +37,16 @@ module ChefAPI
     include Logify
     include ChefAPI::Configurable
 
-    proxy :clients,      'Resource::Client'
-    proxy :cookbooks,    'Resource::Cookbook'
-    proxy :data_bags,    'Resource::DataBag'
-    proxy :environments, 'Resource::Environment'
-    proxy :nodes,        'Resource::Node'
-    proxy :principals,   'Resource::Principal'
-    proxy :roles,        'Resource::Role'
-    proxy :users,        'Resource::User'
+    proxy :clients,        'Resource::Client'
+    proxy :cookbooks,      'Resource::Cookbook'
+    proxy :data_bags,      'Resource::DataBag'
+    proxy :environments,   'Resource::Environment'
+    proxy :nodes,          'Resource::Node'
+    proxy :partial_search, 'Resource::PartialSearch'
+    proxy :principals,     'Resource::Principal'
+    proxy :roles,          'Resource::Role'
+    proxy :search,         'Resource::Search'
+    proxy :users,          'Resource::User'
 
     #
     # Create a new ChefAPI Connection with the given options. Any options
@@ -110,12 +112,14 @@ module ChefAPI
     # @param path (see Connection#request)
     # @param [String, #read] data
     #   the body to use for the request
+    # @param [Hash] params
+    #   the list of query params
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def post(path, data)
-      request(:post, path, data)
+    def post(path, data, params = {})
+      request(:post, path, data, params)
     end
 
     #
@@ -123,12 +127,13 @@ module ChefAPI
     #
     # @param path (see Connection#request)
     # @param data (see Connection#post)
+    # @param params (see Connection#post)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def put(path, data)
-      request(:put, path, data)
+    def put(path, data, params = {})
+      request(:put, path, data, params)
     end
 
     #
@@ -136,12 +141,13 @@ module ChefAPI
     #
     # @param path (see Connection#request)
     # @param data (see Connection#post)
+    # @param params (see Connection#post)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def patch(path, data)
-      request(:patch, path, data)
+    def patch(path, data, params = {})
+      request(:patch, path, data, params)
     end
 
     #
@@ -172,16 +178,22 @@ module ChefAPI
     #   request against
     # @param [#read, Hash, nil] data
     #   the data to use (varies based on the +verb+)
+    # @param [Hash] params
+    #   the params to use for :patch, :post, :put
     #
     # @return [String, Hash]
     #   the response body
     #
-    def request(verb, path, data = {})
+    def request(verb, path, data = {}, params = {})
       log.info  "#{verb.to_s.upcase} #{path}..."
       log.debug "Chef flavor: #{flavor.inspect}"
 
       # Build the URI and request object from the given information
-      uri = build_uri(verb, path, data)
+      if [:delete, :get].include?(verb)
+        uri = build_uri(verb, path, data)
+      else
+        uri = build_uri(verb, path, params)
+      end
       request = class_for_request(verb).new(uri.request_uri)
 
       # Add request headers
@@ -278,13 +290,11 @@ module ChefAPI
       log.info  "Building URI..."
 
       # Add any query string parameters
-      if [:delete, :get].include?(verb)
-        if querystring = to_query_string(params)
-          log.debug "Detected verb deserves a querystring"
-          log.debug "Building querystring using #{params.inspect}"
-          log.debug "Compiled querystring is #{querystring.inspect}"
-          path = [path, querystring].compact.join('?')
-        end
+      if querystring = to_query_string(params)
+        log.debug "Detected verb deserves a querystring"
+        log.debug "Building querystring using #{params.inspect}"
+        log.debug "Compiled querystring is #{querystring.inspect}"
+        path = [path, querystring].compact.join('?')
       end
 
       # Parse the URI

data/lib/chef-api/resource.rb

@@ -10,8 +10,10 @@ module ChefAPI
     autoload :Environment,     'chef-api/resources/environment'
     autoload :Node,            'chef-api/resources/node'
     autoload :Organization,    'chef-api/resources/organization'
+    autoload :PartialSearch,   'chef-api/resources/partial_search'
     autoload :Principal,       'chef-api/resources/principal'
     autoload :Role,            'chef-api/resources/role'
+    autoload :Search,          'chef-api/resources/search'
     autoload :User,            'chef-api/resources/user'
   end
 end

data/lib/chef-api/resources/data_bag_item.rb

@@ -31,5 +31,23 @@ module ChefAPI
       id = attributes.delete(:id) || attributes.delete('id')
       super({ id: id, data: attributes }, prefix)
     end
+
+
+    #
+    # Override the to_hash method to move data to the upper scope.
+    #
+    # @see (Resource::Base#to_hash)
+    #
+    def to_hash
+      {}.tap do |hash|
+        _attributes.each do |key, value|
+          if key == :data
+            hash.merge!(value)
+          else
+            hash[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+          end
+        end
+      end
+    end
   end
 end

data/lib/chef-api/resources/partial_search.rb

@@ -0,0 +1,44 @@
+module ChefAPI
+  class Resource::PartialSearch < Resource::Base
+    collection_path '/search/:index'
+
+    schema do
+      attribute :total, type: Integer
+      attribute :start, type: Integer
+      attribute :rows,  type: Array
+    end
+
+    class << self
+      #
+      # About search : http://docs.opscode.com/essentials_search.html
+      #
+      # @param [String] index
+      #   the name of the index to search
+      # @param [Hash] keys
+      #   key paths for the attributes to be returned
+      # @param [String] query
+      #   the query string
+      # @param [Hash] options
+      #   the query string
+      #
+      # @return [self]
+      #   the current resource
+      #
+      def query(index, keys, query = '*:*', options = {})
+        return nil if index.nil?
+
+        params = {}.tap do |o|
+          o[:q]     = query
+          o[:rows]  = options[:rows]  || 1000
+          o[:sort]  = options[:sort]  || 'X_CHEF_id_CHEF_X'
+          o[:start] = options[:start] || 0
+        end
+
+        path = expanded_collection_path(index: index.to_s)
+        response = connection.post(path, keys.to_json, params)
+        response['rows'].map! { |row| row['data'] }
+        from_json(response, index: index.to_s)
+      end
+    end
+  end
+end

data/lib/chef-api/resources/search.rb

@@ -0,0 +1,41 @@
+module ChefAPI
+  class Resource::Search < Resource::Base
+    collection_path '/search/:index'
+
+    schema do
+      attribute :total, type: Integer
+      attribute :start, type: Integer
+      attribute :rows,  type: Array
+    end
+
+    class << self
+      #
+      # About search : http://docs.opscode.com/essentials_search.html
+      #
+      # @param [String] index
+      #   the name of the index to search
+      # @param [String] query
+      #   the query string
+      # @param [Hash] options
+      #   the query string
+      #
+      # @return [self]
+      #   the current resource
+      #
+      def query(index, query = '*:*', options = {})
+        return nil if index.nil?
+
+        params = {}.tap do |o|
+          o[:q]     = query
+          o[:rows]  = options[:rows]  || 1000
+          o[:sort]  = options[:sort]  || 'X_CHEF_id_CHEF_X'
+          o[:start] = options[:start] || 0
+        end
+
+        path = expanded_collection_path(index: index.to_s)
+        response = connection.get(path, params)
+        from_json(response, index: index.to_s)
+      end
+    end
+  end
+end

data/lib/chef-api/version.rb

@@ -1,3 +1,3 @@
 module ChefAPI
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/integration/resources/client_spec.rb

@@ -41,7 +41,7 @@ module ChefAPI
       let(:client) { described_class.from_file('/path/to/bacon.pem') }
 
       before do
-        File.stub(:read).and_return(private_key)
+        allow(File).to receive(:read).and_return(private_key)
       end
 
       it 'loads the client from the server' do
@@ -49,13 +49,13 @@ module ChefAPI
 
         expect(client.name).to eq('bacon')
         expect(client.private_key).to eq(private_key)
-        expect(client.validator).to be_true
+        expect(client.validator).to be_truthy
       end
 
       it 'creates a new instance when the client does not exist' do
         expect(client.name).to eq('bacon')
-        expect(client.validator).to be_false
-        expect(client.new_resource?).to be_true
+        expect(client.validator).to be_falsey
+        expect(client.new_resource?).to be_truthy
       end
     end
   end

data/spec/integration/resources/partial_search_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Resource::PartialSearch do
+    describe '.query' do
+      it 'returns a partial search resource' do
+        chef_server.send('create_client', 'bacon')
+        results = described_class.query(:client, { name: ['name'] })
+        expect(results).to be_a(described_class)
+      end
+
+      it 'returns partial data' do
+        chef_server.send('create_node', 'bacon1', { foo: :bar })
+        chef_server.send('create_node', 'bacon2', { foo: :baz, bar: :foo })
+        keys = { data: ['bar'] }
+        results = described_class.query(:node, keys, '*:*', start: 1)
+        expect(results.total).to be == 2
+        expect(results.rows.size).to be == 1
+        expect(results.rows.first).to be == { 'data' => 'foo' }
+      end
+    end
+  end
+end

data/spec/integration/resources/search_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Resource::Search do
+    describe '.query' do
+      it 'returns a search resource' do
+        chef_server.send('create_client', 'bacon')
+        results = described_class.query(:client)
+        expect(results).to be_a(described_class)
+      end
+
+      it 'options are passed to the chef-server' do
+        chef_server.send('create_node', 'bacon1', { foo: :bar })
+        chef_server.send('create_node', 'bacon2', { foo: :baz })
+        results = described_class.query(:node, '*:*', start: 1)
+        expect(results.total).to be == 2
+        expect(results.rows.size).to be == 1
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ RSpec.configure do |config|
   Dir[ChefAPI.root.join('spec/support/shared/**/*.rb')].each { |file| require file }
 
   # Basic configuraiton
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run(:focus)
 

data/spec/support/chef_server.rb

@@ -9,11 +9,94 @@ module RSpec
     end
 
     class << self
+      #
+      # Delegate all methods to the singleton instance.
+      #
       def method_missing(m, *args, &block)
         instance.send(m, *args, &block)
       end
+
+      #
+      # RSpec 3 checks +respond_to?+
+      #
+      def respond_to_missing?(m, include_private = false)
+        instance.respond_to?(m, include_private) || super
+      end
+
+      #
+      # @macro entity
+      #   @method create_$1(name, data = {})
+      #     Create a new $1 on the Chef Server
+      #
+      #     @param [String] name
+      #       the name of the $1
+      #     @param [Hash] data
+      #       the list of data to load
+      #
+      #
+      #   @method $1(name)
+      #     Find a $1 at the given name
+      #
+      #     @param [String] name
+      #       the name of the $1
+      #
+      #     @return [$2, nil]
+      #
+      #
+      #   @method $3
+      #     The list of $1 on the Chef Server
+      #
+      #     @return [Array<Hash>]
+      #       all the $1 on the Chef Server
+      #
+      #
+      #   @method has_$1?(name)
+      #     Determine if the Chef Server has the given $1
+      #
+      #     @param [String] name
+      #       the name of the $1 to find
+      #
+      #     @return [Boolean]
+      #
+      def entity(method, key)
+        class_eval <<-EOH, __FILE__, __LINE__ + 1
+          def create_#{method}(name, data = {})
+            # Automatically set the "name" if no explicit one was given
+            data[:name] ||= name
+
+            # Convert it to JSON
+            data = JSON.fast_generate(data)
+
+            load_data(name, '#{key}', data)
+          end
+
+          def #{method}(name)
+            data = get('#{key}', name)
+            JSON.parse(data)
+          rescue ChefZero::DataStore::DataNotFoundError
+            nil
+          end
+
+          def #{key}
+            get('#{key}')
+          end
+
+          def has_#{method}?(name)
+            !get('#{key}', name).nil?
+          rescue ChefZero::DataStore::DataNotFoundError
+            false
+          end
+        EOH
+      end
     end
 
+    entity :client,      :clients
+    entity :data_bag,    :data
+    entity :environment, :environments
+    entity :node,        :nodes
+    entity :role,        :roles
+    entity :user,        :users
+
     require 'singleton'
     include Singleton
 
@@ -22,8 +105,16 @@ module RSpec
     #
     def initialize
       @server = ChefZero::Server.new({
+        # This uses a random port
         port: port,
+
+        # Shut up
         log_level: :fatal,
+
+        # Disable the "old" way - this is actually +multi_tenant: true+
+        single_org: false,
+
+        # Don't generate real keys for faster test
         generate_real_keys: false,
       })
 
@@ -55,38 +146,29 @@ module RSpec
     end
 
     #
+    # Get the path to an item in the data store.
     #
-    #
-    def load_data(key, id, data = {})
-      @server.load_data({ key.to_s => { id => JSON.fast_generate(data) } })
+    def get(*args)
+      if args.size == 1
+        @server.data_store.list(args)
+      else
+        @server.data_store.get(args)
+      end
     end
 
     #
+    # Shortcut method for loading data into Chef Zero.
     #
+    # @param [String] name
+    #   the name or id of the item to load
+    # @param [String, Symbol] key
+    #   the key to load
+    # @param [Hash] data
+    #   the data for the object, which will be converted to JSON and uploaded
+    #   to the server
     #
-    [
-      ['clients', 'client'],
-      ['cookbooks', 'cookbook'],
-      ['environments', 'environment'],
-      ['nodes', 'node'],
-      ['roles', 'role'],
-      ['users', 'user'],
-    ].each do |plural, singular|
-      define_method(plural) do
-        @server.data_store.list([plural])
-      end
-
-      define_method(singular) do |id|
-        JSON.parse(@server.data_store.get([plural, id]))
-      end
-
-      define_method("create_#{singular}") do |id, data = {}|
-        load_data(plural, id, data)
-      end
-
-      define_method("has_#{singular}?") do |id|
-        send(plural).include?(id)
-      end
+    def load_data(name, key, data = {})
+      @server.load_data({ key => { name => data } })
     end
 
     private

data/spec/support/shared/chef_api_resource.rb

@@ -40,12 +40,12 @@ shared_examples_for 'a Chef API resource' do |type, options = {}|
 
   describe '.exists?' do
     it 'returns false when the resource does not exist' do
-      expect(described_class.exists?(resource_id)).to be_false
+      expect(described_class.exists?(resource_id)).to be_falsey
     end
 
     it 'returns true when the resource exists' do
       chef_server.send("create_#{type}", resource_id)
-      expect(described_class.exists?(resource_id)).to be_true
+      expect(described_class.exists?(resource_id)).to be_truthy
     end
   end
 

data/spec/unit/resources/base_spec.rb

@@ -36,8 +36,8 @@ module ChefAPI
 
     describe '.build' do
       it 'creates a new instance' do
-        described_class.stub(:new)
-        described_class.stub(:schema).and_return(double(attributes: {}))
+        allow(described_class).to receive(:new)
+        allow(described_class).to receive(:schema).and_return(double(attributes: {}))
 
         expect(described_class).to receive(:new).with({foo: 'bar'}, {})
         described_class.build(foo: 'bar')

data/spec/unit/resources/connection_spec.rb

@@ -18,13 +18,15 @@ module ChefAPI
       end
     end
 
-    it_behaves_like 'a proxy for', :clients,      'Resource::Client'
-    it_behaves_like 'a proxy for', :data_bags,    'Resource::DataBag'
-    it_behaves_like 'a proxy for', :environments, 'Resource::Environment'
-    it_behaves_like 'a proxy for', :nodes,        'Resource::Node'
-    it_behaves_like 'a proxy for', :principals,   'Resource::Principal'
-    it_behaves_like 'a proxy for', :roles,        'Resource::Role'
-    it_behaves_like 'a proxy for', :users,        'Resource::User'
+    it_behaves_like 'a proxy for', :clients,        'Resource::Client'
+    it_behaves_like 'a proxy for', :data_bags,      'Resource::DataBag'
+    it_behaves_like 'a proxy for', :environments,   'Resource::Environment'
+    it_behaves_like 'a proxy for', :nodes,          'Resource::Node'
+    it_behaves_like 'a proxy for', :partial_search, 'Resource::PartialSearch'
+    it_behaves_like 'a proxy for', :principals,     'Resource::Principal'
+    it_behaves_like 'a proxy for', :roles,          'Resource::Role'
+    it_behaves_like 'a proxy for', :search,         'Resource::Search'
+    it_behaves_like 'a proxy for', :users,          'Resource::User'
 
     context '#initialize' do
       context 'when options are given' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logify
@@ -71,8 +71,10 @@ files:
 - lib/chef-api/resources/environment.rb
 - lib/chef-api/resources/node.rb
 - lib/chef-api/resources/organization.rb
+- lib/chef-api/resources/partial_search.rb
 - lib/chef-api/resources/principal.rb
 - lib/chef-api/resources/role.rb
+- lib/chef-api/resources/search.rb
 - lib/chef-api/resources/user.rb
 - lib/chef-api/schema.rb
 - lib/chef-api/util.rb
@@ -84,7 +86,9 @@ files:
 - spec/integration/resources/client_spec.rb
 - spec/integration/resources/environment_spec.rb
 - spec/integration/resources/node_spec.rb
+- spec/integration/resources/partial_search_spec.rb
 - spec/integration/resources/role_spec.rb
+- spec/integration/resources/search_spec.rb
 - spec/integration/resources/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/chef_server.rb
@@ -142,7 +146,9 @@ test_files:
 - spec/integration/resources/client_spec.rb
 - spec/integration/resources/environment_spec.rb
 - spec/integration/resources/node_spec.rb
+- spec/integration/resources/partial_search_spec.rb
 - spec/integration/resources/role_spec.rb
+- spec/integration/resources/search_spec.rb
 - spec/integration/resources/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/chef_server.rb