hiser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3c5e5a6772791ddcaae7ed3b71cf4b32643004e
+  data.tar.gz: 7e7d2ddafd9415d39313536a81ac7cae23a59783
+SHA512:
+  metadata.gz: eeba35c57b752aec975d91b9d35dc60d549398831e5bd31d818cef60d3197f1ada8fc96a699cb2ce46596c2b4e6bfe8d0ff52e55758ccbcce9452daf5aec41fb
+  data.tar.gz: 4f04bbd05a0f7ef27ca2ec94fb47e3413322cd7517a4a4a5f131c2b63a779f0fbd8faa2ae1ea47f5a54bfebd389ccc504e2187a0ec1327616828a8d8a5739725

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at corey@nwops.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hiser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Corey Osman
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hiser"
+
+# 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
+
+require "irb"
+IRB.start

data/bin/setup

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

data/exe/hiser

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "hiser"
+require 'optparse'
+
+ARGV << '-h' if ARGV.empty?  # sets help screen as default
+options = {}
+OptionParser.new do |opts|
+  opts.program_name = 'Hiser'
+  opts.on('-g', '--generate PROJECT_PATH', 'Generate a hiser project with the given project path') do | path |
+    options[:generate] = true
+    options[:project_path] = path
+  end
+  opts.on('-s', '--serialize', 'Create serialized files from hiera data') { options[:serialize] = true }
+  opts.on('-h', '--help', 'Show help') { puts opts; exit }
+  opts.version = Hiser::VERSION
+  opts.parse!
+end
+
+if options[:generate]
+  Hiser::Cli.generate(options[:project_path])
+elsif options[:serialize]
+  Hiser::Cli.start
+end

data/hiser.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hiser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hiser"
+  spec.version       = Hiser::VERSION
+  spec.authors       = ["Corey Osman"]
+  spec.email         = ["corey@nwops.io"]
+
+  spec.summary       = %q{A simple gem that uses hiera data lookups to create serialized files}
+  spec.description   = %q{A simple script that uses hiera data lookups to create
+         json or yaml serialized files with custom object mappings
+         defined in the hiera common.yaml file}
+  spec.homepage      = "https://github.com/nwops/hiser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "hiera", ">= 3.0"
+  spec.add_runtime_dependency 'retrospec', ">= 0.4.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "release_me"
+end

data/lib/hiser.rb

@@ -0,0 +1,94 @@
+require "hiser/version"
+require 'fileutils'
+require 'retrospec/plugins/v1/module_helpers'
+require 'hiera'
+require 'json'
+require 'yaml'
+require 'retrospec'
+
+module Hiser
+  class Cli
+    include Retrospec::Plugins::V1::ModuleHelpers
+
+    def self.generate(path)
+      instance = Hiser::Cli.new
+      instance.generate_files(path)
+    end
+
+    def self.start
+      instance = Hiser::Cli.new
+      instance.run
+    end
+
+    # produces all the files identified in the output_object_files hash
+    def run
+      files.each do | file_hash|
+        file_hash.each {| map_name, file_name | generate_file(map_name, file_name) }
+      end
+    end
+
+    def generate_files(path, spec_object=nil)
+      safe_create_module_files(template_dir, path, spec_object)
+    end
+
+    private
+
+    # returns the path to the templates
+    # looks inside the gem path templates directory
+    def template_dir
+      File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'templates'))
+    end
+
+    # creates a new hiera object
+    def hiera
+      # create a new instance based on config file
+      @hiera ||= Hiera.new(:config => "./hiera.yaml")
+    end
+
+    # lookups the list of env_scopes via hiera
+    def env_scopes
+      @env_data || hiera.lookup(settings.fetch('scopes'), '', {})
+    end
+
+    # lookups the map called output_object_files and returns a key/value pair
+    # of map types and the designated output file
+    def files
+      @files ||= hiera.lookup(settings.fetch('object_files'), '', {})
+    end
+
+    def settings
+      @settings ||= hiera.lookup('hiera_tool_settings', '', {})
+    end
+
+    def output_dir
+      @output_dir ||= settings.fetch('output_directory', 'output_data')
+    end
+
+    # write the given data to the given file name
+    # also encodes in yaml or json by detecting the extension name
+    def write_data(file_path, data)
+      file_type = File.extname(file_path).downcase
+      if file_type == '.json'
+        File.write(file_path, JSON.pretty_generate(data))
+      else
+        File.write(file_path, data.to_yaml)
+      end
+      puts "Wrote file: #{file_path}"
+    end
+
+    # generate a file based on the map_name
+    # uses the map name to look up the data via hiera
+    def generate_file(map_name, file_name)
+      env_scopes.each do | scope_name, scope |
+        dir = File.join(output_dir, scope_name)
+        FileUtils.mkdir_p(dir) unless File.exists?(dir)
+        file_name_path = File.join(dir, file_name)
+        obj_map = hiera.lookup(map_name, '', scope)
+        write_data(file_name_path, obj_map)
+      end
+    end
+
+
+
+  end
+end

data/lib/hiser/version.rb

@@ -0,0 +1,3 @@
+module Hiser
+  VERSION = "0.1.0"
+end

data/lib/templates/module_files/README.md

@@ -0,0 +1,78 @@
+# File Object Serialization Generator
+
+Serializes any given object mapping to a file.  For ever scope defined a new
+file will be generated under a new directory for the scope.
+
+
+## Setup
+
+### 1. Define the output_object_files map
+In the `common.yaml` file you need to define a new hash
+called `output_object_files`.  In this hash you should define
+a set of key/value pairs that tell the script which mapping to output
+to a file.  The value of the pair should should be the name of the file.
+The extension of the file `.json` or `.yaml` will determine which serialization
+to use when encoding the object.
+
+Example:
+
+```
+output_object_files:
+  giant_object_mapping: 'giant_output_mapping.json'
+```
+
+The script will loop through each mapping and generate a output file for each
+scope.
+
+### 2. Define the mappping of each object
+With the output_object_files map defined above we need to also create
+a map for each mapping we used in the `output_object_files` map.  This mapping
+is defined by you.  It should represent your data structure.  In the example below
+we map `workflows` to a `alias` function which causes hiera to interpolate the key
+by looking in the hierarchy for the key in order to return the value.
+and  the key
+
+```
+workflows:
+  workflow_a:
+    url: 'https://www.something.com'
+
+
+giant_object_mapping:
+  workflows: "%{alias('workflows')}"
+```
+
+Where the JSON output becomes
+
+```
+{
+  "workflows": {
+    "workflow_a": {
+      "url": "https://www.something.com"
+    }
+  }
+}
+```
+
+### 3. Create the scopes
+In order for hiera to correctly find the keys in the hierarchy we need to provide
+a scope for hiera to use.  This scope is defined by you and based on your hierarchical
+structure in `hiera.yaml`.  You should only defined keys in the scope for every
+variable you use in the `hiera.yaml` mapping and any other variables you might
+interpolate in hiera values.  This must be a hash with key/value pairs where the values
+must be strings.
+
+It is mandatory that the mapping name be called `env_scopes`
+
+```
+env_scopes:
+  env_1:
+    provisioning_env: prov_env_a
+    customer_env: environment_a
+    datacenter: datacentera_a
+```
+
+
+## Usage
+To generate the serialized files just run the `ruby_test.rb` file which will generate
+all the files under the current local directory.

data/lib/templates/module_files/data/common.yaml

@@ -0,0 +1,47 @@
+# don't use the hiera lookup interpolation in any values below
+# you must only use the alias function, otherwise a string is returned
+
+# environment scopes where each type of file is produced from
+# this scope is passed into hiera so that hiera can find the correct
+# values at the difference levels.  These scopes represent the variables
+# used with hiera.
+env_scopes:
+  env_1:
+    provisioning_env: prov_env_a
+    customer_env: environment_a
+    datacenter: datacenter_a
+  env_2:
+      provisioning_env: prov_env_b
+      customer_env: environment_b
+      datacenter: datacenter_b
+
+# example map which is utilize in the output_object_files below
+# this map is simple, in that it only looks up a single item
+# called 'workflows'.  
+giant_object_mapping:
+  workflows: "%{alias('workflows')}"
+  special_info: "%{alias('special_info')}"
+
+
+special_data:
+  key1: "%{alias('key1')}"
+
+# the control source for generating map files
+# each file should have a corresponding map
+output_object_files:
+  - giant_object_mapping: 'giant_output_mapping.json'
+  - special_data: 'vro_data.json'
+
+
+# a hash a static settings that are used in the script
+# if you change the value of these you must also change map names above as well
+# do not change the key names, otherwise the script will fail
+# You shoud not need to customize this
+hiera_tool_settings:
+  # the name of the scope object you must define
+  scopes: env_scopes
+  # the name of the object files map you must define
+  object_files: output_object_files
+  # the name of the directory to write files to
+  output_directory: output
+

data/lib/templates/module_files/data/datacenter/datacenter_a.yaml

@@ -0,0 +1,4 @@
+special_info:
+  - one
+  - two
+  - three

data/lib/templates/module_files/data/datacenter/datacenter_b.yaml

@@ -0,0 +1,3 @@
+special_info:
+  - three
+  - four

data/lib/templates/module_files/data/provisioning_env/prov_env_a.yaml

@@ -0,0 +1,5 @@
+workflows:
+  workflow_a:
+    url: 'https://www.something.com'
+
+key1: value1

data/lib/templates/module_files/data/provisioning_env/prov_env_b.yaml

@@ -0,0 +1,5 @@
+workflows:
+  workflow_b:
+    url: 'https://www.something.com'
+
+key1: value2

data/lib/templates/module_files/hiera.yaml

@@ -0,0 +1,10 @@
+---
+:backends:
+  - yaml
+:hierarchy:
+  - "datacenter/%{datacenter}"
+  - "customer_env/%{customer_env}"
+  - "provisioning_env/%{provisioning_env}"
+  - common
+:yaml:
+  :datadir: "data"

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: hiser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corey Osman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hiera
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: retrospec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: release_me
+  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: |-
+  A simple script that uses hiera data lookups to create
+           json or yaml serialized files with custom object mappings
+           defined in the hiera common.yaml file
+email:
+- corey@nwops.io
+executables:
+- hiser
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hiser
+- hiser.gemspec
+- lib/hiser.rb
+- lib/hiser/version.rb
+- lib/templates/module_files/README.md
+- lib/templates/module_files/data/common.yaml
+- lib/templates/module_files/data/customer_env/environment_a.yaml
+- lib/templates/module_files/data/customer_env/environment_b.yaml
+- lib/templates/module_files/data/customer_env/environment_c.yaml
+- lib/templates/module_files/data/customer_env/environment_d.yaml
+- lib/templates/module_files/data/datacenter/datacenter_a.yaml
+- lib/templates/module_files/data/datacenter/datacenter_b.yaml
+- lib/templates/module_files/data/provisioning_env/prov_env_a.yaml
+- lib/templates/module_files/data/provisioning_env/prov_env_b.yaml
+- lib/templates/module_files/hiera.yaml
+homepage: https://github.com/nwops/hiser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: A simple gem that uses hiera data lookups to create serialized files
+test_files: []