livejournal 0.3.0 → 0.3.1

data/Changes

@@ -0,0 +1,4 @@
+0.2.1:  Sat, 06 Jan 2007 10:21:05 -0800
+- Don't die on the "useragent" prop.
+- Add a :strict => false option to GetEvents so we won't die on any new prop.
+  see the GetEvents documentation for details.

data/Rakefile

@@ -5,10 +5,10 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 
 PKG_NAME = 'livejournal'
-PKG_VERSION = '0.3.0'
+PKG_VERSION = '0.3.1'
 
 FILES = FileList[
-  'Rakefile', 'README', 'LICENSE', 'setup.rb',
+  'Rakefile', 'README', 'Changes', 'LICENSE', 'setup.rb',
   'lib/**/*', 'sample/*', 'test/*'
 ]
 

data/lib/livejournal/entry.rb

@@ -53,7 +53,14 @@ module LiveJournal
     attr_accessor :security  # values: {:public, :private, :friends, :custom}
     attr_accessor :allowmask
     attr_accessor :screening # values {:default, :all, :anonymous, :nonfriends, :none}
+
+    # A hash of any leftover properties (including those in KNOWN_EXTRA_PROPS)
+    # that aren't explicitly supported by ljrb.  (See the
+    # Request::GetEvents#new for details.)
     attr_accessor :props
+    # A list of extra properties we're aware of but don't wrap explicitly.
+    # Upon retrieval stored in the props hash.
+    KNOWN_EXTRA_PROPS = %w{revnum revtime commentalter unknown8bit useragent}
 
     def initialize
       @subject = nil
@@ -74,21 +81,24 @@ module LiveJournal
       @props = {}
     end
 
-    def equivalent_to?(other)
+    def ==(other)
       [:subject, :event, :moodid,
        :mood, :music, :location, :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
 
     def time=(time)
       raise RuntimeError, "Must use GMT times everywhere to reduce confusion.  See LiveJournal::coerce_gmt for details." unless time.gmt?
-      components = time.to_a
-      components[0] = 0   # set seconds to zero
-      @time = Time.gm *components
+      @time = time
     end
 
     def from_request(req)
@@ -115,7 +125,8 @@ module LiveJournal
 
       self
     end
-    def load_prop(name, value) #:nodoc:#
+
+    def load_prop(name, value, strict=false) #:nodoc:#
       case name
       when 'current_mood'
         @mood = value.to_i
@@ -149,14 +160,19 @@ module LiveJournal
         end
       when 'hasscreened'
         @screened = value == '1'
-      # and then some props we just store by name
-      when 'revnum';       @props[name] = value
-      when 'revtime';      @props[name] = value
-      when 'commentalter'; @props[name] = value
-      when 'unknown8bit';  @props[name] = value
       else
+        # LJ keeps adding props, so we store all leftovers in a hash.
+        # Unfortunately, we don't know which of these need to be passed
+        # on to new entries.  This may mean we drop some data when we
+        # round-trip.
+        #
+        # Some we've seen so far:
+        #   revnum, revtime, commentalter, unknown8bit, useragent
         @props[name] = value
-        raise Request::ProtocolException, "unknown prop (#{name}, #{value})"
+
+        unless KNOWN_EXTRA_PROPS.include? name or not strict
+          raise Request::ProtocolException, "unknown prop (#{name}, #{value})"
+        end
       end
     end
 
@@ -259,10 +275,28 @@ module LiveJournal
       # * <tt>GetEvents.new(user, :itemid => itemid)</tt> (fetch a single item)
       # * <tt>GetEvents.new(user, :recent => n)</tt> (fetch most recent n itemds)
       # * <tt>GetEvents.new(user, :lastsync => lastsync)</tt> (for syncing)
+      #
+      # We support one final option called <tt>:strict</tt>, which requires
+      # a bit of explanation.
+      #
+      # Whenever LiveJournal adds new metadata to entries (such as the
+      # location field, which was introduced in 2006) it also exposes this
+      # metadata via the LJ protocol.  However, ljrb can't know about future
+      # metadata and doesn't know how to handle it properly.  Some metadata
+      # (like the current location) must be sent to the server to
+      # publish an entry correctly; others, like the last revision time,
+      # must not be.
+      #
+      # Normally, when we see a new property we abort with a ProtocolException.
+      # If the object is constructed with <tt>:strict => false</tt>, we'll
+      # skip over any new properties.
       def initialize(user, opts)
         super(user, 'getevents')
         @request['lineendings'] = 'unix'
 
+        @strict = true
+        @strict = opts[:strict] if opts.has_key? :strict
+
         if opts.has_key? :itemid
           @request['selecttype'] = 'one'
           @request['itemid'] = opts[:itemid]
@@ -290,7 +324,7 @@ module LiveJournal
 
         each_in_array('prop') do |prop|
           itemid = prop['itemid'].to_i
-          entries[itemid].load_prop(prop['name'], prop['value'])
+          entries[itemid].load_prop(prop['name'], prop['value'], @strict)
         end
 
         if @request.has_key? 'itemid'

data/sample/progressbar.rb

@@ -15,7 +15,11 @@ class ProgressBar
   end
 
   def update(cur, max)
-    fill_to(@width*cur/max)
+    if max > 0
+      fill_to(@width*cur/max)
+    else
+      fill_to(@width)
+    end
   end
 
   def finish(error=false)

data/test/database.rb

@@ -24,7 +24,7 @@ class TC_Database < Test::Unit::TestCase
   def roundtrip e
     @db.store_entry e
     new_e = @db.get_entry e.itemid
-    assert(e.equivalent_to?(new_e), "#{e.inspect}\n=>\n#{new_e.inspect}")
+    assert_equal(e, new_e)
   end
 
   def test_roundtrips

data/test/roundtrip.rb

@@ -18,7 +18,7 @@ class TC_RoundTrip < Test::Unit::TestCase
 
     getevents = Request::GetEvents.new(@user, :itemid => entry.itemid)
     new_entry = getevents.run
-    assert(entry.equivalent_to?(new_entry), "#{entry.inspect}\n=>\n#{new_entry.inspect}")
+    assert_equal(new_entry, entry)
 
     delete = Request::EditEvent.new(@user, entry, :delete => true)
     delete.run
@@ -27,7 +27,7 @@ class TC_RoundTrip < Test::Unit::TestCase
   def test_roundtrip
     e = Entry.new
     e.subject = 'subject'
-    e.event = 'event here ' + Time.now.to_s
+    e.event = 'event here'
     e.time = LiveJournal::coerce_gmt Time.now
     roundtrip e
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: livejournal
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2006-07-25 00:00:00 +09:00
+  version: 0.3.1
+date: 2007-01-06 00:00:00 -08:00
 summary: module for interacting with livejournal
 require_paths: 
 - lib
@@ -25,34 +25,36 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Evan Martin
 files: 
 - Rakefile
 - README
+- Changes
 - LICENSE
 - setup.rb
 - lib/livejournal
 - lib/livejournal/database.rb
-- lib/livejournal/logjam.rb
-- lib/livejournal/sync.rb
-- lib/livejournal/request.rb
-- lib/livejournal/entry.rb
-- lib/livejournal/comments-xml.rb
-- lib/livejournal/login.rb
+- lib/livejournal/basic.rb
 - lib/livejournal/comment.rb
+- lib/livejournal/comments-xml.rb
+- lib/livejournal/entry.rb
 - lib/livejournal/friends.rb
-- lib/livejournal/basic.rb
+- lib/livejournal/login.rb
+- lib/livejournal/logjam.rb
+- lib/livejournal/request.rb
+- lib/livejournal/sync.rb
+- sample/export
+- sample/graph
 - sample/fuse
 - sample/progressbar.rb
-- sample/graph
-- sample/export
+- test/login.rb
+- test/checkfriends.rb
+- test/comments-xml.rb
 - test/database.rb
 - test/time.rb
-- test/checkfriends.rb
 - test/roundtrip.rb
-- test/comments-xml.rb
-- test/login.rb
 test_files: []
 
 rdoc_options: []