tumblr-rb 0.1.1 → 1.0.0

data/Gemfile

@@ -1,6 +1,7 @@
 # A sample Gemfile
 
 gem 'weary','>= 0.7.1'
+gem 'highline', '>= 1.5.2'
 
 group :test do
 	gem 'rake'

data/Gemfile.lock

@@ -8,6 +8,10 @@ dependencies:
     group: 
     - :test
     version: ">= 0"
+  highline: 
+    group: 
+    - :default
+    version: ">= 1.5.2"
   weary: 
     group: 
     - :default
@@ -49,10 +53,12 @@ specs:
     version: 1.4.0
 - contest: 
     version: 0.1.2
+- highline: 
+    version: 1.5.2
 - fakeweb: 
     version: 1.2.8
 - vcr: 
     version: 0.1.2
-hash: c4f81bd854c0ac103c3a0434d4d004dd192b9b45
+hash: bb23bf752ce2daa339a799069ab0b6df9063a3a4
 sources: []
 

data/README.md

@@ -8,6 +8,20 @@ Ruby wrapper and command line tool for the [Tumblr API](http://www.tumblr.com/do
 
 	gem install tumblr-rb
 	
+## Usage
+
+	$: tumblr path/to/a_post.markdown
+	Email Address: tumblr-user@foobarmail.com
+	Password:	
+	Published to Tumblr. The ID for this post is: 123456789
+	
+You can pass `tumblr` something from standard input, but you have to set your email and password as arguments:
+
+	$: echo 'Hello world.' | tumblr -a user@tumblr.com:supers3cretp4ssw0rd
+	Published to Tumblr. The ID for this post is: 123456790
+	
+Try `tumblr --help` if you are in need of guidance. Read [tumblr(1)](http://mwunsch.github.com/tumblr/tumblr.1.html) for more information.
+
 ## Getting Started
 
 Like [Jekyll](http://tom.preston-werner.com/jekyll/), and [Mustache](http://defunkt.github.com/mustache/), Tumblr gem will transform documents preceded by a [YAML](http://www.yaml.org/) frontmatter block.
@@ -24,6 +38,8 @@ YAML frontmatter beings with `---` on a single line, followed by YAML, ending wi
 	
 Understood YAML parameters are taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write
 
+Read [tumblr(5)](http://mwunsch.github.com/tumblr/tumblr.5.html) for more info.
+
 #### All Posts
 
 	type				regular, photo, link, quote, conversation, video, audio
@@ -86,8 +102,7 @@ To publish to Tumblr, do this:
 ## TODO:
 
 + Tumblr::Post needs methods for liking and unliking.
-+ Make the CLI
-+ Make the manpages for the CLI
++ Add options to CLI for adding to queue, drafts, etc.
 + File-uploading for Photos, Videos, Audio (needs to get into Weary)
 
 ## Copyright

data/Rakefile

@@ -22,6 +22,7 @@ begin
     gem.homepage = "http://github.com/mwunsch/tumblr"
     gem.authors = ["Mark Wunsch"]
     gem.add_dependency 'weary', '>= 0.7.1'
+    gem.add_dependency 'highline', '>= 1.5.2'
     gem.add_development_dependency "bundler", ">= 0.9.7"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -68,3 +69,13 @@ desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -I lib -r tumblr"
 end
+
+desc "Build the manual"
+task :build_man do
+  sh "ronn -br5 --organization='Mark Wunsch' --manual='Tumblr Manual' man/*.ronn"
+end
+ 
+desc "Show the manual"
+task :man => :build_man do
+  exec "man man/tumblr.1"
+end

data/bin/tumblr

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+## Tumblr is a command line interface for publishing to Tumblr.com
+##
+## Usage: tumblr [ OPTIONS ] [ FILE or URL ]
+## 
+## Publish to Tumblr. If a URL is given, it will create a link post.
+## If URL is a YouTube or Vimeo URL, it will create a video post. 
+## If a FILE is given, it will publish its contents. 
+## See tumblr(5) for formatting instructions for FILE.
+## If a URL or FILE is not given, tumblr will read from the Standard Input.
+## If tumblr reads from the Standard Input, you must authenticate with -a.
+##
+##
+
+require 'optparse'
+
+def usage
+  File.readlines(__FILE__).
+  grep(/^##.*/).
+  map { |line| line.chomp[3..-1] }.
+  join("\n")
+end
+
+begin
+  require 'tumblr'
+rescue LoadError
+  raise if $!.to_s !~ /tumblr/
+  libdir = File.expand_path("../../lib", __FILE__).sub(/^#{Dir.pwd}/, '.')
+  if !$:.include?(libdir)
+    $:.unshift libdir
+    require File.expand_path('../../.bundle/environment', __FILE__)
+    retry
+  end
+  raise
+end
+
+publisher = {}
+
+ARGV.options do |option|
+  option.banner = usage
+  option.separator "Options"
+  
+  auth_text = 'Email Address and Password, separated by a colon'
+  option.on('-a EMAIL:PASSWORD', '--auth EMAIL:PASSWORD', auth_text) do |auth|
+    credentials = auth.split(':')
+    publisher[:email] = credentials[0]
+    publisher[:password] = credentials[1]
+  end
+  
+  address_text = 'Email Address (will prompt for password)'
+  option.on('-e EMAIL', '--email EMAIL', address_text) do |email| 
+    publisher[:email] = email
+  end
+    
+  option.separator ""
+  
+  option.on('-h','--help', 'Show this help message') { puts option ; exit }
+  option.on('-v','--version', 'Show version number') do 
+    puts Tumblr::VERSION
+    exit
+  end
+  
+  option.separator ""  
+  
+  option.parse!
+end
+
+if ARGV.empty? && STDIN.tty?
+  puts usage
+  puts "See 'tumblr --help' for more information."
+  exit
+end
+  
+input = if !ARGV.empty?
+  path = ARGV.first
+  (path =~ /^https?:\/\/\S+$/i) ? path : File.read(path)
+else
+  STDIN.read.chomp!
+end
+
+if !STDIN.tty? && (!publisher[:email] || !publisher[:password])
+  bad_auth = %q(Error: An email address and password are required. Use 'tumblr -a' to authenticate. See 'tumblr --help' for details.)
+  abort bad_auth
+end
+
+if !publisher[:email] || !publisher[:password]
+  begin
+    require 'highline/import'
+  rescue LoadError
+    require 'rubygems'
+    retry
+  end
+  
+  def get_email(pub)
+    pub[:email] = ask("Email Address:  ")
+    get_email(pub) if pub[:email].empty?
+  end
+
+  def get_password(pub)
+    pub[:password] = ask("Password:  ") { |q| q.echo = false }
+    get_password(pub) if pub[:password].empty?
+  end  
+    
+  if !publisher[:email]
+    get_email(publisher)
+  end
+
+  if !publisher[:password]
+    get_password(publisher)
+  end
+end
+
+response = Tumblr.execute(publisher, input)
+if response.success?
+  puts "Published to Tumblr. The ID for this post is: #{response.body}"
+  exit
+else
+  abort %Q(Oh no! Something went wrong. Tumblr says, "#{response.body}")
+end

data/lib/tumblr.rb

@@ -1,13 +1,14 @@
 require 'weary'
 
-require 'tumblr/post'
-require 'tumblr/reader'
-require 'tumblr/writer'
-require 'tumblr/authenticator'
-
 class Tumblr
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
   GENERATOR = "The Tumblr Gem v#{VERSION}"
+  USER_AGENT = "TumblrGem/#{VERSION} (+http://github.com/mwunsch/tumblr)"
+  
+  require 'tumblr/post'
+  require 'tumblr/reader'
+  require 'tumblr/writer'
+  require 'tumblr/authenticator'
   
   def initialize(*credentials)
     @credentials = {:email => credentials[0], :password => credentials[1]} unless credentials.blank?
@@ -53,6 +54,11 @@ class Tumblr
     Writer.new(@credentials[:email],@credentials[:password])
   end
   
+  def self.execute(credentials, input, state=nil)
+    request = new(credentials[:email],credentials[:password]).post(input)
+    request.perform
+  end
+  
   # Parse a post out of a string
   def self.parse(doc)
     document = {}

data/lib/tumblr/authenticator.rb

@@ -1,6 +1,8 @@
 class Tumblr
   class Authenticator < Weary::Base
     
+    headers({"User-Agent" => Tumblr::USER_AGENT})
+    
     def initialize(*credentials)
       @defaults = {:email => credentials[0], :password => credentials[1]} unless credentials.blank?
     end

data/lib/tumblr/reader.rb

@@ -2,6 +2,8 @@
 class Tumblr
   class Reader < Weary::Base
     
+    headers({"User-Agent" => Tumblr::USER_AGENT})
+    
     def initialize(*credentials)
       @defaults = {:email => credentials[0], :password => credentials[1]} unless credentials.blank?
     end

data/lib/tumblr/writer.rb

@@ -1,6 +1,8 @@
 class Tumblr
   class Writer < Weary::Base
     
+    headers({"User-Agent" => Tumblr::USER_AGENT})
+    
     def initialize(*credentials)
       @defaults = {:generator => Tumblr::GENERATOR}
       @defaults.merge!({:email => credentials[0], :password => credentials[1]}) unless credentials.blank?

data/man/tumblr.1

@@ -0,0 +1,112 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "TUMBLR" "1" "March 2010" "Mark Wunsch" "Tumblr Manual"
+.
+.SH "NAME"
+\fBtumblr\fR \-\- publish to tumblr.com
+.
+.SH "SYNOPSIS"
+\fBtumblr\fR [\fIOPTIONS\fR] \fIFILE OR URL\fR
+.
+.SH "DESCRIPTION"
+\fBtumblr\fR is a command line utility and Ruby library for working with Tumblr.com. It can read plain\-text files and publish them to Tumblr.
+.
+.P
+The \fBtumblr\fR command will publish a named input \fIFILE\fR (or Standard Input if no file is given), or if a \fIURL\fR is given it will publish that URL as a Link post (or a Video post if the url is a YouTube or Vimeo post).
+.
+.P
+If you preface your \fIFILE\fR with a bit of YAML (<yaml.org>) frontmatter, you can give \fBtumblr\fR more explicit instructions for publishing your post. See tumblr(5) for available YAML parameters.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-a\fR,\fB\-\-auth\fR [\fIEMAIL:PASSWORD\fR]
+  Provide Email Address and Password, to authenticate to Tumblr, separated by a colon.
+  If these are not provided, you will be prompted for them.
+  You \fBmust\fR provide this argument if the post comes from standard input.
+.
+.TP
+\fB\-e\fR, \fB\-\-email\fR [\fIEMAIL\fR]
+  Email Address associated with your Tumblr account.
+  You will be prompted for a password.
+.
+.P
+Other:
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+  Print the help message and quit.
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+  Print the \fBtumblr\fR version and quit.
+.
+.SH "EXAMPLES"
+Publish a file to Tumblr.com:
+.
+.IP "" 4
+.
+.nf
+$ tumblr my_post.txt
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or from standard input:
+.
+.IP "" 4
+.
+.nf
+$ cat data.yml my_post.txt | tumblr \-a tumblr_user@foobar.com:p4ssw0rd
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Make a Link post:
+.
+.IP "" 4
+.
+.nf
+$ tumblr http://github.com/mwunsch/tumblr
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or a Video post:
+.
+.IP "" 4
+.
+.nf
+$ tumblr http://www.youtube.com/watch?v=CW0DUg63lqU
+.
+.fi
+.
+.IP "" 0
+.
+.SH "INSTALLATION"
+If you have RubyGems installed:
+.
+.IP "" 4
+.
+.nf
+gem install tumblr\-rb
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Tumblr (the gem) is Copyright (C) 2010 Mark Wunsch
+.
+.P
+Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr.
+.
+.SH "SEE ALSO"
+tumblr(5), gem(1)

data/man/tumblr.1.html

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.4.1'>
+  <title>tumblr(1) -- publish to tumblr.com</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>tumblr(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>tumblr(1)</li>
+  <li class='tc'>Tumblr Manual</li>
+  <li class='tr'>tumblr(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>tumblr</code> -- publish to tumblr.com</p>
+
+<h2>SYNOPSIS</h2>
+
+<p><code>tumblr</code> [<var>OPTIONS</var>] <var>FILE OR URL</var></p>
+
+<h2>DESCRIPTION</h2>
+
+<p><code>tumblr</code> is a command line utility and Ruby library for working with Tumblr.com. It can read plain-text files and publish them to Tumblr.</p>
+
+<p>The <code>tumblr</code> command will publish a named input <var>FILE</var> (or Standard Input if no file is given), or if a <var>URL</var> is given it will publish that URL as a Link post (or a Video post if the url is a YouTube or Vimeo post).</p>
+
+<p>If you preface your <var>FILE</var> with a bit of YAML (&lt;yaml.org>) frontmatter, you can give <code>tumblr</code> more explicit instructions for publishing your post. See tumblr(5) for available YAML parameters.</p>
+
+<h2>OPTIONS</h2>
+
+<dl>
+<dt><code>-a</code>,<code>--auth</code> [<em>EMAIL:PASSWORD</em>]</dt><dd><p>  Provide Email Address and Password, to authenticate to Tumblr, separated by a colon.
+  If these are not provided, you will be prompted for them.
+  You <b>must</b> provide this argument if the post comes from standard input.</p></dd>
+<dt><code>-e</code>, <code>--email</code> [<em>EMAIL</em>]</dt><dd><p>  Email Address associated with your Tumblr account.
+  You will be prompted for a password.</p></dd>
+</dl>
+
+
+<p>Other:</p>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>  Print the help message and quit.</p></dd>
+<dt><code>-v</code>, <code>--version</code></dt><dd><p>  Print the <code>tumblr</code> version and quit.</p></dd>
+</dl>
+
+
+<h2>EXAMPLES</h2>
+
+<p>Publish a file to Tumblr.com:</p>
+
+<pre><code>$ tumblr my_post.txt
+</code></pre>
+
+<p>Or from standard input:</p>
+
+<pre><code>$ cat data.yml my_post.txt | tumblr -a tumblr_user@foobar.com:p4ssw0rd
+</code></pre>
+
+<p>Make a Link post:</p>
+
+<pre><code>$ tumblr http://github.com/mwunsch/tumblr
+</code></pre>
+
+<p>Or a Video post:</p>
+
+<pre><code>$ tumblr http://www.youtube.com/watch?v=CW0DUg63lqU
+</code></pre>
+
+<h2>INSTALLATION</h2>
+
+<p>If you have RubyGems installed:</p>
+
+<pre><code>gem install tumblr-rb
+</code></pre>
+
+<h2>COPYRIGHT</h2>
+
+<p>Tumblr (the gem) is Copyright (C) 2010 Mark Wunsch</p>
+
+<p>Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr.</p>
+
+<h2>SEE ALSO</h2>
+
+<p>tumblr(5), gem(1)</p>
+
+
+<ol class='foot man'>
+  <li class='tl'>Mark Wunsch</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>tumblr(1)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/tumblr.1.ronn

@@ -0,0 +1,67 @@
+tumblr(1) -- publish to tumblr.com
+===================================
+
+## SYNOPSIS
+
+`tumblr` [<OPTIONS>] <FILE OR URL>
+
+## DESCRIPTION
+
+`tumblr` is a command line utility and Ruby library for working with Tumblr.com. It can read plain-text files and publish them to Tumblr. 
+
+The `tumblr` command will publish a named input <FILE> (or Standard Input if no file is given), or if a <URL> is given it will publish that URL as a Link post (or a Video post if the url is a YouTube or Vimeo post).
+	
+If you preface your <FILE> with a bit of YAML (<yaml.org>) frontmatter, you can give `tumblr` more explicit instructions for publishing your post. See tumblr(5) for available YAML parameters.
+
+## OPTIONS
+
+* `-a`,`--auth` [_EMAIL:PASSWORD_]:
+	Provide Email Address and Password, to authenticate to Tumblr, separated by a colon. 
+	If these are not provided, you will be prompted for them. 
+	You <b>must</b> provide this argument if the post comes from standard input.
+	
+* `-e`, `--email` [_EMAIL_]:
+	Email Address associated with your Tumblr account.
+	You will be prompted for a password.
+
+Other:
+
+* `-h`, `--help`:
+	Print the help message and quit.
+	
+* `-v`, `--version`:
+	Print the `tumblr` version and quit.
+
+## EXAMPLES
+
+Publish a file to Tumblr.com:
+
+	$ tumblr my_post.txt
+	
+Or from standard input:
+
+	$ cat data.yml my_post.txt | tumblr -a tumblr_user@foobar.com:p4ssw0rd
+	
+Make a Link post:
+
+	$ tumblr http://github.com/mwunsch/tumblr
+	
+Or a Video post:
+
+	$ tumblr http://www.youtube.com/watch?v=CW0DUg63lqU
+	
+## INSTALLATION
+
+If you have RubyGems installed:
+
+	gem install tumblr-rb
+
+## COPYRIGHT
+
+Tumblr (the gem) is Copyright (C) 2010 Mark Wunsch
+
+Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr.
+
+## SEE ALSO
+
+tumblr(5), gem(1)

data/man/tumblr.5

@@ -0,0 +1,137 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "TUMBLR" "5" "March 2010" "Mark Wunsch" "Tumblr Manual"
+.
+.SH "NAME"
+\fBtumblr\fR \-\- tumblr posts in plaintext
+.
+.SH "SYNOPSIS"
+.
+.nf
+\-\-\-
+title: A typical Tumblr post
+state: queue
+publish\-on: next tuesday
+tags: unix, manpages
+format: markdown
+\-\-\-
+This will create a *Regular* type of post on Tumblr.com. It's so easy.
+That bit up at the top is called YAML frontmatter, and it just gives the
+post a bit of metadata, so publishing options are more flexible.
+They correspond to the Tumblr API. This post will be added to your Tumblr
+queue, to be published next Tuesday, tagged with "unix" and "manpages",
+and formatted in markdown.
+.
+.fi
+.
+.SH "DESCRIPTION"
+Any file can be published to Tumblr.com as a \fIRegular\fR post, but if you add a bit of YAML frontmatter (<yaml.org>) to the file, you can tell Tumblr exactly what you want to do.
+.
+.P
+YAML frontmatter beings with \fB\-\-\-\fR on a single line, followed by YAML, ending with another \fB\-\-\-\fR on a single line, e.g.
+.
+.IP "" 4
+.
+.nf
+\-\-\-
+type: quote
+source: Billy Shakespeare
+state: draft
+tags: hamlet, shakespeare
+\-\-\-
+"To be or not to be."
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write
+.
+.SH "BASIC PARAMETERS"
+These YAML parameters are available for all posts
+.
+.IP "\(bu" 4
+\fBtype\fR:
+  \fBregular\fR, \fBphoto\fR, \fBlink\fR, \fBquote\fR, \fBconversation\fR, \fBvideo\fR, \fBaudio\fR
+  Will take a guess if omitted.
+  See \fIPOST\-TYPE SPECIFIC PARAMETERS\fR below.
+.
+.IP "\(bu" 4
+\fBstate\fR:
+  \fBpublished\fR, \fBdraft\fR, \fBqueue\fR, \fBsubmission\fR
+.
+.IP "\(bu" 4
+\fBformat\fR:
+  \fBhtml\fR or \fBmarkdown\fR
+.
+.IP "\(bu" 4
+\fBtags\fR:
+.
+.br
+  Comma\-separated list of tags.
+.
+.IP "\(bu" 4
+\fBdate\fR:
+  Post date.
+.
+.IP "\(bu" 4
+\fBprivate\fR:
+  If the post should be marked private.
+.
+.IP "\(bu" 4
+\fBslug\fR:
+  A custom string to appear in the post's url.
+.
+.IP "\(bu" 4
+\fBgroup\fR:
+  ID for a secondary blog.
+.
+.IP "\(bu" 4
+\fBgenerator\fR:
+  Short description of the publishing application.
+.
+.IP "\(bu" 4
+\fBsend\-to\-twitter\fR:
+  Twitter status update to make if the tumblelog has enabled it.
+.
+.IP "\(bu" 4
+\fBpublish\-on\fR:
+  If the post state is 'queue', publish on this date
+.
+.IP "" 0
+.
+.SH "POST\-TYPE SPECIFIC PARAMETERS"
+These are parameters that are available for specific types of posts.
+.
+.TP
+\fBregular\fR
+  \fBtitle\fR
+.
+.TP
+\fBphoto\fR
+  \fBcaption\fR, \fBclick\-through\-url\fR
+.
+.TP
+\fBquote\fR
+  \fBsource\fR
+.
+.TP
+\fBlink\fR
+  \fBname\fR, \fBdescription\fR
+.
+.TP
+\fBconversation\fR
+  \fBtitle\fR
+.
+.TP
+\fBvideo\fR
+  \fBtitle\fR,\fBcaption\fR
+.
+.TP
+\fBaudio\fR
+  \fBcaption\fR
+.
+.SH "SEE ALSO"
+tumblr(1), markdown(5)

data/man/tumblr.5.html

@@ -0,0 +1,163 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.4.1'>
+  <title>tumblr(5) -- tumblr posts in plaintext</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>tumblr(5)</h1>
+
+<ol class='head man'>
+  <li class='tl'>tumblr(5)</li>
+  <li class='tc'>Tumblr Manual</li>
+  <li class='tr'>tumblr(5)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>tumblr</code> -- tumblr posts in plaintext</p>
+
+<h2>SYNOPSIS</h2>
+
+<pre><code>---
+title: A typical Tumblr post
+state: queue
+publish-on: next tuesday
+tags: unix, manpages
+format: markdown
+---
+
+This will create a *Regular* type of post on Tumblr.com. It's so easy. 
+That bit up at the top is called YAML frontmatter, and it just gives the 
+post a bit of metadata, so publishing options are more flexible.
+They correspond to the Tumblr API. This post will be added to your Tumblr 
+queue, to be published next Tuesday, tagged with "unix" and "manpages", 
+and formatted in markdown.
+</code></pre>
+
+<h2>DESCRIPTION</h2>
+
+<p>Any file can be published to Tumblr.com as a <i>Regular</i> post, but if you add a bit of YAML frontmatter (&lt;yaml.org>) to the file, you can tell Tumblr exactly what you want to do.</p>
+
+<p>YAML frontmatter beings with <code>---</code> on a single line, followed by YAML, ending with another <code>---</code> on a single line, e.g.</p>
+
+<pre><code>---
+type: quote
+source: Billy Shakespeare
+state: draft
+tags: hamlet, shakespeare
+---
+"To be or not to be."
+</code></pre>
+
+<p>Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write</p>
+
+<h2>BASIC PARAMETERS</h2>
+
+<p>These YAML parameters are available for all posts</p>
+
+<ul>
+<li><p><code>type</code>:
+  <code>regular</code>, <code>photo</code>, <code>link</code>, <code>quote</code>, <code>conversation</code>, <code>video</code>, <code>audio</code>
+  Will take a guess if omitted.
+  See <em>POST-TYPE SPECIFIC PARAMETERS</em> below.</p></li>
+<li><p><code>state</code>:
+  <code>published</code>, <code>draft</code>, <code>queue</code>, <code>submission</code></p></li>
+<li><p><code>format</code>:
+  <code>html</code> or <code>markdown</code></p></li>
+<li><p><code>tags</code>: <br />
+  Comma-separated list of tags.</p></li>
+<li><p><code>date</code>:
+  Post date.</p></li>
+<li><p><code>private</code>:
+  If the post should be marked private.</p></li>
+<li><p><code>slug</code>:
+  A custom string to appear in the post's url.</p></li>
+<li><p><code>group</code>:
+  ID for a secondary blog.</p></li>
+<li><p><code>generator</code>:
+  Short description of the publishing application.</p></li>
+<li><p><code>send-to-twitter</code>:
+  Twitter status update to make if the tumblelog has enabled it.</p></li>
+<li><p><code>publish-on</code>:
+  If the post state is 'queue', publish on this date</p></li>
+</ul>
+
+
+<h2>POST-TYPE SPECIFIC PARAMETERS</h2>
+
+<p>These are parameters that are available for specific types of posts.</p>
+
+<dl>
+<dt class="flush"><code>regular</code></dt><dd><p>  <code>title</code></p></dd>
+<dt class="flush"><code>photo</code></dt><dd><p>  <code>caption</code>, <code>click-through-url</code></p></dd>
+<dt class="flush"><code>quote</code></dt><dd><p>  <code>source</code></p></dd>
+<dt class="flush"><code>link</code></dt><dd><p>  <code>name</code>, <code>description</code></p></dd>
+<dt><code>conversation</code></dt><dd><p>  <code>title</code></p></dd>
+<dt class="flush"><code>video</code></dt><dd><p>  <code>title</code>,<code>caption</code></p></dd>
+<dt class="flush"><code>audio</code></dt><dd><p>  <code>caption</code></p></dd>
+</dl>
+
+
+<h2>SEE ALSO</h2>
+
+<p>tumblr(1), markdown(5)</p>
+
+
+<ol class='foot man'>
+  <li class='tl'>Mark Wunsch</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>tumblr(5)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/tumblr.5.ronn

@@ -0,0 +1,104 @@
+tumblr(5) -- tumblr posts in plaintext
+======================================
+
+## SYNOPSIS
+
+	---
+	title: A typical Tumblr post
+	state: queue
+	publish-on: next tuesday
+	tags: unix, manpages
+	format: markdown
+	---
+	
+	This will create a *Regular* type of post on Tumblr.com. It's so easy. 
+	That bit up at the top is called YAML frontmatter, and it just gives the 
+	post a bit of metadata, so publishing options are more flexible.
+	They correspond to the Tumblr API. This post will be added to your Tumblr 
+	queue, to be published next Tuesday, tagged with "unix" and "manpages", 
+	and formatted in markdown.
+	
+## DESCRIPTION
+
+Any file can be published to Tumblr.com as a <i>Regular</i> post, but if you add a bit of YAML frontmatter (<yaml.org>) to the file, you can tell Tumblr exactly what you want to do.
+
+YAML frontmatter beings with `---` on a single line, followed by YAML, ending with another `---` on a single line, e.g.
+
+	---
+	type: quote
+	source: Billy Shakespeare
+	state: draft
+	tags: hamlet, shakespeare
+	---
+	"To be or not to be."
+	
+Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write
+
+## BASIC PARAMETERS
+
+These YAML parameters are available for all posts
+
+* `type`:
+	`regular`, `photo`, `link`, `quote`, `conversation`, `video`, `audio`
+	Will take a guess if omitted.
+	See _POST-TYPE SPECIFIC PARAMETERS_ below.
+
+* `state`:
+	`published`, `draft`, `queue`, `submission`
+	
+* `format`:
+	`html` or `markdown`
+	
+* `tags`:	
+	Comma-separated list of tags.
+	
+* `date`:
+	Post date.
+	
+* `private`:
+	If the post should be marked private.
+	
+* `slug`:
+	A custom string to appear in the post's url.
+	
+* `group`:
+	ID for a secondary blog.
+	
+* `generator`:
+	Short description of the publishing application.
+	
+* `send-to-twitter`:
+	Twitter status update to make if the tumblelog has enabled it.
+	
+* `publish-on`:	
+	If the post state is 'queue', publish on this date
+	
+## POST-TYPE SPECIFIC PARAMETERS
+
+These are parameters that are available for specific types of posts.
+
+* `regular`:
+	`title`
+	
+* `photo`:
+	`caption`, `click-through-url`
+	
+* `quote`:
+	`source`
+	
+* `link`:
+	`name`, `description`
+	
+* `conversation`:
+	`title`
+	
+* `video`:
+	`title`,`caption`
+	
+* `audio`:
+	`caption`
+	
+## SEE ALSO
+
+tumblr(1), markdown(5)
+	

data/test/test_tumblr.rb

@@ -109,6 +109,15 @@ link
       assert tumbl.authenticate.is_a? Weary::Request
       assert_equal auth.uri, tumbl.authenticate.uri
     end
+    
+    test 'executes' do
+      cred = {:email => 'test@testermcgee.com', :password => 'dontrevealmysecrets'}
+      response = VCR.with_cassette('write/write') do
+        Tumblr.execute(cred, 'Hello World.')
+      end
+      assert response.is_a? Weary::Response
+      assert response.success?
+    end
   end
     
   describe 'Reader' do

data/tumblr-rb.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tumblr-rb}
-  s.version = "0.1.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Wunsch"]
-  s.date = %q{2010-03-09}
+  s.date = %q{2010-03-10}
+  s.default_executable = %q{tumblr}
   s.description = %q{Ruby library and command line utility to work with the Tumblr Blogging Platform, powered by Weary.}
   s.email = %q{mark@markwunsch.com}
+  s.executables = ["tumblr"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.md"
@@ -23,6 +25,7 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.md",
      "Rakefile",
+     "bin/tumblr",
      "lib/tumblr.rb",
      "lib/tumblr/authenticator.rb",
      "lib/tumblr/post.rb",
@@ -35,6 +38,12 @@ Gem::Specification.new do |s|
      "lib/tumblr/post/video.rb",
      "lib/tumblr/reader.rb",
      "lib/tumblr/writer.rb",
+     "man/tumblr.1",
+     "man/tumblr.1.html",
+     "man/tumblr.1.ronn",
+     "man/tumblr.5",
+     "man/tumblr.5.html",
+     "man/tumblr.5.ronn",
      "test/fixtures/vcr_cassettes/authenticate/authenticate.yml",
      "test/fixtures/vcr_cassettes/read/authenticated.yml",
      "test/fixtures/vcr_cassettes/read/authentication_failure.yml",
@@ -63,13 +72,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<weary>, [">= 0.7.1"])
+      s.add_runtime_dependency(%q<highline>, [">= 1.5.2"])
       s.add_development_dependency(%q<bundler>, [">= 0.9.7"])
     else
       s.add_dependency(%q<weary>, [">= 0.7.1"])
+      s.add_dependency(%q<highline>, [">= 1.5.2"])
       s.add_dependency(%q<bundler>, [">= 0.9.7"])
     end
   else
     s.add_dependency(%q<weary>, [">= 0.7.1"])
+    s.add_dependency(%q<highline>, [">= 1.5.2"])
     s.add_dependency(%q<bundler>, [">= 0.9.7"])
   end
 end

metadata

@@ -3,10 +3,10 @@ name: tumblr-rb
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mark Wunsch
@@ -14,8 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-09 00:00:00 -05:00
-default_executable: 
+date: 2010-03-10 00:00:00 -05:00
+default_executable: tumblr
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: weary
@@ -32,9 +32,23 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: highline
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,11 +58,11 @@ dependencies:
         - 7
         version: 0.9.7
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: Ruby library and command line utility to work with the Tumblr Blogging Platform, powered by Weary.
 email: mark@markwunsch.com
-executables: []
-
+executables: 
+- tumblr
 extensions: []
 
 extra_rdoc_files: 
@@ -61,6 +75,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/tumblr
 - lib/tumblr.rb
 - lib/tumblr/authenticator.rb
 - lib/tumblr/post.rb
@@ -73,6 +88,12 @@ files:
 - lib/tumblr/post/video.rb
 - lib/tumblr/reader.rb
 - lib/tumblr/writer.rb
+- man/tumblr.1
+- man/tumblr.1.html
+- man/tumblr.1.ronn
+- man/tumblr.5
+- man/tumblr.5.html
+- man/tumblr.5.ronn
 - test/fixtures/vcr_cassettes/authenticate/authenticate.yml
 - test/fixtures/vcr_cassettes/read/authenticated.yml
 - test/fixtures/vcr_cassettes/read/authentication_failure.yml