outliner 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965c6e37c5f452ee902a235cf5eaaa73375894dbf1244cca2065f338ab12badd
-  data.tar.gz: 84533e4c6617795ee3a50181c6e78b178709caa356730cdcc93d26c89a99d5cc
+  metadata.gz: 2f21fefa59fb5ff2a67d87273bcaa82096ba5b1166a42ffa6802003b422c991f
+  data.tar.gz: 14f75297d7f94c001e0f7a43dde6d29f146f575f662e10b614b3e94a1f2d4339
 SHA512:
-  metadata.gz: 29c1e5c613d50fae1337ba041c1203d4d2e5ce82987997e59a83e21875a925c5ed3c0b730513de6a5efa9254997c04c79c4ea8ba26e9925db1019987c888da16
-  data.tar.gz: 0c08dec404bffea65a5b00647770fb761725db0a2d5445830d401a22a26abbd77768a9336635913dca195486faf1b39e9becaef2ef7865cceca6d6064079b9a9
+  metadata.gz: 83dae751c834a29fe279ef18fbe1d6fcc20062466b9bdfd61411dd189aadb6367c16b3fc92dade5087ecfdf86de81e2e4e8cb6db88fea0eb6a1d24f1fcbc142b
+  data.tar.gz: 437a5728107aa019ef6e031fde94f3078d332cc096a294d3ce563a8a6a862d0eebd29a44f3ba8fe5a97cc2ee23507c3a39c125790cf9cbd250b50dcf7da7d7b8

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 1.0.0 - 2020-04-26
+
+### Changed
+
+- Changes `push` to `sync`.
+
+### Added
+
+- `sync` now actually syncs the git repository, and maintains history.
+
+
+## 0.2.2 - 2019-08-14
+
+- Adds a `push` command (See #2)
+
 ## 0.2.0 - 2019-08-12
 
 - Adds export command (See [#1013](https://github.com/outline/outline/pull/1013) for corresponding Outline PR)

data/Dockerfile

@@ -1,9 +1,12 @@
-FROM ruby:2.6-alpine
+FROM ruby:2.7-alpine
 
 WORKDIR /outliner
 COPY . /outliner/
 
 RUN gem install bundler && \
-    bundle install
+    bundle install && \
+    apk add --no-cache git openssh-client rsync && \
+    echo -e "StrictHostKeyChecking no" >> /etc/ssh/ssh_config && \
+    mkdir /root/.ssh
 
 ENTRYPOINT ["/outliner/entrypoint.sh"]

data/Gemfile.lock

@@ -1,29 +1,29 @@
 PATH
   remote: .
   specs:
-    outliner (0.1.1)
+    outliner (0.2.2)
       httparty (~> 0.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    hashdiff (1.0.0)
-    httparty (0.17.0)
+    hashdiff (1.0.1)
+    httparty (0.18.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.2.2)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
+    mime-types-data (3.2019.1009)
     minitest (5.8.5)
     multi_xml (0.6.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.4)
     rake (10.5.0)
     safe_yaml (1.0.5)
-    webmock (3.6.0)
+    webmock (3.6.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -39,4 +39,4 @@ DEPENDENCIES
   webmock (~> 3.6.0)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2019 Abhay Rana
+Copyright 2020 Abhay Rana
 
 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.
+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

@@ -1,4 +1,4 @@
-# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/outliner) [![](https://images.microbadger.com/badges/version/captn3m0/outliner:v0.2.0.svg)](https://microbadger.com/images/captn3m0/outliner:v0.2.0 'Get your own version badge on microbadger.com') [![](https://images.microbadger.com/badges/version/captn3m0/outliner:latest.svg)](https://microbadger.com/images/captn3m0/outliner:latest 'Get your own version badge on microbadger.com')
+# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/outliner) [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner) [![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner)
 
 A simple HTTParty based wrapper for the [Outline API](https://www.getoutline.com/developers). It also offers a one-line import option to let you migrate an existing set of Markdown files to Outline. For quickly running export/import commands, you can use the Docker Image as well.
 
@@ -60,11 +60,16 @@ outliner-export "$DESTINATION_DIRECTORY"
 
 You can use the pre-built docker image to run the above commands as well. See the following commands for examples:
 
+### Setup
+
+Copy the `env.sample` file to `.env` and update the values there.
+
 ### Export
 
+Downloads all collections from Outline, and exports them as nested markdown files inside the given directory (`/data` inside the container, mount it accordingly.)
+
 ```bash
-docker run --env OUTLINE_BASE_URI="https://kb.example.com" \
-           --env OUTLINE_TOKEN="PUT YOUR TOKEN HERE" \
+docker run --env-file .env
            --volume /tmp:/data \
            captn3m0/outliner \
            export \
@@ -73,18 +78,33 @@ docker run --env OUTLINE_BASE_URI="https://kb.example.com" \
 
 ### Import
 
+Imports all markdown documents in a directory to a named Collection on outline. Creates the collection if it doesn't exist.
+
 ```bash
-docker run --env OUTLINE_BASE_URI="https://kb.example.com" \
-           --env OUTLINE_TOKEN="PUT YOUR TOKEN HERE" \
+docker run --env-file .env
            --volume /path/to/wiki:/data \
            captn3m0/outliner \
-           import "/data" "Archive"
+           import /data "Archive"
+```
+
+### Sync
+
+Does a export from Outline, and pushes the corresponding result to the Git repository. Currenly does a force-push to the repository. Use with care.
+
+Note: Sync is currently only available as a Docker Command
+
+```bash
+docker run --env-file .env
+           --volume /etc/ssh/private.key:/root/.ssh/id_rsa
+           captn3m0/outliner \
+           sync
 ```
 
 #### Limitations
 
-- Images are currently not imported. Host them externally for this to work.
-- Only `.md` files are currently supported
+- [import] Images are currently not imported. Host them externally for this to work.
+- [import] Only `.md` files are currently supported
+- [docker] `StrictHostKeyChecking` is currently disabled for `push`, please only run this in trusted networks.
 
 ## Development
 

data/entrypoint.sh

@@ -1,19 +1,77 @@
 #!/bin/sh
-
+set -eu
 if [ $# -eq 0 ]; then
-  echo "Please run with outliner [export|import] arguments"
+  echo "Please run with outliner [export|import|sync] arguments"
   exit
 fi
 
+setup_git() {
+  if [ -f "$HOME/.ssh/id_rsa" ]; then
+    # This is required because Kubernetes secret mounts can't
+    # have file permissions set
+    chmod 0400 "$HOME/.ssh/id_rsa"
+
+    if [ ! -d "$HOME/.ssh/id_rsa.pub" ]; then
+      ssh-keygen -y -f "$HOME/.ssh/id_rsa" > "$HOME/.ssh/id_rsa.pub"
+    fi
+    echo "[+] Using SSH key for git pushes"
+  else
+    echo "[E] Git credentials not available, quitting"
+    exit 1
+  fi
+
+  eval $(ssh-agent)
+  ssh-add "$HOME/.ssh/id_rsa"
+}
+
+update_git_config() {
+  EMAIL=${GIT_EMAIL:-outliner@example.invalid}
+  git config --global user.email "$EMAIL"
+  git config --global user.name "Outliner Backup"
+  git remote add origin "$GIT_REMOTE_URL"
+}
+
 case $1 in
   export)
     shift
-    bundle exec outliner-export $@
+    bundle exec outliner-export "$@"
     ;;
   import)
     shift
-    bundle exec outliner-import $@
-    break
+    bundle exec outliner-import "$@"
+    ;;
+  sync)
+    BRANCH=${GIT_BRANCH:-master}
+    old_git_dir=$(mktemp -d)
+    fresh_export_dir=$(mktemp -d)
+    if [ -z "$GIT_REMOTE_URL" ]; then
+      echo "[E] GIT_REMOTE_URL not set"
+      exit 1
+    else
+      git clone --branch "$BRANCH" "$GIT_REMOTE_URL" "$old_git_dir"
+      setup_git
+      update_git_config
+      echo "[+] Exporting data from Outline"
+      bundle exec outliner-export "$fresh_export_dir"
+      echo "[+] Resetting git repository"
+      cd "$old_git_dir"
+      # We update so that git forgets all files
+      git ls-files -z |xargs -n1 -0 git rm
+      # Then we copy across the files from the new export
+      cd "$fresh_export_dir"
+      echo "[+] Updating git repository"
+      rsync -av . "$old_git_dir"
+      cd "$old_git_dir"
+      echo "[+] Committing to git"
+      git add .
+      git commit --message "Backup: $(date)" > /dev/null
+      git status
+      echo "[+] Pushing to git remote"
+      git push origin "HEAD:$BRANCH"
+      echo "[+] Cleaning up"
+      rm -rf "$old_git_dir"
+      rm -rf "$fresh_export_dir"
+    fi
     ;;
   *)
     echo "Invalid command, please check README"

data/env.sample

@@ -0,0 +1,4 @@
+OUTLINE_BASE_URI=https://outline.example.com
+GIT_BRANCH=master
+GIT_REMOTE_URL=git@example.com:org/outline.backup.git
+OUTLINE_TOKEN=

data/exe/outliner-export

@@ -1,16 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "outliner"
+require 'bundler/setup'
+require 'outliner'
 require 'tempfile'
 
 def validate
-  unless (ARGV.size == 1) and Dir.exists?(ARGV[0]) and ENV.key?('OUTLINE_BASE_URI') and ENV.key?('OUTLINE_TOKEN')
-    puts "[E] Please call as `outliner-export directory`"
-    puts "[E] Please export OUTLINE_BASE_URI and OUTLINE_TOKEN environment variables"
-    puts "[E] OUTLINE_BASE_URI should not include /api"
-    exit 1
-  end
+  raise 'Missing arguments' if ARGV.size != 1
+  raise 'Invalid directory' unless Dir.exist?(ARGV[0])
+  raise 'OUTLINE_BASE_URI not set' unless ENV.key?('OUTLINE_BASE_URI')
+  raise 'OUTLINE_TOKEN not set' unless ENV.key?('OUTLINE_TOKEN')
 end
 
 # Run validations
@@ -25,7 +24,7 @@ response = CLIENT.collections_exportAll(download: true)
 
 # Extract it to a tempfle
 file = Tempfile.new('download.zip')
-File.open(file.path, 'w') { |file| file.write(response.body) }
+File.open(file.path, 'w') { |f| f.write(response.body) }
 
 `unzip -o "#{file.path}" -d "#{local_directory}"`
 

data/exe/outliner-import

@@ -1,25 +1,28 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "outliner"
+require 'bundler/setup'
+require 'outliner'
 
 def validate
-  unless (ARGV.size == 2) and Dir.exists?(ARGV[0]) and ARGV[1].match(/\w+/) and ENV.key?('OUTLINE_BASE_URI') and ENV.key?('OUTLINE_TOKEN')
-    puts "[E] Please call as `outliner-import local_directory remote_collection_name`"
-    puts "[E] Please export OUTLINE_BASE_URI and OUTLINE_TOKEN environment variables"
-    puts "[E] OUTLINE_BASE_URI should not include /api"
-    exit 1
-  end
+  raise 'Missing arguments' if ARGV.size != 2
+  raise 'Invalid directory' unless Dir.exist?(ARGV[0])
+  raise 'Invalid collection' unless ARGV[1].match(/\w+/)
+  raise 'OUTLINE_BASE_URI not set' unless ENV.key?('OUTLINE_BASE_URI')
+  raise 'OUTLINE_TOKEN not set' unless ENV.key?('OUTLINE_TOKEN')
 end
 
-def create_documents_recursively(directory, collection_id, parent_document_id=nil)
+def create_documents_recursively(directory, collection_id, parent_document_id = nil)
   cwd = Dir.pwd
   Dir.chdir directory
   # Create all documents for this directory
-  Dir["*.md"].each do |file|
+  Dir['*.md'].each do |file|
     params = {
       title: file[0...-3],
-      text: file[0...-3] + "\n" + File.read(file) + "\n\n---\nImported at #{Time.now}",
+      text: file[0...-3] +
+            "\n" +
+            File.read(file) +
+            "\n\n---\nImported at #{Time.now}",
       collectionId: collection_id,
       publish: true
     }
@@ -30,11 +33,11 @@ def create_documents_recursively(directory, collection_id, parent_document_id=ni
   end
 
   # Create child documents for each sub-directory
-  Dir.glob('*').select {|f| File.directory? f}.each do |dir|
+  Dir.glob('*').select { |f| File.directory? f }.each do |dir|
     puts "[-] #{dir}"
     params = {
       title: dir,
-      text: dir +"\nImported at #{Time.now}",
+      text: dir + "\nImported at #{Time.now}",
       collectionId: collection_id,
       publish: true,
       parentDocumentId: parent_document_id
@@ -54,16 +57,15 @@ remote_collection_name = ARGV[1]
 
 # Create a root collection
 CLIENT = Outliner::Client.new ENV['OUTLINE_BASE_URI']
-root_collection_id = find_or_create_collection(CLIENT, remote_collection_name)
+root_collection_id = CLIENT.find_or_create_collection(remote_collection_name)
 
 begin
   create_documents_recursively(local_directory, root_collection_id)
-  puts "[S] Import successful"
-rescue Exception => e
+  puts '[S] Import successful'
+rescue StandardError? => e
   # If we fail, print an error, and delete the collection
   puts "[E] Import failed with error: #{e.message}"
   CLIENT.collections_delete(id: root_collection_id)
-  puts "[E] Deleted collection, please report the issue or retry"
+  puts '[E] Deleted collection, please report the issue or retry'
   exit 1
 end
-

data/lib/outliner/client.rb

@@ -10,10 +10,20 @@ module Outliner
       @token = ENV['OUTLINE_TOKEN']
     end
 
+    def find_or_create_collection(name)
+      collections = self.collections_list(limit: 100)['data']
+      collections.filter!{|c|c['name'] == name}
+      if collections.size >= 1
+        collections[0]['id']
+      else
+        self.collections_create(name: name, description: 'Imported Collection')['data']['id']
+      end
+    end
+
     def method_missing(method_name, params = {})
       method_name = '/' + method_name.to_s.sub('_', '.')
       body = {token: @token}.merge(params).to_json
-      options = { 
+      options = {
         body: body,
         headers: {
           'Accept'=>'application/json',

data/lib/outliner/version.rb

@@ -1,3 +1,3 @@
 module Outliner
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/outliner.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "outliner"
   spec.version       = Outliner::VERSION
   spec.authors       = ["Nemo"]
-  spec.email         = ["rubygem.outliner@captnemo.in"]
+  spec.email         = ["outliner@captnemo.in"]
   spec.licenses      = ["MIT"]
 
   spec.summary       = "A simple HTTParty based client for outline knowledge base."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outliner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nemo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -82,7 +82,7 @@ dependencies:
         version: 5.8.4
 description: 
 email:
-- rubygem.outliner@captnemo.in
+- outliner@captnemo.in
 executables:
 - outliner-export
 - outliner-import
@@ -100,11 +100,11 @@ files:
 - bin/console
 - bin/setup
 - entrypoint.sh
+- env.sample
 - exe/outliner-export
 - exe/outliner-import
 - lib/outliner.rb
 - lib/outliner/client.rb
-- lib/outliner/helper.rb
 - lib/outliner/version.rb
 - outliner.gemspec
 homepage: https://github.com/captn3m0/outliner
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple HTTParty based client for outline knowledge base.

data/lib/outliner/helper.rb

@@ -1,13 +0,0 @@
-module Outliner
-  class Helper
-    def find_or_create_collection(client, name)
-      collections = client.collections_list(limit: 100)['data']
-      collections.filter!{|c|c['name'] == name}
-      if collections.size >= 1
-        collections[0]['id']
-      else
-        client.collections_create(name: name, description: 'Imported Collection')['data']['id']
-      end
-    end
-  end
-end