asciidoctor-confluence_publisher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c02a16d80d2c6942088552370ab3f10033ec630caaaf6972830e48c1a11ceee3
+  data.tar.gz: 8a14b5a3ad568ce9fd8cc1151b5ad36a76ef3533bc24b4462ab78e351d6e2482
+SHA512:
+  metadata.gz: e7bb82e7e9159b8a9c9a319fdb82ff6684d61c9af1fce1e85227fd9645e606cd547d549dc971d4c388c17c367a57af6fde3aa5f0154c979a0bcebf050da707f0
+  data.tar.gz: 2ec63862b46679825befa2c4aa878bead193426cf81c471791b275ac8c8e931486fc3de0401c3dc5ea478f97cb3040b13e91b3fc9b1ab40af589beca770de676

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: [2.0, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+.rakeTasks
+Gemfile.lock
+.DS_Store
+*.env
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in asciidoctor-asciidoctor_confluence.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/README.md

@@ -0,0 +1,54 @@
+# Asciidoctor-ConfluencePublisher
+
+Asciidoctor-ConfluencePublisher is a command line tool that parse asciidoc files,
+generate confluence compatible html and upload the content and attachment to confluence.
+
+This repo inspired by [confluence-publisher](https://github.com/confluence-publisher/confluence-publisher)
+
+## Installation
+
+```ruby
+gem install asciidoctor-confluence_publisher
+```
+
+## Usage
+
+### configuration
+`asciidoctor-confluence_publisher` is built on asciidoctor gem, so the gem is compatible with
+all the arguments of asciidoctor. 
+
+The configuration of confluence can be set via attribute(`-a attr=attr_value`), or set via system environment.
+The attribute or environment are:
+
+
+attribute name | environment variable | note | required
+--- | --- | --- | ---
+confluence_host | CONFLUENCE_HOST | confluence host with protocol. | Y |
+space | SPACE | confluence page space. | Y |
+username | CONFLUENCE_USERNAME | confluence username. | Y |
+password | CONFLUENCE_PASSWORD | confluence password. | Y |
+ancestor_id | ANCESTOR_ID | page ancestor id. | Y |
+proxy | CONFLUENCE_PROXY | confluence http proxy. | N |
+skip_verify_ssl | - | whether skip verify ssl. | N |
+
+It is recomanded that use environment for confluence related host, username and password, for example [autoenv](https://github.com/inishchith/autoenv)
+
+### Run
+
+```bash
+confluence-publisher [file or directory]
+```
+The title of source file will be the title in confluence.
+
+If the final argument is a file, it will only processed the single file. It will recursively process all
+the source file except file starting with `_`, for directory parameter.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` 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/polarlights/asciidoctor-confluence_publisher.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/asciidoctor-confluence_publisher.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/asciidoctor/confluence_publisher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-confluence_publisher"
+  spec.version       = Asciidoctor::ConfluencePublisher::VERSION
+  spec.authors       = ["polarlights"]
+  spec.email         = ["godhuyang@hotmail.com"]
+
+  spec.summary       = %q{Parse asciidoc and publish the document to confluence.}
+  spec.description   = %q{Asciidoctor-Confluence parse asciidoc and publish the document to confluence.}
+  spec.homepage      = "https://github.com/polarlights/asciidoctor-confluence_publisher"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + '/releases'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ['confluence-publisher']
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'asciidoctor', '~> 2.0.0'
+  spec.add_runtime_dependency 'haml', '~> 5.1.0'
+  spec.add_runtime_dependency 'rest-client', '~> 2.1.0'
+
+  spec.add_development_dependency 'webmock', '~> 3.8.0'
+end

data/bin/confluence-publisher

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
+require 'asciidoctor/confluence_publisher/command'
+require 'pry-byebug'
+
+Asciidoctor::ConfluencePublisher::Command.execute ARGV

data/lib/asciidoctor/confluence_publisher.rb

@@ -0,0 +1,12 @@
+require 'asciidoctor'
+require_relative "confluence_publisher/version"
+require_relative "confluence_publisher/invoker"
+require_relative 'confluence_publisher/model/base'
+require_relative 'confluence_publisher/model/ancestor'
+require_relative 'confluence_publisher/model/attachment'
+require_relative 'confluence_publisher/model/property'
+require_relative 'confluence_publisher/model/space'
+require_relative 'confluence_publisher/model/version'
+require_relative 'confluence_publisher/model/page'
+require_relative 'confluence_publisher/confluence_api'
+require_relative 'confluence_publisher/asciidoc'

data/lib/asciidoctor/confluence_publisher/asciidoc.rb

@@ -0,0 +1,39 @@
+module Asciidoctor
+  module ConfluencePublisher
+    class Asciidoc
+      attr_reader :path, :children
+
+      def initialize(path)
+        @path = path
+        @children = []
+      end
+
+      def is_leaves?
+        !is_directory?
+      end
+
+      def is_directory?
+        File.directory?(path)
+      end
+
+      def add_child(child)
+        return if child.nil?
+        @children << child
+      end
+
+      def to_s
+        inspect
+      end
+
+      def has_any_leaves?
+        traverse_file_tree(self)
+      end
+
+      private
+      def traverse_file_tree(root)
+        return true if root.is_leaves?
+        return root.children.any? { |node| traverse_file_tree(node) }
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/command.rb

@@ -0,0 +1,59 @@
+require 'asciidoctor/confluence_publisher'
+require 'asciidoctor/cli'
+
+module Asciidoctor
+  module ConfluencePublisher
+    class Command
+      def self.execute(args)
+        options = Asciidoctor::Cli::Options.new
+
+        unless args != ['-v'] && (args & ['-V', '--version']).empty?
+          $stdout.write %(Asciidoctor Confluence #{Asciidoctor::ConfluencePublisher::VERSION} using )
+          options.print_version
+          exit 0
+        end
+
+        orig_args = args.dup
+        # if the parameter is a directory, it will set to the root of source_file
+        source_dir = nil
+        2.times do
+          result = options.parse! args
+          if result.is_a? Integer
+            if args.size == 1
+              file = args.first
+              fstat = ::File.stat file
+              if fstat.ftype == 'directory' && (input_files = parse_directory_files(file)).size > 0
+                source_dir = file
+                orig_args.reject! { |_arg| file == _arg }
+                orig_args.concat input_files
+                args = orig_args
+              else
+                exit result
+              end
+            else
+              exit result
+            end
+          end
+        end
+
+        options[:asciidoc_source_dir] = source_dir
+        invoker = Asciidoctor::ConfluencePublisher::Invoker.new options
+        GC.start
+        invoker.invoke!
+      end
+
+      private
+      # hack asciidoctor to support folder
+      def self.parse_directory_files(directory)
+        infiles = []
+        file = File.join(directory, "**/*.{asc,adoc,asciidoc}")
+        if (matches = ::Dir.glob file).size > 0
+          infiles = matches
+        end
+        # reject file start with "_", in conversion it is a included file
+        infiles.reject! { |file| File.basename(file).start_with?("_")}
+        infiles
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/confluence_api.rb

@@ -0,0 +1,236 @@
+require 'rest-client'
+require 'json'
+
+module Asciidoctor
+  module ConfluencePublisher
+    class ConfluenceApi
+      attr_reader :host, :space, :username
+
+      def initialize(host, space, username, password, skip_verify_ssl: false, proxy: nil)
+        @host = host
+        @space = space
+        @username = username
+        @password = password
+        @skip_verify_ssl = skip_verify_ssl
+        RestClient.proxy = proxy if proxy
+      end
+
+      # create a confluence page
+      #
+      def create_page(title, content, ancestor_id)
+        url = host + '/rest/api/content?expand=version,ancestors,space'
+        payload = {
+            title: title,
+            type: 'page',
+            space: {key: space},
+            ancestors: Array(ancestor_id).map { |ans_id| { id: ans_id } },
+            body: {
+                storage: {
+                    value: content,
+                    representation: 'storage'
+                }
+            }
+        }
+
+        req_result = send_request(:post, url, payload, default_headers)
+        Model::Page.new req_result[:body] if req_result[:success]
+      end
+
+      def update_page(page_id, title, content)
+        url = host + "/rest/api/content/#{page_id}"
+        current_page = get_page_by_id(page_id)
+        payload = {
+            title: title,
+            type: 'page',
+            body: {
+                storage: {
+                    value: content,
+                    representation: 'storage'
+                }
+            },
+            version: {
+                number: current_page.version.number + 1
+            }
+        }
+
+        req_result = send_request(:put, url, payload, default_headers)
+        Model::Page.new req_result[:body] if req_result[:success]
+      end
+
+      def get_page_by_id(page_id)
+        url = host + "/rest/api/content/#{page_id}"
+        payload = {
+            expand: 'version,space,ancestors'
+        }
+        begin
+          req_result = send_request(:get, url, payload, default_headers)
+          Model::Page.new(req_result[:body]) if req_result[:success]
+        rescue => e
+          $stderr.puts "not found page with id #{page_id}. message: #{e.message}"
+        end
+      end
+
+      def get_pages_by_title(title)
+        url = host + '/rest/api/content'
+        payload = {
+            type: 'page',
+            spaceKey: space,
+            title: title,
+            expand: 'ancestors,space,version'
+        }
+
+        start =0
+        limit = 30
+        result = []
+        loop do
+          pageable = { start: start, limit: limit}
+          req_result = send_request(:get, url, payload.merge(pageable), default_headers)
+          no_data = true
+          if req_result[:success] && req_result[:body]['size'] > 0
+            result.concat req_result[:body]['results'].map { |page| Model::Page.new(page) }
+            no_data = req_result[:body]['size'] < req_result[:body]['limit']
+          end
+          break if no_data
+          start += 1
+        end
+        result
+      end
+
+      def get_attachments(page_id)
+        url = host + "/rest/api/content/#{page_id}/child/attachment"
+        start = 0
+        limit = 50
+
+        result = []
+        loop do
+          payload = { start: start, limit: limit}
+          req_result = send_request(:get, url, payload, default_headers)
+          no_data = true
+          if req_result[:success] && req_result[:body]['size'] > 0
+            result.concat req_result[:body]['results'].map { |attachment| Model::Attachment.new attachment }
+          end
+
+          break if no_data
+          start += 1
+        end
+        result
+      end
+
+      def create_attachment(page_id, file_path)
+        url = host + "/rest/api/content/#{page_id}/child/attachment"
+        payload = {
+            file: File.new(file_path, 'rb')
+        }
+        header = {
+            x_atlassian_token: 'nocheck'
+        }
+
+        req_result = send_request(:post, url, payload, default_headers.merge(header), multipart: true)
+        Model::Attachment.new(req_result[:body]) if req_result[:success]
+      end
+
+      def update_attachment(page_id, attachment_id, file_path)
+        url = host + "/rest/api/content/#{page_id}/child/attachment/#{attachment_id}/data"
+        payload = {
+            file: File.new(file_path, 'rb')
+        }
+        header = {
+            x_atlassian_token: 'nocheck',
+            content_type: 'multipart/form-data'
+        }
+
+        req_result = send_request(:post, url, payload, default_headers.merge(header))
+        Model::Attachment.new(req_result[:body]) if req_result[:success]
+      end
+
+      def set_page_property(owner_id, key, value)
+        url = host + "/rest/api/content/#{owner_id}/property/#{key}?expand=version"
+        current_property = get_page_property(owner_id, key)
+        payload = {
+            value: value,
+            version: {
+                number: (current_property && current_property.version.number).to_i + 1
+            }
+        }
+
+        req_result = send_request(:put, url, payload, default_headers)
+        Model::Property.new req_result[:body] if req_result[:success]
+      end
+
+      def get_page_property(owner_id, key)
+        url = host + "/rest/api/content/#{owner_id}/property/#{key}"
+        payload = {
+            expand: 'version'
+        }
+
+        begin
+          req_result = send_request(:get, url, payload, default_headers)
+          Model::Property.new req_result[:body] if req_result[:success]
+        rescue => e
+        end
+      end
+
+      def remove_page_property(owner_id, key)
+        url = host + "/rest/api/content/#{owner_id}/property/#{key}"
+        payload = {}
+
+        send_request(:delete, url, payload, default_headers)
+      end
+
+      private
+      def default_headers
+        {
+            authorization: "Basic #{basic_auth_val}",
+            accept: 'application/json',
+            content_type: 'application/json'
+        }
+      end
+
+      def send_request(mthd, url, req_payload = {}, req_headers = {}, req_options = {})
+        headers = req_headers.dup
+        payload = req_payload.dup
+        options = req_options.dup
+        options[:timeout] = 30
+        if %w(get delete).include? mthd.to_s
+          headers.merge!({ params: payload })
+          payload = {}
+        elsif req_headers.empty?
+          headers = { content_type: 'application/json' }
+        end
+
+        if req_options[:multipart]
+          headers.delete(:content_type)
+        else
+          payload = payload.to_json
+        end
+
+        request_params = {
+            method: mthd,
+            url: url,
+            payload: payload,
+            headers: headers,
+            timeout: 30
+        }
+        request_params[:verify_ssl] = false if @skip_verify_ssl
+
+        RestClient::Request.execute(request_params) do |resp, _, _|
+          begin
+            if resp.code.between?(200, 399)
+              return { success: true, code: resp.code, body: resp.body.length > 1 && JSON.parse(resp.body) }
+            elsif resp.code == 401
+              raise RuntimeError, 'invalid username or password, please confirm it.'
+            else
+              raise RuntimeError, "send request to confluence failed, code: #{resp.code}, error: #{resp.body}"
+            end
+          rescue => error
+            raise RuntimeError, "send request to confluence failed, code: #{resp.code}, error: #{error.message}"
+          end
+        end
+      end
+
+      def basic_auth_val
+        Base64.strict_encode64 "#{@username}:#{@password}"
+      end
+    end
+  end
+end