titi 0.0.5 → 0.0.6

data/README.textile

@@ -2,12 +2,12 @@ h1. titi: Agile Monkeying around with Activity Streams
 
 Titi is a first stab at a universal ActivityStream interface.
 
-h3. BUGS:
+h3. How you can help
 
-* The XML output isn't activity stream format: needs namespaces, much more
+* Give the coders something to target: a) Pick an API or feed to add. For ideas, choose one not yet implemented from "Supported Feeds" list, below. b) Get a sample of the raw API or feed output (use your own account so noone files a copyright violation bug report). c) create an appropriately-named file, say @spec/data/providers/PROVIDER_NAME/PROVIDER_FEED_NAME-raw_feed.xml@ or @spec/data/providers/PROVIDER_NAME/PROVIDER_FEED_NAME-raw_api.json@ or whatever. d) If that feed is not yet in activity_streams format, use the raw sample to create an example activity_streams output. e) Issue a pull request.
+* Take an API or feed that has example input and output and code its interface.
 
-
-h3. Example
+h2. Example
 
 Let's define a super-simple twitter user and status model:
 
@@ -103,6 +103,25 @@ Here's example output. _note: this isn't canonical activity streams format: the
         </entry>
 </code></pre>
 
+h2. Supported Feeds
+
+The goal is to cover all the following services. Thanks to "Cliqset":http://feedproxy.cliqset.com/feed/selection and Rob Dolin for the list:
+
+<pre><code>
+  :social           => %w[ AvatarsUnited   Bebo            Brightkite      Friendster      Friendfeed      GamerDna        Gather          Hi5             Hyves           Identica
+                           Jaiku           Multiply        Myspace         Netlog          Plurk           Raptr           Skyrock         Twitter         Facebook        LinkedIn        Plaxo            Xing                                      ],
+  :blogging         => %w[ Ameba           Baidu           Blogger         Douban          Livejournal     Posterous       Tumblr          Wordpress       Xanga           TypePad         MoveableType    WlSpaces                                   ],
+  :bookmarking      => %w[ Delicious       Digg            Diigo           GoogleReader    Hatena          Meneame         Mixx            Newsvine        Propeller       Reddit          Stumbleupon     Twine                                      ],
+  :music            => %w[ Blipfm          Buzznet         Ilike           Lastfm          Pandora         Zooomr          Zune                                                                                                                       ],
+  :video            => %w[ BuddyTv         TwelveSeconds   Bliptv          Cinchcast       DailyMotion     FunnyOrDie      Hulu            Joost           Metacafe        Qik             Revver          Vimeo           Youtube                    ],
+  :photos           => %w[ DeviantArt      Flickr          Fotolog         MobyPicture     Photobucket     Picasa          Photocase       Slideshare      Smotri          Smugmug         Visualizeus     MetroFlog                       WlSkyDrive ],
+  :reviews          => %w[ Blippr          Corkd           Flixster        Goodreads       Librarything    Qype            Readernaut      Yelp                                                                                                       ],
+  :messengers       => %w[ AIM                             WlMessenger                                                                                                                                                                                ],
+  :location         => %w[ Gowalla         Foursquare      Tripit          UrbanSpoon       Whirl                                                                                                                                                     ],
+  :gaming           => %w[ Zynga           Playdom         MsgrGames                                                                                                                                                                                  ],
+</code></pre>
+
+
 h2. Copyright
 
 Copyright (c) 2010 Infochimps, Inc. Available under Apache license: see LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/examples/twitter.rb

@@ -1,18 +1,10 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'restclient'
-require 'json'
-require 'active_support'
-
 TITI_DIR = File.dirname(File.expand_path(__FILE__+'/..')) unless defined?(TITI_DIR)
 $: << TITI_DIR+'/lib' unless $:.include?(TITI_DIR+'/lib')
-
-require 'titi'
+require 'titi' ; include Titi::Provider
 require 'titi/provider/twitter'
-include Titi::Provider
-
-tweet = Twitter::Status.get(12233609555)
-entry = tweet.to_activity_stream_entry
 
-p tweet.to_hash
-puts entry.to_xml
+tweet   = Twitter::Status.fetch_status(12233609555)
+tw_feed = tweet.to_activity_stream
+puts tw_feed.to_xml

data/lib/titi.rb

@@ -1,4 +1,10 @@
+require 'restclient'
+require 'json'
+require 'wukong'
+require 'erubis'
+
 module Titi
   autoload :Provider,  'titi/provider'
   autoload :Adaptor,   'titi/adaptor'
+  autoload :Fetcher,   'titi/fetcher'
 end

data/lib/titi/fetcher.rb

@@ -0,0 +1,5 @@
+module Titi
+  module Fetcher
+    autoload :Json, 'titi/fetcher/json'
+  end
+end

data/lib/titi/fetcher/json.rb

@@ -0,0 +1,32 @@
+module Titi::Fetcher
+  module Json
+    module ClassMethods
+
+      def parse raw_json_str
+        begin
+          return JSON.load(raw_json_str)
+        rescue StandardError => e
+          warn e
+          return { }
+        end
+      end
+
+      # Call the twitter API and fetch tweet with given ID
+      #
+      # @example
+      #   tweet = Status.get(12233609555)
+      #   tweet.text
+      #   #=> "THANK GOODNESS THE LIBRARY OF CONGRESS HAS UNDERSTOOD THE IMPORTANCE OF MY TWEETS what do you mean others are getting in too"
+      #
+      def get url
+        parse RestClient.get(url).to_s
+      end
+
+      def from_file filename
+        parse File.open(filename)
+      end
+    end
+    # Standard hack to add class methods
+    def self.included(base) base.class_eval{ extend ClassMethods } ; end
+  end
+end

data/lib/titi/provider.rb

@@ -1,4 +1,3 @@
-require 'wukong'
 module Titi
   module Provider
     autoload :ActivityStreams, 'titi/provider/activity_streams'
@@ -16,25 +15,3 @@ module Titi
     # autoload :WordPress , 'titi/provider/word_press'
   end
 end
-
-# # from Rob Dolin, a list:
-# {
-# :text_status => %w[ Twitter         StatusNet       Plurk           AIM             WlMessenger                                            ],
-# :location    => %w[ Gowalla         Foursquare      Tripit          Yelp            Qype            UrbanSpoon      Brightkite      Whirl  ],
-# :social      => %w[ Facebook        MySpace         LinkedIn        Xing            Plaxo                                                  ],
-# :music       => %w[ LastFm          Pandora         Zune            iLike                                                                  ],
-# :bookmarking => %w[ Digg            StumbleUpon     Delicious       Facebook                                                               ],
-# :video       => %w[ YouTube         DailyMotion     Hulu            BuddyTv         SkyDrive                                               ],
-# :gaming      => %w[ Zynga           Playdom         MsgrGames                                                                              ],
-# :photos      => %w[ Flickr          Photobucket     MetroFlog       Fotolog         Picasa          WlSkyDrive                             ],
-# :blogging    => %w[ Blogger         WordPress       TypePad         MySpace         MoveableType    WlSpaces                               ],
-# }
-#
-# # See also: http://feedproxy.cliqset.com/feed/selection
-# {
-# Social       => %w[ AvatarsUnited Bebo BrightKite Friendster FriendFeed GamerDNA Gather hi5 Hyves Identica Jaiku Multiply Netlog Plurk Raptr Skyrock Twitter ],
-# Blogging     => %w[ Ameba Baidu Blogger CustomFeed Douban LiveJournal Posterous Tumblr WordPress Xanga ],
-# Bookmarking  => %w[ Delicious Digg Diigo GoogleReader Hatena Meneame Mixx Newsvine Propeller Reddit StumbleUpon Twine ],
-# Media        => %w[ 12seconds BlipFm BlipTv Buzznet Cinchcast Dailymotion DeviantArt Flickr Fotolog FunnyOrDie Hulu iLike Joost LastFm MetaCafe MobyPicture Pandora Photobucket Photocase Picasa Qik Revver SlideShare Smotri SmugMug VisualizeUs Vimeo YouTube Zooomr ],
-# Reviews      => %w[ Blippr Corkd Flixster Goodreads LibraryThing Qype Readernaut Yelp  ],
-# }

data/lib/titi/provider/activity_streams.rb

@@ -1,141 +1,12 @@
-module Titi
-
-  module Provider
-    #
-    module ActivityStreams
-      # Some methods common to all ActivityStreams classes
-      module Common
-        def to_hash *args
-          hsh = super(*args)
-          hsh.each do |attr, val|
-            hsh[attr] = val.to_hash if val.respond_to?(:to_hash)
-          end
-          hsh
-        end
-
-        def to_xml *args
-          hsh = self.to_hash
-          hsh.to_xml :root => self.class.to_s.underscore.gsub(%r{.*/},'')
-        end
-
-        def has_thingy thingy, *args, &block
-          thingy_klass  = ('ActivityStreams::'+thingy.to_s.classify).constantize
-          thingy_setter = "#{thingy}="
-          p [thingy, thingy_klass, thingy_setter]
-          self.send(thingy_setter, thingy_klass.new) unless self.send(thingy)
-          self.send(thingy).adapt *args, &block
-          self.send(thingy)
-        end
-
-        def method_missing meth, *args, &block
-          if (meth.to_s =~ /has_(\w+)/) && (self.respond_to?("#{$1}="))
-            has_thingy $1, *args, &block
-          else
-            super
-          end
-        end
-      end
-
-      class ActivityStreamsStruct < ActivityStreamsStruct
-        def self.new *args, &block
-          super
-          include Titi::Adaptor
-          include Titi::Provider::ActivityStreams::Common
-        end
-      end
-
-      Feed = ActivityStreamsStruct.new(
-        :entry
-        )
-      Feed.class_eval do
-        def adapt thingys
-          self.entry = thingys.map do |thingy|
-            thingy.to_activity_stream_entry
-          end
-        end
-      end
-
-      # An ActivityStream entry
-      #   http://activitystrea.ms/spec/1.0/atom-activity-01.html#activityentries
-      Entry = ActivityStreamsStruct.new(
-        :id,                # ???
-        :title,             # title
-        :content,           # content
-        :link,              # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
-        :published,         # date published
-        :updated,           # date updated
-        #
-        :category,          # type of entry
-        :activity_verb,     # action it implies:
-        :sync,              # sync
-        :rank,              # rank
-        #
-        :actor,             # actor
-        :author,            # author           {"name"=>["misterflip"], "uri"=>["http://profile.myspace.com/index.cfm?fuseaction=user.viewprofile&friendid=24601"]}
-        :mood,              #
-        :source,
-        :obj,               # object
-        :target             # target
-        )
-      Entry.class_eval do
-        def published= date_time
-          self[:published] = DateTime.parse(date_time) rescue nil
-        end
-        def updated= date_time
-          self[:updated] = DateTime.parse(date_time) rescue nil
-        end
-      end
-
-      # <link href="http://twitter.com/banksean/statuses/12244282580"
-      #    type="text/xhtml" rel="via" title="Just saw a @cliqset #salmon @-mention interop demo by @jpanzer. Very neat stuff!">
-      #  </link>
-
-      Link = ActivityStreamsStruct.new(
-        :href,
-        :title,
-        :rel,
-        :type
-        )
-      Link.class_eval do
-      end
-
-      Address = ActivityStreamsStruct.new(
-        :country,
-        :locality,
-        :postalCode,
-        #
-        :xml_keys          # for debugging, capture the keys from the raw XML hash
-        )
-      Address.class_eval do
-      end
-
-      # ActivityStream author
-      #  http://activitystrea.ms/spec/1.0/atom-activity-01.html#activityactor
-      Actor = ActivityStreamsStruct.new(
-        :name,
-        :uri
-        )
-      Actor.class_eval do
-      end
-      Author = Actor
-
-      # ActivityStream object.
-      # We can't call them 'Object' (ruby has a class like that already :)
-      #   http://activitystrea.ms/spec/1.0/atom-activity-01.html#activityobjectelement
-      Obj = ActivityStreamsStruct.new(
-        :id,
-        :title,
-        :content,
-        :link,
-        :published,
-        :updated,
-        #
-        :author,
-        :object_type,                   # video, post, file
-        :vevent
-        )
-      Obj.class_eval do
-      end
-    end
+module Titi::Provider
+  module ActivityStreams
+    autoload :ActivityStreamsStruct, 'titi/provider/activity_streams/activity_streams_struct'
+    autoload :Actor,                 'titi/provider/activity_streams/actor'
+    autoload :Author,                'titi/provider/activity_streams/actor'
+    autoload :Address,               'titi/provider/activity_streams/address'
+    autoload :Entry,                 'titi/provider/activity_streams/entry'
+    autoload :Feed,                  'titi/provider/activity_streams/feed'
+    autoload :Link,                  'titi/provider/activity_streams/link'
+    autoload :Obj,                   'titi/provider/activity_streams/obj'
   end
 end

data/lib/titi/provider/activity_streams/activity_streams_struct.rb

@@ -0,0 +1,46 @@
+module Titi::Provider::ActivityStreams
+  class ActivityStreamsStruct < Struct
+    include Titi::Adaptor
+
+    # Merge given attributes into the hash
+    def attributes= hsh
+      conv_hsh = {}
+      hsh.each do |k,v|
+        k = k.to_s.gsub(/:/,'_') if k =~ /:/
+        conv_hsh[k] = v
+      end
+      super hsh
+    end
+
+    # expand to hash, and expand all hash values to hash
+    def to_hash *args
+      hsh = super(*args)
+      hsh.each do |attr, val|
+        hsh[attr] = val.to_hash if val.respond_to?(:to_hash)
+      end
+      hsh
+    end
+
+    # def to_xml *args
+    #   hsh = self.to_hash
+    #   hsh.to_xml :root => self.class.to_s.underscore.gsub(%r{.*/},'')
+    # end
+
+    # Use method_missing to dispatch the has_[whatever] setters
+    def method_missing meth, *args, &block
+      if (meth.to_s =~ /has_(\w+)/) && (self.respond_to?("#{$1}="))
+        has_thingy $1, *args, &block
+      else
+        super
+      end
+    end
+
+    def has_thingy thingy, *args, &block
+      thingy_klass  = ('Titi::Provider::ActivityStreams::'+thingy.to_s.camelize).constantize
+      thingy_setter = "#{thingy}="
+      self.send(thingy_setter, thingy_klass.new) unless self.send(thingy)
+      self.send(thingy).adapt *args, &block
+      self.send(thingy)
+    end
+  end
+end

data/lib/titi/provider/activity_streams/actor.rb

@@ -0,0 +1,11 @@
+module Titi::Provider::ActivityStreams
+  # ActivityStream author
+  #  http://activitystrea.ms/spec/1.0/atom-activity-01.html#activityactor
+  Actor = ActivityStreamsStruct.new(
+    :name,
+    :uri
+    )
+  Actor.class_eval do
+  end
+  Author = Actor
+end

data/lib/titi/provider/activity_streams/address.rb

@@ -0,0 +1,11 @@
+module Titi::Provider::ActivityStreams
+  Address = ActivityStreamsStruct.new(
+    :country,
+    :locality,
+    :postalCode,
+    #
+    :xml_keys          # for debugging, capture the keys from the raw XML hash
+    )
+  Address.class_eval do
+  end
+end

data/lib/titi/provider/activity_streams/entry.rb

@@ -0,0 +1,38 @@
+module Titi::Provider::ActivityStreams
+
+  # An ActivityStream entry
+  #   http://activitystrea.ms/spec/1.0/atom-activity-01.html#activityentries
+  Entry = ActivityStreamsStruct.new(
+    :id,                # ???
+    :title,             # title
+    :content,           # content
+    :link_alt,          # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
+    :link_enclosure,    # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
+    :link_preview,      # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
+    :link_icon,         # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
+    :link_related,      # link             {"href"=>"http://x.myspacecdn.com/modules/common/static/img/photo.gif", "rel"=>"icon", "type"=>"image/gif"}
+
+    :published,         # date published
+    :updated,           # date updated
+    #
+    :category,          # type of entry
+    :activity_verb,     # action it implies:
+    :sync,              # sync
+    :rank,              # rank
+    #
+    :actor,             # actor
+    :author,            # author           {"name"=>["misterflip"], "uri"=>["http://profile.myspace.com/index.cfm?fuseaction=user.viewprofile&friendid=24601"]}
+    :mood,              #
+    :source,
+    :obj,               # object
+    :target             # target
+    )
+  Entry.class_eval do
+    def published= date_time
+      self[:published] = DateTime.parse(date_time) rescue nil
+    end
+    def updated= date_time
+      self[:updated] = DateTime.parse(date_time) rescue nil
+    end
+  end
+end

data/lib/titi/provider/activity_streams/feed.rb

@@ -0,0 +1,25 @@
+module Titi::Provider::ActivityStreams
+  Feed = ActivityStreamsStruct.new(
+    :entry
+    )
+  Feed.class_eval do
+    # Location of the .erb file for rendering pretty activity streams XML
+    ACTIVITY_STREAMS_TEMPLATE = File.join(File.dirname(__FILE__)+'/feed.xml.erb')
+
+    def entries
+      [entry].flatten
+    end
+
+    def self.activity_streams_template
+      @activity_streams_template ||= File.read(ACTIVITY_STREAMS_TEMPLATE)
+    end
+
+    def self.activity_streams_renderer
+      @activity_streams_renderer ||= Erubis::Eruby.new(activity_streams_template)
+    end
+
+    def to_xml
+      self.class.activity_streams_renderer.result(:feed => self)
+    end
+  end
+end

data/lib/titi/provider/activity_streams/feed.xml.erb

@@ -1,27 +1,29 @@
 <feed>
+  <%- feed.entries.each do |entry| %>
   <entry>
     <title><%= entry.title %></title>
     <content type="html"><%= entry.content %></content>
     <id><%= entry.id %></id>
     <published><%= entry.published %></published>
     <updated  ><%= entry.updated   %></updated>
-    <link type="text/html"   rel="alternate" href="<%= entry.alt_link %>"/>
-    <link type="image/pjpeg" rel="image"     href="<%= entry.img_link %>"/>
+    <link type="text/html"   rel="alternate" href="<%= entry.link_alt %>"/>
+    <link type="image/pjpeg" rel="icon"      href="<%= entry.link_icon %>"/>
     <author>
       <name><%= entry.author.name %></name>
-      <uri><%=  entry.author.url %></uri>
+      <uri><%=  entry.author.uri %></uri>
     </author>
-    <activity:verb><%= entry.verb %></activity:verb>
+    <activity:verb><%= entry.activity_verb %></activity:verb>
     <activity:object>
-      <id><%= entry.object.id %></id>
-      <title><%= entry.object.title %></title>
-      <link type="text/html" rel="alternate" href="<%= entry.object.alt_link %>"/>
-      <published><%= entry.object.published %></published>
-      <updated  ><%= entry.object.updated %></updated>
+      <id><%= entry.obj.id %></id>
+      <title><%= entry.obj.title %></title>
+      <link type="text/html" rel="alternate" href="<%= entry.obj.link_alt %>"/>
+      <published><%= entry.obj.published %></published>
+      <updated  ><%= entry.obj.updated %></updated>
       <author>
-        <name><%= entry.object.author.name %></name>
-        <uri ><%= entry.object.author.url  %></uri>
+        <name><%= entry.obj.author.name %></name>
+        <uri ><%= entry.obj.author.uri  %></uri>
       </author>
     </activity:object>
   </entry>
+  <%- end %>
 </feed>