chef-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9d6c6244de045894dffca646b3cea3696645629
+  data.tar.gz: 3e5a947c02535d537733ee9009906964d423af88
+SHA512:
+  metadata.gz: 0e4c4aa13d550e8ffeabf24e0dae0bbd9695a276eb85097e265cf121137f9ef19ed96712f3b172b80716789c60504961760f2ee722b6c459731ef6b0e48121d2
+  data.tar.gz: ade2f5cc5dfada170a6922aecf6a6acfe2b23a071a21bca2d062aa86f7d15f4dde1e5caa12e34cf28af7ee8f3c8faaff28b9aa7eb312bab1cff1d3b775f01edb

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin
+.rspec
+.ruby-version

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+# Don't install local development gems on Travis
+bundler_args: --without development
+
+# Only test master
+branches:
+  only:
+    - master
+
+script: bundle exec rspec --color --format progress

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'chef-zero', '~> 2.0'
+  gem 'rake',      '~> 10.1'
+  gem 'rspec',     '~> 2.14'
+end

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 2013 Seth Vargo <sethvargo@gmail.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/README.md

@@ -0,0 +1,264 @@
+ChefAPI Client
+==============
+[![Build Status](https://secure.travis-ci.org/sethvargo/chef-api.png?branch=master)](http://travis-ci.org/sethvargo/chef-api)
+
+**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
+-----------
+Install via Rubygems:
+
+    $ gem install chef-api
+
+or add it to your Gemfile if you are using Bundler:
+
+```ruby
+gem 'chef-api', '~> 0.1'
+```
+
+In your library or project, you will likely want to include the `ChefAPI::Resource` namespace:
+
+```ruby
+include ChefAPI::Resource
+```
+
+This will give you "Rails-like" access to the top-level Chef resources like:
+
+```ruby
+Client.all
+Node.all
+```
+
+If you choose not to include the module, you will need to specify the full module path to access resources:
+
+```ruby
+ChefAPI::Resource::Client.all
+ChefAPI::Resource::Node.all
+```
+
+### Create a connection
+Before you can make a request, you must give the ChefAPI your connection information and credentials.
+
+```ruby
+ChefAPI.configure do |config|
+  # The endpoint for the Chef Server. This can be an Open Source Chef Server,
+  # Hosted Chef Server, or Enterprise Chef Server.
+  config.endpoint = 'https://api.opscode.com/organizations/meats'
+
+  # The client and key must also be specified (unless you are running Chef Zero
+  # in no-authentication mode). The +key+ attribute may be the raw private key,
+  # the path to the private key on disk, or an +OpenSSLL::PKey+ object.
+  config.client = 'bacon'
+  config.key    = '~/.chef/bacon.pem'
+
+  # If you are running your own Chef Server with a custom SSL certificate, you
+  # will need to specify the path to a pem file with your custom certificates
+  # and ChefAPI will wire everything up correctly. (NOTE: it must be a valid
+  # PEM file).
+  config.ssl_pem_file = '/path/to/my.pem'
+
+  # If you would like to be vulnerable to MITM attacks, you can also turn off
+  # SSL verification. Despite what Internet blog posts may suggest, you should
+  # exhaust other methods before disabling SSL verification. ChefAPI will emit
+  # a warning message for every request issued with SSL verification disabled.
+  config.ssl_verify = false
+
+  # If you are behind a proxy, Chef API can run requests through the proxy as
+  # well. Just set the following configuration parameters as needed.
+  config.proxy_username = 'user'
+  config.proxy_password = 'password'
+  config.proxy_address  = 'my.proxy.server' # or 10.0.0.50
+  config.proxy_port     = '8080'
+end
+```
+
+All of these configuration options are available via the top-level `ChefAPI` object.
+
+```ruby
+ChefAPI.endpoint = '...'
+```
+
+You can also configure everything via environment variables (great solution for Docker-based usage). All the environment variables are of the format `CHEF_API_{key}`, where `key` is the uppercase equivalent of the item in the configuration object.
+
+```bash
+# ChefAPI will use these values
+export CHEF_API_ENDPOINT=https://api.opscode.com/organizations/meats
+export CHEF_API_CLIENT=bacon
+export CHEF_API_KEY=~/.chef/bacon.pem
+```
+
+### 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
+Client.create(name: 'new-client') #=> #<Resource::Client name: "new-client", admin: false, ...>
+```
+
+Or you can create an instance of the object, setting parameters as you go.
+
+```ruby
+client = Client.new
+client.name = 'new-client'
+client.save #=> #<Resource::Client name: "new-client", admin: false, ...>
+```
+
+You can also mix-and-match the hash and object initialization:
+
+```ruby
+client = Client.new(name: 'new-client')
+client.validator = true
+client.admin = true
+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
+Client.list #=> ["chef-webui", "validator"]
+```
+
+You can also get the full collection of Chef resources using the `.all` method:
+
+```ruby
+Client.all #=> [#<Resource::Client name: "chef-webui", admin: false ...>,
+                #<Resource::Client name: "validator", admin: false ...>]
+```
+
+However, this is incredibly inefficient. Because of the way the Chef Server serves requests, this will make N+1 queries to the Chef Server. Unless you absolutely need every resource in the collection, you are much better using the lazy enumerable:
+
+```ruby
+Client.each do |client|
+  puts client.name
+end
+```
+
+Because the resources include Ruby's custom Enumerable, you can treat the top-level resources as if they were native Ruby enumerable objects. Here are just a few examples:
+
+```ruby
+Client.first #=> #<Resource::Client name: "chef-webui" ...>
+Client.first(3) #=> [#<Resource::Client name: "chef-webui" ...>, ...]
+Client.map(&:public_key) #=> ["-----BEGIN PUBLIC KEY-----\nMIGfMA...", "-----BEGIN PUBLIC KEY-----\nMIIBI..."]
+```
+
+##### 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
+Client.fetch('chef-webui') #=> #<Resource::Client name: "chef-webui" ...>
+```
+
+If a resource with the given identifier does not exist, it will return `nil`:
+
+```ruby
+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
+Client.update('chef-webui', admin: true)
+```
+
+Or you can get an instance of the object and update the attributes manually:
+
+```ruby
+client = Client.fetch('chef-webui')
+client.admin = true
+client.save
+```
+
+#### Delete
+You can destroy a resource using it's unique identifier:
+
+```ruby
+Client.destroy('chef-webui') #=> true
+```
+
+Or you can get an instance of the object and delete it manually:
+
+```ruby
+client = Client.fetch('chef-webui')
+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
+client = Client.new
+client.save #=> false
+```
+
+Notice that the `client.save` call returned `false`? This is an indication that the resource did not commit back to the server because of a failed validation. You can get the error(s) that prevented the object from saving using the `.errors` method on an instance:
+
+```ruby
+client.errors #=> { :name => ["must be present"] }
+```
+
+Just like Rails, you can also get the human-readable list of these errors by calling `#full_messages` on the errors hash. This is useful if you are using ChefAPI as a library and want to give developers a semantic error:
+
+```ruby
+client.errors.full_messages #=> ["`name' must be present"]
+```
+
+You can also force ChefAPI to raise an exception if the validations fail, using the "bang" version of save - `save!`:
+
+```ruby
+client.save! #=> InvalidResource: There were errors saving your resource: `name' must be present
+```
+
+
+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
+-----------
+1. Clone the project on GitHub
+2. Create a feature branch
+3. Submit a Pull Request
+
+Important Notes:
+
+- **All new features must include test coverage.** At a bare minimum, Unit tests are required. It is preferred if you include acceptance tests as well.
+- **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
+-----------------
+- Author: Seth Vargo <sethvargo@gmail.com>
+
+```text
+Copyright 2013-2014 Seth Vargo
+
+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 @@
+require 'bundler/gem_tasks'

data/chef-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chef-api'
+  spec.version       = ChefAPI::VERSION
+  spec.authors       = ['Seth Vargo']
+  spec.email         = ['sethvargo@gmail.com']
+  spec.description   = 'A tiny Chef API client with minimal dependencies'
+  spec.summary       = 'A Chef API client in Ruby'
+  spec.homepage      = 'https://github.com/sethvargo/chef-api'
+  spec.license       = 'Apache 2.0'
+
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.files         = `git ls-files`.split($/)
+  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 'i18n',                  '~> 0.6'
+  spec.add_dependency 'mixlib-authentication', '~> 1.3'
+end

data/lib/chef-api/boolean.rb

@@ -0,0 +1,6 @@
+module ChefAPI
+  module Boolean; end
+
+  TrueClass.send(:include, Boolean)
+  FalseClass.send(:include, Boolean)
+end

data/lib/chef-api/configurable.rb

@@ -0,0 +1,78 @@
+module ChefAPI
+  #
+  # A re-usable class containing configuration information for the {Client}. See
+  # {Defaults} for a list of default values.
+  #
+  module Configurable
+    class << self
+      #
+      # The list of configurable keys.
+      #
+      # @return [Array<Symbol>]
+      #
+      def keys
+        @keys ||= [
+          :endpoint,
+          :client,
+          :key,
+          :proxy_address,
+          :proxy_password,
+          :proxy_port,
+          :proxy_username,
+          :ssl_pem_file,
+          :ssl_verify,
+          :user_agent,
+        ]
+      end
+    end
+
+    #
+    # Create one attribute getter and setter for each key.
+    #
+    ChefAPI::Configurable.keys.each do |key|
+      attr_accessor key
+    end
+
+    #
+    # Set the configuration for this config, using a block.
+    #
+    # @example Configure the API endpoint
+    #   ChefAPI.configure do |config|
+    #     config.endpoint = "http://www.my-ChefAPI-server.com/ChefAPI"
+    #   end
+    #
+    def configure
+      yield self
+    end
+
+    #
+    # Reset all configuration options to their default values.
+    #
+    # @example Reset all settings
+    #   ChefAPI.reset!
+    #
+    # @return [self]
+    #
+    def reset!
+      ChefAPI::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Defaults.options[key])
+      end
+      self
+    end
+    alias_method :setup, :reset!
+
+    private
+
+    #
+    # The list of configurable keys, as an options hash.
+    #
+    # @return [Hash]
+    #
+    def options
+      map = ChefAPI::Configurable.keys.map do |key|
+        [key, instance_variable_get(:"@#{key}")]
+      end
+      Hash[map]
+    end
+  end
+end