lotus 0.0.12

data/lib/lotus/atom/entry.rb

@@ -0,0 +1,159 @@
+module Lotus
+  module Atom
+    require 'atom'
+
+    class Entry < ::Atom::Entry
+      require 'lotus/activity'
+      require 'lotus/author'
+      require 'lotus/link'
+
+      require 'lotus/atom/author'
+      require 'lotus/atom/thread'
+      require 'lotus/atom/link'
+      require 'lotus/atom/source'
+
+      require 'libxml'
+
+      # The XML namespace that identifies the conforming specification of 'thr'
+      # elements.
+      THREAD_NAMESPACE = "http://purl.org/syndication/thread/1.0"
+
+      # The XML namespace that identifies the conforming specification.
+      ACTIVITY_NAMESPACE = 'http://activitystrea.ms/spec/1.0/'
+
+      # The XML schema that identifies the conforming schema for objects.
+      SCHEMA_ROOT = 'http://activitystrea.ms/schema/1.0/'
+
+      include ::Atom::SimpleExtensions
+
+      add_extension_namespace :activity, ACTIVITY_NAMESPACE
+      element 'activity:object-type'
+      element 'activity:object', :class => Lotus::Atom::Author
+      element 'activity:verb'
+      element 'activity:target'
+
+      add_extension_namespace :thr, THREAD_NAMESPACE
+      elements 'thr:in-reply-to', :class => Lotus::Atom::Thread
+
+      # This is for backwards compatibility with some implementations of Activity
+      # Streams. It should not be generated for Atom representation of Activity
+      # Streams (although it is used in JSON)
+      element 'activity:actor', :class => Lotus::Atom::Author
+
+      element :source, :class => Lotus::Atom::Source
+
+      namespace ::Atom::NAMESPACE
+      element :title, :id, :summary
+      element :updated, :published, :class => DateTime, :content_only => true
+      elements :links, :class => Lotus::Atom::Link
+
+      elements :categories, :class => ::Atom::Category
+      element :content, :class => ::Atom::Content
+      element :author, :class => Lotus::Atom::Author
+
+      def url
+        if links.alternate
+          links.alternate.href
+        elsif links.self
+          links.self.href
+        else
+          links.map.each do |l|
+            l.href
+          end.compact.first
+        end
+      end
+
+      def link
+        links.group_by { |l| l.rel.intern if l.rel }
+      end
+
+      def link= options
+        links.clear << ::Atom::Link.new(options)
+      end
+
+      def self.from_canonical(obj)
+        entry_hash = obj.to_hash
+
+        # Ensure that the content type is encoded.
+        node = XML::Node.new("content")
+        node['type'] = entry_hash[:content_type] if entry_hash[:content_type]
+        node << entry_hash[:content]
+
+        xml = XML::Reader.string(node.to_s)
+        xml.read
+        entry_hash[:content] = ::Atom::Content.parse(xml)
+        entry_hash.delete :content_type
+
+        if entry_hash[:source]
+          entry_hash[:source] = Lotus::Atom::Source.from_canonical(entry_hash[:source])
+        end
+
+        if entry_hash[:actor]
+          entry_hash[:author] = Lotus::Atom::Author.from_canonical(entry_hash[:actor])
+        end
+        entry_hash.delete :actor
+
+        # Encode in-reply-to fields
+        entry_hash[:thr_in_reply_to] = entry_hash[:in_reply_to].map do |t|
+          Lotus::Atom::Thread.new(:href => t.url,
+                                    :ref  => t.id)
+        end
+        entry_hash.delete :in_reply_to
+
+        entry_hash[:links] ||= []
+
+        if entry_hash[:url]
+          entry_hash[:links] << ::Atom::Link.new(:rel => "self", :href => entry_hash[:url])
+        end
+        entry_hash.delete :url
+
+        object_type = entry_hash[:type]
+        if object_type
+          entry_hash[:activity_object_type] = SCHEMA_ROOT + object_type.to_s
+        end
+        entry_hash[:activity_object] = entry_hash[:object] if entry_hash[:object]
+        if entry_hash[:verb]
+          entry_hash[:activity_verb] = SCHEMA_ROOT + entry_hash[:verb].to_s
+        end
+        entry_hash[:activity_target] = entry_hash[:target] if entry_hash[:target]
+
+        entry_hash.delete :object
+        entry_hash.delete :verb
+        entry_hash.delete :target
+        entry_hash.delete :type
+
+        self.new(entry_hash)
+      end
+
+      def to_canonical
+        # Reform the activity type
+        # TODO: Add new Base schema verbs
+        object_type = self.activity_object_type
+        if object_type && object_type.start_with?(SCHEMA_ROOT)
+          object_type.gsub!(/^#{Regexp.escape(SCHEMA_ROOT)}/, "")
+        end
+
+        object = nil
+        object = self.activity_object.to_canonical if self.activity_object
+
+        source = self.source
+        source = source.to_canonical if source
+        Lotus::Activity.new(:actor        => self.author ? self.author.to_canonical : nil,
+                            :id           => self.id,
+                            :url          => self.url,
+                            :title        => self.title,
+                            :source       => source,
+                            :in_reply_to  => self.thr_in_reply_to.map(&:to_canonical),
+                            :content      => self.content.to_s,
+                            :content_type => self.content.type,
+                            :link         => self.link,
+                            :object       => object,
+                            :type         => object_type,
+                            :verb         => self.activity_verb,
+                            :target       => self.activity_target,
+                            :published    => self.published,
+                            :updated      => self.updated)
+      end
+    end
+  end
+end

data/lib/lotus/atom/feed.rb

@@ -0,0 +1,174 @@
+require 'lotus/activity'
+require 'lotus/author'
+require 'lotus/category'
+require 'lotus/generator'
+
+require 'lotus/atom/entry'
+require 'lotus/atom/generator'
+require 'lotus/atom/category'
+require 'lotus/atom/author'
+require 'lotus/atom/link'
+
+module Lotus
+  require 'atom'
+
+  module Atom
+    # This class represents an OStatus Feed object.
+    class Feed < ::Atom::Feed
+      require 'open-uri'
+
+      include ::Atom::SimpleExtensions
+
+      # The XML namespace the specifies this content.
+      POCO_NAMESPACE = 'http://portablecontacts.net/spec/1.0'
+
+      # The XML namespace that identifies the conforming specification.
+      ACTIVITY_NAMESPACE = 'http://activitystrea.ms/spec/1.0/'
+
+      namespace ::Atom::NAMESPACE
+
+      add_extension_namespace :poco, POCO_NAMESPACE
+      add_extension_namespace :activity, ACTIVITY_NAMESPACE
+      element :id, :rights, :icon, :logo
+      element :generator, :class => Lotus::Atom::Generator
+      element :title, :class => ::Atom::Content
+      element :subtitle, :class => ::Atom::Content
+      element :published, :class => Time, :content_only => true
+      element :updated, :class => Time, :content_only => true
+      elements :links, :class => ::Atom::Link
+      elements :authors, :class => Lotus::Atom::Author
+      elements :contributors, :class => Lotus::Atom::Author
+      elements :categories, :class => Lotus::Atom::Category
+      elements :entries, :class => Lotus::Atom::Entry
+
+      # Creates an Atom generator for the given Lotus::Feed.
+      def self.from_canonical(obj)
+        hash = obj.to_hash
+        hash[:entries].map! {|e|
+          Lotus::Atom::Entry.from_canonical(e)
+        }
+
+        # Ensure that the generator is encoded.
+        if hash[:generator]
+          hash[:generator] = Lotus::Atom::Generator.from_canonical(hash[:generator])
+        end
+
+        hash[:links] ||= []
+
+        if hash[:salmon_url]
+          hash[:links] << ::Atom::Link.new(:rel => "salmon", :href => hash[:salmon_url])
+        end
+        hash.delete :salmon_url
+
+        if hash[:url]
+          hash[:links] << ::Atom::Link.new(:rel => "self", :href => hash[:url])
+        end
+        hash.delete :url
+
+        hash[:hubs].each {|h|
+          hash[:links] << ::Atom::Link.new(:rel => "hub", :href => h)
+        }
+        hash.delete :hubs
+
+        hash[:authors].map! {|a|
+          Lotus::Atom::Author.from_canonical(a)
+        }
+
+        hash[:contributors].map! {|a|
+          Lotus::Atom::Author.from_canonical(a)
+        }
+
+        hash[:categories].map! {|c|
+          Lotus::Atom::Category.from_canonical(c)
+        }
+
+        # title/subtitle content type
+        node = XML::Node.new("title")
+        node['type'] = hash[:title_type] if hash[:title_type]
+        node << hash[:title]
+
+        xml = XML::Reader.string(node.to_s)
+        xml.read
+        hash[:title] = ::Atom::Content.parse(xml)
+        hash.delete :title_type
+
+        if hash[:subtitle]
+          node = XML::Node.new("subtitle")
+          node['type'] = hash[:subtitle_type] if hash[:subtitle_type]
+          node << hash[:subtitle]
+
+          xml = XML::Reader.string(node.to_s)
+          xml.read
+          hash[:subtitle] = ::Atom::Content.parse(xml)
+        else
+          hash.delete :subtitle
+        end
+        hash.delete :subtitle_type
+
+        self.new(hash)
+      end
+
+      def to_canonical
+        generator = nil
+        generator = self.generator.to_canonical if self.generator
+
+        salmon_url = nil
+        if self.link('salmon').any?
+          salmon_url = self.link('salmon').first.href
+        end
+
+        url = self.url
+
+        categories = self.categories.map(&:to_canonical)
+
+        Lotus::Feed.new(:title         => self.title.to_s,
+                        :title_type    => self.title ? self.title.type : nil,
+                        :subtitle      => self.subtitle.to_s,
+                        :subtitle_type => self.subtitle ? self.subtitle.type : nil,
+                        :id            => self.id,
+                        :url           => url,
+                        :categories    => categories,
+                        :icon          => self.icon,
+                        :logo          => self.logo,
+                        :rights        => self.rights,
+                        :published     => self.published,
+                        :updated       => self.updated,
+                        :entries       => self.entries.map(&:to_canonical),
+                        :authors       => self.authors.map(&:to_canonical),
+                        :contributors  => self.contributors.map(&:to_canonical),
+                        :hubs          => self.hubs,
+                        :salmon_url    => salmon_url,
+                        :generator     => generator)
+      end
+
+      # Returns an array of ::Atom::Link instances for all link tags
+      # that have a rel equal to that given by attribute.
+      #
+      # For example:
+      #   link(:hub).first.href -- Gets the first link tag with rel="hub" and
+      #                            returns the contents of the href attribute.
+      #
+      def link(attribute)
+        links.find_all { |l| l.rel == attribute.to_s }
+      end
+
+      # Returns an array of URLs for each hub link tag.
+      def hubs
+        link('hub').map { |link| link.href }
+      end
+
+      # Returns a string of the url for this feed.
+      def url
+        if links.alternate
+          links.alternate.href
+        elsif links.self
+          links.self.href
+        else
+          links.map.each do |l|
+            l.href
+          end.compact.first
+        end
+      end
+    end
+  end
+end

data/lib/lotus/atom/generator.rb

@@ -0,0 +1,40 @@
+require 'lotus/generator'
+
+module Lotus
+  require 'atom'
+
+  module Atom
+    # This class represents an OStatus Generator object.
+    class Generator < ::Atom::Generator
+      require 'open-uri'
+
+      attribute :'xml:base'
+      attribute :'xml:lang'
+      attribute :version
+      attribute :uri
+
+      def self.from_canonical(obj)
+        hash = obj.to_hash
+        if hash[:base]
+          hash[:xml_base] = hash[:base]
+        end
+        if hash[:lang]
+          hash[:xml_lang] = hash[:lang]
+        end
+        hash.delete :base
+        hash.delete :lang
+        self.new(hash)
+      end
+
+      def to_canonical
+        Lotus::Generator.new(:base    => self.xml_base,
+                             :lang    => self.xml_lang,
+                             :version => self.version,
+                             :name    => self.name,
+                             :uri     => self.uri)
+      end
+    end
+  end
+end
+
+

data/lib/lotus/atom/link.rb

@@ -0,0 +1,79 @@
+module Lotus
+  require 'atom'
+
+  module Atom
+
+    # This represents an Atom parser/generator for <link> tags.
+    class Link < ::Atom::Link
+      include ::Atom::Xml::Parseable
+
+      attribute :rel, :type, :length, :hreflang, :title, :text
+
+      uri_attribute :href
+
+      # Create a link.
+      #
+      # +o+:: An XML::Reader containing a link element or a Hash of attributes.
+      #
+      def initialize(o)
+        case o
+        when XML::Reader
+          if current_node_is?(o, 'link')
+            self.text = o.read_string
+            parse(o, :once => true)
+          else
+            raise ArgumentError, "Link created with node other than atom:link: #{o.name}"
+          end
+        when Hash
+          [:href, :rel, :type, :length, :hreflang, :title].each do |attr|
+            self.send("#{attr}=", o[attr])
+          end
+        else
+          raise ArgumentError, "Don't know how to handle #{o}"
+        end
+      end
+
+      remove_method :length=
+        def length=(v)
+          @length = v.to_i
+        end
+
+      # Returns the href of the link, or the content of the link if no href is
+      # provided.
+      def href
+        @href || self.text
+      end
+
+      # Reports the href of the link.
+      def to_s
+        self.href
+      end
+
+      # Two links are equal when their href is exactly the same regardless of
+      # case.
+      def ==(o)
+        o.respond_to?(:href) && o.href == self.href
+      end
+
+      # This will fetch the URL referenced by the link.
+      #
+      # If the URL contains a valid feed, a Feed will be returned, otherwise,
+      # the body of the response will be returned.
+      #
+      # TODO: Handle redirects.
+      #
+      def fetch(options = {})
+        begin
+          ::Atom::Feed.load_feed(URI.parse(self.href), options)
+        rescue ArgumentError
+          Net::HTTP.get_response(URI.parse(self.href)).body
+        end
+      end
+
+      # :nodoc:
+      def inspect
+        "<Lotus::Link href:'#{href}' type:'#{type}'>"
+      end
+    end
+  end
+end