chef-api 0.9.0 → 0.10.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8604bcf5bcfe321caabd69eaf49850a1cb3a2a2e64f4ba3f1f9f19dbe23b70
-  data.tar.gz: 792c8bf1f685f45317e80b13b389fd5898e57db767f447bacc5bf5711a47d3af
+  metadata.gz: 9190cfe613a46da5a280ffc69ba7f58a0a955a354e3272c166f8e76c8bbbbc49
+  data.tar.gz: a8851cab2284d7935300c90883eb27ffc3c88673cb1d3566528fb37167a120de
 SHA512:
-  metadata.gz: e0ec7e3b00bbfee5ccb9774803f1db57b8c326e0ba4f63d61e4dceebadd921ff6281f560873ef4a31372e0158fdda4173b0380162e16014171bbf817eaf6d7db
-  data.tar.gz: a346455a325f6454efd34a6b4fe370e8f37734886e8ad85f00118cc67467c0d473a3140b87d1ca86f2fa9c003159679b5debd5a3527a6e8fdb9ab65d89a7e8ba
+  metadata.gz: 5275c0487d47da3cb81c1a9eff0bb07cdd5a71fe24534dff2b5e78e547db9c8c2e65b63fc817b0041f952770ea10a97e5438083829ed4c0a76439a37b225970e
+  data.tar.gz: bf8f4fb60b9c8da3a4071da529f4b54093bf73c80d0e806594f6ed741f4d8df8e2dc6ddd69bcc4fae9779c65a2d4f305d73919fc19dbcd7d19a1343cff114ad1

data/lib/chef-api.rb

@@ -1,21 +1,21 @@
-require 'json'
-require 'logify'
-require 'pathname'
-require 'chef-api/version'
+require "json" unless defined?(JSON)
+require "pathname" unless defined?(Pathname)
+require_relative "chef-api/log"
+require_relative "chef-api/version"
 
 module ChefAPI
-  autoload :Authentication,  'chef-api/authentication'
-  autoload :Boolean,         'chef-api/boolean'
-  autoload :Configurable,    'chef-api/configurable'
-  autoload :Connection,      'chef-api/connection'
-  autoload :Defaults,        'chef-api/defaults'
-  autoload :Error,           'chef-api/errors'
-  autoload :ErrorCollection, 'chef-api/error_collection'
-  autoload :Multipart,       'chef-api/multipart'
-  autoload :Resource,        'chef-api/resource'
-  autoload :Schema,          'chef-api/schema'
-  autoload :Util,            'chef-api/util'
-  autoload :Validator,       'chef-api/validator'
+  autoload :Authentication,  "chef-api/authentication"
+  autoload :Boolean,         "chef-api/boolean"
+  autoload :Configurable,    "chef-api/configurable"
+  autoload :Connection,      "chef-api/connection"
+  autoload :Defaults,        "chef-api/defaults"
+  autoload :Error,           "chef-api/errors"
+  autoload :ErrorCollection, "chef-api/error_collection"
+  autoload :Multipart,       "chef-api/multipart"
+  autoload :Resource,        "chef-api/resource"
+  autoload :Schema,          "chef-api/schema"
+  autoload :Util,            "chef-api/util"
+  autoload :Validator,       "chef-api/validator"
 
   #
   # @todo Document this and why it's important
@@ -35,7 +35,7 @@ module ChefAPI
     #   the log level to set
     #
     def log_level=(level)
-      Logify.level = level
+      ChefAPI::Log.level = level
     end
 
     #
@@ -44,7 +44,7 @@ module ChefAPI
     # @return [Symbol]
     #
     def log_level
-      Logify.level
+      ChefAPI::Log.level
     end
 
     #
@@ -54,7 +54,7 @@ module ChefAPI
     # @return [Pathname]
     #
     def root
-      @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+      @root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
 
     #
@@ -93,4 +93,3 @@ end
 
 # Load the initial default values
 ChefAPI.setup
-

data/lib/chef-api/aclable.rb

@@ -0,0 +1,35 @@
+module ChefAPI
+  module AclAble
+    def acl_path
+      resource_path + "/_acl"
+    end
+
+    def load_acl
+      data = self.class.connection.get(acl_path)
+      # make deep copy
+      @orig_acl_data = Marshal.load(Marshal.dump(data))
+      data.freeze
+      @acl = data
+    end
+
+    def acl
+      unless @acl
+        load_acl
+      end
+      @acl
+    end
+
+    def save!
+      super
+      if @acl != @orig_acl_data
+        %w{create update grant read delete}.each { |action|
+          if @acl[action] != @orig_acl_data[action]
+            url = "#{acl_path}/#{action}"
+            self.class.connection.put(url, { action => @acl[action] }.to_json)
+          end
+        }
+      end
+    end
+  end
+
+end

data/lib/chef-api/authentication.rb

@@ -1,7 +1,7 @@
-require 'base64'
-require 'digest'
-require 'openssl'
-require 'time'
+require "base64" unless defined?(Base64)
+require "digest" unless defined?(Digest)
+require "openssl" unless defined?(OpenSSL)
+require "time" unless defined?(Time)
 
 #
 # DEBUG steps:
@@ -11,20 +11,19 @@ require 'time'
 
 module ChefAPI
   class Authentication
-    include Logify
 
     # @todo: Enable this in the future when Mixlib::Authentication supports
     # signing the full request body instead of just the uploaded file parameter.
     SIGN_FULL_BODY = false
 
-    SIGNATURE = 'algorithm=sha1;version=1.0;'.freeze
+    SIGNATURE = "algorithm=sha1;version=1.0;".freeze
 
     # Headers
-    X_OPS_SIGN          = 'X-Ops-Sign'.freeze
-    X_OPS_USERID        = 'X-Ops-Userid'.freeze
-    X_OPS_TIMESTAMP     = 'X-Ops-Timestamp'.freeze
-    X_OPS_CONTENT_HASH  = 'X-Ops-Content-Hash'.freeze
-    X_OPS_AUTHORIZATION = 'X-Ops-Authorization'.freeze
+    X_OPS_SIGN          = "X-Ops-Sign".freeze
+    X_OPS_USERID        = "X-Ops-Userid".freeze
+    X_OPS_TIMESTAMP     = "X-Ops-Timestamp".freeze
+    X_OPS_CONTENT_HASH  = "X-Ops-Content-Hash".freeze
+    X_OPS_AUTHORIZATION = "X-Ops-Authorization".freeze
 
     class << self
       #
@@ -96,9 +95,9 @@ module ChefAPI
     #
     def headers
       {
-        X_OPS_SIGN         => SIGNATURE,
-        X_OPS_USERID       => @user,
-        X_OPS_TIMESTAMP    => canonical_timestamp,
+        X_OPS_SIGN => SIGNATURE,
+        X_OPS_USERID => @user,
+        X_OPS_TIMESTAMP => canonical_timestamp,
         X_OPS_CONTENT_HASH => content_hash,
       }.merge(signature_lines)
     end
@@ -114,7 +113,7 @@ module ChefAPI
       return @content_hash if @content_hash
 
       if SIGN_FULL_BODY
-        @content_hash = hash(@body || '').chomp
+        @content_hash = hash(@body || "").chomp
       else
         if @body.is_a?(Multipart::MultiIO)
           filepart = @body.ios.find { |io| io.is_a?(Multipart::MultiIO) }
@@ -122,7 +121,7 @@ module ChefAPI
 
           @content_hash = hash(file).chomp
         else
-          @content_hash = hash(@body || '').chomp
+          @content_hash = hash(@body || "").chomp
         end
       end
 
@@ -148,29 +147,28 @@ module ChefAPI
     def canonical_key
       return @canonical_key if @canonical_key
 
-      log.info "Parsing private key..."
+      ChefAPI::Log.info "Parsing private key..."
 
       if @key.nil?
-        log.warn "No private key given!"
-        raise 'No private key given!'
+        ChefAPI::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"
+        ChefAPI::Log.debug "Detected private key is an OpenSSL Ruby object"
         @canonical_key = @key
-      elsif @key =~ /(.+)\.pem$/ || File.exists?(File.expand_path(@key))
-        log.debug "Detected private key is the path to a file"
+      elsif @key =~ /(.+)\.pem$/ || File.exist?(File.expand_path(@key))
+        ChefAPI::Log.debug "Detected private key is the path to a file"
         contents = File.read(File.expand_path(@key))
         @canonical_key = OpenSSL::PKey::RSA.new(contents)
       else
-        log.debug "Detected private key was the literal string key"
+        ChefAPI::Log.debug "Detected private key was the literal string key"
         @canonical_key = OpenSSL::PKey::RSA.new(@key)
       end
 
       @canonical_key
     end
 
-
     #
     # The canonical path, with duplicate and trailing slashes removed. This
     # value is then hashed.
@@ -181,7 +179,7 @@ module ChefAPI
     # @return [String]
     #
     def canonical_path
-      @canonical_path ||= hash(@path.squeeze('/').gsub(/(\/)+$/,'')).chomp
+      @canonical_path ||= hash(@path.squeeze("/").gsub(%r{(/)+$}, "")).chomp
     end
 
     #

data/lib/chef-api/configurable.rb

@@ -11,20 +11,20 @@ module ChefAPI
       # @return [Array<Symbol>]
       #
       def keys
-        @keys ||= [
-          :endpoint,
-          :flavor,
-          :client,
-          :key,
-          :proxy_address,
-          :proxy_password,
-          :proxy_port,
-          :proxy_username,
-          :ssl_pem_file,
-          :ssl_verify,
-          :user_agent,
-          :read_timeout,
-        ]
+        @keys ||= %i{
+          endpoint
+          flavor
+          client
+          key
+          proxy_address
+          proxy_password
+          proxy_port
+          proxy_username
+          ssl_pem_file
+          ssl_verify
+          user_agent
+          read_timeout
+        }
       end
     end
 

data/lib/chef-api/connection.rb

@@ -1,7 +1,7 @@
-require 'net/http'
-require 'net/https'
-require 'openssl'
-require 'uri'
+require "net/http" unless defined?(Net::HTTP)
+require "openssl" unless defined?(OpenSSL)
+require "uri" unless defined?(URI)
+require "cgi" unless defined?(CGI)
 
 module ChefAPI
   #
@@ -34,20 +34,21 @@ module ChefAPI
       end
     end
 
-    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 :partial_search, 'Resource::PartialSearch'
-    proxy :principals,     'Resource::Principal'
-    proxy :roles,          'Resource::Role'
-    proxy :search,         'Resource::Search'
-    proxy :users,          'Resource::User'
-    proxy :organizations,  'Resource::Organization'
+    proxy :clients,        "Resource::Client"
+    proxy :cookbooks,      "Resource::Cookbook"
+    proxy :data_bags,      "Resource::DataBag"
+    proxy :data_bag_item,  "Resource::DataBagItem"
+    proxy :environments,   "Resource::Environment"
+    proxy :groups,         "Resource::Group"
+    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"
+    proxy :organizations,  "Resource::Organization"
 
     #
     # Create a new ChefAPI Connection with the given options. Any options
@@ -73,9 +74,9 @@ module ChefAPI
       # Use any options given, but fall back to the defaults set on the module
       ChefAPI::Configurable.keys.each do |key|
         value = if options[key].nil?
-          ChefAPI.instance_variable_get(:"@#{key}")
-        else
-          options[key]
+                  ChefAPI.instance_variable_get(:"@#{key}")
+                else
+                  options[key]
         end
 
         instance_variable_set(:"@#{key}", value)
@@ -196,11 +197,11 @@ module ChefAPI
     #   the response body
     #
     def request(verb, path, data = {}, params = {}, request_options = {})
-      log.info  "#{verb.to_s.upcase} #{path}..."
-      log.debug "Chef flavor: #{flavor.inspect}"
+      ChefAPI::Log.info  "#{verb.to_s.upcase} #{path}..."
+      ChefAPI::Log.debug "Chef flavor: #{flavor.inspect}"
 
       # Build the URI and request object from the given information
-      if [:delete, :get].include?(verb)
+      if %i{delete get}.include?(verb)
         uri = build_uri(verb, path, data)
       else
         uri = build_uri(verb, path, params)
@@ -211,38 +212,38 @@ module ChefAPI
       add_request_headers(request)
 
       # Setup PATCH/POST/PUT
-      if [:patch, :post, :put].include?(verb)
+      if %i{patch post put}.include?(verb)
         if data.respond_to?(:read)
-          log.info "Detected file/io presence"
+          ChefAPI::Log.info "Detected file/io presence"
           request.body_stream = data
         elsif data.is_a?(Hash)
           # If any of the values in the hash are File-like, assume this is a
           # multi-part post
           if data.values.any? { |value| value.respond_to?(:read) }
-            log.info "Detected multipart body"
+            ChefAPI::Log.info "Detected multipart body"
 
             multipart = Multipart::Body.new(data)
 
-            log.debug "Content-Type: #{multipart.content_type}"
-            log.debug "Content-Length: #{multipart.content_length}"
+            ChefAPI::Log.debug "Content-Type: #{multipart.content_type}"
+            ChefAPI::Log.debug "Content-Length: #{multipart.content_length}"
 
             request.content_length = multipart.content_length
             request.content_type   = multipart.content_type
 
             request.body_stream    = multipart.stream
           else
-            log.info "Detected form data"
+            ChefAPI::Log.info "Detected form data"
             request.form_data = data
           end
         else
-          log.info "Detected regular body"
+          ChefAPI::Log.info "Detected regular body"
           request.body = data
         end
       end
 
       # Sign the request
       if request_options[:sign] == false
-        log.info "Skipping signed header authentication (user requested)..."
+        ChefAPI::Log.info "Skipping signed header authentication (user requested)..."
       else
         add_signing_headers(verb, uri.path, request)
       end
@@ -259,7 +260,7 @@ module ChefAPI
       connection.read_timeout = read_timeout if read_timeout
 
       # Apply SSL, if applicable
-      if uri.scheme == 'https'
+      if uri.scheme == "https"
         # Turn on SSL
         connection.use_ssl = true
 
@@ -274,8 +275,8 @@ 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 "Neither ChefAPI nor the maintainers are responsible for " \
+          ChefAPI::Log.warn "Disabling SSL verification..."
+          ChefAPI::Log.warn "Neither ChefAPI nor the maintainers are responsible for " \
             "damages incurred as a result of disabling SSL verification. " \
             "Please use this with extreme caution, or consider specifying " \
             "a custom certificate using `config.ssl_pem_file'."
@@ -288,13 +289,13 @@ module ChefAPI
       connection.start do |http|
         response = http.request(request)
 
-        log.debug "Raw response:"
-        log.debug response.body
+        ChefAPI::Log.debug "Raw response:"
+        ChefAPI::Log.debug response.body
 
         case response
         when Net::HTTPRedirection
-          redirect = URI.parse(response['location']).to_s
-          log.debug "Performing HTTP redirect to #{redirect}"
+          redirect = URI.parse(response["location"]).to_s
+          ChefAPI::Log.debug "Performing HTTP redirect to #{redirect}"
           request(verb, redirect, data)
         when Net::HTTPSuccess
           success(response)
@@ -303,7 +304,7 @@ module ChefAPI
         end
       end
     rescue SocketError, Errno::ECONNREFUSED, EOFError
-      log.warn "Unable to reach the Chef Server"
+      ChefAPI::Log.warn "Unable to reach the Chef Server"
       raise Error::HTTPServerUnavailable.new
     end
 
@@ -326,14 +327,14 @@ module ChefAPI
     # @return [URI]
     #
     def build_uri(verb, path, params = {})
-      log.info  "Building URI..."
+      ChefAPI::Log.info "Building URI..."
 
       # Add any query string parameters
       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('?')
+        ChefAPI::Log.debug "Detected verb deserves a querystring"
+        ChefAPI::Log.debug "Building querystring using #{params.inspect}"
+        ChefAPI::Log.debug "Compiled querystring is #{querystring.inspect}"
+        path = [path, querystring].compact.join("?")
       end
 
       # Parse the URI
@@ -341,8 +342,8 @@ module ChefAPI
 
       # Don't merge absolute URLs
       unless uri.absolute?
-        log.debug "Detected URI is relative"
-        log.debug "Appending #{path} to #{endpoint}"
+        ChefAPI::Log.debug "Detected URI is relative"
+        ChefAPI::Log.debug "Appending #{path} to #{endpoint}"
         uri = URI.parse(File.join(endpoint, path))
       end
 
@@ -375,8 +376,8 @@ module ChefAPI
     #
     def to_query_string(hash)
       hash.map do |key, value|
-        "#{URI.escape(key.to_s)}=#{URI.escape(value.to_s)}"
-      end.join('&')[/.+/]
+        "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+      end.join("&")[/.+/]
     end
 
     private
@@ -393,15 +394,15 @@ module ChefAPI
     #   the parsed response, as an object
     #
     def success(response)
-      log.info "Parsing response as success..."
+      ChefAPI::Log.info "Parsing response as success..."
 
-      case response['Content-Type']
+      case response["Content-Type"]
       when /json/
-        log.debug "Detected response as JSON"
-        log.debug "Parsing response body as JSON"
+        ChefAPI::Log.debug "Detected response as JSON"
+        ChefAPI::Log.debug "Parsing response body as JSON"
         JSON.parse(response.body)
       else
-        log.debug "Detected response as text/plain"
+        ChefAPI::Log.debug "Detected response as text/plain"
         response.body
       end
     end
@@ -414,15 +415,15 @@ module ChefAPI
     #   the response object from the request
     #
     def error(response)
-      log.info "Parsing response as error..."
+      ChefAPI::Log.info "Parsing response as error..."
 
-      case response['Content-Type']
+      case response["Content-Type"]
       when /json/
-        log.debug "Detected error response as JSON"
-        log.debug "Parsing error response as JSON"
+        ChefAPI::Log.debug "Detected error response as JSON"
+        ChefAPI::Log.debug "Parsing error response as JSON"
         message = JSON.parse(response.body)
       else
-        log.debug "Detected response as text/plain"
+        ChefAPI::Log.debug "Detected response as text/plain"
         message = response.body
       end
 
@@ -454,19 +455,19 @@ module ChefAPI
     # @param [Net::HTTP::Request] request
     #
     def add_request_headers(request)
-      log.info "Adding request headers..."
+      ChefAPI::Log.info "Adding request headers..."
 
       headers = {
-        'Accept'         => 'application/json',
-        'Content-Type'   => 'application/json',
-        'Connection'     => 'keep-alive',
-        'Keep-Alive'     => '30',
-        'User-Agent'     => user_agent,
-        'X-Chef-Version' => '11.4.0',
+        "Accept" => "application/json",
+        "Content-Type" => "application/json",
+        "Connection" => "keep-alive",
+        "Keep-Alive" => "30",
+        "User-Agent" => user_agent,
+        "X-Chef-Version" => "11.4.0",
       }
 
       headers.each do |key, value|
-        log.debug "#{key}: #{value}"
+        ChefAPI::Log.debug "#{key}: #{value}"
         request[key] = value
       end
     end
@@ -482,18 +483,18 @@ module ChefAPI
     # @param [Net::HTTP::Request] request
     #
     def add_signing_headers(verb, path, request)
-      log.info "Adding signed header authentication..."
+      ChefAPI::Log.info "Adding signed header authentication..."
 
       authentication = Authentication.from_options(
         user: client,
         key:  key,
         verb: verb,
         path: path,
-        body: request.body || request.body_stream,
+        body: request.body || request.body_stream
       )
 
       authentication.headers.each do |key, value|
-        log.debug "#{key}: #{value}"
+        ChefAPI::Log.debug "#{key}: #{value}"
         request[key] = value
       end