We're happy you're considering contributing to the Write.as command-line client!
It won't take long to get up to speed on this. Here are our development resources:
* We do our project management in [Phabricator](https://phabricator.write.as/tag/write.as_cli/).
* We accept and respond to bugs here on [GitHub](https://github.com/writeas/writeas-cli/issues).
* We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as).
## Testing
We try to write tests for all parts of the CLI, but aren't there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review.
## Submitting changes
Please send a [pull request](https://github.com/writeas/writeas-cli/compare) with a clear list of what you've done.
Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc.
## Coding conventions
We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow.
-* We use `go fmt` before committing anything
+* We use `goimports` before committing anything
* We aim to document all exported entities
* Go files are broken up into logical functional components
* General functions are extracted into modules when possible
+### Import Groups
+
+We aim for two import groups:
+
+* Standard library imports
+* Everything else
+
+`goimports` already does this for you along with running `go fmt`.
+
## Design conventions
We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality:
* Updates should be backwards compatible or provide a seamless migration path from *any* previous version
* Each subcommand should perform one action and do it well
* Each subcommand will ideally work well in a script
* Avoid clever functionality and assume each function will be used in ways we didn't imagine
diff --git a/GUIDE.md b/GUIDE.md
index 07b308f..864ae45 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -1,107 +1,143 @@
# Write.as CLI User Guide
The Write.as Command-Line Interface (CLI) is a cross-platform tool for publishing text to [Write.as](https://write.as) and its other sites, like [Paste.as](https://paste.as). It is designed to be simple, scriptable, do one job (publishing) well, and work as you'd expect with other command-line tools.
Write.as is a text-publishing service that protects your privacy. There's no sign up required to publish, but if you do sign up, you can access posts across devices and compile collections of them in what most people would call a "blog".
-**Note** accounts are not supported in CLI v1.0. They'll be available in [v2.0](https://github.com/writeas/writeas-cli/milestone/4).
-
## Uses
These are a few common uses for `writeas`. If you get stuck or want to know more, run `writeas [command] --help`. If you still have questions, [ask us](https://write.as/contact).
- post Alias for default action: create post from stdin
- new Compose a new post from the command-line and publish
- delete Delete a post
- update Update (overwrite) a post
- get Read a raw post
- add Add an existing post locally
- list List local posts
- help, h Shows a list of commands or help for one command
-
+ post Alias for default action: create post from stdin
+ new Compose a new post from the command-line and publish
+ publish Publish a file to Write.as
+ delete Delete a post
+ update Update (overwrite) a post
+ get Read a raw post
+ add Add an existing post locally
+ posts List all of your posts
+ claim Claim local unsynced posts
+ blogs List blogs
+ auth Authenticate with Write.as
+ logout Log out of Write.as
+ help, h Shows a list of commands or help for one command
+
GLOBAL OPTIONS:
- --tor, -t Perform action on Tor hidden service
- --tor-port "9150" Use a different port to connect to Tor
- --code Specifies this post is code
- --verbose, -v Make the operation more talkative
- --font value Sets post font to given value (default: "mono")
- --help, -h show help
- --version, -v print the version
+ -c value, -b value Optional blog to post to
+ --tor, -t Perform action on Tor hidden service
+ --tor-port value Use a different port to connect to Tor (default: 9150)
+ --code Specifies this post is code
+ --md Returns post URL with Markdown enabled
+ --verbose, -v Make the operation more talkative
+ --font value Sets post font to given value (default: "mono")
+ --lang value Sets post language to given ISO 639-1 language code
+ --user-agent value Sets the User-Agent for API requests
+ --help, -h show help
+ --version, -V print the version
```
#### Share something
By default, `writeas` creates a post with a `monospace` typeface that doesn't word wrap (scrolls horizontally). It will return a single line with a URL, and automatically copy that URL to the clipboard:
```bash
$ echo "Hello world!" | writeas
-https://write.as/aaaaaaaaaaaa
+https://write.as/aaaazzzzzzzza
```
This is generally more useful for posting terminal output or code, like so (the `--code` flag turns on syntax highlighting):
This completely overwrites an existing post you own.
```bash
-$ echo "See you later!" | writeas update aaaaaaaaaaaa
+$ echo "See you later!" | writeas update aaaazzzzzzzza
+```
+
+#### Claim a post
+
+This moves an unsynced local post to a draft on your account. You will need to authenticate first.
+```bash
+$ writeas claim aaaazzzzzzzza
```
### Composing posts
If you simply have a penchant for never leaving your keyboard, `writeas` is great for composing new posts from the command-line. Just use the `new` subcommand.
`writeas new` will open your favorite command-line editor, as specified by your `WRITEAS_EDITOR` or `EDITOR` environment variables (in that order), falling back to `vim` on OS X / *nix.
Customize your post's appearance with the `--font` flag:
| Argument | Appearance (Typeface) | Word Wrap? |
| -------- | --------------------- | ---------- |
| `sans` | Sans-serif (Open Sans) | Yes |
| `serif` | Serif (Lora) | Yes |
| `wrap` | Monospace | Yes |
| `mono` | Monospace | No |
| `code` | Syntax-highlighted monospace | No |
Put it all together, e.g. publish with a sans-serif font: `writeas new --font sans`
If you're publishing Markdown, supply the `--md` flag to get a URL back that will render Markdown, e.g.: `writeas new --font sans --md`
diff --git a/LICENSE b/LICENSE
index 7371932..f288702 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,22 +1,674 @@
-The MIT License (MIT)
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
-Copyright (c) 2015 Write.as
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
-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
+ [](https://goreportcard.com/report/github.com/writeas/writeas-cli) [](http://webchat.freenode.net/?channels=writeas) [](https://discuss.write.as/c/development)
Command line interface for [Write.as](https://write.as). Works on Windows, macOS, and Linux.
+**NOTE: the `master` branch is currently unstable while we prepare the v2.0 release! You should install via official release channel, or build from the `v1.2` tag.**
+
## Features
* Publish anonymously to Write.as
-* A stable, easy back-end for your GUI app or desktop-based workflow
+* Authenticate with a Write.as account
+* A stable, easy back-end for your [GUI app](https://write.as/apps/desktop) or desktop-based workflow
* Compatible with our [Tor hidden service](http://writeas7pm7rcdqg.onion/)
* Locally keeps track of any posts you make
-* Update and delete anonymous posts
+* Update and delete posts, anonymous and authenticated
* Fetch any post by ID
* Add anonymous post credentials (like for one published with the [Android app](https://play.google.com/store/apps/details?id=com.abunchtell.writeas)) for editing
## Installing
The easiest way to get the CLI is to download a pre-built executable for your OS.
Get the latest version for your operating system as a standalone executable.
**Windows**<br />
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.2/writeas_1.2_windows_amd64.zip) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.2/writeas_1.2_windows_386.zip) executable and put it somewhere in your `%PATH%`.
**macOS**<br />
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.2/writeas_1.2_darwin_amd64.tar.gz) executable and put it somewhere in your `$PATH`, like `/usr/local/bin`.
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.2/writeas_1.2_linux_amd64.tar.gz) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.2/writeas_1.2_linux_386.tar.gz) executable and put it somewhere in your `$PATH`, like `/usr/local/bin`.
### Go get it
```bash
go get github.com/writeas/writeas-cli/cmd/writeas
```
Once this finishes, you'll see `writeas` or `writeas.exe` inside `$GOPATH/bin/`.
## Upgrading
To upgrade the CLI, download and replace the executable you downloaded before.
If you previously installed with `go get`, run it again with the `-u` option.
```bash
go get -u github.com/writeas/writeas-cli/cmd/writeas
```
## Usage
See full usage documentation on our [User Guide](GUIDE.md).
- post Alias for default action: create post from stdin
- new Compose a new post from the command-line and publish
- delete Delete a post
- update Update (overwrite) a post
- get Read a raw post
- add Add an existing post locally
- list List local posts
- help, h Shows a list of commands or help for one command
-
+ post Alias for default action: create post from stdin
+ new Compose a new post from the command-line and publish
+ publish Publish a file to Write.as
+ delete Delete a post
+ update Update (overwrite) a post
+ get Read a raw post
+ add Add an existing post locally
+ posts List all of your posts
+ blogs List blogs
+ claim Claim local unsynced posts
+ auth Authenticate with Write.as
+ logout Log out of Write.as
+ help, h Shows a list of commands or help for one command
+
GLOBAL OPTIONS:
- --tor, -t Perform action on Tor hidden service
- --tor-port "9150" Use a different port to connect to Tor
- --code Specifies this post is code
- --verbose, -v Make the operation more talkative
- --font value Sets post font to given value (default: "mono")
- --help, -h show help
- --version, -v print the version
+ -c value, -b value Optional blog to post to
+ --tor, -t Perform action on Tor hidden service
+ --tor-port value Use a different port to connect to Tor (default: 9150)
+ --code Specifies this post is code
+ --md Returns post URL with Markdown enabled
+ --verbose, -v Make the operation more talkative
+ --font value Sets post font to given value (default: "mono")
+ --lang value Sets post language to given ISO 639-1 language code
+ --user-agent value Sets the User-Agent for API requests
+ --help, -h show help
+ --version, -V print the version
```
## Contributing to the CLI
For a complete guide to contributing, see the [Contribution Guide](.github/CONTRIBUTING.md).
We welcome any kind of contributions including documentation, organizational improvements, tutorials, bug reports, feature requests, new features, answering questions, etc.
### Getting Support
-We're available on [several channels](https://write.as/contact), and prefer the #development channel [in Slack](http://slack.write.as) for project discussion. Please don't use the GitHub issue tracker to ask questions.
+We're available on [several channels](https://write.as/contact), and prefer our [forum](https://discuss.write.as) for project discussion. Please don't use the GitHub issue tracker to ask questions.
### Reporting Issues
If you believe you have found a bug in the CLI or its documentation, file an issue on this repo. If you're not sure if it's a bug or not, [reach out to us](https://write.as/contact) in one way or another. Be sure to provide the version of the CLI (with `writeas --version`) in your report.
diff --git a/api/api.go b/api/api.go
new file mode 100644
index 0000000..d3fa3fc
--- /dev/null
+++ b/api/api.go
@@ -0,0 +1,267 @@
+package api
+
+import (
+ "fmt"
+ "path/filepath"
+
+ "github.com/atotto/clipboard"
+ writeas "github.com/writeas/go-writeas/v2"
+ "github.com/writeas/web-core/posts"
+ "github.com/writeas/writeas-cli/config"
+ "github.com/writeas/writeas-cli/fileutils"
+ "github.com/writeas/writeas-cli/log"
+ cli "gopkg.in/urfave/cli.v1"
+)
+
+func client(userAgent string, tor bool) *writeas.Client {
+ t.Errorf("Incorrect output, expecting \"%s\" but got \"%s\"", tc.ResultData, out)
+ }
+
+ if idx != tc.ResultIDX {
+ t.Errorf("Incorrect last index, expected \"%d\" but got \"%d\"", tc.ResultIDX, idx)
+ }
+ })
+ }
+}
+
+func TestGetExcerpt(t *testing.T) {
+ tt := []struct {
+ Name string
+ Data string
+ Result string
+ }{
+ {
+ "Shorter than one line",
+ "This is much less than 80 chars",
+ "This is much less than 80 chars",
+ }, {
+ "Exact length, one line",
+ "This will be only 80 chars. Maybe all the way to column 88, that will do it. ---",
+ "This will be only 80 chars. Maybe all the way to column 88, that will do it. ---",
+ }, {
+ "Shorter than two lines",
+ "This will be more than one line but shorter than two. It should break at the 80th or less character. Let's check it out.",
+ "This will be more than one line but shorter than two. It should break at the\n 80th or less character. Let's check it out.",
+ }, {
+ "Exact length, two lines",
+ "This should be the exact length for two lines. There should ideally be no trailing periods to indicate further text. However trimToLength breaks on word bounds.",
+ "This should be the exact length for two lines. There should ideally be no\n trailing periods to indicate further text. However trimToLength breaks on word...",
+ }, {
+ "Longer than two lines",
+ "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque volutpat sagittis aliquet. Ut eu rutrum nisl. Proin molestie ante in dui vulputate dictum. Proin ac bibendum eros. Nulla porta congue tellus, sed vehicula sem bibendum eu. Donec vehicula erat viverra fermentum mattis. Integer volutpat.",
+ "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque volutpat\n sagittis aliquet. Ut eu rutrum nisl. Proin molestie ante in dui vulputate...",
+ },
+ }
+
+ for _, tc := range tt {
+ t.Run(tc.Name, func(t *testing.T) {
+ out := getExcerpt(tc.Data)
+ if out != tc.Result {
+ t.Errorf("Output does not match:\nexpected \"%s\"\nbut got \"%s\"", tc.Result, out)