puppet2conf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c5f6cd86dea2b3c04deb56bf11b4620be8405dc
+  data.tar.gz: 65dd18418792584785d43eeb3bc2a3f2d8454c90
+SHA512:
+  metadata.gz: cd08beaf1a6d96c1592d8b8daab833fded599fa210f226e51bdf79e2924c53c1e7d7607e366956a7ebbc069921fc549060f0ed4c8eae13a6bd6f82b21c3910c2
+  data.tar.gz: e276438b4a9acf5ad410d0a00bb973066ce61acfde36d97bb2334db1dea4dc6d1a14784c78c8442431b1207a5633f61c55422977af7629264d8a5c68216b5fc6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

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 vtyshkevich@iponweb.net. 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/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+This is very early version of gem yet, so everybody a welcome to make impovements. 

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vladimir Tyshkevich
+
+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,67 @@
+# Puppet2conf
+
+Generate all related to your puppet module documentation in your confluence
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet2conf'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+First, generate a configuration file located at `~/.puppet2conf.yml`:
+
+```yaml
+username: confluence-bot
+password: MySecurePassword
+url: https://confluence.mycompany.com
+space: OpsSpace
+ancestor: PuppetModules
+```
+
+then create a Rake task that looks like this:
+
+```ruby
+desc 'Generate documentation'
+task :gendoc do
+  require 'puppet2conf'
+  doc_pusher = Puppet2conf::DocPusher.new
+  doc_pusher.gendocs('module_name')
+end
+```
+
+If you have lots of modules with the same Rakefile, you could parse out the module name from metadata:
+
+```ruby
+desc 'Generate documentation'
+task :gendoc do
+  require 'puppet2conf'
+  require 'json'
+  module_name = JSON.parse(File.read 'metadata.json')['name'].split('-')[1]
+  doc_pusher = Puppet2conf::DocPusher.new
+  doc_pusher.gendocs(module_name)
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/v0v04ka/puppet2conf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Puppet2conf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/v0v04ka/puppet2conf/blob/master/CODE_OF_CONDUCT.md).

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 "puppet2conf"
+
+# 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(__FILE__)

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/lib/puppet2conf.rb

@@ -0,0 +1,92 @@
+require 'puppet2conf/version'
+require 'strings2conf'
+require 'md2conf'
+require 'conf/api/client'
+require 'puppet-strings'
+require 'yaml'
+
+module Puppet2conf
+  class DocPusher
+    # Pass the following variables as parameters:
+    # - username
+    # - password
+    # - url
+    # - space
+    # - ancestor
+    #
+    # or provide them in configuration file in YAML format.
+    # Configuration file location can be overridden by `config_file` parameter.
+    def initialize(config_file: '~/.puppet2conf.yaml', username: nil, password: nil, url: nil, space: nil, ancestor: nil)
+      params             = {}
+      params['username'] = username if username
+      params['password'] = password if password
+      params['url']      = url if url
+      params['space']    = space if space
+      params['ancestor'] = ancestor if ancestor
+
+      if File.file? File.expand_path(config_file)
+        @config = YAML.load_file(File.expand_path(config_file))
+      end
+
+      @config.merge! params
+      @client = Conf::Api::Client.new(@config['username'], @config['password'], @config['url'])
+    end
+
+    def push_page(page_title, html, ancestor)
+      page = @client.get(spaceKey: @config['space'], title: page_title)[0]
+      if ancestor
+        parent_page = @client.get(spaceKey: @config['space'], title: ancestor)[0]
+        if parent_page
+          ancestors = [{ type: 'page', id: parent_page['id'] }]
+        else
+          warn "Couldn't find parent page #{ancestor}"
+          exit 1
+        end
+      end
+      if page.nil?
+        puts "Page '#{page_title}' doesn't exist, creating it"
+        @client.create(
+          type:      'page',
+          title:     page_title,
+          space:     { key: @config['space'] },
+          ancestors: ancestors,
+          body:      { storage: { value: html, representation: 'storage' } }
+        )
+      else
+        page = @client.get_by_id(page['id'])
+        puts "Page '#{page_title}' exists. Updating it"
+        version = page['version']['number'] || 1
+        @client.update(
+          page['id'],
+          type:      'page',
+          id:        page['id'],
+          title:     page_title,
+          space:     { key: @config['space'] },
+          ancestors: ancestors,
+          version:   { number: version + 1 },
+          body:      { storage: { value: html, representation: 'storage' } }
+        )
+      end
+    end
+
+    def gendocs(title_page, strings: true)
+      module_html = Md2conf.parse_markdown File.read('README.md')
+      push_page(title_page, module_html, @config['ancestor'])
+      Dir.glob('*.md').each do |md_file|
+        next if md_file.eql? 'README.md'
+        html       = if md_file.eql? 'CHANGELOG.md'
+          Md2conf.parse_markdown(File.read(md_file), max_toc_level: 2)
+        else
+          Md2conf.parse_markdown File.read(md_file)
+        end
+        page_title = "#{title_page} #{File.basename(md_file).sub('.md', '').split('_').map(&:capitalize).join(' ')}"
+        push_page(page_title, html, title_page)
+      end
+      if strings
+        PuppetStrings.generate(PuppetStrings::DEFAULT_SEARCH_PATTERNS, json: 'puppet_strings.json')
+        reference_html = Strings2conf.convert(File.read('puppet_strings.json'))
+        push_page("#{title_page} Reference", reference_html, title_page)
+      end
+    end
+  end
+end

data/lib/puppet2conf/version.rb

@@ -0,0 +1,3 @@
+module Puppet2conf
+  VERSION = '0.1.0'.freeze
+end

data/puppet2conf.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet2conf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puppet2conf'
+  spec.version       = Puppet2conf::VERSION
+  spec.authors       = ['Vladimir Tyshkevich', 'Eugene Piven']
+  spec.email         = ['vtyshkevich@iponweb.net', 'epiven@iponweb.net']
+  spec.summary       = 'Gets XHTML Confluence storage and push it to Confluence'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'md2conf'
+  spec.add_runtime_dependency 'strings2conf'
+  spec.add_runtime_dependency 'puppet-strings'
+  spec.add_runtime_dependency 'conf-api-client'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: puppet2conf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Tyshkevich
+- Eugene Piven
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: md2conf
+  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'
+- !ruby/object:Gem::Dependency
+  name: strings2conf
+  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'
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  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'
+- !ruby/object:Gem::Dependency
+  name: conf-api-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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: 
+email:
+- vtyshkevich@iponweb.net
+- epiven@iponweb.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puppet2conf.rb
+- lib/puppet2conf/version.rb
+- puppet2conf.gemspec
+homepage: 
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Gets XHTML Confluence storage and push it to Confluence
+test_files: []