outliner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6b3e32c28045daaedc8385bafa2363feda000954ebd9cd056438aefe7ea868d
+  data.tar.gz: ce770363063c8a15c697c0dee6c09594465c07f262becc4f4a422945f1e7dab6
+SHA512:
+  metadata.gz: 9c0ced89c0f1365fe33acda03a54cbf04660d2d17721fb84665508b65f5124d4d893e28985fafa8aad9692ba3553c4fcfc86e3a1b7098572807653d732d90998
+  data.tar.gz: 9949c41e764a318a99f62ca53ef1152a80215a955246eb0dc9762a1764e533e6e14d1ddce55f35103359378566fed38616838818986e927530bafb1d0a470e6d

data/.editorconfig

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

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

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- Dockerfile
+
+## 0.1.0 - 2019-07-24
+
+### Added
+
+- Initial release
+
+[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...HEAD

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 me@captnemo.in. 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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in outliner.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 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.

data/README.md

@@ -0,0 +1,67 @@
+# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'outliner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outliner
+
+## Usage
+
+The API Client automatically picks up the Token from the `OUTLINE_TOKEN` environment variable. All the API calls are available with the `.` replaced with a `_` in the method name. So if you need to call the `collections.remove_user` API, use the `collections_remove_user` method.
+
+```ruby
+require 'outliner'
+
+client = Outliner.new('https://knowledge.example.com')
+pp client.auth_info
+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:
+
+```bash
+export OUTLINE_BASE_URI="https://kb.example.com"
+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"
+```
+
+#### Limitations
+
+- Images are currently not imported
+- Only `.md` files are currently supported
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/captn3m0/outliner. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Outliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/captn3m0/outliner/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+desc "Run tests"
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "outliner"
+
+# 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/import

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+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"
+    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']
+  end
+end
+
+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|
+    params = {
+      title: file[0...-3],
+      text: file[0...-3] + "\n" + File.read(file) + "\n\n---\nImported at #{Time.now}",
+      collectionId: collection_id,
+      publish: true
+    }
+
+    params[:parentDocumentId] = parent_document_id if parent_document_id
+    CLIENT.documents_create(params)
+    puts "[-] #{file}"
+  end
+
+  # Create child documents for each sub-directory
+  Dir.glob('*').select {|f| File.directory? f}.each do |dir|
+    puts "[-] #{dir}"
+    params = {
+      title: dir,
+      text: dir +"\nImported at #{Time.now}",
+      collectionId: collection_id,
+      publish: true,
+      parentDocumentId: parent_document_id
+    }
+    response = CLIENT.documents_create(params)
+    create_documents_recursively(dir, collection_id, response['data']['id'])
+  end
+  Dir.chdir cwd
+end
+
+# Run validations
+validate
+
+# Setup variables
+local_directory = ARGV[0]
+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)
+
+begin
+  create_documents_recursively(local_directory, root_collection_id)
+  puts "[S] Import successful"
+rescue Exception => 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"
+  exit 1
+end
+

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/outliner/client.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+require 'json'
+
+module Outliner
+  class Client
+    include HTTParty
+
+    def initialize(base_uri)
+      self.class.base_uri (base_uri + "/api")
+      @token = ENV['OUTLINE_TOKEN']
+    end
+
+    def method_missing(method_name, params = {})
+      method_name = '/' + method_name.to_s.sub('_', '.')
+      body = {token: @token}.merge(params).to_json
+      options = { 
+        body: body,
+        headers: {
+          'Accept'=>'application/json',
+          'Content-Type': 'application/json',
+          'User-Agent': "Outliner/#{Outliner::VERSION}"
+        },
+        format: :json
+      }
+
+      self.class.post(method_name, options)
+    end
+  end
+end

data/lib/outliner/version.rb

@@ -0,0 +1,3 @@
+module Outliner
+  VERSION = "0.1.0"
+end

data/lib/outliner.rb

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

data/outliner.gemspec

@@ -0,0 +1,35 @@
+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.summary       = "A simple HTTParty based client for outline knowledge base."
+  spec.homepage      = "https://github.com/captn3m0/outliner"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "httparty", "~> 0.17"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 3.6.0"
+  spec.add_development_dependency "minitest", "~> 5.8.4"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: outliner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nemo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+description: 
+email:
+- rubygem.outliner@captnemo.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/import
+- bin/setup
+- lib/outliner.rb
+- lib/outliner/client.rb
+- lib/outliner/version.rb
+- outliner.gemspec
+homepage: https://github.com/captn3m0/outliner
+licenses: []
+metadata:
+  homepage_uri: https://github.com/captn3m0/outliner
+  source_code_uri: https://github.com/captn3m0/outliner
+  changelog_uri: https://github.com/captn3m0/outliner/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A simple HTTParty based client for outline knowledge base.
+test_files: []