livejournal2 0.4.0

data/lib/livejournal/friends.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby
+#--
+# ljrb -- LiveJournal Ruby module
+# Copyright (c) 2005 Evan Martin <martine@danga.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+#++
+
+require 'livejournal/request'
+
+module LiveJournal
+  # Represents a LiveJournal friend relationship.
+  # See LiveJournal::Request::Friends to get an array of these.
+  class Friend
+    attr_accessor :username, :fullname
+    # as HTML color, like '#ff0000'
+    attr_accessor :background, :foreground
+    # bitfield of friend groups this friend is a member of
+    attr_accessor :groupmask
+    # friend type. possible values: :community, :news, :syndicated, :shared, :identity, :user
+    attr_accessor :type
+    def initialize
+      @username = nil
+      @fullname = nil
+      @background = nil
+      @foreground = nil
+      @groupmask = nil
+      @type = nil
+    end
+    def from_request(req)
+      @username = req['user']
+      @fullname = req['name']
+      @foreground = req['fg']
+      @background = req['bg']
+      @groupmask = req['groupmask']
+      @type =
+        case req['type']
+          when 'community';  :community
+          when 'news';       :news
+          when 'syndicated'; :syndicated
+          when 'shared';     :shared
+          when 'identity';   :identity
+          when nil;          :user
+          else raise LiveJournal::Request::ProtocolException.new(
+                       "unknown friend type: #{req['type']}")
+        end
+      self
+    end
+    def to_s
+      "#{@username}: #{@fullname}"
+    end
+  end
+
+  module Request
+    class Friends < Req
+      attr_reader :friends, :friendofs
+      # Allowed options:
+      # :include_friendofs => true:: also fill out @friendofs in single request
+      def initialize(user, opts={})
+        super(user, 'getfriends')
+        @friends = nil
+        @friendofs = nil
+        @request['includefriendof'] = true if opts.has_key? :include_friendofs
+      end
+      # Returns an array of LiveJournal::Friend.
+      def run
+        super
+        @friends = build_array('friend') { |r| Friend.new.from_request(r) }
+        @friendofs = build_array('friendof') { |r| Friend.new.from_request(r) }
+        @friends
+      end
+    end
+
+    # See Friends to fetch both friends and friend-ofs in one request.
+    class FriendOfs < Req
+      attr_reader :friendofs
+      def initialize(user)
+        super(user, 'friendof')
+        @friendofs = nil
+      end
+      # Returns an array of LiveJournal::Friend.
+      def run
+        super
+        @friends = build_array('friendof') { |r| Friend.new.from_request(r) }
+        @friends
+      end
+    end
+
+    # An example of polling for friends list updates.
+    #   req = LiveJournal::Request::CheckFriends.new(user)
+    #   req.run   # always will return false on the first run.
+    #   loop do
+    #     puts "Waiting for new entries..."
+    #     sleep req.interval   # uses the server-recommended sleep time.
+    #     break if req.run == true
+    #   end
+    #   puts "#{user.username}'s friends list has been updated!"
+    class CheckFriends < Req
+      # The server-recommended number of seconds to wait between running this.
+      attr_reader :interval
+      # If you want to keep your CheckFriends state without saving the object,
+      # save the #lastupdate field and pass it to a new object.
+      attr_reader :lastupdate
+      def initialize(user, lastupdate=nil)
+        super(user, 'checkfriends')
+        @lastupdate = lastupdate
+        @interval = 90   # reasonable default?
+      end
+      # Returns true if there are new posts available.
+      def run
+        @request['lastupdate'] = @lastupdate if @lastupdate
+        super
+        @lastupdate = @result['lastupdate']
+        @interval = @result['interval'].to_i
+        @result['new'] == '1'
+      end
+    end
+  end
+end
+
+# vim: ts=2 sw=2 et :

data/lib/livejournal/login.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+#--
+# ljrb -- LiveJournal Ruby module
+# Copyright (c) 2005 Evan Martin <martine@danga.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+#++
+
+require 'livejournal/request'
+
+module LiveJournal
+  module Request
+    class Login < Req
+      def initialize(user)
+        super(user, 'login')
+      end
+      # Fills in the <tt>fullname</tt> of the #User this was created with.
+      # (XXX this sould be updated to also get the list of communities, etc.)
+      def run
+        super
+        u = @user  # should we clone here?
+        u.fullname = @result['name']
+        u.journals = @result.select{|k,v| k=~/^access_\d+/}.collect{|k,v| v}.sort
+        u
+      end
+    end
+  end
+end
+
+# vim: ts=2 sw=2 et :

data/lib/livejournal/logjam.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby
+#--
+# ljrb -- LiveJournal Ruby module
+# Copyright (c) 2005 Evan Martin <martine@danga.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+#++
+#
+# This module extends the LiveJournal module to work with LogJam's data.
+# XXX this is currently not working due to database schema divergence
+
+require 'rexml/document'    # parsing logjam conf
+
+module LiveJournal
+  # XXX this is currently not working due to database schema divergence
+  module LogJam
+    # Path to LogJam data.
+    def self.logjam_path
+      File.expand_path '~/.logjam'
+    end
+
+    def self.xml_fetch(file, path)  #:nodoc:
+      doc = REXML::Document.new(File.open(file))
+      doc.elements.each(path) { |element| return element.text }
+      return nil
+    end
+
+    # Name of LogJam's current server.
+    def self.current_server
+      xml_fetch(logjam_path + '/conf.xml', '/configuration/currentserver')
+    end
+
+    # Path to LogJam's data for a given server.
+    def self.server_path servername
+      logjam_path + '/servers/' + servername  # is escaping needed here?
+    end
+
+    # Username for a given server's current user.
+    def self.current_user servername
+      xml_fetch(server_path(servername) + '/conf.xml',
+                '/server/currentuser')
+    end
+
+    # Path to a given user's data.
+    def self.user_path servername, username
+      server_path(servername) + "/users/#{username}"
+    end
+
+    # Return [current_server, current_user].
+    def self.current_server_user
+      server = current_server
+      user = current_user server
+      [server, user]
+    end
+
+    def self.database_from_server_user servername, username
+      Database.new(LogJam::user_path(servername, username) + "/journal.db")
+    end
+  end
+end
+
+# vim: ts=2 sw=2 et :

data/lib/livejournal/request.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby
+#--
+# ljrb -- LiveJournal Ruby module
+# Copyright (c) 2005 Evan Martin <martine@danga.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+#++
+
+
+require 'livejournal/basic'
+require 'cgi'
+require 'net/http'
+require 'date'
+require 'digest/md5'
+
+module LiveJournal
+  module Request
+    class ProtocolException < RuntimeError; end
+
+    # ljtimes look like 2005-12-04 10:24:00.
+    # Convert a Time to an ljtime.
+    def self.time_to_ljtime time
+      time.strftime '%Y-%m-%d %H:%M:%S'
+    end
+    # Convert an ljtime to a Time.
+    def self.ljtime_to_time str
+      dt = DateTime.strptime(str, '%Y-%m-%d %H:%M')
+      Time.gm(dt.year, dt.mon, dt.day, dt.hour, dt.min, 0, 0)
+    end
+
+    # wrapper around a given hash, prefixing all key lookups with base
+    class HashStrip #:nodoc:
+      def initialize(base, hash)
+        @base = base
+        @hash = hash
+      end
+      def [](key)
+        @hash[@base + key]
+      end
+    end
+
+    # Superclass for all LiveJournal requests.
+    class Req #:nodoc:
+      def initialize(user, mode, server = nil)
+        @server = server || (user && user.server) || LiveJournal::DEFAULT_SERVER
+        @user = user
+        @request = { 'mode'          => mode,
+                     'clientversion' => 'Ruby',
+                     'ver'           => 1 }
+        if user
+          challenge = GetChallenge.new(@server).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
+
+      def verbose!; @verbose = true; end
+      def dryrun!; @dryrun = true; end
+
+      def run
+        h = Net::HTTP.new(@server.host, @server.port)
+        h.use_ssl = @server.use_ssl
+        h.set_debug_output $stderr if @verbose
+        request = @request.collect { |key, value|
+          "#{CGI.escape(key)}=#{CGI.escape(value.to_s)}"
+        }.join("&")
+        p request if @verbose
+        return if @dryrun
+        response = h.post('/interface/flat', request, {"User-Agent" => "ljrb/0.3.x"})
+        data = response.read_body
+        parseresponse(data)
+        dumpresponse if @verbose
+        if @result['success'] != "OK"
+          raise ProtocolException, @result['errmsg']
+        end
+      end
+
+      def dumpresponse
+        @result.keys.sort.each { |key| puts "#{key} -> #{@result[key]}" }
+      end
+
+      protected
+      def parseresponse(data)
+        lines = data.split(/\r?\n/)
+        @result = {}
+        0.step(lines.length-1, 2) do |i|
+          @result[lines[i]] = lines[i+1]
+        end
+      end
+
+      def each_in_array(base)
+        for i in 1..(@result["#{base}_count"].to_i) do
+          yield HashStrip.new("#{base}_#{i.to_s}_", @result)
+        end
+      end
+      def build_array(base)
+        array = []
+        each_in_array(base) { |x| array << yield(x) }
+        array
+      end
+    end
+
+    # Used for LiveJournal's challenge-response based authentication,
+    # and used by ljrb for all requests.
+    class GetChallenge < Req
+      def initialize(server = nil)
+        super(nil, 'getchallenge', server)
+      end
+      # Returns the challenge.
+      def run
+        super
+        return @result['challenge']
+      end
+    end
+  end
+end
+
+# vim: ts=2 sw=2 et cino=(0 :

data/lib/livejournal/sync.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/ruby
+#--
+# ljrb -- LiveJournal Ruby module
+# Copyright (c) 2005 Evan Martin <martine@danga.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+#++
+
+# A full sync involves both the LiveJournal flat protocol, for entries:
+require 'livejournal/request'
+# As well as a custom XML format via REST, for comments:
+# http://www.livejournal.com/developer/exporting.bml
+require 'open-uri'
+require 'livejournal/comments-xml'
+
+require 'livejournal/entry'
+require 'livejournal/comment'
+
+module LiveJournal
+  module Request
+    class SyncItems < Req
+      attr_reader :syncitems, :fetched, :total
+      def initialize(user, syncitems=nil, lastsync=nil)
+        super(user, 'syncitems')
+        @syncitems = syncitems || {}
+        @request['lastsync'] = lastsync if lastsync
+      end
+
+      def run
+        super
+        lasttime = nil
+        @fetched = 0
+        @total = @result['sync_total'].to_i
+        each_in_array('sync') do |item|
+          item, time = item['item'], item['time']
+          next if @syncitems.has_key? item
+          @fetched += 1
+          lasttime = time if lasttime.nil? or time > lasttime
+          @syncitems[item] = time
+        end
+        lasttime
+      end
+
+      def self.subset_items(syncitems, want_type='L')
+        items = {}
+        syncitems.each do |item, time|
+          next unless item =~ /^(.)-(\d+)$/
+          type, id = $1, $2.to_i
+          items[id] = time if type == want_type
+        end
+        items
+      end
+    end
+
+    # This is only used for generating sessions used for syncing comments.
+    # It is used by ljrb internally.
+    class SessionGenerate < Req
+      def initialize(user)
+        super(user, 'sessiongenerate')
+      end
+      # Returns the LJ session.
+      def run
+        super
+        @result['ljsession']
+      end
+    end
+  end
+
+  # Journal export.  A full export involves syncing both entries and comments.
+  # See <tt>samples/export</tt> for a full example.
+  module Sync
+
+    # To run a sync, create a Sync::Entries object, then call
+    # Entries#run_syncitems to fetch the sync metadata, then call
+    # Entries#run_sync to get the actual entries.
+    class Entries
+      # To resume from a previous sync, pass in its lastsync value.
+      attr_reader :lastsync
+
+      def initialize(user, lastsync=nil)
+        @user = user
+        @logitems = {}
+        @lastsync = lastsync
+      end
+      def run_syncitems  # :yields: cur, total
+        cur = 0
+        total = nil
+        items = {}
+        lastsync = @lastsync
+        while total.nil? or cur < total
+          req = Request::SyncItems.new(@user, items, lastsync)
+          lastsync = req.run
+          cur += req.fetched
+          total = req.total unless total
+          yield cur, total if block_given?
+        end
+        @logitems = Request::SyncItems::subset_items(items, 'L')
+        return (not @logitems.empty?)
+      end
+
+      def run_sync  # :yields: entries_hash, lastsync, remaining_count
+        return if @logitems.empty?
+
+        lastsync = @lastsync
+        while @logitems.size > 0
+          req = Request::GetEvents.new(@user, :lastsync => lastsync)
+          entries = req.run
+          # pop off all items that we now have entries for
+          entries.each do |itemid, entry|
+            time = @logitems.delete itemid
+            lastsync = time if lastsync.nil? or time > lastsync
+          end
+          yield entries, lastsync, @logitems.size
+        end
+      end
+    end
+    
+    class Comments
+      def initialize(user)
+        @user = user
+        @session = nil
+        @maxid = nil
+      end
+
+      def run_GET(mode, start)
+        unless @session
+          req = Request::SessionGenerate.new(@user)
+          @session = req.run
+        end
+
+        path = "/export_comments.bml?get=comment_#{mode}&startid=#{start}"
+        # authas:  hooray for features discovered by reading source!
+        path += "&authas=#{@user.usejournal}" if @user.usejournal
+
+        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
+
+      def run_metadata(start=0)  # :yields: cur, total, comments_hash
+        while @maxid.nil? or start < @maxid
+          data = run_GET('meta', start)
+          parsed = LiveJournal::Sync::CommentsXML::Parser.new(data)
+          @maxid ||= parsed.maxid
+          break if parsed.comments.empty?
+          cur = parsed.comments.keys.max
+          yield cur, @maxid, parsed
+          start = cur + 1
+        end
+      end
+      
+      def run_body(start=0)  # :yields: cur, total, comments_hash
+        while start < @maxid
+          data = run_GET('body', start)
+          parsed = LiveJournal::Sync::CommentsXML::Parser.new(data)
+          break if parsed.comments.empty?
+          cur = parsed.comments.keys.max
+          yield cur, @maxid, parsed
+          start = cur + 1
+        end
+      end
+    end
+  end
+end
+
+# vim: ts=2 sw=2 et :