chef2wiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 438be1b605ce6823c9b6e9bd118ae1fd73511a08
+  data.tar.gz: b895ce7dda352b90a10e63a235d3234f4d89a396
+SHA512:
+  metadata.gz: d698d29e42806f541f1afae7b7d55977b889091dd1ed385b9954703081c6489b129d38a1c86aa10ac0d43d62486c34c492db2865d3993f0a2a1337f2ddc1ebd3
+  data.tar.gz: 0fc34fb07b9c7bc1856b8a545f37b0ea242fad741d24ef116674fb6dd7261a23915c527ded9fa4e486ec945280ac03446da40fc2864342832125ca25a94429a7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Ivan Larionov
+
+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,65 @@
+# chef2wiki
+
+Generates wiki documentation from Chef node attributes using ERB templates.
+
+## Quick start:
+
+On the first launch chef2wiki creates default config and templates files at `~/.chef2wiki`.
+
+### Configure wiki parameters:
+`~/.chef2wiki/config.yml` example:
+
+```
+wiki:
+  api_url: "http://my.wiki.org/api.php"
+  login: Admin
+  password: Password
+  # domain: my_ldap
+
+chef:
+  config: ~/.chef/knife.rb
+
+cookbooks:
+  repo_paths:
+    - "~/chef/cookbooks/repo/cookbooks"
+    - "~/chef/cookbooks/repo/site-cookbooks"
+
+nodes:
+  exclude: ["old_node.example.com", "node2.example.com"]
+```
+
+- change wiki api url to yours
+- change login and password if you need it (or just remove if not)
+- provide a path to knife/chef config
+- provide a path(s) to cookbooks if you want README.md files being posted to wiki as well
+- you can exclude nodes from being processed
+- execute chef2wiki
+
+LDAP domain support requires http://www.mediawiki.org/wiki/Extension:LDAP_Authentication
+
+## Templates system
+
+Templates are located at `~/.chef2wiki/templates/`. Required templates are:
+
+| Template | Wiki page | Variables |
+| -------- | --------- | --------- |
+| `node.erb` – main node template | As node name | `@data` – node attributes (Hash) |
+| `nodes.erb` – nodes list | `Servers_list` | `@node_list` – list of nodes (Array of Strings) |
+| `documentation.erb` – template for README.md | As cookbook name | `@content` – content of README.md |
+| `documentation_list.erb` – cookbooks list | `Cookbooks_documentation` | `@cookbooks` – list of cookbooks (Array) |
+
+You can use partials. For example default `node.erb` calls `node/common.erb`: `<%= render 'node/common.erb' %>`
+
+## Contributing to chef2wiki
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Ivan Larionov. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rubygems/package_task'
+
+gemspec = eval(File.read("chef2wiki.gemspec"))
+Gem::PackageTask.new(gemspec).define
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "chef2wiki #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/bin/chef2wiki

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "chef2wiki"
+
+c2w = Chef2Wiki.new
+
+@node_list = c2w.node_list
+@node_list.each do |node|
+  unless c2w.excluded_node_list.include?(node)
+    c2w.add_page(node, c2w.render_node(node))
+  else
+    puts "[Chef2Wiki]\tNode #{node} exluded by configuration."
+  end
+end
+
+# Create other pages
+c2w.add_page("Servers_list", c2w.templates["nodes"].result)
+
+# Create documentation pages
+c2w.generate_docs

data/lib/chef2wiki.rb

@@ -0,0 +1,11 @@
+require 'chef'
+require 'yaml'
+require 'json'
+require 'erb'
+require 'set'
+require 'media_wiki'
+
+require 'chef2wiki/base'
+require 'chef2wiki/chef'
+require 'chef2wiki/cookbook'
+require 'chef2wiki/mediawiki'

data/lib/chef2wiki/base.rb

@@ -0,0 +1,124 @@
+class Chef2Wiki
+
+  attr_reader :wiki, :config, :templates, :options
+
+  GEM_DATADIR = Gem.datadir("chef2wiki") || "data"
+  GEM_HOMEDIR = File.join(ENV["HOME"], ".chef2wiki")
+  DEFAULT_CONFIG_PATH = File.join(GEM_HOMEDIR, "config.yml")
+  DEFAULT_TEMPLATES_PATH = File.join(GEM_HOMEDIR, "templates")
+
+  def initialize(options = {})
+    options[:config] ||= DEFAULT_CONFIG_PATH
+    options[:templates] ||= DEFAULT_TEMPLATES_PATH
+    options[:wiki] ||= :mediawiki
+
+    @options = options
+    @config = read_config(File.expand_path(options[:config]))
+    @templates = register_templates(File.expand_path(options[:templates]))
+    @wiki = case options[:wiki]
+    when :mediawiki
+      setup_media_wiki
+    end
+
+    Chef::Config.from_file(File.expand_path(config["chef"]["config"]))
+  end
+
+  # Render node.
+  #
+  # ==== Attributes
+  # * +node+ - Node name (String)
+  def render_node(node)
+    puts "[Chef2Wiki]\tWorking for node #{node}..."
+    @data = node_data(node)
+    templates["node"].result(binding)
+  end
+
+  private
+
+  # Read chef2wiki config file. Create default config if missing.
+  #
+  # ==== Attributes
+  # * +path+ - path for chef2wiki config file
+  # ==== Returns
+  # * Config data (Hash)
+  def read_config(path)
+    unless File.exist?(path)
+      puts "[Chef2Wiki]\tCreating config file at #{path}..."
+      FileUtils.mkdir_p(File.dirname(path))
+      FileUtils.cp(File.join(GEM_DATADIR, "config.yml"), path)
+    end
+
+    YAML::load_file(path)
+  end
+
+  # Register templates from templates folder. Create default templates if missing.
+  #
+  # ==== Attributes
+  # * +path+ - path for erb templates
+  # ==== Returns
+  # * Templates data (Hash)
+  def register_templates(path)
+    unless File.directory?(path)
+      puts "[Chef2Wiki]\tCreating default templates at #{path}..."
+      FileUtils.mkdir_p(path)
+      FileUtils.cp_r(File.join(GEM_DATADIR, "templates", "."), path)
+    end
+
+    templates_data = {}
+    Dir.glob(File.join(path, "*.erb")) do |file|
+      name = File.basename(file, ".erb")
+      begin
+        templates_data[name] = ERB.new(File.read(file), nil, "%<>")
+      rescue => ex
+        puts "[Chef2Wiki]\tError loading template #{tem}: " + ex.to_s
+      end
+    end
+    puts "[Chef2Wiki]\tRegistered templates: #{templates_data.keys.join(", ")}"
+    return templates_data
+  end
+
+  # Render partial template.
+  #
+  # ==== Attributes
+  # * +name+ - Name of template (String)
+  def render(name)
+    puts "[Chef2Wiki]\tRendering partial #{name}..."
+    template = ERB.new(File.read(File.join(options[:templates], name)), nil, "%<>")
+    template.result(binding)
+  end
+
+  # Recursively print object attributes with arg and value.
+  # If value class is a Hash - call this method again for value.
+  # If value class is an Array - print value with join.
+  #
+  # ==== Attributes
+  # * +obj+ - Object for print (Hash)
+  # * +point+ - String for start of line (String)
+  # * +splitter+ - String for split attribute and value (String)
+  # * +endline+ - String for end of line (String)
+  def print_attrs(obj, point="* ", splitter=":", endline="\n")
+    result = ""
+    if obj
+      obj.each do |arg, value|
+        result += "#{point}#{arg}"
+        if !value.to_s.empty?
+          result += "#{splitter} "
+          if value.is_a?(Hash)
+            # TODO: Hate this recursion. Also it's too wiki-related with this pointer usage.
+            result += "#{endline}#{print_attrs(value, point[0,1]+point, splitter, endline)}"
+          elsif value.is_a?(Array)
+            result += value.join(", ")
+            result += "#{endline}"
+          else
+            result += "#{value}"
+            result += "#{endline}"
+          end
+        else
+          result += "#{endline}"
+        end
+      end
+    end
+    return result
+  end
+
+end

data/lib/chef2wiki/chef.rb

@@ -0,0 +1,32 @@
+class Chef2Wiki
+
+  # Get data for node.
+  #
+  # ==== Attributes
+  # * +node_name+ - Name of the node from chef (String)
+  # ==== Returns
+  # * Node data (Hash)
+  def node_data(node_name)
+    node = Chef::Node.load(node_name)
+    data = node.to_hash
+    data["run_list"] = node.run_list.run_list_items
+    return data
+  end
+
+  # Get node list.
+  #
+  # ==== Returns
+  # * Node list (Array)
+  def node_list
+    Chef::Node.list.keys
+  end
+
+  # Get excluded node list.
+  #
+  # ==== Returns
+  # * Node list (Array)
+  def excluded_node_list
+    config["nodes"] ? config["nodes"]["exclude"] : []
+  end
+
+end

data/lib/chef2wiki/cookbook.rb

@@ -0,0 +1,27 @@
+class Chef2Wiki
+
+# This requires markdown extension for mediawiki.
+
+def generate_docs
+  if config["cookbooks"]["repo_paths"].any?
+    puts "[Chef2Wiki]\tCreating documentation..."
+    @cookbooks = []
+
+    config["cookbooks"]["repo_paths"].each do |repo_path|
+      doc_files = File.join(repo_path, "**", "README.md")
+
+      Dir.glob(File.expand_path(doc_files)).sort.each do |file|
+        cookbook = file.gsub("#{File.expand_path(repo_path)}/", "").gsub("/README.md", "")
+        if cookbook != "README.md"
+          @cookbooks += [cookbook]
+          @content = File.read(file)
+          add_page(cookbook, templates["documentation"].result(binding))
+        end
+      end
+    end
+
+    add_page("Cookbooks_documentation", templates["documentation_list"].result(binding))
+  end
+end
+
+end

data/lib/chef2wiki/mediawiki.rb

@@ -0,0 +1,41 @@
+class Chef2Wiki
+
+  # Add page to MediaWiki
+  #
+  # ==== Attributes
+  # * +title+ - Title of the page (String)
+  # * +content+ - Content of the page (String)
+  # * +overwrite+ - Overwrite flag (Boolean)
+  def add_page(title, content, overwrite = true)
+    begin
+      print "[MediaWiki]\tCreating page #{title}... "
+      wiki.create(title, content, :overwrite => overwrite)
+      puts "done."
+    rescue Exception => ex
+      puts "[MediaWiki]\tError adding page #{title}: " + ex.message.to_s
+    end
+  end
+
+  private
+
+  # Do wiki connect and login.
+  def setup_media_wiki
+    if config["wiki"]["api_url"] && !config["wiki"]["api_url"].empty?
+      mediawiki = MediaWiki::Gateway.new(config["wiki"]["api_url"])
+    else
+      abort "[MediaWiki]\tPlease, configure mediawiki api url."
+    end
+
+    if config["wiki"]["login"] && !config["wiki"]["login"].empty?
+      begin
+        mediawiki.login(config["wiki"]["login"], config["wiki"]["password"], config["wiki"]["domain"])
+        puts "[MediaWiki]\tLogged in successfully."
+      rescue Exception => ex
+        puts "[MediaWiki]\tError while login into wiki: " + ex.message.to_s
+      end
+    end
+
+    return mediawiki
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: chef2wiki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Larionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+- !ruby/object:Gem::Dependency
+  name: mediawiki-gateway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Generates wiki documentation from Chef node attributes using ERB templates.
+email: xeron.oskom@gmail.com
+executables:
+- chef2wiki
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/chef2wiki
+- lib/chef2wiki.rb
+- lib/chef2wiki/base.rb
+- lib/chef2wiki/chef.rb
+- lib/chef2wiki/cookbook.rb
+- lib/chef2wiki/mediawiki.rb
+homepage: http://github.com/xeron/chef2wiki
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generates wiki documentation from Chef node attributes using ERB templates.
+test_files: []