chef-api 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb60acbcccaaf06781a238fb0698a48492bb89a9f953d19a6fa0ba5861d26e3f
-  data.tar.gz: d646e7a1a4d1fae8c62f8cd107df7d2ed7fd6f2c02516b1adef0ea9c07c7bbd0
+  metadata.gz: 46c0549e102320d5807b0489a96c6b361ae8f9c394f850379f5eff6919d51401
+  data.tar.gz: 0e9c8f3684fa76bb9044e97b66cc77272adfe44b4612542cc8e4ca19d7370bf0
 SHA512:
-  metadata.gz: 9f5050adf73f8f580274b32718524e50b813bb4a70c3c4664b182f95b759cd8f20ccd3604aaad5bb32b10a6d545e3f108d3d4fad5b482c9a08a3209ead137a7c
-  data.tar.gz: 9c73fc775086eddb194614d1a0094e84311aeb9d027df08aff68061a9498f9a2af8977486e3664f58311f3d9efe02d09a9bb11c3b889e47062e2427337bb7ec8
+  metadata.gz: 232b3d9f101f12d57e6a8594faa2c7e595a05052bcd331df708a8221db1168529a4c204037d1dc8e7b160cc507aa21f4854f2ec0d3fe5db7a51c7669cf860a19
+  data.tar.gz: 30310067ede141b9c8873d01371560ceb3f1127b3da6d6a0f96772a0f266b47b25c1dbb3a480d035f97923545e030d3132b7eb8b2a0abe959b53aeab2ed139cb

data/lib/chef-api.rb

@@ -1,21 +1,21 @@
-require 'json'
-require 'logify'
-require 'pathname'
-require 'chef-api/version'
+require "json"
+require "logify"
+require "pathname"
+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
@@ -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

@@ -1,7 +1,7 @@
 module ChefAPI
   module AclAble
     def acl_path
-      self.resource_path + '/_acl'
+      resource_path + "/_acl"
     end
 
     def load_acl
@@ -14,7 +14,7 @@ module ChefAPI
 
     def acl
       unless @acl
-        self.load_acl
+        load_acl
       end
       @acl
     end
@@ -22,14 +22,14 @@ module ChefAPI
     def save!
       super
       if @acl != @orig_acl_data
-        %w(create update grant read delete).each{|action|
+        %w{create update grant read delete}.each { |action|
           if @acl[action] != @orig_acl_data[action]
-            url = "#{self.acl_path}/#{action}"
-            self.class.connection.put(url, {action => @acl[action]}.to_json)
+            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"
+require "digest"
+require "openssl"
+require "time"
 
 #
 # DEBUG steps:
@@ -17,14 +17,14 @@ module ChefAPI
     # 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 +96,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 +114,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 +122,7 @@ module ChefAPI
 
           @content_hash = hash(file).chomp
         else
-          @content_hash = hash(@body || '').chomp
+          @content_hash = hash(@body || "").chomp
         end
       end
 
@@ -152,13 +152,13 @@ module ChefAPI
 
       if @key.nil?
         log.warn "No private key given!"
-        raise '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"
         @canonical_key = @key
-      elsif @key =~ /(.+)\.pem$/ || File.exists?(File.expand_path(@key))
+      elsif @key =~ /(.+)\.pem$/ || File.exist?(File.expand_path(@key))
         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)
@@ -170,7 +170,6 @@ module ChefAPI
       @canonical_key
     end
 
-
     #
     # The canonical path, with duplicate and trailing slashes removed. This
     # value is then hashed.
@@ -181,7 +180,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"
+require "net/https"
+require "openssl"
+require "uri"
 
 module ChefAPI
   #
@@ -37,19 +37,19 @@ module ChefAPI
     include Logify
     include ChefAPI::Configurable
 
-    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'
+    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
@@ -75,9 +75,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)
@@ -202,7 +202,7 @@ module 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)
@@ -213,7 +213,7 @@ 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"
           request.body_stream = data
@@ -261,7 +261,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
 
@@ -295,7 +295,7 @@ module ChefAPI
 
         case response
         when Net::HTTPRedirection
-          redirect = URI.parse(response['location']).to_s
+          redirect = URI.parse(response["location"]).to_s
           log.debug "Performing HTTP redirect to #{redirect}"
           request(verb, redirect, data)
         when Net::HTTPSuccess
@@ -328,14 +328,14 @@ module ChefAPI
     # @return [URI]
     #
     def build_uri(verb, path, params = {})
-      log.info  "Building URI..."
+      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('?')
+        path = [path, querystring].compact.join("?")
       end
 
       # Parse the URI
@@ -378,7 +378,7 @@ module ChefAPI
     def to_query_string(hash)
       hash.map do |key, value|
         "#{URI.escape(key.to_s)}=#{URI.escape(value.to_s)}"
-      end.join('&')[/.+/]
+      end.join("&")[/.+/]
     end
 
     private
@@ -397,7 +397,7 @@ module ChefAPI
     def success(response)
       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"
@@ -418,7 +418,7 @@ module ChefAPI
     def error(response)
       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"
@@ -459,12 +459,12 @@ module 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|
@@ -491,7 +491,7 @@ module ChefAPI
         key:  key,
         verb: verb,
         path: path,
-        body: request.body || request.body_stream,
+        body: request.body || request.body_stream
       )
 
       authentication.headers.each do |key, value|

data/lib/chef-api/defaults.rb

@@ -1,11 +1,11 @@
-require 'chef-api/version'
-require 'pathname'
-require 'json'
+require_relative "version"
+require "pathname"
+require "json"
 
 module ChefAPI
   module Defaults
     # Default API endpoint
-    ENDPOINT = 'https://api.opscode.com/'.freeze
+    ENDPOINT = "https://api.opscode.com/".freeze
 
     # Default User Agent header string
     USER_AGENT = "ChefAPI Ruby Gem #{ChefAPI::VERSION}".freeze
@@ -37,7 +37,7 @@ module ChefAPI
         if result = chef_api_config_path
           Pathname(result).expand_path
         else
-          Pathname('')
+          Pathname("")
         end
       end
 
@@ -46,8 +46,8 @@ module ChefAPI
       #
       # @return [String, nil] Path to config file, or nil
       def chef_api_config_path
-        ENV['CHEF_API_CONFIG'] || if ENV.key?('HOME')
-                                    '~/.chef-api'
+        ENV["CHEF_API_CONFIG"] || if ENV.key?("HOME")
+                                    "~/.chef-api"
                                   else
                                     nil
                                   end
@@ -70,7 +70,7 @@ module ChefAPI
       # @return [String] (default: +https://api.opscode.com/+)
       #
       def endpoint
-        ENV['CHEF_API_ENDPOINT'] || config['CHEF_API_ENDPOINT'] || ENDPOINT
+        ENV["CHEF_API_ENDPOINT"] || config["CHEF_API_ENDPOINT"] || ENDPOINT
       end
 
       #
@@ -85,12 +85,12 @@ module ChefAPI
       # @return [true, false]
       #
       def flavor
-        if ENV['CHEF_API_FLAVOR']
-          ENV['CHEF_API_FLAVOR'].to_sym
-        elsif config['CHEF_API_FLAVOR']
-          config['CHEF_API_FLAVOR']
+        if ENV["CHEF_API_FLAVOR"]
+          ENV["CHEF_API_FLAVOR"].to_sym
+        elsif config["CHEF_API_FLAVOR"]
+          config["CHEF_API_FLAVOR"]
         else
-          endpoint.include?('/organizations') ? :enterprise : :open_source
+          endpoint.include?("/organizations") ? :enterprise : :open_source
         end
       end
 
@@ -100,7 +100,7 @@ module ChefAPI
       # @return [String]
       #
       def user_agent
-        ENV['CHEF_API_USER_AGENT'] || config['CHEF_API_USER_AGENT'] || USER_AGENT
+        ENV["CHEF_API_USER_AGENT"] || config["CHEF_API_USER_AGENT"] || USER_AGENT
       end
 
       #
@@ -111,7 +111,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def client
-        ENV['CHEF_API_CLIENT'] || config['CHEF_API_CLIENT']
+        ENV["CHEF_API_CLIENT"] || config["CHEF_API_CLIENT"]
       end
 
       #
@@ -122,15 +122,16 @@ module ChefAPI
       # @return [String, nil]
       #
       def key
-         ENV['CHEF_API_KEY'] || config['CHEF_API_KEY']
+        ENV["CHEF_API_KEY"] || config["CHEF_API_KEY"]
       end
+
       #
       # The HTTP Proxy server address as a string
       #
       # @return [String, nil]
       #
       def proxy_address
-        ENV['CHEF_API_PROXY_ADDRESS'] || config['CHEF_API_PROXY_ADDRESS']
+        ENV["CHEF_API_PROXY_ADDRESS"] || config["CHEF_API_PROXY_ADDRESS"]
       end
 
       #
@@ -139,7 +140,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_password
-        ENV['CHEF_API_PROXY_PASSWORD'] || config['CHEF_API_PROXY_PASSWORD']
+        ENV["CHEF_API_PROXY_PASSWORD"] || config["CHEF_API_PROXY_PASSWORD"]
       end
 
       #
@@ -148,7 +149,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_port
-        ENV['CHEF_API_PROXY_PORT'] || config['CHEF_API_PROXY_PORT']
+        ENV["CHEF_API_PROXY_PORT"] || config["CHEF_API_PROXY_PORT"]
       end
 
       #
@@ -157,7 +158,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_username
-        ENV['CHEF_API_PROXY_USERNAME'] || config['CHEF_API_PROXY_USERNAME']
+        ENV["CHEF_API_PROXY_USERNAME"] || config["CHEF_API_PROXY_USERNAME"]
       end
 
       #
@@ -166,7 +167,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def ssl_pem_file
-        ENV['CHEF_API_SSL_PEM_FILE'] || config['CHEF_API_SSL_PEM_FILE']
+        ENV["CHEF_API_SSL_PEM_FILE"] || config["CHEF_API_SSL_PEM_FILE"]
       end
 
       #
@@ -175,10 +176,10 @@ module ChefAPI
       # @return [true, false]
       #
       def ssl_verify
-        if ENV['CHEF_API_SSL_VERIFY'].nil? && config['CHEF_API_SSL_VERIFY'].nil?
+        if ENV["CHEF_API_SSL_VERIFY"].nil? && config["CHEF_API_SSL_VERIFY"].nil?
           true
         else
-          %w[t y].include?(ENV['CHEF_API_SSL_VERIFY'].downcase[0]) || config['CHEF_API_SSL_VERIFY']
+          %w{t y}.include?(ENV["CHEF_API_SSL_VERIFY"].downcase[0]) || config["CHEF_API_SSL_VERIFY"]
         end
       end
 
@@ -188,7 +189,7 @@ module ChefAPI
       # @return [Integer, nil]
       #
       def read_timeout
-        timeout_from_env = ENV['CHEF_API_READ_TIMEOUT'] || config['CHEF_API_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