sync_readme 1.0.0

data/README.md

@@ -0,0 +1,81 @@
+# SyncReadme
+
+`sync_readme` is a gem designed to help you synchronize a readme between a repository and a confluence wiki page. The idea is that on merge to master, you can run the sync to take docs FROM the readme and put them in the confluence page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'sync_readme'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sync_readme
+
+Then set up a .sync_readme.yml file
+
+``` yaml
+default: readme                     # optional if not set, default runs all configurations
+
+readme:
+  url: http://confluence.url.here   # required
+  page_id: 123456                   # required
+  filename: Readme.md               # required
+  username: foo                     # optional, generally better as an environment variable
+  password: bar                     # optional, generally better as an environment variable
+  notice: this file is sync'd!      # optional, adds the notice (as html) to the top of the confluance docs
+  strip_title: false                # optional, defaults false, strips the first h1 (#) tag from the file
+  syntax_highlighting: true         # optional, defaults true, uses coderay sytax highlighting on code blocks
+```
+
+You'll also need to set environment variables with credentials to update the page in question:
+
+```
+CONFLUENCE_USERNAME=jsmith
+CONFLUENCE_PASSWORD=$UPER $ECURE PA$$WORD
+```
+
+## Usage
+```
+sync_readme [configuration]
+```
+
+## Adding to Gitlab-CI
+
+1. Create a confluence user specifically to sync with
+2. If you haven't already, create the pages you want to sync to on confluence and get their IDs.
+3. Create your `.sync_readme.yml` file like the one above (or see the example)
+4. Add `gem 'sync_readme'` to your apps gemfile
+5. Set `CONFLUENCE_USERNAME` and `CONFLUENCE_PASSWORD` as CI Variables. 
+6. Add the following job to your .gitlab-ci.yml 
+   ``` yaml
+   Sync To Confluence:
+     stage: update_docs                # Replace that with the stage you want this to run
+     only: master                      # Only run on master branch probably after you deploy
+     script:
+       - bundle exec sync_readme --all # Alternately just the profile you want to run
+    ```
+
+## Development
+
+Set up a copy of ruby 2.3.1 (We suggest rbenv)
+
+`bundle install`
+
+## Running Tests
+
+`bundle exec rspec`
+
+## Contributing
+
+Contributions are welcome as long as they contain tests for the behaviors added or changed.
+
+## License
+
+The gem is available as open source under the terms of the [BSD-3-Clause](http://opensource.org/licenses/BSD-3-Clause).

data/Rakefile

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

data/exe/sync_readme

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'sync_readme'
+SyncReadme.invoke(ARGV)

data/lib/sync_readme.rb

@@ -0,0 +1,40 @@
+require 'sync_readme/config'
+require 'sync_readme/confluence_sync'
+require 'sync_readme/reader'
+require 'sync_readme/version'
+require 'optparse'
+require 'dotenv'
+
+Dotenv.load
+
+module SyncReadme
+  def self.invoke(args)
+    options = {}
+    OptionParser.new do |opts|
+      opts.banner = "Usage: sync_readme [options] [profile]"
+
+      opts.on("-a", "--all", "Run verbosely") do
+        options[:all] = true
+      end
+    end.parse!(args)
+
+    default_profile = SyncReadme::Config.default
+
+    if options[:all] || (args.empty? && default_profile.nil?)
+      SyncReadme::Config.profiles.each do |profile|
+        SyncReadme.perform(profile)
+      end
+    elsif args.empty?
+      SyncReadme.perform(default_profile)
+    else
+      SyncReadme.perform(args.last)
+    end
+  end
+
+  def self.perform(profile)
+    config = SyncReadme::Config.new(profile)
+    content = SyncReadme::Reader.new(config).html
+    sync = SyncReadme::ConfluenceSync.new(config)
+    sync.update_page_content(content)
+  end
+end

data/lib/sync_readme/config.rb

@@ -0,0 +1,59 @@
+require 'yaml'
+
+module SyncReadme
+  class Config
+    DEFAULT_CONFIG_FILE = File.join(Dir.pwd, '.sync_readme.yml')
+    NO_CONFIGURATION_ERROR = "this profile has not been configured, please add it to #{DEFAULT_CONFIG_FILE}".freeze
+
+    def self.profiles(config_file = DEFAULT_CONFIG_FILE)
+      YAML.load_file(config_file).keys.select { |key| key != 'default' }
+    end
+
+    def self.default(config_file = DEFAULT_CONFIG_FILE)
+      default = YAML.load_file(config_file)['default']
+      unless default
+        profiles = SyncReadme::Config.profiles(config_file)
+        return profiles[0] unless profiles.empty? || profiles[1]
+        raise NO_CONFIGURATION_ERROR if profiles.empty?
+      end
+      default
+    end
+
+    def initialize(profile, config_file = DEFAULT_CONFIG_FILE)
+      @raw_config = YAML.load_file(config_file)[profile]
+      raise NO_CONFIGURATION_ERROR unless @raw_config
+    end
+
+    def url
+      @raw_config['url']
+    end
+
+    def username
+      ENV['CONFLUENCE_USERNAME'] || @raw_config['username']
+    end
+
+    def notice
+      @raw_config['notice']
+    end
+
+    def password
+      ENV['CONFLUENCE_PASSWORD'] || @raw_config['password']
+    end
+
+    def page_id
+      @raw_config['page_id']
+    end
+
+    def filename
+      @raw_config['filename']
+    end
+
+    def strip_title?
+      @raw_config['strip_title'].nil? ? false : @raw_config['strip_title']
+    end
+
+    def syntax_highlighting?
+      @raw_config['syntax_highlighting'].nil? ? true : @raw_config['syntax_highlighting']
+    end
+  end
+end

data/lib/sync_readme/confluence_sync.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'faraday'
+
+module SyncReadme
+  class ConfluenceSync
+    def initialize(config)
+      @page_id = config.page_id
+      @client = Faraday.new(url: config.url) do |faraday|
+        faraday.request  :url_encoded
+        # faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter # make requests with Net::HTTP
+        faraday.basic_auth(config.username, config.password)
+      end
+    end
+
+    def update_page_content(content)
+      page = get_page
+      update(updated_page_params(page, content))
+    end
+
+    def get_page
+      response = @client.get("/rest/api/content/#{@page_id}", expand: 'body.view,version')
+      JSON.parse(response.body)
+    end
+
+    def update(params)
+      @client.put do |request|
+        request.url "/rest/api/content/#{@page_id}"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = params.to_json
+      end
+    end
+
+    def updated_page_params(page, new_content)
+      {
+        version: {
+          number: increment_version(page),
+          minorEdit: true
+        },
+        title: page['title'],
+        type: 'page',
+        body: {
+          storage: {
+            value: new_content,
+            representation: 'storage'
+          }
+        }
+      }
+    end
+
+    def increment_version(page)
+      page['version']['number'] + 1
+    end
+  end
+end

data/lib/sync_readme/reader.rb

@@ -0,0 +1,28 @@
+require 'kramdown'
+
+module SyncReadme
+  class Reader
+    def initialize(config)
+      @file_contents = File.read(config.filename)
+      @notice = config.notice
+      @strip_title = config.strip_title?
+      @highlighter = config.syntax_highlighting? ? 'coderay' : nil
+    end
+
+    def html
+      markdown = @file_contents
+      markdown.sub!(/# .*\n/, '') if @strip_title
+      options = {
+        input: 'GFM',
+        syntax_highlighter: @highlighter,
+        syntax_highlighter_opts: {
+          css: 'style',
+          line_numbers: 'table'
+        }
+      }
+      value = Kramdown::Document.new(markdown, options).to_html
+      value = "#{@notice}#{value}" if @notice
+      value
+    end
+  end
+end

data/lib/sync_readme/version.rb

@@ -0,0 +1,3 @@
+module SyncReadme
+  VERSION = '1.0.0'.freeze
+end

data/sync_readme.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sync_readme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sync_readme'
+  spec.version       = SyncReadme::VERSION
+  spec.authors       = ['Alex Ives']
+  spec.email         = ['alex.ives@govdelivery.com']
+
+  spec.summary       = 'Syncs markdown files with confluence'
+  spec.description   = 'Converts markdown files and synchronizes them with confluence pages'
+  spec.homepage      = 'https://github.com/govdelivery/sync_readme'
+  spec.license       = 'BSD-3-Clause'
+
+  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_dependency 'faraday', '~> 0.11'
+  spec.add_dependency 'kramdown', '~> 1.13'
+  spec.add_dependency 'dotenv', '~> 2.1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: sync_readme
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Ives
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Converts markdown files and synchronizes them with confluence pages
+email:
+- alex.ives@govdelivery.com
+executables:
+- sync_readme
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".sync_readme.example.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exe/sync_readme
+- lib/sync_readme.rb
+- lib/sync_readme/config.rb
+- lib/sync_readme/confluence_sync.rb
+- lib/sync_readme/reader.rb
+- lib/sync_readme/version.rb
+- sync_readme.gemspec
+homepage: https://github.com/govdelivery/sync_readme
+licenses:
+- BSD-3-Clause
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Syncs markdown files with confluence
+test_files: []