tumblr4r 0.7.2 → 0.8.0

data/ChangeLog

@@ -1,3 +1,8 @@
+== 0.8.0 / 2011-02-20
+* new: dashboard support.
+* new: active_support 3.0 support.
+
+
 == 0.7.2 / 2009-10-15
 * new: photoset support added.(Thanks to http://github.com/smajda for the patch.)
 

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/rdoctask'
 require 'rake/contrib/rubyforgepublisher'
 require 'rake/contrib/sshpublisher'
 require 'fileutils'
-require 'lib/tumblr4r'
+require './lib/tumblr4r'
 include FileUtils
 
 NAME              = "tumblr4r"

data/lib/tumblr4r.rb

@@ -1,12 +1,25 @@
+# -*- coding: utf-8 -*-
 require 'net/http'
 require 'rubygems'
 require 'rexml/document'
-require 'active_support'
+begin 
+  require 'active_support/core_ext' 
+  require 'active_support/core_ext' 
+rescue 
+  require 'activesupport' 
+end 
+
 require 'logger'
 require 'cgi'
+
 module Tumblr4r
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
   class TumblrError < StandardError
+    attr_accessor :attachment
+    def initialize(msg, attachment=nil)
+      super(msg)
+      @attachment = attachment
+    end
   end
 
   module POST_TYPE
@@ -28,9 +41,9 @@ module Tumblr4r
     attr_accessor :hostname, :email, :password, :name, :timezone, :title, :cname,
     :description, :feeds
     attr_accessor :logger
-    # TODO: 変数名もうちょっと考える
-    API_READ_LIMIT = 50
-    @@default_log_level = Logger::INFO
+    API_READ_MAX_ALLOWED_COUNT = 50
+    SLEEP_SECONDS_FOR_EVERY_FETCH = 10.0 # API manual says "Requests are rate-limited to one every 10 seconds."
+    @@default_log_level = Logger::DEBUG
     cattr_accessor :default_log_level
 
     class << self
@@ -59,71 +72,127 @@ module Tumblr4r
       self.site_info
     end
 
-    # TODO: ここの再帰取得ロジックはTumblrAPIとは独立してるので
-    # TumblrAPIとは独立した形に切り出したり、TumblrAPIとは切り離してテストを書きたいものだ
     # @param [Symbol|Integer] id_or_type :all, id
+    # @param [Hash] options :offset, :limit, :type, :filter, :tagged, :search,
     # @return [Array<Post>|Post]
     def find(id_or_type, options = { })
+      if id_or_type == :all
+        normal_find(options)
+      elsif id_or_type.kind_of?(Integer)
+        xml = @conn.get({:id => id_or_type})
+        posts, start, total = @parser.posts(xml)
+        @logger.info("size: #{posts.size}")
+        @logger.info("start: #{start}")
+        @logger.info("total: #{total}")
+        return posts[0]
+      else
+        raise ArgumentError.new("id_or_type must be :all or Integer, but was #{id_or_type}(<#{id_or_type.class}>)")
+      end
+    end
+
+    # TODO: ループごとに実行して欲しい処理をblockで渡せるようにするといいかも？
+    # そのブロック引数にエラー情報も渡してあげれば、エラーが起きたのならretryだな、みたいな
+    # 指示ができない、、、、かな
+    def normal_find(options)
+      limit = options[:limit] && options[:limit].to_i
+      offset = options[:offset].to_i
+      total = self.count(options)
+      result = []
       params = { }
-      return result if options[:offset] && options[:offset].to_i < 0
       [:type, :filter, :tagged, :search].each do |option|
         params[option] = options[option] if options[option]
       end
-
-      if id_or_type == :all
-        result = []
-        # 取得開始位置の初期化
-        params[:start] = options[:offset] || 0
-        # goal の設定
-        total = self.count(options)
-        if options[:limit]
-          goal = [total - params[:start],
-                  options[:limit]].min
-        else
-          goal = total - params[:start]
+      last_fetched_at = nil
+      each_fetch(limit, offset, API_READ_MAX_ALLOWED_COUNT, total) do |offset, num|
+        params[:start] = offset
+        params[:num] = num
+        # APIマニュアルにはこっちのスリープ時間については明記されてないが、dashboardと同じ秒数SLEEPしとく
+        sleep_secs = last_fetched_at ? SLEEP_SECONDS_FOR_EVERY_FETCH - (Time.now - last_fetched_at) : 0
+        if sleep_secs > 0
+          logger.debug("sleeping #{sleep_secs} secs.")
+          sleep sleep_secs
         end
-        # 取得件数の初期化
-        if goal < 0
-          return result
-        elsif goal < API_READ_LIMIT
-          params[:num] = goal
-        else
-          params[:num] = API_READ_LIMIT # :num を指定しないとデフォルトでは20件しかとれない
+        xml = @conn.get(params)
+        last_fetched_at = Time.now
+        posts, start, total = @parser.posts(xml)
+        result += posts
+        if posts.size == 0
+          # Tumblr API の total で得られる値は全く信用ならない。
+          # 検索条件を考慮した件数を返してくれない。
+          # (つまり、goalは信用ならない)ので、posts.sizeも終了判定に利用する。
+          # TODO: もしくは:numの値を足し合わせていって、それとgoalを比較する？
+          break
         end
+        posts.size
+      end
+      result
+    end
 
-        loop do
-          xml = @conn.get(params)
-          posts, start, total = @parser.posts(xml)
-          @logger.info("size: #{posts.size}")
-          @logger.info("start: #{start}")
-          @logger.info("total: #{total}")
-          result += posts
-          if result.size >= goal || posts.size == 0
-            # Tumblr API の total で得られる値は全く信用ならない。
-            # 検索条件を考慮した件数を返してくれない。
-            # (つまり、goalは信用ならない)ので、posts.sizeも終了判定に利用する。
-            # TODO: もしくは:numの値を足し合わせていって、それとgoalを比較する？
-            break
-          end
-          # 取得開始位置の調整
-          params[:start] += params[:num]
-          # 取得件数の調整
-          if (goal - result.size) >= API_READ_LIMIT
-            params[:num] = API_READ_LIMIT
-          else
-            params[:num] = goal - result.size
-          end
+    #, :search,
+    # @param [Hash] options :offset, :limit, :type, :filter
+    # @return [Array<Post>]
+    def dashboard(options = { })
+      limit = options[:limit] ? options[:limit].to_i : nil
+      offset = options[:offset].to_i
+      result = []
+      params = {:likes => "1" }
+      [:type, :filter].each do |option|
+        params[option] = options[option] if options[option]
+      end
+
+      total = 1000 # 明記されてないがたぶん1000件ぐらいが上限？
+      last_fetched_at = nil
+      each_fetch(limit, offset, API_READ_MAX_ALLOWED_COUNT, total) do |offset, num|
+        params[:start] = offset
+        params[:num] = num
+        sleep_secs = last_fetched_at ? SLEEP_SECONDS_FOR_EVERY_FETCH - (Time.now - last_fetched_at) : 0
+        if sleep_secs > 0
+          logger.debug("sleeping #{sleep_secs} secs.")
+          sleep sleep_secs
         end
-        return result
-      elsif id_or_type.kind_of?(Integer)
-        xml = @conn.get({:id => id_or_type})
+        xml = @conn.dashboard(params)
+        last_fetched_at = Time.now
         posts, start, total = @parser.posts(xml)
-        @logger.info("size: #{posts.size}")
+        result += posts
+        if posts.size == 0
+          # Tumblr API の total で得られる値は全く信用ならない。
+          # 検索条件を考慮した件数を返してくれない。
+          # (つまり、goalは信用ならない)ので、posts.sizeも終了判定に利用する。
+          # TODO: もしくは:numの値を足し合わせていって、それとgoalを比較する？
+          break
+        end
+        posts.size
+      end
+      result
+    end
+
+    def each_fetch(limit, offset, max_at_once, total, &block)
+      return if offset && offset.to_i < 0
+
+      # 取得開始位置の初期化
+      start = offset || 0
+      if limit
+        goal = [total - start, limit].min
+      else
+        goal = total - start
+      end
+      # 取得件数の初期化
+      num = [goal, max_at_once].min
+      if num < 0
+        return
+      end
+
+      all_fetched = 0
+      while all_fetched < goal
+        fetched_count = yield(start, num)
+        @logger.info("size: #{fetched_count}")
         @logger.info("start: #{start}")
         @logger.info("total: #{total}")
-        return posts[0]
-      else
-        raise ArgumentError
+        all_fetched += fetched_count
+        # 取得開始位置の調整
+        start += num
+        # 取得件数の調整
+        num = [goal - fetched_count, max_at_once].min
       end
     end
 
@@ -150,8 +219,17 @@ module Tumblr4r
       return new_post
     end
 
-    # @param [Integer] post_id
-    def delete(post_id)
+    # @param [Integer|Post] post_id_or_post
+    def delete(post_id_or_post)
+      post_id = nil
+      case post_id_or_post
+      when Tumblr4r::Post
+        post_id = post_id_or_post.post_id
+      when Integer
+        post_id = post_id_or_post
+      else
+        raise ArgumentError.new("post_id_or_post must be Tumblr4r::Post or Integer, but was #{post_id_or_post}(<#{post_id_or_post.class}>)")
+      end
       return @conn.delete(post_id)
     end
 
@@ -173,6 +251,9 @@ module Tumblr4r
     :private, # Integer(0|1)
     :generator # String
 
+    attr_accessor :liked, # Boolean
+    :reblog_key # String
+
     @@default_generator = nil
     cattr_accessor :default_generator
 
@@ -293,7 +374,7 @@ module Tumblr4r
       when Net::HTTP
         @conn = http_or_hostname
       else
-        raise ArgumentError.new("http_or_hostname must be String or Net::HTTP")
+        raise ArgumentError.new("http_or_hostname must be String or Net::HTTP but is #{http_or_hostname.class}")
       end
       @email= email
       @password = password
@@ -321,9 +402,25 @@ module Tumblr4r
       when Net::HTTPOK
         return res.body
       when Net::HTTPNotFound
-        raise TumblrError.new("no such site(#{@hostname})")
+        raise TumblrError.new("no such site(#{@hostname})", res)
       else
-        raise TumblrError.new("unexpected response #{res.inspect}")
+        raise TumblrError.new("unexpected response #{res.inspect}", res)
+      end
+    end
+
+    def dashboard(options = { })
+      response = nil
+      http = Net::HTTP.new("www.tumblr.com")
+      params = options.merge({"email" => @email, "password" => @password, "group" => @group})
+      query_string = params.delete_if{|k,v| v == nil }.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}" unless v.nil?}.join("&")
+      logger.debug("#### query_string: #{query_string}")
+      response = http.post('/api/dashboard', query_string)
+      logger.debug(response.body)
+      case response
+      when Net::HTTPSuccess
+        return response.body
+      else
+        raise TumblrError.new(format_error(response), response)
       end
     end
 
@@ -339,7 +436,7 @@ module Tumblr4r
       when Net::HTTPOK
         return true
       else
-        raise TumblrError.new(response.inspect + "\n" + response.body)
+        raise TumblrError.new(format_error(response), response)
       end
     end
 
@@ -358,10 +455,7 @@ module Tumblr4r
       when Net::HTTPSuccess
         return response.body.to_i
       else
-        msg = response.inspect + "\n"
-        response.each{|k,v| msg += "#{k}: #{v}\n"}
-        msg += response.body
-        raise TumblrError.new(msg)
+        raise TumblrError.new(format_error(response), response)
       end
     end
 
@@ -379,12 +473,16 @@ module Tumblr4r
         logger.debug("#### response: #{response.code}: #{response.body}")
         return true
       else
-        msg = response.inspect + "\n"
-        response.each{|k,v| msg += "#{k}: #{v}\n"}
-        msg += response.body
-        raise TumblrError.new(msg)
+        raise TumblrError.new(format_error(response), response)
       end
     end
+
+    def format_error(response)
+      msg = response.inspect + "\n"
+      response.each{|k,v| msg += "#{k}: #{v}\n"}
+      msg += response.body
+      msg
+    end
   end
 
   # Tumblr XML API
@@ -446,6 +544,8 @@ module Tumblr4r
       post.post_id = rexml_post.attributes["id"].to_i
       post.url = rexml_post.attributes["url"]
       post.url_with_slug = rexml_post.attributes["url-with-slug"]
+      post.liked = (rexml_post.attributes["liked"] == "true")
+      post.reblog_key = rexml_post.attributes["reblog-key"]
       post.type = rexml_post.attributes["type"]
       # TODO: time 関係の型をStringじゃなくTimeとかにする？
       post.date_gmt = rexml_post.attributes["date-gmt"]

data/test/tumblr4r_dashboard_test.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require "test/unit"
+require 'pit'
+require 'pp'
+$KCODE='u'
+class Tumblr4rDashboardTest < Test::Unit::TestCase
+  include Tumblr4r
+  DASHBOARD_TEST_HOST = "tumblr4r-dashboard-test.tumblr.com"
+  TOTAL_COUNT = 123
+  REGULAR_COUNT = 6
+  QUOTE_COUNT = 103
+  PHOTO_COUNT = 2
+
+  def setup
+    Site.default_log_level = Logger::DEBUG
+    auth_info = Pit.get("tumblr4r-dashbard-test",
+                             :require => {"email" => "required email",
+                             "password" => "required password"})
+    @site = Site.new(DASHBOARD_TEST_HOST,
+                     auth_info["email"],
+                     auth_info["password"])
+  end
+
+  def teardown
+  end
+=begin
+  def test_find_all
+    posts = @site.dashboard
+    pp posts
+    assert_equal TOTAL_COUNT, posts.size
+  end
+=end
+  def test_type
+    posts = @site.dashboard(:type => "regular")
+    assert_equal REGULAR_COUNT, posts.size
+    assert posts.all?{|p| p.type == Tumblr4r::POST_TYPE::REGULAR }
+
+    posts = @site.dashboard(:type => "quote")
+    assert_equal QUOTE_COUNT, posts.size
+    assert posts.all?{|p| p.type == Tumblr4r::POST_TYPE::QUOTE }
+
+    posts = @site.dashboard(:type => "photo")
+    assert_equal PHOTO_COUNT, posts.size
+    assert posts.all?{|p| p.type == Tumblr4r::POST_TYPE::PHOTO }
+  end
+end

data/test/tumblr4r_test.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require File.dirname(__FILE__) + '/test_helper.rb'
 require "test/unit"
 require 'pit'
@@ -53,6 +54,7 @@ class Tumblr4rTest < Test::Unit::TestCase
   end
 
   def test_find
+    debugger
     posts = @site.find(:all)
     assert_equal 9, posts.size
     assert_equal Photo, posts[0].class
@@ -144,7 +146,7 @@ EOF
     assert_equal false, posts[1].bookmarklet
 
     assert_equal "", posts[1].regular_title
-    assert_equal "Tumblr4rのテストです", posts[1].regular_body
+    assert_equal "<p>Tumblr4rのテストです</p>", posts[1].regular_body
   end
 
   def test_find_with_type_photo
@@ -166,7 +168,7 @@ EOF
 
     assert_equal "<p>Photoのテストです。</p>\n\n<p>ギコです。</p>", posts[1].photo_caption
     assert_equal "http://www.google.co.jp/", posts[1].photo_link_url
-    assert_equal "http://5.media.tumblr.com/GyEYZujUYopiula4XKmXhCgmo1_250.jpg", posts[1].photo_url
+    assert_equal "http://28.media.tumblr.com/GyEYZujUYopiula4XKmXhCgmo1_250.jpg", posts[1].photo_url
     assert_equal [], posts[1].photoset
 
     # photoset
@@ -182,12 +184,12 @@ EOF
     assert_equal [], posts[0].tags
     assert_equal false, posts[0].bookmarklet
 
-    assert_equal "Photoset test.", posts[0].photo_caption
+    assert_equal "<p>Photoset test.</p>", posts[0].photo_caption
     assert_equal "", posts[0].photo_link_url
-    assert_equal "http://22.media.tumblr.com/tumblr_krg7btBOD21qzfaavo1_250.jpg", posts[0].photo_url
-    assert_equal ["http://22.media.tumblr.com/tumblr_krg7btBOD21qzfaavo1_250.jpg",
-                 "http://6.media.tumblr.com/tumblr_krg7btBOD21qzfaavo2_500.jpg",
-                 "http://16.media.tumblr.com/tumblr_krg7btBOD21qzfaavo3_500.png"], posts[0].photoset
+    assert_equal "http://25.media.tumblr.com/tumblr_krg7btBOD21qzfaavo1_250.jpg", posts[0].photo_url
+    assert_equal ["http://25.media.tumblr.com/tumblr_krg7btBOD21qzfaavo1_250.jpg",
+                 "http://30.media.tumblr.com/tumblr_krg7btBOD21qzfaavo2_500.jpg",
+                 "http://27.media.tumblr.com/tumblr_krg7btBOD21qzfaavo3_500.png"], posts[0].photoset
 
   end
 
@@ -229,7 +231,7 @@ EOF
 
     assert_equal "たんぶらー", posts[0].link_text
     assert_equal "http://www.tumblr.com/", posts[0].link_url
-    assert_equal "ですくりぷしょん", posts[0].link_description
+    assert_equal "<p>ですくりぷしょん</p>", posts[0].link_description
   end
 
   def test_find_with_type_conversation
@@ -274,8 +276,9 @@ EOF
     assert_equal false, posts[0].bookmarklet
 
     assert_equal true, posts[0].audio_plays
-    assert_equal "tumblr4r miku", posts[0].audio_caption
-    assert_equal "<embed type=\"application/x-shockwave-flash\" src=\"http://tumblr4rtest.tumblr.com/swf/audio_player.swf?audio_file=http://www.tumblr.com/audio_file/131705561/GyEYZujUYp9df3nv1WMefTH8&color=FFFFFF\" height=\"27\" width=\"207\" quality=\"best\"></embed>", posts[0].audio_player
+    assert_equal "<p>tumblr4r miku</p>", posts[0].audio_caption
+#    assert_equal "<embed type=\"application/x-shockwave-flash\" src=\"http://tumblr4rtest.tumblr.com/swf/audio_player.swf?audio_file=http://www.tumblr.com/audio_file/131705561/GyEYZujUYp9df3nv1WMefTH8&color=FFFFFF\" height=\"27\" width=\"207\" quality=\"best\"></embed>", posts[0].audio_player
+    assert_equal "<embed type=\"application/x-shockwave-flash\" src=\"http://assets.tumblr.com/swf/audio_player.swf?audio_file=http://www.tumblr.com/audio_file/131705561/GyEYZujUYp9df3nv1WMefTH8&color=FFFFFF\" height=\"27\" width=\"207\" quality=\"best\"></embed>", posts[0].audio_player
   end
 
   def test_find_with_type_video
@@ -293,9 +296,9 @@ EOF
     assert_equal [], posts[0].tags
     assert_equal false, posts[0].bookmarklet
 
-    assert_equal "matrix sappoloaded", posts[0].video_caption
+    assert_equal "<p>matrix sappoloaded</p>", posts[0].video_caption
     assert_equal "http://www.youtube.com/watch?v=FavWH5RhYpw", posts[0].video_source
-    assert_equal "<object width=\"400\" height=\"336\"><param name=\"movie\" value=\"http://www.youtube.com/v/FavWH5RhYpw&amp;rel=0&amp;egm=0&amp;showinfo=0&amp;fs=1\"></param><param name=\"wmode\" value=\"transparent\"></param><param name=\"allowFullScreen\" value=\"true\"></param><embed src=\"http://www.youtube.com/v/FavWH5RhYpw&amp;rel=0&amp;egm=0&amp;showinfo=0&amp;fs=1\" type=\"application/x-shockwave-flash\" width=\"400\" height=\"336\" allowFullScreen=\"true\" wmode=\"transparent\"></embed></object>", posts[0].video_player
+    assert_equal "<object width=\"400\" height=\"325\"><param name=\"movie\" value=\"http://www.youtube.com/v/FavWH5RhYpw&amp;rel=0&amp;egm=0&amp;showinfo=0&amp;fs=1\"></param><param name=\"wmode\" value=\"transparent\"></param><param name=\"allowFullScreen\" value=\"true\"></param><embed src=\"http://www.youtube.com/v/FavWH5RhYpw&amp;rel=0&amp;egm=0&amp;showinfo=0&amp;fs=1\" type=\"application/x-shockwave-flash\" width=\"400\" height=\"325\" allowFullScreen=\"true\" wmode=\"transparent\"></embed></object>", posts[0].video_player
   end
 
   def test_find_with_tagged
@@ -402,6 +405,5 @@ EOF
     videos = @site.find(:all, :type => Tumblr4r::POST_TYPE::VIDEO)
     post = @write_site.save(videos[0])
   end
-
 end
 

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: tumblr4r
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
+  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors: 
 - Tomoki MAEDA
@@ -9,29 +10,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +09:00
-default_executable: 
+date: 2012-01-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 2.3.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: pit
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.0.6
-    version: 
+  type: :development
+  version_requirements: *id002
 description: Tumblr API Wrapper for Ruby
 email: tmaeda@ruby-sapporo.org
 executables: []
@@ -46,10 +48,12 @@ files:
 - ChangeLog
 - Rakefile
 - test/test_helper.rb
+- test/tumblr4r_dashboard_test.rb
 - test/tumblr4r_test.rb
 - lib/tumblr4r.rb
-has_rdoc: true
 homepage: http://tumblr4r.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -67,23 +71,24 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: 1.8.6
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: tumblr4r
-rubygems_version: 1.3.1
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Tumblr API Wrapper for Ruby
 test_files: 
+- test/tumblr4r_dashboard_test.rb
 - test/tumblr4r_test.rb