livejournal 0.0.1 → 0.1.0

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 
 PKG_NAME = 'livejournal'
-PKG_VERSION = '0.0.1'
+PKG_VERSION = '0.1.0'
 
 FILES = FileList[
   'Rakefile', 'README', 'LICENSE', 'setup.rb',

data/lib/livejournal/database.rb

@@ -146,10 +146,10 @@ module LiveJournal
       end
     end
 
-    # Yield most recent limit entries.
-    def each_entry(limit=nil, &block)
-      sql = 'SELECT * FROM entry ORDER BY itemid DESC'
-      sql += " LIMIT #{limit}" if limit
+    # Yield a set of entries.
+    def each_entry(where=nil, &block)
+      sql = 'SELECT * FROM entry ORDER BY itemid ASC'
+      sql += " WHERE #{where}" if where
       query_entries sql, &block
     end
 

data/lib/livejournal/entry.rb

@@ -74,10 +74,15 @@ module LiveJournal
 
     def ==(other)
       [:subject, :event, :moodid, :mood, :music, :taglist, :pickeyword,
-       :preformatted, :backdated, :comments, :time, :security, :allowmask,
+       :preformatted, :backdated, :comments, :security, :allowmask,
        :screening, :props].each do |attr|
         return false if send(attr) != other.send(attr)
       end
+      # compare time fields one-by-one because livejournal ignores the
+      # "seconds" field.
+      [:year, :mon, :day, :hour, :min, :zone].each do |attr|
+        return false if @time.send(attr) != other.time.send(attr)
+      end
       return true
     end
 
@@ -174,9 +179,67 @@ module LiveJournal
       end
       html
     end
+
+    def add_to_request req
+      req['event'] = self.event
+      req['lineendings'] = 'unix'
+      req['subject'] = self.subject
+
+      case self.security
+      when :public
+        req['security'] = 'public'
+      when :friends
+        req['security'] = 'usemask'
+        req['allowmask'] = 1
+      when :private
+        req['security'] = 'private'
+      when :custom
+        req['security'] = 'usemask'
+        req['allowmask'] = self.allowmask
+      end
+
+      req['year'], req['mon'], req['day'] = 
+        self.time.year, self.time.mon, self.time.day
+      req['hour'], req['min'] = self.time.hour, self.time.min
+
+      { 'current_mood' => self.mood,
+        'current_moodid' => self.moodid,
+        'current_music' => self.music,
+        'picture_keyword' => self.pickeyword,
+        'taglist' => self.taglist.join(', '),
+        'opt_preformatted' => self.preformatted ? 1 : 0,
+        'opt_nocomments' => self.comments == :none ? 1 : 0,
+        'opt_noemail' => self.comments == :noemail ? 1 : 0,
+        'opt_backdated' => self.backdated ? 1 : 0,
+        'opt_screening' =>
+          case self.screening
+          when :all; 'A'
+          when :anonymous; 'R'
+          when :nonfriends; 'F'
+          when :none; 'N'
+          when :default; ''
+          end
+      }.each do |name, value|
+        req["prop_#{name}"] = value
+      end
+    end
   end
 
   module Request
+    class PostEvent < Req
+      def initialize(user, entry)
+        super(user, 'postevent')
+        entry.add_to_request @request
+        @entry = entry
+      end
+
+      def run
+        super
+        @entry.itemid = @result['itemid'].to_i
+        @entry.anum = @result['anum'].to_i
+      end
+    end
+
     class GetEvents < Req
       # We support three different types of GetEvents:
       # * <tt>GetEvents.new(user, :itemid => itemid)</tt> (fetch a single item)
@@ -184,17 +247,19 @@ module LiveJournal
       # * <tt>GetEvents.new(user, :lastsync => lastsync)</tt> (for syncing)
       def initialize(user, opts)
         super(user, 'getevents')
-        self['lineendings'] = 'unix'
+        @request['lineendings'] = 'unix'
 
         if opts.has_key? :itemid
-          self['selecttype'] = 'one'
-          self['itemid'] = opts[:itemid]
+          @request['selecttype'] = 'one'
+          @request['itemid'] = opts[:itemid]
         elsif opts.has_key? :recent
-          self['selecttype'] = 'lastn'
-          self['howmany'] = opts[:recent]
+          @request['selecttype'] = 'lastn'
+          @request['howmany'] = opts[:recent]
         elsif opts.has_key? :lastsync
-          self['selecttype'] = 'syncitems'
-          self['lastsync'] = opts[:lastsync] if opts[:lastsync]
+          @request['selecttype'] = 'syncitems'
+          @request['lastsync'] = opts[:lastsync] if opts[:lastsync]
+        else
+          raise ArgumentError, 'invalid options for GetEvents'
         end
       end
 
@@ -214,63 +279,27 @@ module LiveJournal
           entries[itemid].load_prop(prop['name'], prop['value'])
         end
 
-        if @reqparams.has_key? 'itemid'
-          return entries[@reqparams['itemid']]
+        if @request.has_key? 'itemid'
+          return entries[@request['itemid']]
         else
           return entries
         end
       end
     end
+
     class EditEvent < Req
       def initialize(user, entry, opts={})
         super(user, 'editevent')
-        self['itemid'] = entry.itemid
-        if entry.event
-          self['event'] = entry.event
-        elsif entry.entry.nil? and opts.has_key? :delete
-          self['event'] = ''
-        else
-          raise AccidentalDeleteError
-        end
-        self['lineendings'] = 'unix'
-        self['subject'] = entry.subject
 
-        case entry.security
-        when :public
-          self['security'] = 'public'
-        when :friends
-          self['security'] = 'usemask'
-          self['allowmask'] = 1
-        when :private
-          self['security'] = 'private'
-        when :custom
-          self['security'] = 'usemask'
-          self['allowmask'] = entry.allowmask
+        @request['itemid'] = entry.itemid
+        if opts.has_key? :delete
+          @request['event'] = ''
+        else
+          entry.add_to_request @request
         end
 
-        self['year'], self['mon'], self['day'] = 
-          entry.time.year, entry.time.mon, entry.time.day
-        self['hour'], self['min'] = entry.time.hour, entry.time.min
-
-        { 'current_mood' => entry.mood,
-          'current_moodid' => entry.moodid,
-          'current_music' => entry.music,
-          'picture_keyword' => entry.pickeyword,
-          'taglist' => entry.taglist.join(', '),
-          'opt_preformatted' => entry.preformatted ? 1 : 0,
-          'opt_nocomments' => entry.comments == :none ? 1 : 0,
-          'opt_noemail' => entry.comments == :noemail ? 1 : 0,
-          'opt_backdated' => entry.backdated ? 1 : 0,
-          'opt_screening' =>
-            case entry.screening
-            when :all; 'A'
-            when :anonymous; 'R'
-            when :nonfriends; 'F'
-            when :none; 'N'
-            when :default; ''
-            end
-        }.each do |name, value|
-          self["prop_#{name}"] = value
+        if @request['event'].nil? or @request['event'].empty?
+          raise AccidentalDeleteError unless opts.has_key? :delete
         end
       end
     end

data/lib/livejournal/friends.rb

@@ -89,11 +89,11 @@ module LiveJournal
       end
       # Returns true if there are new posts available.
       def run
-        self['lastupdate'] = @lastupdate if @lastupdate
+        @request['lastupdate'] = @lastupdate if @lastupdate
         super
-        @lastupdate = self['lastupdate']
-        @interval = self['interval']
-        self['new'] == '1'
+        @lastupdate = @result['lastupdate']
+        @interval = @result['interval']
+        @result['new'] == '1'
       end
     end
   end

data/lib/livejournal/request.rb

@@ -27,6 +27,7 @@ require 'livejournal/basic'
 require 'cgi'
 require 'net/http'
 require 'date'
+require 'digest/md5'
 
 module LiveJournal
   module Request
@@ -58,13 +59,20 @@ module LiveJournal
     class Req #:nodoc:
       def initialize(user, mode)
         @user = user
-        @reqparams = { "user"          => user.username, 
-                       "password"      => user.password,
-                       "mode"          => mode,
-                       "clientversion" => "Ruby",
-                       "ver"           => 1 }
-        @reqparams['usejournal'] = user.usejournal if user.usejournal
-        @results = {}
+        @request = { 'mode'          => mode,
+                     'clientversion' => 'Ruby',
+                     'ver'           => 1 }
+        if user
+          challenge = GetChallenge.new.run
+          response = Digest::MD5.hexdigest(challenge +
+                       Digest::MD5.hexdigest(user.password))
+          @request.update({ 'user'           => user.username,
+                            'auth_method'    => 'challenge',
+                            'auth_challenge' => challenge,
+                            'auth_response'  => response })
+          @request['usejournal'] = user.usejournal if user.usejournal
+        end
+        @result = {}
         @verbose = false
         @dryrun = false
       end
@@ -72,18 +80,10 @@ module LiveJournal
       def verbose!; @verbose = true; end
       def dryrun!; @dryrun = true; end
 
-      def []=(key, value)
-        @reqparams[key] = value
-      end
-
-      def [](key)
-        @result[key]
-      end
-
       def run
         h = Net::HTTP.new('www.livejournal.com')
         h.set_debug_output $stderr if @verbose
-        request = @reqparams.collect { |key, value|
+        request = @request.collect { |key, value|
           "#{CGI.escape(key)}=#{CGI.escape(value.to_s)}"
         }.join("&")
         p request if @verbose
@@ -91,8 +91,8 @@ module LiveJournal
         response, data = h.post('/interface/flat', request)
         parseresponse(data)
         dumpresponse if @verbose
-        if self['success'] != "OK"
-          raise ProtocolException, self['errmsg']
+        if @result['success'] != "OK"
+          raise ProtocolException, @result['errmsg']
         end
       end
 
@@ -110,8 +110,8 @@ module LiveJournal
       end
 
       def each_in_array(base)
-        for i in 1..(self["#{base}_count"].to_i) do
-          yield HashStrip.new("#{base}_#{i.to_s}_", self)
+        for i in 1..(@result["#{base}_count"].to_i) do
+          yield HashStrip.new("#{base}_#{i.to_s}_", @result)
         end
       end
       def build_array(base)
@@ -120,7 +120,17 @@ module LiveJournal
         array
       end
     end
+
+    class GetChallenge < Req
+      def initialize
+        super(nil, 'getchallenge')
+      end
+      def run
+        super
+        return @result['challenge']
+      end
+    end
   end
 end
 
-# vim: ts=2 sw=2 et :
+# vim: ts=2 sw=2 et cino=(0 :

data/lib/livejournal/sync.rb

@@ -26,8 +26,7 @@
 require 'livejournal/request'
 # As well as a custom XML format via REST, for comments:
 # http://www.livejournal.com/developer/exporting.bml
-require 'net/http'
-require 'uri'
+require 'open-uri'
 require 'livejournal/comments-xml'
 
 require 'livejournal/entry'
@@ -40,14 +39,14 @@ module LiveJournal
       def initialize(user, syncitems=nil, lastsync=nil)
         super(user, 'syncitems')
         @syncitems = syncitems || {}
-        self['lastsync'] = lastsync if lastsync
+        @request['lastsync'] = lastsync if lastsync
       end
 
       def run
         super
         lasttime = nil
         @fetched = 0
-        @total = self['sync_total'].to_i
+        @total = @result['sync_total'].to_i
         each_in_array('sync') do |item|
           item, time = item['item'], item['time']
           next if @syncitems.has_key? item
@@ -75,7 +74,7 @@ module LiveJournal
       end
       def run
         super
-        self['ljsession']
+        @result['ljsession']
       end
     end
   end
@@ -145,13 +144,13 @@ module LiveJournal
         path = "/export_comments.bml?get=comment_#{mode}&startid=#{start}"
         # authas:  hooray for features discovered by reading source!
         path += "&authas=#{@user.usejournal}" if @user.usejournal
-        url = URI.parse(@user.server.url + path)
-                        
-        http = Net::HTTP.new(url.host, url.port)
-        resp, data = http.get(url, 'Cookie' => "ljsession=#{@session}")
-        # XXX we'd like to stream this data to the XML parser.
-        # is this possible?
-        raise RuntimeError, "XXX" if resp.code != '200'
+
+        data = nil
+        open(@user.server.url + path,
+             'Cookie' => "ljsession=#{@session}") do |f|
+          # XXX stream this data to the XML parser.
+          data = f.read
+        end
         return data
       end
       private :run_GET

data/sample/export

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/ruby -I../lib
 
 require 'livejournal/sync'
 require 'livejournal/database'

data/sample/graph

@@ -0,0 +1,209 @@
+#!/usr/bin/ruby -I../lib
+
+begin
+  require 'rubygems'
+  require 'gruff'
+rescue LoadError => e
+  puts <<EOT
+Error loading libraries: #{e}
+Though ljrb itself doesn't require them, the graph sample uses
+the gruff library: http://nubyonrails.com/pages/gruff ,
+which itself requires rubygems.
+EOT
+  exit 1
+end
+require 'livejournal/database'
+require 'livejournal/entry'
+require 'optparse'
+require 'time'
+
+class Options
+  # required options
+  attr_reader :dbfile, :outfile, :mode
+  # optional options
+  attr_reader :smooth, :normalize, :geom, :starttime, :endtime
+  # mode-specific options
+  attr_reader :tags
+
+  def initialize
+    @smooth = 1
+    @dbfile = nil
+    @outfile = nil
+    @normalize = false
+    @mode = nil
+    @geom = 800
+    @opts = OptionParser.new do |o|
+      o.banner = "usage: graph [options] [modeparam [modeparam ...]]"
+      o.on('-d', '--db=FILE', 'database (required)') { |@dbfile| }
+      o.on('-o', '--out=FILENAME.PNG', 'output file (required)') { |@outfile| }
+      o.on('-g', '--geom=WxH', 'output geometry') { |@geom| }
+      o.on('--smooth=N',
+           'merge every set of n consecutive datapoints') do |smooth|
+        @smooth = smooth.to_i
+      end
+      o.on('--normalize',
+           'normalize relative to entry counts') { |@normalize| }
+      o.on('--start=TIME', 'start time') { |t| @starttime = Time.parse t }
+      o.on('--end=TIME',   'end time')   { |t| @endtime = Time.parse t }
+      o.on('-m', '--mode=MODE',
+           'mode (required) one of {tags, security}') do |mode|
+        case mode
+        when 'tags'
+          @mode = :tags
+        when 'security'
+          @mode = :security
+        else
+          die "bad mode #{mode}"
+        end
+      end
+    end
+    self
+  end
+  def parse!(argv)
+    @opts.parse! ARGV
+    check_params
+    self
+  end
+  def die(msg)
+    puts msg
+    puts @opts
+    exit 1
+  end
+  def check_params
+    die "must specify database." unless @dbfile
+    die "must specify output file." unless @outfile
+    die "must specify mode." unless @mode
+
+    case @mode
+    when :tags
+      @tags = ARGV
+      unless @tags.length > 0
+        die "must specify at least one tag as an extra command-line parameter."
+      end
+    end
+  end
+end
+$opts = Options.new.parse! ARGV
+
+class DataSet
+  # store a series of (time, class, count) observations.
+
+  def initialize
+    # data:  klass -> time -> count
+    @data = Hash.new { |h,k| h[k] = Hash.new { |h,k| h[k] = 0 } }
+    @firsttime = @lasttime = nil
+    @bucketing = :month
+  end
+
+  def bucket(time)
+    case @bucketing
+    when :month
+      mon = time.month
+      if $opts.smooth != 1
+        # when smooth = 3,
+        #   1 -> 1
+        #   3 -> 1
+        #   4 -> 4
+        #   5 -> 4
+        #  12 -> 10
+        mon = ((mon-1)/$opts.smooth * $opts.smooth) + 1
+      end
+      "%d-%02d" % [time.year, mon]
+    end
+  end
+
+  def each_bucket
+    case @bucketing
+    when :month
+      time = Date.parse(@firsttime.strftime('%Y-%m-01'))
+      lasttime = Date.parse(@lasttime.strftime('%Y-%m-01'))
+      lastbucket = nil
+      while time < lasttime
+        b = bucket(time)
+        yield b if b != lastbucket
+        lastbucket = b
+        time = time >> 1
+      end
+    end
+  end
+
+  def labels(count=5)
+    total = 0
+    each_bucket { total += 1 }
+    skip = (total / count.to_f).round
+
+    labels = {}
+    i = 0
+    each_bucket do |bucket|
+      labels[i] = bucket if i % skip == 0
+      i += 1
+    end
+    labels
+  end
+
+  def get_class(klass)
+    buckets = []
+    data = @data[klass]
+    each_bucket do |bucket|
+      buckets << if data.has_key? bucket
+                   if $opts.normalize
+                     data[bucket] / @data[:total][bucket].to_f
+                   else
+                     data[bucket]
+                   end
+                 else
+                   0
+                 end
+    end
+    buckets
+  end
+
+  def add(klass, time, count=1)
+    @firsttime = time if @firsttime.nil? or time < @firsttime
+    @lasttime  = time if @lasttime.nil?  or time > @lasttime
+    @data[klass][bucket(time)] += count
+  end
+end
+
+dataset = DataSet.new
+db = LiveJournal::Database.new $opts.dbfile
+total_entries = 0
+
+db.each_entry do |entry|
+  next if $opts.starttime and $opts.starttime > entry.time 
+  next if $opts.endtime and $opts.endtime < entry.time 
+
+  dataset.add(:total, entry.time, 1)
+  case $opts.mode
+  when :tags
+    entry.taglist.each do |tag|
+      dataset.add(tag, entry.time)
+    end
+  when :security
+    case entry.security
+    when :public;  dataset.add(:public, entry.time)
+    when :friends; dataset.add(:friends, entry.time)
+    else; dataset.add(:other, entry.time)
+    end
+  end
+  total_entries += 1
+end
+
+g = Gruff::Line.new($opts.geom)
+g.labels = dataset.labels
+case $opts.mode
+when :tags
+  g.title = 'Tag Rate'
+  $opts.tags.each do |tag|
+    g.data(tag, dataset.get_class(tag))
+  end
+when :security
+  g.title = 'Entry Security'
+  [:public, :friends, :other].each do |sec|
+    g.data(sec.to_s, dataset.get_class(sec))
+  end
+end
+g.write $opts.outfile
+
+# vim: ts=2 sw=2 et :
+

data/test/login.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby
+
+require 'livejournal/login'
+require 'livejournal/entry'
+require 'test/unit'
+
+class TC_Login < Test::Unit::TestCase
+  def setup
+    @user = LiveJournal::User.new('test', 'test')
+  end
+
+  def test_login
+    login = LiveJournal::Request::Login.new(@user)
+    login.run
+    assert_not_equal(@user.fullname, nil)
+  end
+end
+
+# vim: ts=2 sw=2 et :

data/test/roundtrip.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby
+
+require 'livejournal/login'
+require 'livejournal/entry'
+require 'test/unit'
+
+include LiveJournal
+
+class TC_RoundTrip < Test::Unit::TestCase
+  def setup
+    @user = User.new('ljrb_test', 'test_ljrb')
+  end
+
+  def roundtrip entry
+    postevent = Request::PostEvent.new(@user, entry)
+    postevent.run
+
+    getevents = Request::GetEvents.new(@user,
+                                                    :itemid => entry.itemid)
+    new_entry = getevents.run
+    assert_equal(new_entry, entry)
+
+    delete = Request::EditEvent.new(@user, entry, :delete => true)
+    delete.run
+  end
+
+  def test_roundtrip
+    e = Entry.new
+    e.subject = 'subject'
+    e.event = 'event here'
+    e.time = LiveJournal::coerce_gmt Time.now
+    roundtrip e
+
+    e = Entry.new
+    e.subject = 'subject here'
+    e.event = 'eventblah here'
+    e.time = LiveJournal::coerce_gmt Time.now
+    e.comments = :noemail
+    e.preformatted = true
+    e.security = :friends
+    roundtrip e
+  end
+end
+
+# vim: set ts=2 sw=2 et cino=(0 :

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: livejournal
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-03-09 00:00:00 +09:00
+  version: 0.1.0
+date: 2006-03-25 00:00:00 +09:00
 summary: module for interacting with livejournal
 require_paths: 
   - lib
@@ -45,12 +45,14 @@ files:
   - lib/livejournal/comment.rb
   - lib/livejournal/friends.rb
   - lib/livejournal/basic.rb
-  - sample/lj
+  - sample/graph
   - sample/export
   - test/database.rb
   - test/time.rb
   - test/checkfriends.rb
+  - test/roundtrip.rb
   - test/comments-xml.rb
+  - test/login.rb
 test_files: []
 rdoc_options: []
 extra_rdoc_files: []

data/sample/lj

@@ -1,23 +0,0 @@
-#!/usr/bin/ruby
-
-require 'livejournal/login'
-require 'livejournal/entry'
-
-puts "Logging in..."
-user = LiveJournal::User.new('test', 'test')
-login = LiveJournal::Request::Login.new(user)
-login.run
-
-puts "Login response:"
-login.dumpresponse
-
-puts "User's full name: #{user.fullname}"
-
-if false
-  get = LiveJournal::Request::GetEvents.new(user, :recent => 1)
-  entry = get.run
-  get.dumpresponse
-  p entry
-end
-
-# vim: ts=2 sw=2 et :