outliner 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78468e90b9cfa5b4edbddc88991a2a3bf9abf7def91fa7e9c370179838947bb2
-  data.tar.gz: 5bc469b0dd84226362ea76da9a343cdc569361c39aae188b3b8d5ada30957ce5
+  metadata.gz: 965c6e37c5f452ee902a235cf5eaaa73375894dbf1244cca2065f338ab12badd
+  data.tar.gz: 84533e4c6617795ee3a50181c6e78b178709caa356730cdcc93d26c89a99d5cc
 SHA512:
-  metadata.gz: fe63570fb9585c14326f045d8819d31ac9539e9cb4e561cbd2b8280babb21811af0f5d0090b221b41047c3f2af1747a42029606964103eb451fca3e74d8788f8
-  data.tar.gz: d58622b22451ea9b1e738b2e3686b4f4cc21b475f380448cbe9e26a555133cd788607710c7bb1287d5869856d95aadc27ba0340e572c95e3bb0eea2b23f2b4ea
+  metadata.gz: 29c1e5c613d50fae1337ba041c1203d4d2e5ce82987997e59a83e21875a925c5ed3c0b730513de6a5efa9254997c04c79c4ea8ba26e9925db1019987c888da16
+  data.tar.gz: 0c08dec404bffea65a5b00647770fb761725db0a2d5445830d401a22a26abbd77768a9336635913dca195486faf1b39e9becaef2ef7865cceca6d6064079b9a9

data/CHANGELOG.md

@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-- Dockerfile
+## 0.2.0 - 2019-08-12
+
+- Adds export command (See [#1013](https://github.com/outline/outline/pull/1013) for corresponding Outline PR)
+- Adds support for running import|export via Docker
+- Sets up `outline-export` and `outline-import` as rubygem executables
 
 ## 0.1.1 - 2019-07-24
 
@@ -18,5 +22,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial release
-
-[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...HEAD

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.6-alpine
+
+WORKDIR /outliner
+COPY . /outliner/
+
+RUN gem install bundler && \
+    bundle install
+
+ENTRYPOINT ["/outliner/entrypoint.sh"]

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    outliner (0.1.1)
+      httparty (~> 0.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (1.0.0)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    minitest (5.8.5)
+    multi_xml (0.6.0)
+    public_suffix (3.1.1)
+    rake (10.5.0)
+    safe_yaml (1.0.5)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.8.4)
+  outliner!
+  rake (~> 10.0)
+  webmock (~> 3.6.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -1,6 +1,6 @@
-# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/outliner)
+# 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')
 
-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.
+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.
 
 ## Installation
 
@@ -32,7 +32,7 @@ pp client.collections_list(offset: 0, limit: 10)
 
 ### Import
 
-`outliner` can be used to import an existing collection of documents into Outline. To do this run:
+`outliner` can be used to import an existing collection of documents into Outline. To do this, run:
 
 ```bash
 export OUTLINE_BASE_URI="https://kb.example.com"
@@ -40,12 +40,50 @@ export OUTLINE_TOKEN="PUT YOUR TOKEN HERE"
 export SOURCE_DIRECTORY="/home/user/wiki"
 export DESTINATION_COLLECTION_NAME="Archive"
 bundle install outliner
-bundle exec bin/import "$SOURCE_DIRECTORY" "$DESTINATION_COLLECTION_NAME"
+outliner-import "$SOURCE_DIRECTORY" "$DESTINATION_COLLECTION_NAME"
+```
+
+### Export
+
+`outliner` can be used to run a one-time export of all documents in Outline to a local directory. To do this, run:
+
+```bash
+export OUTLINE_BASE_URI="https://kb.example.com"
+export OUTLINE_TOKEN="PUT YOUR TOKEN HERE"
+# Ensure that this exists and is writable
+export DESTINATION_DIRECTORY="/data"
+bundle install outliner
+outliner-export "$DESTINATION_DIRECTORY"
+```
+
+## Docker
+
+You can use the pre-built docker image to run the above commands as well. See the following commands for examples:
+
+### Export
+
+```bash
+docker run --env OUTLINE_BASE_URI="https://kb.example.com" \
+           --env OUTLINE_TOKEN="PUT YOUR TOKEN HERE" \
+           --volume /tmp:/data \
+           captn3m0/outliner \
+           export \
+           /data
+```
+
+### Import
+
+```bash
+docker run --env OUTLINE_BASE_URI="https://kb.example.com" \
+           --env OUTLINE_TOKEN="PUT YOUR TOKEN HERE" \
+           --volume /path/to/wiki:/data \
+           captn3m0/outliner \
+           import "/data" "Archive"
 ```
 
 #### Limitations
 
-- Images are currently not imported
+- Images are currently not imported. Host them externally for this to work.
 - Only `.md` files are currently supported
 
 ## Development

data/entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+if [ $# -eq 0 ]; then
+  echo "Please run with outliner [export|import] arguments"
+  exit
+fi
+
+case $1 in
+  export)
+    shift
+    bundle exec outliner-export $@
+    ;;
+  import)
+    shift
+    bundle exec outliner-import $@
+    break
+    ;;
+  *)
+    echo "Invalid command, please check README"
+    ;;
+esac

data/exe/outliner-export

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+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
+end
+
+# Run validations
+validate
+
+# Setup variables
+local_directory = ARGV[0]
+CLIENT = Outliner::Client.new ENV['OUTLINE_BASE_URI']
+
+# Download the complete zip
+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) }
+
+`unzip -o "#{file.path}" -d "#{local_directory}"`
+
+# Delete tempfile
+file.unlink

data/{bin/import → exe/outliner-import}

@@ -4,20 +4,11 @@ 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')
-    puts "[E] Please call as import local_directory remote_collection_name"
+  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"
-  end
-end
-
-def find_or_create_collection(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']
+    exit 1
   end
 end
 
@@ -63,7 +54,7 @@ remote_collection_name = ARGV[1]
 
 # Create a root collection
 CLIENT = Outliner::Client.new ENV['OUTLINE_BASE_URI']
-root_collection_id = find_or_create_collection(remote_collection_name)
+root_collection_id = find_or_create_collection(CLIENT, remote_collection_name)
 
 begin
   create_documents_recursively(local_directory, root_collection_id)

data/lib/outliner/helper.rb

@@ -0,0 +1,13 @@
+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

data/lib/outliner/version.rb

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

data/lib/outliner.rb

@@ -1,4 +1,5 @@
 require "outliner/version"
+require "outliner/client"
 
 module Outliner
   class Error < StandardError; end

data/outliner.gemspec

@@ -2,13 +2,13 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "outliner/version"
-require "outliner/client"
 
 Gem::Specification.new do |spec|
   spec.name          = "outliner"
   spec.version       = Outliner::VERSION
   spec.authors       = ["Nemo"]
   spec.email         = ["rubygem.outliner@captnemo.in"]
+  spec.licenses      = ["MIT"]
 
   spec.summary       = "A simple HTTParty based client for outline knowledge base."
   spec.homepage      = "https://github.com/captn3m0/outliner"
@@ -17,11 +17,8 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/captn3m0/outliner"
   spec.metadata["changelog_uri"] = "https://github.com/captn3m0/outliner/blob/master/CHANGELOG.md"
 
-  # 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.files         = Dir['**/*'].reject { |f| f.match(%r{^(vendor|test|spec|features)/}) }
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outliner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nemo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -83,27 +83,33 @@ dependencies:
 description: 
 email:
 - rubygem.outliner@captnemo.in
-executables: []
+executables:
+- outliner-export
+- outliner-import
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
-- bin/import
 - bin/setup
+- entrypoint.sh
+- 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
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/captn3m0/outliner
   source_code_uri: https://github.com/captn3m0/outliner

data/.editorconfig

@@ -1,12 +0,0 @@
-; This file is for unifying the coding style for different editors and IDEs.
-; More information at http://EditorConfig.org
-
-root = true
-; Use 2 spaces for indentation in all files
-[*]
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-indent_style = space
-indent_size = 2
-insert_final_newline = true

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/vendor/
-Gemfile.lock