tumblr-rb 2.0.0 → 2.1.0

data/Gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 0.9.2"
 
 group :test do
   gem "rspec", "~> 2.11.0"
-  gem "webmock", "~> 1.8.5"
+  gem "webmock", "~> 1.9.0"
   gem "rack-test", "~> 0.6.1"
 end
 

data/Gemfile.lock

@@ -1,28 +1,31 @@
 PATH
   remote: .
   specs:
-    tumblr-rb (2.0.0)
-      sinatra (~> 1.3.2)
-      thor (~> 0.16.0)
+    tumblr-rb (2.1.0)
+      launchy (~> 2.1.2)
+      sinatra (~> 1.4.0)
+      thor (~> 0.18.0)
       weary (~> 1.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.2)
-    crack (0.3.1)
+    addressable (2.3.4)
+    crack (0.3.2)
     diff-lcs (1.1.3)
     hpricot (0.8.6)
-    multi_json (1.3.6)
+    launchy (2.1.2)
+      addressable (~> 2.3)
+    multi_json (1.7.3)
     mustache (0.99.4)
     promise (0.3.0)
-    rack (1.4.1)
-    rack-protection (1.2.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (0.9.2.2)
-    rdiscount (1.6.8)
+    rake (0.9.6)
+    rdiscount (2.0.7.3)
     ronn (0.7.3)
       hpricot (>= 0.8.2)
       mustache (>= 0.7.0)
@@ -35,22 +38,22 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
-    simple_oauth (0.1.9)
-    sinatra (1.3.3)
-      rack (~> 1.3, >= 1.3.6)
-      rack-protection (~> 1.2)
-      tilt (~> 1.3, >= 1.3.3)
-    thor (0.16.0)
-    tilt (1.3.3)
-    weary (1.1.1)
-      addressable (~> 2.3.2)
-      multi_json (~> 1.3.0)
+    simple_oauth (0.2.0)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    thor (0.18.1)
+    tilt (1.4.1)
+    weary (1.1.3)
+      addressable (~> 2.3)
+      multi_json (~> 1.7)
       promise (~> 0.3.0)
-      rack (~> 1.4.0)
-      simple_oauth (~> 0.1.5)
-    webmock (1.8.11)
+      rack (~> 1.5)
+      simple_oauth (~> 0.2)
+    webmock (1.9.3)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
@@ -62,4 +65,4 @@ DEPENDENCIES
   ronn
   rspec (~> 2.11.0)
   tumblr-rb!
-  webmock (~> 1.8.5)
+  webmock (~> 1.9.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Mark Wunsch
+Copyright (c) 2010-2013 Mark Wunsch
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -59,8 +59,16 @@ Understood YAML parameters are taken from the Tumblr API: http://www.tumblr.com/
 
 See [tumblr(5)](http://mwunsch.github.com/tumblr/tumblr.5.html) for more info.
 
+## Configuration
+
+The gem has some configuration options – API keys are kept in `~/.tumblr` and can be changed if needed. It will also use a `$TUMBLRHOST` environment variable if specified. These are usually placed in your `.bashrc` or `.zshrc`, or specified on running the `tumblr` command: `TUMBLRHOST=foo.tumblr.com tumblr post "Hello world!"`
+
+## TODO
+
+- [ ] Photoset support
+
 ## Copyright
 
-The Tumblr gem is Copyright (c) 2010 - 2012 Mark Wunsch and is licensed under the [MIT License](http://creativecommons.org/licenses/MIT/).
+The Tumblr gem is Copyright (c) 2010 - 2013 Mark Wunsch and is licensed under the [MIT License](http://creativecommons.org/licenses/MIT/).
 
 Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr, Inc.

data/lib/tumblr/client.rb

@@ -7,7 +7,7 @@ module Tumblr
     USER_AGENT = "Tumblr API Client (Ruby)/#{Tumblr::VERSION} (+http://github.com/mwunsch/tumblr)"
 
     POST_OPTIONS = [
-      :state, :tags, :tweet, :date, :format, :slug,
+      :state, :tags, :tweet, :date, :format, :slug, :source_url, :source_title,
       :title, :body, # Text posts
       :caption, :link, :source, :data, #Photo posts
       :quote, # Quote posts

data/lib/tumblr/command_line_interface.rb

@@ -33,7 +33,7 @@ module Tumblr
 
       Writes the serialized post to STDOUT.
     LONGDESC
-    def pipe
+    def pipe(*args)
       if !$stdin.tty?
         puts post($stdin).serialize
       else
@@ -108,7 +108,7 @@ module Tumblr
       end
     end
 
-    desc "fetch POST_ID", "Fetch a post and write out its serialized form."
+    desc "fetch POST_ID", "Fetch a post and write out its serialized form"
     def fetch(id)
       client = get_client
       response = client.posts(:id => id, :filter => :raw).perform
@@ -126,6 +126,54 @@ module Tumblr
       ui_success "Post #{id} successfully deleted."
     end
 
+    desc "list", "List Tumblr post_ids and URLs for posts"
+    method_option :tag, :type => :string,
+                        :desc => "Post tag"
+    method_option :type, :type => :string,
+                         :desc => "Post type: text, quote, link, answer, video, audio, photo, chat"
+    def list()
+      client = get_client
+      posts = Tumblr::Post.perform client.posts(:tag => options[:tag], :type => options[:type], :filter => :text)
+      ui_puts Hash[ posts.map {|post| [post.id, post.post_url]} ].to_yaml
+    end
+
+    desc "backup <DIR>", "Download, serialize, and save all the public posts for HOST into DIR"
+    long_desc <<-LONGDESC
+      Download all of the public posts for the host tumblr, and save them into DIR.
+      DIR, if absent, is the current working directory.
+
+      The posts are written to .txt files with the filename {POST-ID}_{POST-SLUG}, or just the POST-ID if there is no slug.
+    LONGDESC
+    def backup(dir = Dir.getwd, offset = 0)
+      backup_dir = File.expand_path(dir)
+      unless File.directory?(backup_dir) && File.writable?(backup_dir)
+        ui_abort "Can't write to directory: #{backup_dir}"
+      end
+      client = get_client
+      response = client.posts(:filter => :raw, :offset => offset).perform
+      tumblr_error(response) unless response.success?
+      json = response.parse["response"]
+      total_post_count = json["blog"]["posts"]
+
+      ui_puts "Downloading #{total_post_count} posts to #{backup_dir}." if offset.zero?
+
+      posts = json["posts"].map{|post| Tumblr::Post.create(post) }
+      posts.each do |post|
+        file_name = post.id.to_s + (post.slug.empty? ? "" : "_#{post.slug}") + ".txt"
+        File.open(File.join(backup_dir, file_name), "w") do |f|
+          ui_puts "Writing file: #{f.path} for #{post.type} post #{post.id}."
+          f.write(post.serialize)
+        end
+      end
+
+      new_offset = offset + posts.size
+      if total_post_count > new_offset
+        backup(dir, new_offset)
+      else
+        ui_success "Downloaded #{new_offset}/#{total_post_count} posts to #{backup_dir}"
+      end
+    end
+
     desc "authorize", "Authenticate and authorize the cli to post on your behalf"
     option :port, :type => :string,
                   :default => "4567",
@@ -147,13 +195,14 @@ module Tumblr
     LONGDESC
     def authorize(*soak)
       require 'tumblr/authentication'
+      require 'launchy'
       sinatra_options = {
         :port => options[:port],
         :bind => options[:bind],
         :credential_path => options[:credentials]
       }
       Tumblr::Authentication.run!(sinatra_options) do |server|
-        `open http://#{options[:bind]}:#{options[:port]}/`
+        ::Launchy.open("http://#{options[:bind]}:#{options[:port]}/")
       end
       if has_credentials?
         ui_success "Success! Your Tumblr OAuth credentials were written to #{credentials.path}"
@@ -167,7 +216,7 @@ module Tumblr
       puts Tumblr::VERSION
     end
 
-    private
+  private
 
     def credentials
       require 'tumblr/credentials'
@@ -187,6 +236,7 @@ module Tumblr
     end
 
     def get_host
+      return ENV["TUMBLRHOST"] if ENV["TUMBLRHOST"]
       host = ask("What is your Tumblr hostname?") if options[:host].nil? and $stdin.tty?
       host ||= options[:host]
       ui_abort "You need to provide a hostname i.e. --host=YOUR-NAME.tumblr.com" if host.nil? or host.empty?
@@ -219,4 +269,4 @@ module Tumblr
     end
 
   end
-end
+end

data/lib/tumblr/post.rb

@@ -17,7 +17,7 @@ module Tumblr
       :blog_name, :id, :post_url, :type, :timestamp, :date, :format,
       :reblog_key, :tags, :bookmarklet, :mobile, :source_url, :source_title,
       :total_posts,
-      :photos, :dialogue, :player # Post-specific response fields
+      :photos, :dialogue, :player, :text, :question, :asking_name, :asking_url # Post-specific response fields
     ]
 
     # Some post types have several "body keys", which allow the YAML front-matter
@@ -81,9 +81,12 @@ module Tumblr
       meta_data["format"] ||= "markdown"
 
       post_type = get_post_type(meta_data["type"])
-      post_body_parts = doc_body.split(POST_BODY_SEPARATOR)
-
-      pairs = pair_post_body_types(post_type.post_body_keys, post_body_parts.dup)
+      pairs = if post_type.post_body_keys.length > 1 
+                pair_post_body_types(post_type.post_body_keys, doc_body.split(POST_BODY_SEPARATOR).dup)
+              else
+                [[post_type.post_body_keys.first, doc_body]]
+              end
+      
       Hash[pairs].merge(meta_data)
     end
 
@@ -228,6 +231,10 @@ module Tumblr
       @slug
     end
 
+    def post_url
+      @post_url
+    end
+
     # These are handy convenience methods.
 
     def markdown?

data/lib/tumblr/post/answer.rb

@@ -9,9 +9,15 @@ module Tumblr
       def answer
         @answer
       end
+
+      def question
+        @question
+      end
+
+      def self.post_body_keys
+        [:question, :answer]
+      end
     end
   end
 end
 
-
-

data/lib/tumblr/post/quote.rb

@@ -4,6 +4,7 @@ module Tumblr
       def initialize(post_data = {})
         super(post_data)
         @type = :quote
+        @quote ||= @text
       end
 
       def quote
@@ -14,6 +15,14 @@ module Tumblr
         @source
       end
 
+      def source_url
+        @source_url
+      end
+
+      def source_title
+        @source_title
+      end
+
       def self.post_body_keys
         [:quote]
       end

data/lib/tumblr/version.rb

@@ -1,3 +1,3 @@
 module Tumblr
-  VERSION = "2.0.0"
-end
+  VERSION = "2.1.0"
+end

data/man/tumblr.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TUMBLR" "1" "October 2012" "Mark Wunsch" "Tumblr Manual"
+.TH "TUMBLR" "1" "May 2013" "Mark Wunsch" "Tumblr Manual"
 .
 .SH "NAME"
 \fBtumblr\fR \- publish to tumblr\.com
@@ -41,10 +41,18 @@ Fetch \fIPOST_ID\fR from tumblr and write out its serialized form\.
 Delete \fIPOST_ID\fR from tumblr\.
 .
 .TP
+\fBtumblr list\fR
+Print a YAML listing of Post IDs to Post URLs\.
+.
+.TP
 \fBtumblr help\fR [\fITASK\fR]
 Print the help message and the description for \fITASK\fR\.
 .
 .TP
+\fBtumblr backup\fR [\fIDIR\fR]
+Download, serialize, and save all the public posts for this \fIHOST\fR into \fIDIR\fR\. \fIDIR\fR will default to the current working directory\.
+.
+.TP
 \fBtumblr authorize\fR
 Start a web server and application to authenticate to tumblr and authorize the cli\. See \fIAUTHORIZATION\fR
 .
@@ -152,7 +160,7 @@ $ tumblr post \-d http://www\.youtube\.com/watch?v=CW0DUg63lqU
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Tumblr (the gem) is Copyright (C) 2010 \- 2012 Mark Wunsch
+Tumblr (the gem) is Copyright (C) 2010 \- 2013 Mark Wunsch
 .
 .P
 Tumblr is Copyright (c) Tumblr, Inc\. The Tumblr gem is NOT affiliated with Tumblr, Inc\.

data/man/tumblr.1.html

@@ -100,7 +100,10 @@
   Will open the serialized post in the foreground with $TUMBLREDITOR then $EDITOR.</p></dd>
 <dt><code>tumblr fetch</code> <var>POST_ID</var></dt><dd><p>  Fetch <var>POST_ID</var> from tumblr and write out its serialized form.</p></dd>
 <dt><code>tumblr delete</code> <var>POST_ID</var></dt><dd><p>  Delete <var>POST_ID</var> from tumblr.</p></dd>
+<dt><code>tumblr list</code></dt><dd><p>Print a YAML listing of Post IDs to Post URLs.</p></dd>
 <dt><code>tumblr help</code> [<var>TASK</var>]</dt><dd><p>  Print the help message and the description for <var>TASK</var>.</p></dd>
+<dt><code>tumblr backup</code> [<var>DIR</var>]</dt><dd><p>Download, serialize, and save all the public posts for this <var>HOST</var> into <var>DIR</var>.
+<var>DIR</var> will default to the current working directory.</p></dd>
 <dt><code>tumblr authorize</code></dt><dd><p>  Start a web server and application to authenticate to tumblr and authorize the cli.
   See <a href="#AUTHORIZATION" title="AUTHORIZATION" data-bare-link="true">AUTHORIZATION</a></p></dd>
 <dt><code>tumblr version</code></dt><dd><p>  Print the <code>tumblr</code> version and quit.</p></dd>
@@ -168,7 +171,7 @@ Alternatively, use the <code>$TUMBLRCRED</code> environment variable.</p>
 
 <h2 id="COPYRIGHT">COPYRIGHT</h2>
 
-<p>Tumblr (the gem) is Copyright (C) 2010 - 2012 Mark Wunsch</p>
+<p>Tumblr (the gem) is Copyright (C) 2010 - 2013 Mark Wunsch</p>
 
 <p>Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr, Inc.</p>
 
@@ -179,7 +182,7 @@ Alternatively, use the <code>$TUMBLRCRED</code> environment variable.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'>Mark Wunsch</li>
-    <li class='tc'>October 2012</li>
+    <li class='tc'>May 2013</li>
     <li class='tr'>tumblr(1)</li>
   </ol>
 

data/man/tumblr.1.ronn

@@ -34,9 +34,16 @@ If you preface your plaintext file with a bit of YAML (<yaml.org>) frontmatter,
 * `tumblr delete` <POST_ID>:
 	Delete <POST_ID> from tumblr.
 
+* `tumblr list`:
+  Print a YAML listing of Post IDs to Post URLs.
+
 * `tumblr help` [<TASK>]:
 	Print the help message and the description for <TASK>.
 
+* `tumblr backup` [<DIR>]:
+  Download, serialize, and save all the public posts for this <HOST> into <DIR>.
+  <DIR> will default to the current working directory.
+
 * `tumblr authorize`:
 	Start a web server and application to authenticate to tumblr and authorize the cli.
 	See [AUTHORIZATION][]
@@ -103,7 +110,7 @@ Save it as a draft:
 
 ## COPYRIGHT
 
-Tumblr (the gem) is Copyright (C) 2010 - 2012 Mark Wunsch
+Tumblr (the gem) is Copyright (C) 2010 - 2013 Mark Wunsch
 
 Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr, Inc.
 

data/share/tumblr-rb.rb

@@ -18,7 +18,7 @@ class RubyGemFormula < Formula
     ENV['GEM_HOME']="#{prefix}"
     ENV['GEM_PATH']="#{prefix}"
     system "gem", "install", "tumblr-rb",
-             "--version", "2.0.0",
+             "--version", "2.1.0",
              "--no-rdoc", "--no-ri",
              "--install-dir", prefix
     bin.rmtree
@@ -43,7 +43,7 @@ load "#{file}"
 end
 
 class TumblrRb < RubyGemFormula
-  url "http://rubygems.org/downloads/tumblr-rb-2.0.0.gem"
+  url "http://rubygems.org/downloads/tumblr-rb-2.1.0.gem"
   homepage "http://rubygems.org/gems/tumblr-rb"
-  version "2.0.0"
+  version "2.1.0"
 end

data/tumblr-rb.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Tumblr::VERSION
 
   gem.add_runtime_dependency "weary", "~> 1.1.0"
-  gem.add_runtime_dependency "sinatra", "~> 1.3.2"
-  gem.add_runtime_dependency "thor", "~> 0.16.0"
+  gem.add_runtime_dependency "sinatra", "~> 1.4.0"
+  gem.add_runtime_dependency "thor", "~> 0.18.0"
+  gem.add_runtime_dependency "launchy", "~> 2.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tumblr-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: weary
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 description: Ruby library and command line utility to interact with the Tumblr API.
 email:
 - mark@markwunsch.com
@@ -123,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -998266851628618470
+      hash: 3871275753992045384
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -998266851628618470
+      hash: 3871275753992045384
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23