chef_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a491b130004bcf71472edcc0f8fb1284fbf0bb7
+  data.tar.gz: 6e2e3e916fa05785ab34ab5841c01f3255f3157c
+SHA512:
+  metadata.gz: 54532b47360ddef55771548d145f6433c49b55a77ecb44e4ff43f5f2e9b0acc0b2130049e3d2a8b1eac65964b7badab26c69e7cfe707495640fb72fcb3ea6290
+  data.tar.gz: a5087c580ed46f456fb72f09f1a461b0066f318ca79125a19ffa44053f28551a840f976fe7b60f348ff8f6f1a9cacf56ac480192ec043c19e8622eb382c27c64

data/.config.reek

@@ -0,0 +1,3 @@
+---
+UtilityFunction:
+  public_methods_only: true

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rake_tasks

data/.overcommit.yml

@@ -0,0 +1,46 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+  Reek:
+    enabled: true
+
+  RubyLint:
+    enabled: true
+
+  Flog:
+    enabled: true
+
+  TrailingWhitespace:
+    enabled: true
+    exclude:
+      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+
+CommitMsg:
+  SpellCheck:
+    enabled: true
+
+PostCheckout:
+  ALL: # Special hook name that customizes all hooks of this type
+    quiet: true # Change all post-checkout hooks to only display output on failure
+
+  IndexTags:
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+---
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-23 14:28:36 -0600 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.ruby-gemset

@@ -0,0 +1 @@
+chef_helpers

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+bundler_args: --without local

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chef_helpers.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :local do
+  gem 'guard-rspec', require: false
+  gem 'simplecov', require: false
+  gem 'pry'
+  gem 'pry-theme'
+  gem 'colorize', require: false
+  gem 'reek', require: false
+  gem 'flog', require: false
+  gem 'overcommit'
+  gem 'guard-yard', require: false
+  gem 'rb-fsevent', require: false if RUBY_PLATFORM =~ /darwin/i
+  gem 'ruby-lint', require: false, github: 'baberthal/ruby-lint'
+  gem 'ruby_gntp'
+  gem 'rubycritic'
+end

data/Guardfile

@@ -0,0 +1,30 @@
+notification :gntp, host: '127.0.0.1'
+
+rspec_opts = {
+  cmd: 'rspec',
+  all_after_pass: false,
+  all_on_start: false,
+  failed_mode: :focus
+}
+
+guard :rspec, rspec_opts do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end
+#  vim: set ts=8 sw=2 tw=0 ft=ruby et :

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Morgan Lieberthal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# ChefHelpers
+
+This gem provides a set of helper methods to use in chef recipies. Currently, the only implemented method is `#encrypt_password`, which takes a plain-text password and generates a shadow hash for use by the User resource.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chef_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chef_helpers
+
+## Usage
+
+Include the gem in your chef cookbook:
+
+In a recipe:
+```ruby
+extend ChefHelpers
+```
+
+In an LWRP:
+```ruby
+include ChefHelpers
+```
+
+In any ruby file:
+```ruby
+include ChefHelpers
+```
+
+Encrypt a password like this:
+```ruby
+password = 'shhitsasecret'
+shadow_hash = encrypt_password(password)
+```
+
+Use it in a user recipe like this:
+```ruby
+password_hash = encrypt_password('shhitsasecret')
+
+user 'my_user' do
+  password password_hash
+  ...
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork this repo
+2. Create a new branch for your feature
+3. Write specs for the feature / method
+4. Implement the feature / method
+5. Create a pull request
+6. ???
+7. Profit
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/baberthal/chef_helpers.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = %w(lib/**/*.rb)
+  task.formatters = %w(files fuubar)
+  task.fail_on_error = false
+end
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chef_helpers'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chef_helpers.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_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chef_helpers'
+  spec.version       = ChefHelpers::VERSION
+  spec.authors       = ['Morgan Lieberthal']
+  spec.email         = ['morgan@jmorgan.org']
+
+  spec.summary       = 'Provides a set of helper methods for chef recipes.'
+  spec.description   = File.read(File.expand_path('../README.md', __FILE__))
+  spec.homepage      = 'https://github.com/baberthal/chef_helpers.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } # rubocop:disable Metrics/LineLength
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'unix-crypt', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'yard'
+end

data/lib/chef_helpers.rb

@@ -0,0 +1,35 @@
+require 'chef_helpers/version'
+require 'chef_helpers/exceptions'
+require 'unix_crypt'
+
+# The top-level namespace
+module ChefHelpers
+  # Returns an encrypted, salted password hash for use in /etc/shadow and by
+  # the Chef user resource.
+  #
+  # @param [String] password the password to encrypt.
+  # @param [Symbol] hash_algo a symbol identifying the hashing algorithm to use.
+  #   Valid options are:
+  #     :sha512
+  #     :sha256
+  #     :md5
+  #     :des
+  #
+  # @raise [InvalidPasswordError] if the generated hash does not match the
+  #   password that was passed into the method.
+  #
+  # @return [String] the encrypted, salted password hash.
+  #
+  def encrypt_password(password, hash_algo = :sha512)
+    build_password(password, hash_algo).tap do |pw|
+      fail InvalidPasswordError unless UnixCrypt.valid?(password, pw)
+    end
+  end
+
+  private
+
+  def build_password(password, hash_algo = :sha512)
+    hashing_alogrithm = UnixCrypt.const_get(hash_algo.upcase)
+    hashing_alogrithm.build(password)
+  end
+end

data/lib/chef_helpers/exceptions.rb

@@ -0,0 +1,16 @@
+module ChefHelpers
+  # Namespace for Exceptions raised by methods provided by [ChefHelpers]
+  module Exceptions
+    # This exception is raised if a password was generated, but for some reason
+    # does not match the password that was supposed to be encrypted.
+    #
+    class InvalidPasswordError < StandardError
+      # Error message specific to the InvalidPasswordError.
+      #
+      # @return [String] The error message.
+      def message
+        'The password hash generated did not match the password passed in.'
+      end
+    end
+  end
+end

data/lib/chef_helpers/version.rb

@@ -0,0 +1,3 @@
+module ChefHelpers # rubocop:disable Style/Documentation
+  VERSION = '0.1.0'
+end

data/ruby-lint.yml

@@ -0,0 +1,7 @@
+---
+directories:
+  - lib
+  - lib/rspec/matchers
+
+ignore_paths:
+  - spec/support

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: chef_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Morgan Lieberthal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unix-crypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  # ChefHelpers
+
+  This gem provides a set of helper methods to use in chef recipies. Currently, the only implemented method is `#encrypt_password`, which takes a plain-text password and generates a shadow hash for use by the User resource.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'chef_helpers'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install chef_helpers
+
+  ## Usage
+
+  Include the gem in your chef cookbook:
+
+  In a recipe:
+  ```ruby
+  extend ChefHelpers
+  ```
+
+  In an LWRP:
+  ```ruby
+  include ChefHelpers
+  ```
+
+  In any ruby file:
+  ```ruby
+  include ChefHelpers
+  ```
+
+  Encrypt a password like this:
+  ```ruby
+  password = 'shhitsasecret'
+  shadow_hash = encrypt_password(password)
+  ```
+
+  Use it in a user recipe like this:
+  ```ruby
+  password_hash = encrypt_password('shhitsasecret')
+
+  user 'my_user' do
+    password password_hash
+    ...
+  end
+  ```
+
+  ## Development
+
+  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+  To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+  ## Contributing
+
+  1. Fork this repo
+  2. Create a new branch for your feature
+  3. Write specs for the feature / method
+  4. Implement the feature / method
+  5. Create a pull request
+  6. ???
+  7. Profit
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/baberthal/chef_helpers.
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+email:
+- morgan@jmorgan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".config.reek"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chef_helpers.gemspec
+- lib/chef_helpers.rb
+- lib/chef_helpers/exceptions.rb
+- lib/chef_helpers/version.rb
+- ruby-lint.yml
+homepage: https://github.com/baberthal/chef_helpers.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides a set of helper methods for chef recipes.
+test_files: []
+has_rdoc: