chef-api 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e22717c3690474e0b8d8dc2e49662ae7541c9dd
-  data.tar.gz: b77f6c57956db9b6b9e06ee677171fa26bf39ced
+SHA256:
+  metadata.gz: 2bcf51b085093e35d5a5530be9c9a9cd0cf39f6d1ff91a926ae1cdd769728a47
+  data.tar.gz: b625563e99b004213a2d122639cf056a1865ca53d5068b2f935f08595589f12e
 SHA512:
-  metadata.gz: 20c1d17608e4670595086eef399b4ee6108f987546f6124c82ffe7e7a3bbd16fce2015bda69e2f860ea4cc1275e07d7ecfd2d88834fb521ebf391dfe230703d8
-  data.tar.gz: dfa5c1c5a75e2f75c1b7dc6c4e0346774aecd664f6ea4103b8d12dd531338f091628b1ac7e7829a3cea59db5b53266f77f55c145c16cee41adee684e6dd5cd3b
+  metadata.gz: abc470931db747708c4f10b42c5481a0648e671f9121468cedad898b6305444f7e4131e8104c6ef49d168bdcb57dee5a36a5e4adc1d5c471627d430530f27d81
+  data.tar.gz: 25baa85de8cc2c1145028c83b61bc8cbaf53a9ef994e22676c334befcee145f9c715e52e4f94bc2d8943fdd4b37df83918071a96ab18931557b423715303b161

data/.travis.yml

@@ -2,9 +2,10 @@ sudo: false
 dist: trusty
 
 rvm:
-  - 2.2.5
-  - 2.3.1
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 
 # Don't install local development gems on Travis, use parallel gem downloads
 bundler_args: --without development --jobs 7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChefAPI Changelog
 
+## v0.8.0 (2018-03-02)
+
+- support `filter_result` in chef queries 
+- support a configurable read_timeout
+
 ## v0.7.1 (2017-08-06)
 
 - Don't set nil `JSON.create_id` as it's unnecessary in recent versions

data/README.md

@@ -1,21 +1,18 @@
-ChefAPI Client
-==============
-[![Gem Version](http://img.shields.io/gem/v/chef-api.svg)][gem]
-[![Build Status](http://img.shields.io/travis/sethvargo/chef-api.svg)][travis]
+# ChefAPI Client
 
-[gem]: https://rubygems.org/gems/chef-api
-[travis]: 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]
 
 **ChefAPI is currently in rapid development!** You should not consider this API stable until the official 1.0.0 release.
 
 ChefAPI is a dependency-minimal Ruby client for interacting with a Chef Server. It adopts many patterns and principles from Rails
 
+## Quick start
 
-Quick start
------------
 Install via Rubygems:
 
-    $ gem install chef-api
+```
+$ gem install chef-api
+```
 
 or add it to your Gemfile if you are using Bundler:
 
@@ -44,6 +41,7 @@ ChefAPI::Resource::Node.all
 ```
 
 ### Create a connection
+
 Before you can make a request, you must give the ChefAPI your connection information and credentials.
 
 ```ruby
@@ -84,6 +82,11 @@ ChefAPI.configure do |config|
   config.proxy_password = 'password'
   config.proxy_address  = 'my.proxy.server' # or 10.0.0.50
   config.proxy_port     = '8080'
+
+  # If you want to make queries that return a very large result chef, you might
+  # need to adjust the timeout limits for the network request. (NOTE: time is
+  # given in seconds).
+  config.read_timeout = 120
 end
 ```
 
@@ -140,11 +143,13 @@ end
 ```
 
 ### Making Requests
+
 The ChefAPI gem attempts to wrap the Chef Server API in an object-oriented and Rubyesque way. All of the methods and API calls are heavily documented inline using YARD. For a full list of every possible option, please see the inline documentation.
 
 Most resources can be listed, retrieved, created, updated, and destroyed. In programming, this is commonly referred to as "CRUD".
 
 #### Create
+
 There are multiple ways to create a new Chef resource on the remote Chef Server. You can use the native `create` method. It accepts a list of parameters as a hash:
 
 ```ruby
@@ -169,12 +174,14 @@ client.save #=> #<Resource::Client name: "new-client", admin: false, ...>
 ```
 
 #### Read
+
 Most resources have the following "read" functions:
 
 - `.list`, `.all`, and `.each` for listing Chef resources
 - `.fetch` for getting a single Chef resource with the given identifier
 
 ##### Listing
+
 You can get a list of all the identifiers for a given type of resource using the `.list` method. This is especially useful when you only want to list items by their identifier, since it only issues a single API request. For example, to get the names of all of the Client resources:
 
 ```ruby
@@ -205,6 +212,7 @@ Client.map(&:public_key) #=> ["-----BEGIN PUBLIC KEY-----\nMIGfMA...", "-----BEG
 ```
 
 ##### Fetching
+
 You can also fetch a single resource from the Chef Server using the given identifier. Each Chef resource has a unique identifier; internally this is called the "primary key". For most resources, this attribute is "name". You can fetch a resource by it's primary key using the `.fetch` method:
 
 ```ruby
@@ -218,6 +226,7 @@ Client.fetch('not-a-real-client') #=> nil
 ```
 
 #### Update
+
 You can update a resource using it's unique identifier and a list of hash attributes:
 
 ```ruby
@@ -233,6 +242,7 @@ client.save
 ```
 
 #### Delete
+
 You can destroy a resource using it's unique identifier:
 
 ```ruby
@@ -247,6 +257,7 @@ client.destroy #=> true
 ```
 
 ### Validations
+
 Each resource includes its own validations. If these validations fail, they exhibit custom errors messages that are added to the resource. For example, Chef clients **must** have a name attribute. This is validated on the client side:
 
 ```ruby
@@ -273,15 +284,15 @@ client.save! #=> InvalidResource: There were errors saving your resource: `name'
 ```
 
 ### Objects on Disk
+
 ChefAPI also has the ability to read and manipulate objects on disk. This varies from resource-to-resource, but the `.from_file` method accepts a path to a resource on disk and loads as much information about the object on disk as it can. The attributes are then merged with the remote resource, if one exists. For example, you can read a Client resource from disk:
 
 ```ruby
 client = Client.from_file('~/.chef/bacon.pem') #=> #<Resource::Client name: "bacon", admin: false, public_key: nil, private_key: "..." ...>
 ```
 
+## Searching
 
-Searching
----------
 ChefAPI employs both search and partial search functionality.
 
 ```ruby
@@ -300,15 +311,13 @@ results.rows.each do |result|
 end
 ```
 
+## FAQ
 
-FAQ
----
 **Q: How is this different than [Ridley](https://github.com/RiotGames/ridley)?**<br>
 A: Ridley is optimized for highly concurrent connections with support for multiple Chef Servers. ChefAPI is designed for the "average user" who does not need the advanced use cases that Ridley provides. For this reason, the ChefAPI is incredibly opinionated about the features it will include. If you need complex features, take a look at [Ridley](https://github.com/RiotGames/ridley).
 
+## Development
 
-Development
------------
 1. Clone the project on GitHub
 2. Create a feature branch
 3. Submit a Pull Request
@@ -319,10 +328,9 @@ Important Notes:
 - **The tests must be be idempotent.** The HTTP calls made during a test should be able to be run over and over.
 - **Tests are order independent.** The default RSpec configuration randomizes the test order, so this should not be a problem.
 
+## License & Authors
 
-License & Authors
------------------
-- Author: Seth Vargo <sethvargo@gmail.com>
+- Author: Seth Vargo [sethvargo@gmail.com](mailto:sethvargo@gmail.com)
 
 ```text
 Copyright 2013-2014 Seth Vargo
@@ -339,3 +347,6 @@ 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.
 ```
+
+[gem]: https://rubygems.org/gems/chef-api
+[travis]: http://travis-ci.org/sethvargo/chef-api

data/lib/chef-api/configurable.rb

@@ -23,6 +23,7 @@ module ChefAPI
           :ssl_pem_file,
           :ssl_verify,
           :user_agent,
+          :read_timeout,
         ]
       end
     end

data/lib/chef-api/connection.rb

@@ -253,6 +253,11 @@ module ChefAPI
       connection = Net::HTTP.new(uri.host, uri.port,
         proxy_address, proxy_port, proxy_username, proxy_password)
 
+      # Large or filtered result sets can take a long time to return, so allow
+      # setting a longer read_timeout for our client if we want to make an
+      # expensive request.
+      connection.read_timeout = read_timeout if read_timeout
+
       # Apply SSL, if applicable
       if uri.scheme == 'https'
         # Turn on SSL

data/lib/chef-api/defaults.rb

@@ -181,6 +181,17 @@ module ChefAPI
           %w[t y].include?(ENV['CHEF_API_SSL_VERIFY'].downcase[0]) || config['CHEF_API_SSL_VERIFY']
         end
       end
+
+      #
+      # Network request read timeout in seconds (default: 60)
+      #
+      # @return [Integer, nil]
+      #
+      def read_timeout
+        timeout_from_env = ENV['CHEF_API_READ_TIMEOUT'] || config['CHEF_API_READ_TIMEOUT']
+
+        Integer(timeout_from_env) unless timeout_from_env.nil?
+      end
     end
   end
 end

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

@@ -33,7 +33,13 @@ module ChefAPI
         end
 
         path = expanded_collection_path(index: index.to_s)
-        response = connection.get(path, params)
+
+        response = if filter_result = options[:filter_result]
+          connection.post(path, filter_result.to_json, params)
+        else
+          connection.get(path, params)
+        end
+
         from_json(response, index: index.to_s)
       end
     end

data/lib/chef-api/version.rb

@@ -1,3 +1,3 @@
 module ChefAPI
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-api
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logify
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: A Chef API client in Ruby