chef-infra-api 0.9.1

data/lib/chef-api/util.rb

@@ -0,0 +1,119 @@
+module ChefAPI
+  module Util
+    extend self
+
+    #
+    # Covert the given CaMelCaSeD string to under_score. Graciously borrowed
+    # from http://stackoverflow.com/questions/1509915.
+    #
+    # @param [String] string
+    #   the string to use for transformation
+    #
+    # @return [String]
+    #
+    def underscore(string)
+      string
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    #
+    # Convert an underscored string to it's camelcase equivalent constant.
+    #
+    # @param [String] string
+    #   the string to convert
+    #
+    # @return [String]
+    #
+    def camelize(string)
+      string
+        .to_s
+        .split('_')
+        .map { |e| e.capitalize }
+        .join
+    end
+
+    #
+    # Truncate the given string to a certain number of characters.
+    #
+    # @param [String] string
+    #   the string to truncate
+    # @param [Hash] options
+    #   the list of options (such as +length+)
+    #
+    def truncate(string, options = {})
+      length = options[:length] || 30
+
+      if string.length > length
+        string[0..length-3] + '...'
+      else
+        string
+      end
+    end
+
+    #
+    # "Safely" read the contents of a file on disk, catching any permission
+    # errors or not found errors and raising a nicer exception.
+    #
+    # @example Reading a file that does not exist
+    #   safe_read('/non-existent/file') #=> Error::FileNotFound
+    #
+    # @example Reading a file with improper permissions
+    #   safe_read('/bad-permissions') #=> Error::InsufficientFilePermissions
+    #
+    # @example Reading a regular file
+    #   safe_read('my-file.txt') #=> ["my-file", "..."]
+    #
+    # @param [String] path
+    #   the path to the file on disk
+    #
+    # @return [Array<String>]
+    #   A array where the first value is the basename of the file and the
+    #   second value is the literal contents from +File.read+.
+    #
+    def safe_read(path)
+      path     = File.expand_path(path)
+      name     = File.basename(path, '.*')
+      contents = File.read(path)
+
+      [name, contents]
+    rescue Errno::EACCES
+      raise Error::InsufficientFilePermissions.new(path: path)
+    rescue Errno::ENOENT
+      raise Error::FileNotFound.new(path: path)
+    end
+
+    #
+    # Quickly iterate over a collection using native Ruby threads, preserving
+    # the original order of elements and being all thread-safe and stuff.
+    #
+    # @example Parse a collection of JSON files
+    #
+    #   fast_collect(Dir['**/*.json']) do |item|
+    #     JSON.parse(File.read(item))
+    #   end
+    #
+    # @param [#each] collection
+    #   the collection to iterate
+    # @param [Proc] block
+    #   the block to evaluate (typically an expensive operation)
+    #
+    # @return [Array]
+    #   the result of the iteration
+    #
+    def fast_collect(collection, &block)
+      collection.map do |item|
+        Thread.new do
+          Thread.current[:result] = block.call(item)
+        end
+      end.collect do |thread|
+        thread.join
+        thread[:result]
+      end
+    end
+  end
+end

data/lib/chef-api/validator.rb

@@ -0,0 +1,16 @@
+module ChefAPI
+  module Validator
+    autoload :Base,       'chef-api/validators/base'
+    autoload :Required,   'chef-api/validators/required'
+    autoload :Type,       'chef-api/validators/type'
+
+    #
+    # Find a validator by the given key.
+    #
+    def self.find(key)
+      const_get(Util.camelize(key))
+    rescue NameError
+      raise Error::InvalidValidator.new(key: key)
+    end
+  end
+end

data/lib/chef-api/validators/base.rb

@@ -0,0 +1,82 @@
+module ChefAPI
+  class Validator::Base
+    #
+    # @return [Symbol]
+    #   the attribute to apply this validation on
+    #
+    attr_reader :attribute
+
+    #
+    # @return [Hash]
+    #   the hash of additional arguments passed in
+    #
+    attr_reader :options
+
+    #
+    # Create anew validator.
+    #
+    # @param [Symbol] attribute
+    #   the attribute to apply this validation on
+    # @param [Hash] options
+    #   the list of options passed in
+    #
+    def initialize(attribute, options = {})
+      @attribute = attribute
+      @options   = options.is_a?(Hash) ? options : {}
+    end
+
+    #
+    # Just in case someone forgets to define a key, this will return the
+    # class's underscored name without "validator" as a symbol.
+    #
+    # @example
+    #   FooValidator.new.key #=> :foo
+    #
+    # @return [Symbol]
+    #
+    def key
+      name = self.class.name.split('::').last
+      Util.underscore(name).to_sym
+    end
+
+    #
+    # Execute the validations. This is an abstract class and must be
+    # overridden in custom validators.
+    #
+    # @param [Resource::Base::Base] resource
+    #   the parent resource to validate against
+    #
+    def validate(resource)
+      raise Error::AbstractMethod.new(method: 'Validators::Base#validate')
+    end
+
+    #
+    # The string representation of this validation.
+    #
+    # @return [String]
+    #
+    def to_s
+      "#<#{classname}>"
+    end
+
+    #
+    # The string representation of this validation.
+    #
+    # @return [String]
+    #
+    def inspect
+      "#<#{classname} :#{attribute}>"
+    end
+
+    private
+
+    #
+    # The class name for this validator.
+    #
+    # @return [String]
+    #
+    def classname
+      @classname ||= self.class.name.split('::')[1..-1].join('::')
+    end
+  end
+end

data/lib/chef-api/validators/required.rb

@@ -0,0 +1,11 @@
+module ChefAPI
+  class Validator::Required < Validator::Base
+    def validate(resource)
+      value = resource._attributes[attribute]
+
+      if value.to_s.strip.empty?
+        resource.errors.add(attribute, 'must be present')
+      end
+    end
+  end
+end

data/lib/chef-api/validators/type.rb

@@ -0,0 +1,23 @@
+module ChefAPI
+  class Validator::Type < Validator::Base
+    attr_reader :types
+
+    #
+    # Overload the super method to capture the type attribute in the options
+    # hash.
+    #
+    def initialize(attribute, type)
+      super
+      @types = Array(type)
+    end
+
+    def validate(resource)
+      value = resource._attributes[attribute]
+
+      if value && !types.any? { |type| value.is_a?(type) }
+        short_name = type.to_s.split('::').last
+        resource.errors.add(attribute, "must be a kind of #{short_name}")
+      end
+    end
+  end
+end

data/lib/chef-api/version.rb

@@ -0,0 +1,3 @@
+module ChefAPI
+  VERSION = '0.9.1'
+end

data/templates/errors/abstract_method.erb

@@ -0,0 +1,5 @@
+'<%= @method %>' is an abstract method. You must override this method in your subclass with the proper implementation and logic. For more information, please see the inline documentation for <%= @method %>. If you are not a developer, this is most likely a bug in the ChefAPI gem. Please file a bug report at:
+
+    https://github.com/sethvargo/chef-api/issues/new
+
+and include the command(s) or code you ran to arrive at this error.

data/templates/errors/cannot_regenerate_key.erb

@@ -0,0 +1 @@
+You attempted to regenerate the private key for a Client or User that does not yet exist on the remote Chef Server. You can only regenerate the key for an object that is persisted. Try saving this record this object before regenerating the key.

data/templates/errors/chef_api_error.erb

@@ -0,0 +1 @@
+Oh no! Something really bad happened. I am not sure what actually happened because this is the catch-all error, but you should most definitely report an issue on GitHub at https://github.com/sethvargo/chef-api.

data/templates/errors/file_not_found.erb

@@ -0,0 +1 @@
+I could not find a file at '<%= @path %>'. Please make sure you have typed the path correctly and that the resource exists at the given path.

data/templates/errors/http_bad_request.erb

@@ -0,0 +1,3 @@
+The Chef Server did not understand the request because it was malformed.
+
+    <%= @message %>

data/templates/errors/http_forbidden_request.erb

@@ -0,0 +1,3 @@
+The Chef Server actively refused to fulfill the request.
+
+    <%= @message %>

data/templates/errors/http_gateway_timeout.erb

@@ -0,0 +1,3 @@
+The Chef Server did not respond in an adequate amount of time.
+
+    <%= @message %>

data/templates/errors/http_method_not_allowed.erb

@@ -0,0 +1,3 @@
+That HTTP method is not allowed on this URL.
+
+    <%= @message %>

data/templates/errors/http_not_acceptable.erb

@@ -0,0 +1,3 @@
+The Chef Server identified this request as unacceptable. This usually means you have not specified the correct Accept or Content-Type headers on the request.
+
+    <%= @message %>

data/templates/errors/http_not_found.erb

@@ -0,0 +1,3 @@
+The requested URL does not exist on the Chef Server.
+
+    <%= @message %>

data/templates/errors/http_server_unavailable.erb

@@ -0,0 +1 @@
+The Chef Server is currently unavailable or is not currently accepting client connections. Please ensure the server is accessible via ping or telnet on your local network. If this error persists, please contact your network administrator.

data/templates/errors/http_unauthorized_request.erb

@@ -0,0 +1,3 @@
+The Chef Server requires authorization. Please ensure you have specified the correct client name and private key. If this error continues, please verify the given client has the proper permissions on the Chef Server.
+
+    <%= @message %>

data/templates/errors/insufficient_file_permissions.erb

@@ -0,0 +1 @@
+I cannot read the file at '<%= @path %>' because the permissions on the file do not permit it. Please ensure the file has the correct permissions and that this Ruby process is running as a user with access to that path.

data/templates/errors/invalid_resource.erb

@@ -0,0 +1 @@
+There were errors saving your resource: <%= @errors %>

data/templates/errors/invalid_validator.erb

@@ -0,0 +1 @@
+'<%= @key %>' is not a valid validator. Please make sure it is spelled correctly and that the constant is properly defined. If you are using a custom validator, please ensure the validator extends ChefAPI::Validator::Base and is a subclass of ChefAPI::Validator.

data/templates/errors/missing_url_parameter.erb

@@ -0,0 +1 @@
+The required URL parameter '<%= @param %>' was not present. Please specify the parameter as an option, like Resource.new(id, <%= @param %>: 'value').

data/templates/errors/not_a_directory.erb

@@ -0,0 +1 @@
+The given path '<%= @path %>' is not a directory. Please make sure you have passed the path to a directory on disk.

data/templates/errors/resource_already_exists.erb

@@ -0,0 +1 @@
+The <%= @type %> '<%= @id %>' already exists on the Chef Server. Each <%= @type %> must have a unique identifier and the Chef Server indicated this <%= @type %> already exists. If you are trying to update the <%= @type %>, consider using the 'update' method instead.

data/templates/errors/resource_not_found.erb

@@ -0,0 +1 @@
+There is no <%= @type %> with an id of '<%= @id %>' on the Chef Server. If you are updating the <%= @type %>, please make sure the <%= @type %> exists and has the correct Chef identifier (primary key).

data/templates/errors/resource_not_mutable.erb

@@ -0,0 +1 @@
+The <%= @type %> '<%= @id %>' is not mutable. It may be locked by the remote Chef Server, or the Chef Server may not permit modifying the resource.

data/templates/errors/unknown_attribute.erb

@@ -0,0 +1 @@
+'<%= @attribute %>' is not a valid attribute!

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: chef-infra-api
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Seth Vargo
+- Tim Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tiny Chef API client with minimal dependencies
+email:
+- sethvargo@gmail.com
+- tsmith84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/chef-api.rb
+- lib/chef-api/aclable.rb
+- lib/chef-api/authentication.rb
+- lib/chef-api/boolean.rb
+- lib/chef-api/configurable.rb
+- lib/chef-api/connection.rb
+- lib/chef-api/defaults.rb
+- lib/chef-api/error_collection.rb
+- lib/chef-api/errors.rb
+- lib/chef-api/multipart.rb
+- lib/chef-api/resource.rb
+- lib/chef-api/resources/base.rb
+- lib/chef-api/resources/client.rb
+- lib/chef-api/resources/collection_proxy.rb
+- lib/chef-api/resources/cookbook.rb
+- lib/chef-api/resources/cookbook_version.rb
+- lib/chef-api/resources/data_bag.rb
+- lib/chef-api/resources/data_bag_item.rb
+- lib/chef-api/resources/environment.rb
+- lib/chef-api/resources/group.rb
+- lib/chef-api/resources/node.rb
+- lib/chef-api/resources/organization.rb
+- lib/chef-api/resources/partial_search.rb
+- lib/chef-api/resources/principal.rb
+- lib/chef-api/resources/role.rb
+- lib/chef-api/resources/search.rb
+- lib/chef-api/resources/user.rb
+- lib/chef-api/schema.rb
+- lib/chef-api/util.rb
+- lib/chef-api/validator.rb
+- lib/chef-api/validators/base.rb
+- lib/chef-api/validators/required.rb
+- lib/chef-api/validators/type.rb
+- lib/chef-api/version.rb
+- templates/errors/abstract_method.erb
+- templates/errors/cannot_regenerate_key.erb
+- templates/errors/chef_api_error.erb
+- templates/errors/file_not_found.erb
+- templates/errors/http_bad_request.erb
+- templates/errors/http_forbidden_request.erb
+- templates/errors/http_gateway_timeout.erb
+- templates/errors/http_method_not_allowed.erb
+- templates/errors/http_not_acceptable.erb
+- templates/errors/http_not_found.erb
+- templates/errors/http_server_unavailable.erb
+- templates/errors/http_unauthorized_request.erb
+- templates/errors/insufficient_file_permissions.erb
+- templates/errors/invalid_resource.erb
+- templates/errors/invalid_validator.erb
+- templates/errors/missing_url_parameter.erb
+- templates/errors/not_a_directory.erb
+- templates/errors/resource_already_exists.erb
+- templates/errors/resource_not_found.erb
+- templates/errors/resource_not_mutable.erb
+- templates/errors/unknown_attribute.erb
+homepage: https://github.com/chef/chef-api
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: A Chef API client in Ruby
+test_files: []