moose-inventory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ae525b63b01fa467335121abcfc387da59cdb12
-  data.tar.gz: 7737d54dfed69d5c804a26792d82c19264aae0f6
+  metadata.gz: 9406c59a0185749227febf07cb62cb0e3d273955
+  data.tar.gz: 063fba0f37a46d48ce9f4be6aee93ba3cd3d32e4
 SHA512:
-  metadata.gz: d7dd1233f73280f6d9b7135c25b37abe4e4db23cc9dec8d2f768e092d08c83d567222845811129729d772db2cc68fda518873cdac75231e00a8d590a9756b7f5
-  data.tar.gz: 3c335922f0f578bd8e37a2b36875c17d843886e3a005687b349a8ed832fbe792187debb164135e3eda9b70c6a7bd304c29d5006f1490b88eb0dbfd5ff2996700
+  metadata.gz: 756f88cac996b96406384956ae9c70508fe4cbdf80565a188fab545a4cf5d52ee92fbef20acde57565f2bfa42b1d8ddaf0bb4a5e238ab232398be93376402d30
+  data.tar.gz: d696b2bfba34799daba4181d21c028785a97ff020367efa8e2b4b5fc857e2c453947802a63e52db3d23fb4cbf05b79f5d63fb189c3635a83da567e137e337afb

data/.gitignore

@@ -15,3 +15,4 @@ mkmf.log
 .buildpath
 .project
 /coverage/
+*.gem

data/Guardfile

@@ -19,7 +19,7 @@ group 'quality' do
 end
 
 group 'test' do 
-  cmd = 'bundle exec rspec -I lib/moose/inventory -I spec '\
+  cmd = 'bundle exec rspec -I lib/moose_inventory -I spec '\
     '--color --format html --out spec/reports/test/rspec.html'
   guard :rspec, cmd: cmd do
     require 'guard/rspec/dsl'

data/README.md

@@ -1,6 +1,8 @@
 # Moose::Inventory
 
-TODO: Write a gem description
+The [moose-inventory](https://github.com/RusDavies/moose-inventory) Ruby Gem is a package for managing dynamic inventories, intended for use with [Ansible](http://www.ansible.com/home). 
+
+Note: This software is intended for use on UNIX, Linux, or similar systems.  It will likely not work on Windows, due to some hard-wired search paths - I may fix that in the future, but for now, sorry. 
 
 ## Installation
 
@@ -13,19 +15,80 @@ gem 'moose-inventory'
 And then execute:
 
     $ bundle
-
 Or install it yourself as:
 
     $ gem install moose-inventory
 
+## Configuration
+The [moose-inventory](https://github.com/RusDavies/moose-inventory) tool makes use of a simple YAML configuration file.  
+
+
+###Location
+ 
+The following locations, in descending order of precedence, are  searched for a configuration file:
+ 1. location passed via the *config* CLI option
+ 2. ./.moose-tools/inventory/config
+ 4. ~/.moose-tools/inventory/config
+ 5. ~/local/etc/moose-tools/inventory/config
+ 6. /etc/moose-tools/inventory/config
+
+###Format
+The file contains a mandatory general section, and at least one environment section. For example: 
+```yaml
+---
+general:
+  defaultenv: moose_dev
+
+moose_dev:
+  db:
+    adapter: "sqlite3"
+    file:    "~/.moose/db/dev.db"
+
+moose_ops:
+  db:
+    adapter:  "mysql"
+    host:     "localhost"
+    database: "water"
+    user:     "duck"
+    password: "quack"
+
+another_example_section:
+  db:
+    adapter:  "postgresql"
+    host:     "localhost"
+    database: "grass"
+    user:     "cow"
+    password: "moo"
+
+```
+
+###The 'general' section
+The general section is mandatory, and contains a single parameter **defaultenv**, which points to the name of the default environment section.   This is used in the case when no target environment is specified via the command line. 
+
+###Environment sections
+You may add as many environment sections as you desire. The intention is to enable the user to easily manage multiple environments, such as development, staging, production, etc., via a single configuration file.  The name of each environment section must be unique, but can otherwise be any valid YAML tag.
+
+At present,  each environment section contains only a **db** subsection, describing the database connection parameters.  Additional subsections may be added in the future, as functionality increases. 
+
+Each **db** section must include an **adapter** parameter. Currently supported adapter types are sqlite3, mysql, and postresql.  Note, as a matter of portability, only sqlite3 has been exercised via the test suite. 
+
+Additional parameters are also required in the **db** subsection, depending on the adapter type.   For the sqlite3 adapter only a **file** parameter is required.  For both mysql and postgresql, then **host**, **database**, **user**, and **password** parameters are required. 
+
+
 ## Usage
 
-TODO: Write usage instructions here
+##Missing features
+The following desired features are yet to be implemented:
+1. Groups as children of groups:
+-- Group model shall provide a many-to-many relationship to self.
+-- CLI:Group shall provided an addchild method.
+-- CLI:Group shall provided a rmchild method.
+-- CLI:Group.get method shall display child group relationships.
+-- CLI:Group.list method shall display child group relationships.
 
 ## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/moose-inventory/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+1. Fork it (https://github.com/RusDavies/moose-inventory/fork )
+2. Create your feature branch (git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request

data/bin/moose-inventory

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'moose_inventory'
+rescue
+  require 'rubygems'
+  require 'moose_inventory'
+end
+
+Moose::Inventory::Cli.start(ARGV) 

data/config/dotfiles/gitignore

@@ -15,3 +15,4 @@ mkmf.log
 .buildpath
 .project
 /coverage/
+*.gem

data/lib/{moose/inventory/moose_inventory_cli.rb → moose_inventory.rb}

@@ -1,7 +1,7 @@
 require 'thor'
-require_relative './config/config.rb'
-require_relative './db/db.rb'
-require_relative './cli/application.rb'
+require_relative './moose_inventory/config/config.rb'
+require_relative './moose_inventory/db/db.rb'
+require_relative './moose_inventory/cli/application.rb'
 
 module Moose
   module Inventory

data/lib/moose_inventory/version.rb

@@ -0,0 +1,7 @@
+module Moose
+  ##
+  # The Moose-Tools dynamic inventory management library
+  module Inventory
+    VERSION = '0.1.2'
+  end
+end

data/moose-inventory.gemspec

@@ -3,7 +3,7 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'moose/inventory/version'
+require 'moose_inventory/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'moose-inventory'

data/scripts/files.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+files = `git ls-files -z`.split("\x0")
+executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+test_files    = files.grep(%r{^(test|spec|features)/})
+require_paths = ['lib']
+
+out = {}
+out['Executables'.to_sym] = executables
+out['Test_Files'.to_sym] = test_files
+out['Require_Paths'.to_sym] = require_paths
+
+puts "#{out.to_yaml}"
+
+
+

data/spec/spec_helper.rb

@@ -25,14 +25,14 @@ if RUBY_VERSION >= '1.9'
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__),
-                             '..', 'lib/moose/inventory'))
+                             '..', 'lib/moose_inventory'))
 
 # require 'rdoc'
 require 'rspec'
 require 'json'
 require 'yaml'
 require 'find'
-require 'moose_inventory_cli'
+require 'moose_inventory'
 
 RSpec.configure do |config|
   #config.filter_run focus: true # <- enable to allow test focus

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moose-inventory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Russell Davies
@@ -252,9 +252,7 @@ description: The Moosecastle CLI tool for Ansible-compatable dynamic inventory m
 email:
 - russell@blakemere.ca
 executables:
-- ".buildpath"
-- ".project"
-- moose_inventory
+- moose-inventory
 extensions: []
 extra_rdoc_files: []
 files:
@@ -267,69 +265,68 @@ files:
 - README.md
 - README.md.orig
 - Rakefile
-- bin/.buildpath
-- bin/.project
-- bin/moose_inventory
+- bin/moose-inventory
 - config/dotfiles/coveralls.yml
 - config/dotfiles/gitignore
 - config/dotfiles/rubocop.yml
-- lib/moose/inventory/cli/application.rb
-- lib/moose/inventory/cli/formatter.rb
-- lib/moose/inventory/cli/group.rb
-- lib/moose/inventory/cli/group_add.rb
-- lib/moose/inventory/cli/group_addchild.rb
-- lib/moose/inventory/cli/group_addhost.rb
-- lib/moose/inventory/cli/group_addvar.rb
-- lib/moose/inventory/cli/group_get.rb
-- lib/moose/inventory/cli/group_list.rb
-- lib/moose/inventory/cli/group_rm.rb
-- lib/moose/inventory/cli/group_rmchild.rb
-- lib/moose/inventory/cli/group_rmhost.rb
-- lib/moose/inventory/cli/group_rmvar.rb
-- lib/moose/inventory/cli/host.rb
-- lib/moose/inventory/cli/host_add.rb
-- lib/moose/inventory/cli/host_addgroup.rb
-- lib/moose/inventory/cli/host_addvar.rb
-- lib/moose/inventory/cli/host_get.rb
-- lib/moose/inventory/cli/host_list.rb
-- lib/moose/inventory/cli/host_rm.rb
-- lib/moose/inventory/cli/host_rmgroup.rb
-- lib/moose/inventory/cli/host_rmvar.rb
-- lib/moose/inventory/config/config.rb
-- lib/moose/inventory/db/db.rb
-- lib/moose/inventory/db/exceptions.rb
-- lib/moose/inventory/db/models.rb
-- lib/moose/inventory/moose_inventory_cli.rb
-- lib/moose/inventory/version.rb
+- lib/moose_inventory.rb
+- lib/moose_inventory/cli/application.rb
+- lib/moose_inventory/cli/formatter.rb
+- lib/moose_inventory/cli/group.rb
+- lib/moose_inventory/cli/group_add.rb
+- lib/moose_inventory/cli/group_addchild.rb
+- lib/moose_inventory/cli/group_addhost.rb
+- lib/moose_inventory/cli/group_addvar.rb
+- lib/moose_inventory/cli/group_get.rb
+- lib/moose_inventory/cli/group_list.rb
+- lib/moose_inventory/cli/group_rm.rb
+- lib/moose_inventory/cli/group_rmchild.rb
+- lib/moose_inventory/cli/group_rmhost.rb
+- lib/moose_inventory/cli/group_rmvar.rb
+- lib/moose_inventory/cli/host.rb
+- lib/moose_inventory/cli/host_add.rb
+- lib/moose_inventory/cli/host_addgroup.rb
+- lib/moose_inventory/cli/host_addvar.rb
+- lib/moose_inventory/cli/host_get.rb
+- lib/moose_inventory/cli/host_list.rb
+- lib/moose_inventory/cli/host_rm.rb
+- lib/moose_inventory/cli/host_rmgroup.rb
+- lib/moose_inventory/cli/host_rmvar.rb
+- lib/moose_inventory/config/config.rb
+- lib/moose_inventory/db/db.rb
+- lib/moose_inventory/db/exceptions.rb
+- lib/moose_inventory/db/models.rb
+- lib/moose_inventory/version.rb
 - moose-inventory.gemspec
+- scripts/files.rb
 - scripts/guard_quality.sh
 - scripts/guard_test.sh
 - scripts/reports.sh
 - spec/config/config.yml
-- spec/lib/moose/inventory/cli/application_spec.rb
-- spec/lib/moose/inventory/cli/cli_spec.rb
-- spec/lib/moose/inventory/cli/formatter_spec.rb
-- spec/lib/moose/inventory/cli/group_add_spec.rb
-- spec/lib/moose/inventory/cli/group_addhost_spec.rb
-- spec/lib/moose/inventory/cli/group_addvar_spec.rb
-- spec/lib/moose/inventory/cli/group_get_spec.rb
-- spec/lib/moose/inventory/cli/group_list_spec.rb
-- spec/lib/moose/inventory/cli/group_rm_spec.rb
-- spec/lib/moose/inventory/cli/group_rmhost_spec.rb
-- spec/lib/moose/inventory/cli/group_rmvar_spec.rb
-- spec/lib/moose/inventory/cli/group_spec.rb
-- spec/lib/moose/inventory/cli/host_add_spec.rb
-- spec/lib/moose/inventory/cli/host_addgroup_spec.rb
-- spec/lib/moose/inventory/cli/host_addvar_spec.rb
-- spec/lib/moose/inventory/cli/host_get_spec.rb
-- spec/lib/moose/inventory/cli/host_list_spec.rb
-- spec/lib/moose/inventory/cli/host_rm_spec.rb
-- spec/lib/moose/inventory/cli/host_rmgroup_spec.rb
-- spec/lib/moose/inventory/cli/host_rmvar_spec.rb
-- spec/lib/moose/inventory/cli/host_spec.rb
-- spec/lib/moose/inventory/config/config_spec.rb
-- spec/lib/moose/inventory/db/db_spec.rb
-- spec/lib/moose/inventory/db/models_spec.rb
+- spec/lib/moose_inventory/cli/application_spec.rb
+- spec/lib/moose_inventory/cli/cli_spec.rb
+- spec/lib/moose_inventory/cli/formatter_spec.rb
+- spec/lib/moose_inventory/cli/group_add_spec.rb
+- spec/lib/moose_inventory/cli/group_addhost_spec.rb
+- spec/lib/moose_inventory/cli/group_addvar_spec.rb
+- spec/lib/moose_inventory/cli/group_get_spec.rb
+- spec/lib/moose_inventory/cli/group_list_spec.rb
+- spec/lib/moose_inventory/cli/group_rm_spec.rb
+- spec/lib/moose_inventory/cli/group_rmhost_spec.rb
+- spec/lib/moose_inventory/cli/group_rmvar_spec.rb
+- spec/lib/moose_inventory/cli/group_spec.rb
+- spec/lib/moose_inventory/cli/host_add_spec.rb
+- spec/lib/moose_inventory/cli/host_addgroup_spec.rb
+- spec/lib/moose_inventory/cli/host_addvar_spec.rb
+- spec/lib/moose_inventory/cli/host_get_spec.rb
+- spec/lib/moose_inventory/cli/host_list_spec.rb
+- spec/lib/moose_inventory/cli/host_rm_spec.rb
+- spec/lib/moose_inventory/cli/host_rmgroup_spec.rb
+- spec/lib/moose_inventory/cli/host_rmvar_spec.rb
+- spec/lib/moose_inventory/cli/host_spec.rb
+- spec/lib/moose_inventory/config/config_spec.rb
+- spec/lib/moose_inventory/db/db_spec.rb
+- spec/lib/moose_inventory/db/models_spec.rb
 - spec/shared/shared_config_setup.rb
 - spec/spec_helper.rb
 homepage: https://github.com/RusDavies/moose-inventory
@@ -358,29 +355,29 @@ specification_version: 4
 summary: Moose-tools inventory manager
 test_files:
 - spec/config/config.yml
-- spec/lib/moose/inventory/cli/application_spec.rb
-- spec/lib/moose/inventory/cli/cli_spec.rb
-- spec/lib/moose/inventory/cli/formatter_spec.rb
-- spec/lib/moose/inventory/cli/group_add_spec.rb
-- spec/lib/moose/inventory/cli/group_addhost_spec.rb
-- spec/lib/moose/inventory/cli/group_addvar_spec.rb
-- spec/lib/moose/inventory/cli/group_get_spec.rb
-- spec/lib/moose/inventory/cli/group_list_spec.rb
-- spec/lib/moose/inventory/cli/group_rm_spec.rb
-- spec/lib/moose/inventory/cli/group_rmhost_spec.rb
-- spec/lib/moose/inventory/cli/group_rmvar_spec.rb
-- spec/lib/moose/inventory/cli/group_spec.rb
-- spec/lib/moose/inventory/cli/host_add_spec.rb
-- spec/lib/moose/inventory/cli/host_addgroup_spec.rb
-- spec/lib/moose/inventory/cli/host_addvar_spec.rb
-- spec/lib/moose/inventory/cli/host_get_spec.rb
-- spec/lib/moose/inventory/cli/host_list_spec.rb
-- spec/lib/moose/inventory/cli/host_rm_spec.rb
-- spec/lib/moose/inventory/cli/host_rmgroup_spec.rb
-- spec/lib/moose/inventory/cli/host_rmvar_spec.rb
-- spec/lib/moose/inventory/cli/host_spec.rb
-- spec/lib/moose/inventory/config/config_spec.rb
-- spec/lib/moose/inventory/db/db_spec.rb
-- spec/lib/moose/inventory/db/models_spec.rb
+- spec/lib/moose_inventory/cli/application_spec.rb
+- spec/lib/moose_inventory/cli/cli_spec.rb
+- spec/lib/moose_inventory/cli/formatter_spec.rb
+- spec/lib/moose_inventory/cli/group_add_spec.rb
+- spec/lib/moose_inventory/cli/group_addhost_spec.rb
+- spec/lib/moose_inventory/cli/group_addvar_spec.rb
+- spec/lib/moose_inventory/cli/group_get_spec.rb
+- spec/lib/moose_inventory/cli/group_list_spec.rb
+- spec/lib/moose_inventory/cli/group_rm_spec.rb
+- spec/lib/moose_inventory/cli/group_rmhost_spec.rb
+- spec/lib/moose_inventory/cli/group_rmvar_spec.rb
+- spec/lib/moose_inventory/cli/group_spec.rb
+- spec/lib/moose_inventory/cli/host_add_spec.rb
+- spec/lib/moose_inventory/cli/host_addgroup_spec.rb
+- spec/lib/moose_inventory/cli/host_addvar_spec.rb
+- spec/lib/moose_inventory/cli/host_get_spec.rb
+- spec/lib/moose_inventory/cli/host_list_spec.rb
+- spec/lib/moose_inventory/cli/host_rm_spec.rb
+- spec/lib/moose_inventory/cli/host_rmgroup_spec.rb
+- spec/lib/moose_inventory/cli/host_rmvar_spec.rb
+- spec/lib/moose_inventory/cli/host_spec.rb
+- spec/lib/moose_inventory/config/config_spec.rb
+- spec/lib/moose_inventory/db/db_spec.rb
+- spec/lib/moose_inventory/db/models_spec.rb
 - spec/shared/shared_config_setup.rb
 - spec/spec_helper.rb

data/bin/.buildpath

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<buildpath>
-	<buildpathentry kind="src" path=""/>
-	<buildpathentry kind="con" path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
-</buildpath>

data/bin/.project

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-	<name>moose-inventory</name>
-	<comment></comment>
-	<projects>
-	</projects>
-	<buildSpec>
-		<buildCommand>
-			<name>org.eclipse.dltk.core.scriptbuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-	</buildSpec>
-	<natures>
-		<nature>org.eclipse.dltk.ruby.core.nature</nature>
-	</natures>
-</projectDescription>

data/bin/moose_inventory

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'moose_inventory_cli'
-rescue
-  require 'rubygems'
-  require 'moose-inventory-cli'
-end
-
-Moose::Inventory::Cli.start(ARGV) if __FILE__ == $PROGRAM_NAME

data/lib/moose/inventory/version.rb

@@ -1,7 +0,0 @@
-module Moose
-  ##
-  # The Moose-Tools dynanic inventory management library
-  module Inventory
-    VERSION = '0.1.1'
-  end
-end