quickpress 0.0.1

data/README.md

@@ -0,0 +1,163 @@
+# quickpress
+
+[![Gem Version](https://badge.fury.io/rb/quickpress.png)](http://badge.fury.io/rb/quickpress)
+[![emacs banner](http://badges.alexdantas.net/emacs.png)](http://badges.alexdantas.net/)
+[![free-software banner](http://badges.alexdantas.net/free-software.png)](http://badges.alexdantas.net/)
+
+Manage your Wordpress site on the command-line.
+
+## Features
+
+Quickpress allows you to quickly post on your Wordpress site.
+It is also:
+
+* **Powerful**: With quickpress you can create, delete and list
+  your posts and pages. More actions are expected on next releases.
+* **Easy-to-use**: [Two to three commands](#getting-started) should
+  be everything you need to know about it.
+* **Versatile**: It supports a wide range of templating languages.
+  Markdown, Asciidoc, ERB and [much more](#supported-template-engines)!
+* **Documented**: [The wiki][wiki]
+  has all the guides you'll ever need. Also, reference is only
+  a `qp help` away.
+* **Unified**: Works on both Wordpress.com and self-hosted Wordpress.org
+  websites.
+* **Safe**: Quickpress doesn't store your username/password anywhere.
+* **Free**: It is licensed under the GPLv3. It means that quickpress
+  will always be free
+  ([both as in "free beer" and as in "freedom"](http://en.wikipedia.org/wiki/Gratis_versus_libre#.22Free_beer.22_vs_.22free_speech.22_distinction)).
+
+## Installation
+
+Quickpress is on RubyGems. To install it, do:
+
+    $ gem install quickpress
+
+If you want to install it yourself, [grab the gem][gem]
+and there you go!
+
+## Getting started
+
+To use quickpress we call `qp` with some commands, just like `git`.
+
+To start using a site withing quickpress, do:
+
+    $ qp new-site
+
+Now you can do a lot with it. For example, let's list all
+existing posts there:
+
+    $ qp list-posts
+
+Want to post? Write it anywhere and point `qp` to it!
+
+    $ qp new-post my-post.md
+
+If you're too lazy, calling `new-post` without no filenames will
+call your default text editor to write it.
+Try it!
+
+Oops, you made a mistake and want to delete a post.
+First, list them and then delete by id:
+
+    $ qp list-posts      # shows all posts, with their ID
+	$ qp delete-post ID
+
+All of the previous commands can be done with pages too.
+
+Now say you want to post on another Worpress site.
+By doing `qp new-site` it should become the default.
+
+After doing this, you can switch between them by using:
+
+	$ qp list-sites      # shows them all, with their ID
+	$ qp use-site ID     # sets a default site by it's ID
+
+If you want help with any command, just call:
+
+    $ qp help (command)
+
+To see a list of all commands, call:
+
+    $ qp help
+
+Finally, a simple cheatsheet is shown when doing:
+
+    $ qp
+
+For more help and nice guides, check out [the wiki][wiki].
+
+## Supported template engines
+
+Thanks to [Tilt][tilt], you can write on `quickpress` with several templating
+engines. Just be sure to have at least one *required gem* of your favorite
+*engine*.
+
+| Engine                  | File extensions       | Required gem               |
+| ----------------------- | --------------------- | -------------------------- |
+| Asciidoc                | .ad, .adoc, .asciidoc | `asciidoctor` (>= 0.1.0)|
+| ERB                     | .erb, .rhtml          | none (included on ruby stdlib)|
+| Interpolated String     | .str                  | none (included on ruby core)|
+| Erubis                  | .erb, .rhtml, .erubis | `erubis`|
+| Haml                    | .haml                 | `haml`|
+| Sass                    | .sass                 | `haml` (< 3.1) or `sass` (>= 3.1)|
+| Scss                    | .scss                 | `haml` (< 3.1) or `sass` (>= 3.1)|
+| Less CSS                | .less                 | `less`|
+| Builder                 | .builder              | `builder`|
+| Liquid                  | .liquid               | `liquid`|
+| Markdown                | .markdown, .mkd, .md  | `rdiscount` or `redcarpet` or `bluecloth` or `kramdown` or `maruku`|
+| Textile                 | .textile              | `redcloth`|
+| RDoc                    | .rdoc                 | `rdoc`|
+| Radius                  | .radius               | `radius`|
+| Markaby                 | .mab                  | `markaby`|
+| Nokogiri                | .nokogiri             | `nokogiri`|
+| CoffeeScript            | .coffee               | `coffee-script` (+ javascript)|
+| Creole (Wiki markup)    | .wiki, .creole        | `creole`|
+| MediaWiki (Wiki markup) | .wiki, .mediawiki, .mw| `wikicloth`|
+| Yajl                    | .yajl                 | `yajl-ruby`|
+| CSV                     | .rcsv                 | none (Ruby >= 1.9), `fastercsv` (Ruby < 1.9)|
+
+As said before, simply point `qp` to the filename or specify the engine in
+lowercase:
+
+    $ qp post my-markdown.md
+    $ qp post my-asciidoc.adoc
+	$ qp post -m asciidoc my-text-file.txt
+	$ qp post -m textile my-text-file.txt
+
+## Development
+
+Quickpress uses [Thor][thor] for it's CLI interface and [rubypress] for
+the Wordpress XMLRPC API.
+
+For now the source code is a mess.
+Any comments are well-appreciated.
+
+Contributions are *always* welcome, regardless of the size.
+Here's how you can do it:
+
+1. Fork me
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Do your magic
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+An easy way is to help on documentation. For that, simply head up
+for [the wiki][wiki] and start editing things.
+
+## Contact
+
+Hi, I'm Alexandre Dantas! Thanks for having interest in this project.
+Please take the time to visit any of the links below.
+
+* `quickpress` homepage: http://quickpress.alexdantas.net/
+* My homepage: http://www.alexdantas.net
+* Mail me: `eu at alexdantas.net`
+
+[tilt]:https://github.com/rtomayko/tilt
+[thor]:http://whatisthor.com/
+[rubypress]:https://github.com/zachfeldman/rubypress
+[wiki]:https://github.com/alexdantas/quickpress/wiki
+[gem]:https://rubygems.org/gem/quickpress/
+

data/Rakefile

@@ -0,0 +1,3 @@
+# See default bundler take tasks with `rake -T`
+require "bundler/gem_tasks"
+

data/bin/qp

@@ -0,0 +1,417 @@
+#!/usr/bin/env ruby
+#  ___    _     _   __    _     ___   ___   ____  __   __
+# / / \  | | | | | / /`  | |_/ | |_) | |_) | |_  ( (` ( (`
+# \_\_\\ \_\_/ |_| \_\_, |_| \ |_|   |_| \ |_|__ _)_) _)_)
+
+require 'thor'
+require 'quickpress'
+
+# Command line interface above the `Quickpress` class.
+#
+class QP < Thor
+
+  # Global `--debug` flag
+  class_option(:debug,
+               :desc => "debugging mode",
+               :type => :boolean)
+
+  #  _      ____  _         ___   ___   __  _____
+  # | |\ | | |_  \ \    /  | |_) / / \ ( (`  | |
+  # |_| \| |_|__  \_\/\/   |_|   \_\_/ _)_)  |_|
+  #
+  desc('new-post [FILENAME]',
+       'Creates a post on your Wordpress site')
+
+  option('markup',
+         :banner  => "name",
+         :desc    => "markup language",
+         :aliases => "-m")
+
+  long_desc(<<-END).remove_starting!
+    If FILENAME is given, will post it to your Wordpress site.
+
+    If no FILENAME is set, will launch default text editor and
+    \x5wait for you to write a post. After you save it, will post
+    \x5that.
+
+    * Set default text editor with the `EDITOR` environment
+    \x5variable.
+    \x5* For a list of markup languages, do `qp markup-list`.
+  END
+
+  def new_post(filename=nil)
+    $options[:debug] = options[:debug]
+    $options[:markup] = options[:markup]
+
+    Quickpress::new(:post, filename)
+  end
+
+  #  _     _   __  _____    ___   ___   __  _____  __
+  # | |   | | ( (`  | |    | |_) / / \ ( (`  | |  ( (`
+  # |_|__ |_| _)_)  |_|    |_|   \_\_/ _)_)  |_|  _)_)
+  #
+  desc('list-posts [COUNT]',
+       'Shows last posts from Wordpress site')
+
+  long_desc <<-END.remove_starting!
+    If COUNT is given, will show last COUNT posts,
+    \x5most recent first.
+
+    If no COUNT is given, will show all posts.
+  END
+
+  def list_posts(ammount=0)
+    $options[:debug] = options[:debug]
+    Quickpress::list(:post, ammount.to_i)
+  end
+
+  #  ___   ____ _____  ____  _     ____    ___   ___   __  _____
+  # | | \ | |_   | |  | |_  | |   | |_    | |_) / / \ ( (`  | |
+  # |_|_/ |_|__  |_|  |_|__ |_|__ |_|__   |_|   \_\_/ _)_)  |_|
+  #
+  desc('delete-post ID',
+       'Deletes post by ID')
+
+  option('force',
+         :type => :boolean,
+         :desc    => "delete without confirming first",
+         :aliases => "-f")
+
+  long_desc(<<-END).remove_starting!
+    Deletes the post with numerical id equal to ID.
+
+    To see IDs, use `qp list-posts`.
+
+    You can specify multiple IDs, just make sure to
+    \x5keep them apart with commas.
+
+    For example:
+
+    > $ qp delete-post "4,8,15,16,23,42"
+
+    If the post doesn't exist, do nothing.
+  END
+
+  def delete_post(ids)
+    $options[:debug] = options[:debug]
+    $options[:force] = options[:force]
+
+    Quickpress::delete(:post, ids)
+  end
+
+  #  _      ____  _         ___    __    __    ____
+  # | |\ | | |_  \ \    /  | |_)  / /\  / /`_ | |_
+  # |_| \| |_|__  \_\/\/   |_|   /_/--\ \_\_/ |_|__
+  #
+  desc('new-page [FILENAME]',
+       'Creates a page on your Wordpress site')
+
+  option('markup',
+         :banner  => "name",
+         :desc    => "markup language",
+         :aliases => "-m")
+
+  long_desc <<-END.remove_starting!
+    If FILENAME is given, will send it as a page to your
+    \x5Wordpress site.
+
+    If no FILENAME is set, will launch default text editor and
+    \x5wait for you to write a page. After you save it, will send
+    \x5that.
+
+    * Set default text editor with the `EDITOR` environment
+    \x5  variable.
+    \x5* For a list of markup languages, do `qp list-markup`.
+  END
+
+  def new_page(filename=nil)
+    $options[:debug] = options[:debug]
+    $options[:markup] = options[:markup]
+
+    Quickpress::new(:page, filename)
+  end
+
+  #  _     _   __  _____    ___    __    __    ____  __
+  # | |   | | ( (`  | |    | |_)  / /\  / /`_ | |_  ( (`
+  # |_|__ |_| _)_)  |_|    |_|   /_/--\ \_\_/ |_|__ _)_)
+  #
+  desc('list-pages [COUNT]',
+       'Shows last pages from Wordpress site')
+
+  long_desc <<-END.remove_starting!
+    If COUNT is given, will show last COUNT pages,
+    \x5most recent first.
+
+    If no COUNT is given, will show all pages.
+  END
+
+  def list_pages(ammount=0)
+    $options[:debug] = options[:debug]
+    Quickpress::list(:page, ammount.to_i)
+  end
+
+  #  ___   ____  _     ____ _____  ____    ___    __    __    ____
+  # | | \ | |_  | |   | |_   | |  | |_    | |_)  / /\  / /`_ | |_
+  # |_|_/ |_|__ |_|__ |_|__  |_|  |_|__   |_|   /_/--\ \_\_/ |_|__
+  #
+  desc('delete-page ID',
+       'Deletes page by ID')
+
+  option('force',
+         :type => :boolean,
+         :desc    => "delete without confirming first",
+         :aliases => "-f")
+
+  long_desc(<<-END).remove_starting!
+    Deletes the page with numerical id equal to ID.
+
+    To see IDs, use `qp list-pages`.
+
+    You can specify multiple IDs, just make sure to
+    \x5keep them apart with commas.
+    \x5For example:
+
+    > $ qp delete-page "42,666,1337"
+
+    If the page doesn't exist, do nothing.
+  END
+
+  def delete_page(ids)
+    $options[:debug] = options[:debug]
+    $options[:force] = options[:force]
+
+    Quickpress::delete(:page, ids)
+  end
+
+  #  _      ____  _         __   _  _____  ____
+  # | |\ | | |_  \ \    /  ( (` | |  | |  | |_
+  # |_| \| |_|__  \_\/\/   _)_) |_|  |_|  |_|__
+  #
+  desc('new-site [ADDRESS]',
+       'Starts managing a Wordpress site.')
+
+  long_desc <<-END.remove_starting!
+    If ADDRESS is provided, add it to quickpress.
+
+    If not, will prompt you for an address, username and password.
+    \x5If everything's correct, will add that site to quickpress.
+
+    By adding we mean you'll be able to do all commands on it.
+
+    To see all sites added to quickpress, see `qp list-sites`.
+  END
+
+  def new_site(address=nil)
+    $options[:debug] = options[:debug]
+    Quickpress::new_site address
+  end
+
+  #  _     _   __  _____    __   _  _____  ____  __
+  # | |   | | ( (`  | |    ( (` | |  | |  | |_  ( (`
+  # |_|__ |_| _)_)  |_|    _)_) |_|  |_|  |_|__ _)_)
+  #
+  desc('list-sites',
+       'Shows all sites currently added to quickpress')
+
+  long_desc <<-END.remove_starting!
+    Will list all sites you've added with `qp new-site`.
+    \x5If no COUNT is given, will show all pages.
+  END
+
+  def list_sites
+    $options[:debug] = options[:debug]
+    Quickpress::list_sites
+  end
+
+  #  ____  ___   ___   __    ____ _____    __   _  _____  ____
+  # | |_  / / \ | |_) / /`_ | |_   | |    ( (` | |  | |  | |_
+  # |_|   \_\_/ |_| \ \_\_/ |_|__  |_|    _)_) |_|  |_|  |_|__
+  #
+  desc('forget-site ID',
+       'Forgets site with ID')
+
+  option('force',
+         :type => :boolean,
+         :desc    => "forget without confirming first",
+         :aliases => "-f")
+
+  long_desc(<<-END).remove_starting!
+    Makes quickpress stop managing the site with numerical
+    \x5id equal to ID.
+
+    To see IDs, use `qp list-sites`.
+
+    You can specify multiple IDs, just make sure to
+    \x5keep them apart with commas.
+    \x5For example:
+
+    > $ qp forget-site "11,24,69"
+  END
+
+  def forget_site(ids)
+    $options[:debug] = options[:debug]
+    $options[:force] = options[:force]
+
+    Quickpress::forget_site(ids)
+  end
+
+  #  _     __   ____    __   _  _____  ____
+  # | | | ( (` | |_    ( (` | |  | |  | |_
+  # \_\_/ _)_) |_|__   _)_) |_|  |_|  |_|__
+  #
+  desc('use-site ID',
+       'Sets site with ID as default')
+
+  long_desc(<<-END).remove_starting!
+    From now on will do actions on the site with numerical
+    \x5id equal to ID.
+
+    To see IDs, use `qp list-sites`.
+  END
+
+  def use_site id
+    $options[:debug] = options[:debug]
+    Quickpress::use_site(id.to_i)
+  end
+
+  #  _     _   __  _____    _       __    ___   _     _     ___
+  # | |   | | ( (`  | |    | |\/|  / /\  | |_) | |_/ | | | | |_)
+  # |_|__ |_| _)_)  |_|    |_|  | /_/--\ |_| \ |_| \ \_\_/ |_|
+  #
+  desc('list-markup',
+       'Show all supported templating languages')
+
+  long_desc(<<-END).remove_starting!
+    Lists all templating languages supported by quickpress.
+
+    You can use them with the `--markup` option when creating
+    \x5new posts or pages.
+
+    > $ qp new-post --markup asciidoc
+
+    If you create a post/page with a file, they're implied
+    \x5based on it's filename extension.
+
+    > $ qp new-post filename.asciidoc
+  END
+
+  def list_markup
+    Quickpress::list_markup
+  end
+end
+
+#  ___   ____  __    _   _
+# | |_) | |_  / /`_ | | | |\ |
+# |_|_) |_|__ \_\_/ |_| |_| \|
+#
+begin
+  if ARGV.empty?
+    puts <<-END.remove_starting!
+      quickpress v#{Quickpress::VERSION}
+      Cheatsheet:
+
+      	$ qp {new,delete}-{post,page}
+      	$ qp list-(post|page|site)s
+      	$ qp {new,forget}-site
+      	$ qp use-site
+      	$ qp list-markup
+
+      All commands: `qp help`
+      Command info: `qp help (command)`
+
+      Config directory: `~/.config/quickpress/`
+
+      homepage: http://quickpress.alexdantas.net
+      mailto:   eu@alexdantas.net
+
+      This software is licensed under the
+      GNU General Public License version 3 or later.
+    END
+    exit
+  end
+
+  Quickpress::config_init
+  QP.start ARGV
+
+  # Real mess of error-handling.
+  # I wonder if there's a better way to do it.
+  #
+  # Well, at least I'm not polluting the whole code
+  # with this `rescue` stuff.
+
+rescue Net::ReadTimeout
+  $stderr.puts <<-END.remove_starting!
+
+    * Connection took too long.
+      Check your internet settings and try again.
+  END
+  exit 666
+
+rescue XMLRPC::FaultException => e
+  if e.message =~ /Incorrect username or password/
+
+    $stderr.puts <<-END.remove_starting!
+
+      * Incorrect username or password.
+    END
+
+  else
+    $stderr.puts
+    $stderr.puts e.message
+  end
+  exit 666
+
+rescue ArgumentError => arg
+  if arg.message =~ /Wrong protocol specified/
+    $stderr.puts <<-END.remove_starting!
+          * Wrong protocol at Wordpress site.
+            Please use `http` or `https`.
+        END
+    exit 666
+  end
+
+rescue Interrupt => i
+  $stderr.puts
+  $stderr.puts "* You've interrupted me, mate"
+
+  $stderr.puts i.backtrace if $options[:debug]
+  exit 666
+
+rescue LoadError => l
+  $stderr.puts <<-END.remove_starting!
+
+    * Couldn't load '#{l.path}'.
+      Make sure it's gem is installed and try again.
+  END
+  exit 666
+
+rescue StandardError => e
+
+  if e.message =~ /Wrong content-type/
+    $stderr.puts <<-END.remove_starting!
+          * This doesn't seem to be a Wordpress site.
+            Check the address again.
+        END
+    exit 666
+
+  elsif e.message =~ /Name or service not known/
+    $stderr.puts <<-END.remove_starting!
+
+      * Connection error!
+        Either site doesn't exist or there's
+        something wrong with your internet connection.
+    END
+
+    if Quickpress::CLI::ask("Wanna retry?")
+      puts
+      retry
+    end
+    exit 666
+  end
+
+  $stderr.puts e
+  $stderr.puts e.message
+  $stderr.puts e.backtrace if $options[:debug]
+  exit 666
+end
+