chef-api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9d6c6244de045894dffca646b3cea3696645629
-  data.tar.gz: 3e5a947c02535d537733ee9009906964d423af88
+  metadata.gz: 2eb1855e2b759c9728d8bb855286295c5051174a
+  data.tar.gz: e04becfd2a2fdbac4bfa2420810f4cedace3c4f4
 SHA512:
-  metadata.gz: 0e4c4aa13d550e8ffeabf24e0dae0bbd9695a276eb85097e265cf121137f9ef19ed96712f3b172b80716789c60504961760f2ee722b6c459731ef6b0e48121d2
-  data.tar.gz: ade2f5cc5dfada170a6922aecf6a6acfe2b23a071a21bca2d062aa86f7d15f4dde1e5caa12e34cf28af7ee8f3c8faaff28b9aa7eb312bab1cff1d3b775f01edb
+  metadata.gz: f6bfa54343067d1ebe47610970206ed7c55701e01d942a4774fb1e1645a7d289bfc965975ad2b4d25ba468b5da6091ee8c94b2e21c86a46f88cdae74136cf2ee
+  data.tar.gz: 5bbfff5db04efb34eb49977bc62e89bdb3c21ba97c58194e5fb3b00aee44b271be2f33ef25919fea8db55376464bc52b39b0888f47745ee0ac6b19b3897538c7

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
   - 2.0.0
   - 2.1.0
 
-# Don't install local development gems on Travis
-bundler_args: --without development
+# Don't install local development gems on Travis, use parallel gem downloads
+bundler_args: --without development --jobs 7
 
 # Only test master
 branches:

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+ChefAPI Changelog
+=================
+
+v0.2.1 (2014-04-17)
+-------------------
+- Fix a series of typographical errors
+- Improved documentation for loading resources from disk
+- Improved spec coverage
+- Switch to Logify for logging
+- Add HEC endpoint for authenticating users
+- Change the default options for Hosted Chef
+- Implement HTTPGatewayTimeout (504)
+- Do not automatically inflate JSON objects
+- Improved logging awesomeness
+- Add "flavors" when defining the schema (OSC is different than HEC)
+- Remove i18n in favor of ERB
+- Fix an issue when providing a key at an unexpanded path

data/README.md

@@ -48,6 +48,14 @@ ChefAPI.configure do |config|
   # Hosted Chef Server, or Enterprise Chef Server.
   config.endpoint = 'https://api.opscode.com/organizations/meats'
 
+  # ChefAPI will try to determine if you are running on an Enterprise Chef
+  # Server or Open Source Chef depending on the URL you provide for the
+  # +endpoint+ attribute. However, it may be incorrect. If is seems like the
+  # generated schema does not match the response from the server, it is
+  # possible this value was calculated incorrectly. Thus, you should set it
+  # manually. Possible values are +:enterprise+ and +:open_source+.
+  config.flavor = :enterprise
+
   # 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.
@@ -90,6 +98,33 @@ export CHEF_API_CLIENT=bacon
 export CHEF_API_KEY=~/.chef/bacon.pem
 ```
 
+If you prefer a more object-oriented approach (or if you want to support multiple simultaneous connections), you can create a raw `ChefAPI::Connection` object. All of the options that are available on the `ChefAPI` object are also available on a raw connection:
+
+```ruby
+connection = ChefAPI::Connection.new(
+  endpoint: 'https://api.opscode.com/organizations/meats',
+  client:   'bacon',
+  key:      '~/.chef/bacon.pem'
+)
+
+connection.clients.fetch('chef-webui')
+connection.environments.delete('production')
+```
+
+If you do not want to manage a `ChefAPI::Connection` object, or if you just prefer an alternative syntax, you can use the block-form:
+
+```ruby
+ChefAPI::Connection.new do |connection|
+  connection.endpoint = 'https://api.opscode.com/organizations/meats'
+  connection.client   = 'bacon'
+  connection.key      = '~/.chef/bacon.pem'
+
+  # The connection object is now setup, so you can use it directly:
+  connection.clients.fetch('chef-webui')
+  connection.environments.delete('production')
+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.
 
@@ -223,6 +258,13 @@ You can also force ChefAPI to raise an exception if the validations fail, using
 client.save! #=> InvalidResource: There were errors saving your resource: `name' must be present
 ```
 
+### 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: "..." ...>
+```
+
 
 FAQ
 ---

data/chef-api.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'i18n',                  '~> 0.6'
+  spec.add_dependency 'logify',                '~> 0.1'
   spec.add_dependency 'mixlib-authentication', '~> 1.3'
 end

data/lib/chef-api/configurable.rb

@@ -1,7 +1,7 @@
 module ChefAPI
   #
-  # A re-usable class containing configuration information for the {Client}. See
-  # {Defaults} for a list of default values.
+  # A re-usable class containing configuration information for the {Connection}.
+  # See {Defaults} for a list of default values.
   #
   module Configurable
     class << self
@@ -13,6 +13,7 @@ module ChefAPI
       def keys
         @keys ||= [
           :endpoint,
+          :flavor,
           :client,
           :key,
           :proxy_address,

data/lib/chef-api/connection.rb

@@ -16,33 +16,54 @@ module ChefAPI
       #
       # @macro proxy
       #   @method $1
-      #     Get a proxied collection for +$1+. The proxy automatically injects
-      #     the current connection into the $2, providing a very Rubyesque way
-      #     for handling multiple connection objects.
+      #     Get the list of $1 for this {Connection}. This method is threadsafe.
       #
-      #     @example Get the $1 from the connection object
+      #     @example Get the $1 from this {Connection} object
       #       connection = ChefAPI::Connection.new('...')
-      #       connection.$1 #=> $2 (with the connection object pre-populated)
+      #       connection.$1 #=> $2(attribute1, attribute2, ...)
       #
-      #     @return [ChefAPI::Proxy<$2>]
-      #       a collection proxy for the $2
+      #     @return [Class<$2>]
       #
       def proxy(name, klass)
         class_eval <<-EOH, __FILE__, __LINE__ + 1
           def #{name}
-            @#{name} ||= ChefAPI::Proxy.new(self, #{klass})
+            Thread.current['chefapi.connection'] = self
+            #{klass}
           end
         EOH
       end
     end
 
+    include Logify
     include ChefAPI::Configurable
-    include ChefAPI::Logger
+
+    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'
 
     #
     # Create a new ChefAPI Connection with the given options. Any options
     # given take precedence over the default options.
     #
+    # @example Create a connection object from a list of options
+    #   ChefAPI::Connection.new(
+    #     endpoint: 'https://...',
+    #     client:   'bacon',
+    #     key:      '~/.chef/bacon.pem',
+    #   )
+    #
+    # @example Create a connection object using a block
+    #   ChefAPI::Connection.new do |connection|
+    #     connection.endpoint = 'https://...'
+    #     connection.client   = 'bacon'
+    #     connection.key      = '~/.chef/bacon.pem'
+    #   end
+    #
     # @return [ChefAPI::Connection]
     #
     def initialize(options = {})
@@ -56,6 +77,8 @@ module ChefAPI
 
         instance_variable_set(:"@#{key}", value)
       end
+
+      yield self if block_given?
     end
 
     #
@@ -149,14 +172,13 @@ module ChefAPI
     #   request against
     # @param [#read, Hash, nil] data
     #   the data to use (varies based on the +verb+)
-    # @param [Hash] headers
-    #   the list of headers to use
     #
     # @return [String, Hash]
     #   the response body
     #
     def request(verb, path, data = {})
-      log.info "===> #{verb.to_s.upcase} #{path}..."
+      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)
@@ -201,7 +223,7 @@ module ChefAPI
         # Naughty, naughty, naughty! Don't blame when when someone hops in
         # and executes a MITM attack!
         unless ssl_verify
-          log.warn "===> Disabling SSL verification..."
+          log.warn "Disabling SSL verification..."
           log.warn "Neither ChefAPI nor the maintainers are responsible for " \
             "damanges incurred as a result of disabling SSL verification. " \
             "Please use this with extreme caution, or consider specifying " \
@@ -215,11 +237,14 @@ module ChefAPI
       connection.start do |http|
         response = http.request(request)
 
+        log.debug "Raw response:"
+        log.debug response.body
+
         case response
         when Net::HTTPRedirection
-          redirect = URI.parse(response['location'])
-          log.debug "===> Performing HTTP redirect to #{redirect}"
-          request(verb, redirect, params)
+          redirect = URI.parse(response['location']).to_s
+          log.debug "Performing HTTP redirect to #{redirect}"
+          request(verb, redirect, data)
         when Net::HTTPSuccess
           success(response)
         else
@@ -227,7 +252,7 @@ module ChefAPI
         end
       end
     rescue SocketError, Errno::ECONNREFUSED, EOFError
-      log.warn "     Unable to reach the Chef Server"
+      log.warn "Unable to reach the Chef Server"
       raise Error::HTTPServerUnavailable.new
     end
 
@@ -250,13 +275,16 @@ module ChefAPI
     # @return [URI]
     #
     def build_uri(verb, path, params = {})
-      log.info  "===> Building URI..."
+      log.info  "Building URI..."
 
       # Add any query string parameters
       if [:delete, :get].include?(verb)
-        log.debug "     Detected verb deserves a querystring"
-        log.debug "     Building querystring using #{params.inspect}"
-        path = [path, to_query_string(params)].compact.join('?')
+        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
       end
 
       # Parse the URI
@@ -264,8 +292,8 @@ module ChefAPI
 
       # Don't merge absolute URLs
       unless uri.absolute?
-        log.debug "     Detected URI is relative"
-        log.debug "     Appending #{endpoint} to #{path}"
+        log.debug "Detected URI is relative"
+        log.debug "Appending #{path} to #{endpoint}"
         uri = URI.parse(File.join(endpoint, path))
       end
 
@@ -274,7 +302,7 @@ module ChefAPI
     end
 
     #
-    # Helper method to get the corresponding {Net::HTTP} class from the given
+    # Helper method to get the corresponding +Net::HTTP+ class from the given
     # HTTP verb.
     #
     # @param [#to_s] verb
@@ -323,24 +351,24 @@ module ChefAPI
     def parsed_key
       return @parsed_key if @parsed_key
 
-      log.info "===> Parsing private key..."
+      log.info "Parsing private key..."
 
       if key.nil?
-        log.warn "     No private key given!"
+        log.warn "No private key given!"
         raise 'No private key given!'
       end
 
       if key.is_a?(OpenSSL::PKey::RSA)
-        log.debug "     Detected private key is an OpenSSL Ruby object"
+        log.debug "Detected private key is an OpenSSL Ruby object"
         @parsed_key = key
       end
 
-      if key =~ /(.+)\.pem$/ || File.exists?(key)
-        log.debug "     Detected private key is the path to a file"
+      if key =~ /(.+)\.pem$/ || File.exists?(File.expand_path(key))
+        log.debug "Detected private key is the path to a file"
         contents = File.read(File.expand_path(key))
         @parsed_key = OpenSSL::PKey::RSA.new(contents)
       else
-        log.debug "     Detected private key was the literal string key"
+        log.debug "Detected private key was the literal string key"
         @parsed_key = OpenSSL::PKey::RSA.new(key)
       end
 
@@ -359,15 +387,15 @@ module ChefAPI
     #   the parsed response, as an object
     #
     def success(response)
-      log.info "===> Parsing response as success..."
+      log.info "Parsing response as success..."
 
       case response['Content-Type']
-      when 'application/json'
-        log.debug "     Detected response as JSON"
-        log.debug "     Parsing response body as JSON"
+      when /json/
+        log.debug "Detected response as JSON"
+        log.debug "Parsing response body as JSON"
         JSON.parse(response.body)
       else
-        log.debug "     Detected response as text/plain"
+        log.debug "Detected response as text/plain"
         response.body
       end
     end
@@ -380,15 +408,15 @@ module ChefAPI
     #   the response object from the request
     #
     def error(response)
-      log.info "===> Parsing response as error..."
+      log.info "Parsing response as error..."
 
       case response['Content-Type']
-      when 'application/json'
-        log.debug "     Detected error response as JSON"
-        log.debug "     Parsing error response as JSON"
-        message = JSON.parse(response.body)['error'].first
+      when /json/
+        log.debug "Detected error response as JSON"
+        log.debug "Parsing error response as JSON"
+        message = Array(JSON.parse(response.body)['error']).join(', ')
       else
-        log.debug "     Detected response as text/plain"
+        log.debug "Detected response as text/plain"
         message = response.body
       end
 
@@ -405,6 +433,8 @@ module ChefAPI
         raise Error::HTTPMethodNotAllowed.new(message: message)
       when 406
         raise Error::HTTPNotAcceptable.new(message: message)
+      when 504
+        raise Error::HTTPGatewayTimeout.new(message: message)
       when 500..600
         raise Error::HTTPServerUnavailable.new
       else
@@ -418,7 +448,7 @@ module ChefAPI
     # @param [Net::HTTP::Request] request
     #
     def add_request_headers(request)
-      log.info "===> Adding request headers..."
+      log.info "Adding request headers..."
 
       headers = {
         'Accept'         => 'application/json',
@@ -430,7 +460,7 @@ module ChefAPI
       }
 
       headers.each do |key, value|
-        log.debug "     #{key}: #{value}"
+        log.debug "#{key}: #{value}"
         request[key] = value
       end
     end
@@ -441,9 +471,9 @@ module ChefAPI
     # @param [Net::HTTP::Request] request
     #
     def add_signing_headers(verb, uri, request, key)
-      log.info "===> Adding signed header authentication..."
+      log.info "Adding signed header authentication..."
 
-      unless defined?(Mixlib::Authentication)
+      unless defined?(Mixlib::Authentication::SignedHeaderAuth)
         require 'mixlib/authentication/signedheaderauth'
       end
 
@@ -451,14 +481,14 @@ module ChefAPI
         :http_method => verb,
         :body        => request.body || '',
         :host        => "#{uri.host}:#{uri.port}",
-        :path        => request.path,
+        :path        => uri.path,
         :timestamp   => Time.now.utc.iso8601,
         :user_id     => client,
         :file        => '',
       ).sign(key)
 
       headers.each do |key, value|
-        log.debug "     #{key}: #{value}"
+        log.debug "#{key}: #{value}"
         request[key] = value
       end
     end

data/lib/chef-api/defaults.rb

@@ -3,7 +3,7 @@ require 'chef-api/version'
 module ChefAPI
   module Defaults
     # Default API endpoint
-    ENDPOINT = 'http://localhost:4000/'.freeze
+    ENDPOINT = 'https://api.opscode.com/'.freeze
 
     # Default User Agent header string
     USER_AGENT = "ChefAPI Ruby Gem #{ChefAPI::VERSION}".freeze
@@ -21,22 +21,42 @@ module ChefAPI
       #
       # The endpoint where the Chef Server lives. This is equivalent to the
       # +chef_server_url+ in Chef terminology. If you are using Enterprise
-      # Hosted Chef or Enterprise Chef on premise, this endpoint includes your
-      # organization name, such as:
+      # Hosted Chef or Enterprise Chef on premise, this endpoint should include
+      # your organization name. For example:
       #
-      #     https://api.opscode.com/organizations/NAME
+      #     https://api.opscode.com/organizations/bacon
       #
-      # If you are running Open Source Chef Server or Chef Zero, this is just
-      # the URL to your Chef Server instance, such as:
+      # If you are running Open Source Chef Server or Chef Zero, this is the
+      # full URL to your Chef Server instance, including the server port and
+      # FQDN.
       #
-      #     http://chef.example.com/
+      #     https://chef.server.local:4567/
       #
-      # @return [String]
+      # @return [String] (default: +https://api.opscode.com/+)
       #
       def endpoint
         ENV['CHEF_API_ENDPOINT'] || ENDPOINT
       end
 
+      #
+      # The flavor of the target Chef Server. There are two possible values:
+      #
+      #   - enterprise
+      #   - open_source
+      #
+      # "Enterprise" covers both Hosted Chef and Enterprise Chef. "Open Source"
+      # covers both Chef Zero and Open Source Chef Server.
+      #
+      # @return [true, false]
+      #
+      def flavor
+        if ENV['CHEF_API_FLAVOR']
+          ENV['CHEF_API_FLAVOR'].to_sym
+        else
+          endpoint.include?('/organizations') ? :enterprise : :open_source
+        end
+      end
+
       #
       # The User Agent header to send along.
       #

data/lib/chef-api/errors.rb

@@ -1,11 +1,39 @@
+require 'erb'
+
 module ChefAPI
   module Error
+    class ErrorBinding
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
     class ChefAPIError < StandardError
       def initialize(options = {})
-        class_name = self.class.to_s.split('::').last
-        error_key  = Util.underscore(class_name)
+        @options  = options
+        @filename = options.delete(:_template)
+
+        super()
+      end
 
-        super I18n.t("chef_api.errors.#{error_key}", options)
+      def message
+        erb = ERB.new(File.read(template))
+        erb.result(ErrorBinding.new(@options).get_binding)
+      end
+      alias_method :to_s, :message
+
+      private
+
+      def template
+        class_name = self.class.to_s.split('::').last
+        filename   = @filename || Util.underscore(class_name)
+        ChefAPI.root.join('templates', 'errors', "#{filename}.erb")
       end
     end
 
@@ -16,6 +44,7 @@ module ChefAPI
     class HTTPError < ChefAPIError; end
     class HTTPBadRequest < HTTPError; end
     class HTTPForbiddenRequest < HTTPError; end
+    class HTTPGatewayTimeout < HTTPError; end
     class HTTPNotAcceptable < HTTPError; end
     class HTTPNotFound < HTTPError; end
     class HTTPMethodNotAllowed < HTTPError; end

data/lib/chef-api/resource.rb

@@ -9,6 +9,7 @@ module ChefAPI
     autoload :DataBagItem,     'chef-api/resources/data_bag_item'
     autoload :Environment,     'chef-api/resources/environment'
     autoload :Node,            'chef-api/resources/node'
+    autoload :Organization,    'chef-api/resources/organization'
     autoload :Principal,       'chef-api/resources/principal'
     autoload :Role,            'chef-api/resources/role'
     autoload :User,            'chef-api/resources/user'