ostatus 0.0.7 → 0.0.8

data/lib/ostatus/activity.rb

@@ -35,7 +35,13 @@ module OStatus
         @entry[:object]
       else
         obj = @entry.activity_verb
-        obj[SCHEMA_ROOT.size..-1].intern unless obj.nil?
+        if obj.nil?
+          nil
+        elsif obj.start_with?(SCHEMA_ROOT)
+          obj[SCHEMA_ROOT.size..-1].intern unless obj.nil?
+        else
+          obj
+        end
       end
     end
 
@@ -48,7 +54,13 @@ module OStatus
         @entry[:object_type]
       else
         obj = @entry.activity_object_type
-        obj[SCHEMA_ROOT.size..-1].intern unless obj.nil?
+        if obj.nil?
+          nil
+        elsif obj.start_with?(SCHEMA_ROOT)
+          obj[SCHEMA_ROOT.size..-1].intern unless obj.nil?
+        else
+          obj
+        end
       end
     end
 

data/lib/ostatus/author.rb

@@ -14,6 +14,8 @@ module OStatus
     element :email
     element :uri
 
+    elements :links, :class => Atom::Link
+
     add_extension_namespace :poco, POCO_NS
     element 'poco:id'
     element 'poco:displayName'

data/lib/ostatus/entry.rb

@@ -1,7 +1,9 @@
 require_relative 'activity'
 require_relative 'author'
+require_relative 'thread'
 
 module OStatus
+  THREAD_NS = 'http://purl.org/syndication/thread/1.0'
 
   # Holds information about an individual entry in the Feed.
   class Entry < Atom::Entry
@@ -9,10 +11,18 @@ module OStatus
 
     add_extension_namespace :activity, ACTIVITY_NS
     element 'activity:object-type'
-    element 'activity:object'
+    element 'activity:object', :class => OStatus::Author
     element 'activity:verb'
     element 'activity:target'
 
+    add_extension_namespace :thr, THREAD_NS
+    element 'thr:in-reply-to', :class => OStatus::Thread
+
+    # This is for backwards compatibility with some implementations of Activity 
+    # Streams. It should not be used, and in fact is obscured as it is not a 
+    # method in OStatus::Activity.
+    element 'activity:actor', :class => OStatus::Author
+
     namespace Atom::NAMESPACE
     element :title, :id, :summary
     element :updated, :published, :class => DateTime, :content_only => true
@@ -35,7 +45,6 @@ module OStatus
         self.activity_verb = OStatus::Activity::SCHEMA_ROOT + value.activity_verb.to_s
       end
       self.activity_target = value.activity_target if value.target
-      activity_object_type = "HEY"
     end
 
     def url

data/lib/ostatus/feed.rb

@@ -25,6 +25,11 @@ module OStatus
 
     attr_reader :url
 
+    # Store in reverse order so that the -1 from .index "not found"
+    # will sort properly
+    MIME_ORDER = ['application/atom+xml', 'application/rss+xml',
+                  'application/xml'].reverse
+
     def initialize(str, url, access_token, options)
       @str = str
       @url = url
@@ -32,6 +37,34 @@ module OStatus
       @options = options
 
       if str
+
+        if str =~ /<html/
+          doc = LibXML::XML::HTMLParser.string(str).parse
+          links = doc.find(
+            "//*[contains(concat(' ',normalize-space(@rel),' '), 'alternate')]"
+          ).map {|el|
+            {:type => el.attributes['type'].to_s,
+             :href => el.attributes['href'].to_s}
+          }.sort {|a, b|
+            MIME_ORDER.index(b[:type]) <=> MIME_ORDER.index(a[:type])
+          }
+
+          # Resolve relative links
+          link = URI::parse(links.first[:href]) rescue URI.new
+
+          unless link.host
+            link.host = URI::parse(@url).host rescue nil
+          end
+
+          unless link.absolute?
+            link.path = File::dirname(URI::parse(@url).path) \
+                        + '/' + link.path rescue nil
+          end
+
+          @url = link.to_s
+          @str = str = open(@url).read
+        end
+
         super(XML::Reader.string(str))
       else
         super(options)

data/lib/ostatus/salmon.rb

@@ -0,0 +1,227 @@
+require 'xml'
+require 'atom'
+require 'digest/sha2'
+require 'rsa'
+
+module OStatus
+  class Salmon
+    attr_accessor :entry
+
+    # Create a Salmon instance for a particular OStatus::Entry
+    def initialize entry, signature = nil, plaintext = nil
+      @entry = entry
+      @signature = signature
+      @plaintext = plaintext
+    end
+
+    # Creates an entry for following a particular Author.
+    def Salmon.from_follow(user_author, followed_author)
+      entry = OStatus::Entry.new(
+        :author => user_author,
+        :title => "Now following #{followed_author.name}",
+        :content => Atom::Content::Html.new("Now following #{followed_author.name}")
+      )
+
+      entry.activity_verb = :follow
+      entry.activity_object = followed_author
+
+      OStatus::Salmon.new(entry)
+    end
+
+    # Creates an entry for unfollowing a particular Author.
+    def Salmon.from_unfollow(user_author, followed_author)
+      entry = OStatus::Entry.new(
+        :author => user_author,
+        :title => "Stopped following #{followed_author.name}",
+        :content => Atom::Content::Html.new("Stopped following #{followed_author.name}")
+      )
+
+      entry.activity_verb = "http://ostatus.org/schema/1.0/unfollow"
+      entry.activity_object = followed_author
+
+      OStatus::Salmon.new(entry)
+    end
+
+    # Will pull a OStatus::Entry from a magic envelope described by the xml.
+    def Salmon.from_xml source
+      if source.is_a?(String)
+        source = XML::Document.string(source, 
+                                      :options => XML::Parser::Options::NOENT)
+      end
+
+      # Retrieve the envelope
+      envelope = source.find('/me:env', 
+                          'me:http://salmon-protocol.org/ns/magic-env').first
+
+      if envelope.nil?
+        return nil
+      end
+
+      data = envelope.find('me:data', 
+                           'me:http://salmon-protocol.org/ns/magic-env').first
+      if data.nil?
+        return nil
+      end
+
+      data_type = data.attributes["type"]
+      if data_type.nil?
+        data_type = 'application/atom+xml'
+        armored_data_type = ''
+      else
+        armored_data_type = Base64::urlsafe_encode64(data_type)
+      end
+
+      encoding = envelope.find('me:encoding',
+                               'me:http://salmon-protocol.org/ns/magic-env').first
+
+      algorithm = envelope.find(
+                          'me:alg',
+                          'me:http://salmon-protocol.org/ns/magic-env').first
+
+      signature = source.find('me:sig',
+                           'me:http://salmon-protocol.org/ns/magic-env').first
+
+      # Parse fields
+
+      if signature.nil?
+        # Well, if we cannot verify, we don't accept
+        return nil
+      else
+        # XXX: Handle key_id attribute
+        signature = signature.content
+        signature = Base64::urlsafe_decode64(signature)
+      end
+
+      if encoding.nil?
+        # When the encoding is omitted, use base64url
+        # Cite: Magic Envelope Draft Spec Section 3.3
+        armored_encoding = ''
+        encoding = 'base64url'
+      else
+        armored_encoding = Base64::urlsafe_encode64(encoding.content)
+        encoding = encoding.content.downcase
+      end
+
+      if algorithm.nil?
+        # When algorithm is omitted, use 'RSA-SHA256'
+        # Cite: Magic Envelope Draft Spec Section 3.3
+        armored_algorithm = ''
+        algorithm = 'rsa-sha256'
+      else
+        armored_algorithm = Base64::urlsafe_encode64(algorithm.content)
+        algorithm = algorithm.content.downcase
+      end
+
+      # Retrieve and decode data payload
+
+      data = data.content
+      armored_data = data
+
+      case encoding
+      when 'base64url'
+        data = Base64::urlsafe_decode64(data)
+      else
+        # Unsupported data encoding
+        return nil
+      end
+
+      # Signature plaintext
+      plaintext = "#{armored_data}.#{armored_data_type}.#{armored_encoding}.#{armored_algorithm}"
+
+      # Interpret data payload
+      payload = XML::Reader.string(data)
+      Salmon.new OStatus::Entry.new(payload), signature, plaintext
+    end
+
+    # Generate the xml for this Salmon notice and sign with the given private
+    # key.
+    def to_xml key
+      # Generate magic envelope
+      magic_envelope = XML::Document.new
+
+      magic_envelope.root = XML::Node.new 'env'
+
+      me_ns = XML::Namespace.new(magic_envelope.root, 
+                   'me', 'http://salmon-protocol.org/ns/magic-env')
+
+      magic_envelope.root.namespaces.namespace = me_ns
+
+      # Armored Data <me:data>
+      data = @entry.to_xml
+      @plaintext = data
+      data_armored = Base64::urlsafe_encode64(data)
+      elem = XML::Node.new 'data', data_armored, me_ns
+      elem.attributes['type'] = 'application/atom+xml'
+      data_type_armored = 'YXBwbGljYXRpb24vYXRvbSt4bWw='
+      magic_envelope.root << elem
+
+      # Encoding <me:encoding>
+      magic_envelope.root << XML::Node.new('encoding', 'base64url', me_ns)
+      encoding_armored = 'YmFzZTY0dXJs'
+
+      # Signing Algorithm <me:alg>
+      magic_envelope.root << XML::Node.new('alg', 'RSA-SHA256', me_ns)
+      algorithm_armored = 'UlNBLVNIQTI1Ng=='
+
+      # Signature <me:sig>
+      plaintext = "#{data_armored}.#{data_type_armored}.#{encoding_armored}.#{algorithm_armored}"
+      
+      # Assign @signature to the signature generated from the plaintext
+      sign(plaintext, key)
+
+      signature_armored = Base64::urlsafe_encode64(@signature)
+      magic_envelope.root << XML::Node.new('sig', signature_armored, me_ns)
+      
+      magic_envelope.to_s :indent => true, :encoding => XML::Encoding::UTF_8
+    end
+
+    # Return the EMSA string for this Salmon instance given the size of the
+    # public key modulus.
+    def signature modulus_byte_length
+      plaintext = Digest::SHA2.new(256).digest(@plaintext)
+
+      prefix = "\x30\x31\x30\x0d\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x01\x05\x00\x04\x20"
+      padding_count = modulus_byte_length - prefix.bytes.count - plaintext.bytes.count - 3
+
+      padding = ""
+      padding_count.times do 
+        padding = padding + "\xff"
+      end
+
+      "\x00\x01#{padding}\x00#{prefix}#{plaintext}"
+    end
+
+    def sign message, key
+      @plaintext = message 
+
+      modulus_byte_count = key.private_key.modulus.size
+
+      @signature = signature(modulus_byte_count)
+      @signature = key.decrypt(@signature)
+    end
+
+    # Use RSA to verify the signature
+    # key - RSA::KeyPair with the public key to use
+    def verified? key
+      # RSA encryption is needed to compare the signatures
+
+      # Get signature to check
+      emsa = self.signature key.public_key.modulus.size
+
+      # Get signature in payload
+      emsa_signature = key.encrypt(@signature)
+
+      # RSA gem drops leading 0s since it does math upon an Integer
+      # As a workaround, I check for what I expect the second byte to be (\x01)
+      # This workaround will also handle seeing a \x00 first if the RSA gem is
+      # fixed.
+      if emsa_signature.getbyte(0) == 1
+        emsa_signature = "\x00#{emsa_signature}"
+      end
+
+      # Does the signature match?
+      # Return the result.
+      emsa_signature == emsa
+    end
+  end
+end

data/lib/ostatus/thread.rb

@@ -0,0 +1,45 @@
+require 'xml/libxml'
+require 'atom/xml/parser.rb'
+
+module OStatus
+
+  # This will parse the Thread Atom extension
+  class Thread
+    include Atom::Xml::Parseable
+    attribute :ref, :type, :source
+    uri_attribute :href
+
+    def initialize(o)
+      case o
+      when XML::Reader
+        if current_node_is?(o, 'in-reply-to')
+          parse(o, :once => true)
+        else
+          raise ArgumentError, "Thread created with node other than thr:in-reply-to: #{o.name}"
+        end
+      when Hash
+        [:href, :ref, :type, :source].each do |attr|
+          self.send("#{attr}=", o[attr])
+        end
+      else
+        raise ArgumentError, "Don't know how to handle #{o}"
+      end
+    end
+
+    def length=(v)
+      @length = v.to_i
+    end
+     
+    def to_s
+      self.href
+    end
+
+    def ==(o)
+      o.respond_to?(:href) && o.href == self.href
+    end
+
+    def inspect
+      "<OStatus::Thread href:'#{href}' type:'#{type}'>"
+    end
+  end
+end

data/lib/ostatus/version.rb

@@ -1,3 +1,3 @@
 module OStatus
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/ostatus.rb

@@ -3,3 +3,5 @@ require_relative 'ostatus/entry'
 require_relative 'ostatus/author'
 require_relative 'ostatus/activity'
 require_relative 'ostatus/portable_contacts'
+require_relative 'ostatus/salmon'
+require_relative 'ostatus/thread'

data/ostatus.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "ostatus"
 
-  s.add_dependency "oauth"
   s.add_dependency "ratom"
   s.add_development_dependency "rspec"
 

data/spec/activity_spec.rb

@@ -1,6 +1,7 @@
 require_relative '../lib/ostatus/feed.rb'
 require_relative '../lib/ostatus/entry.rb'
 require_relative '../lib/ostatus/activity.rb'
+require_relative '../lib/ostatus/author.rb'
 
 describe OStatus::Activity do
   before(:each) do
@@ -12,8 +13,8 @@ describe OStatus::Activity do
   end
 
   describe "#object" do
-    it "should give a String containing the content of the activity:object tag" do
-      @activity.object.should eql('Foobar')
+    it "should give an Author containing the content of the activity:object tag" do
+      @activity.object.class.should eql(OStatus::Author)
     end
 
     it "should give nil when no activity:object was given" do

data/spec/feed_spec.rb

@@ -6,6 +6,13 @@ describe OStatus::Feed do
     @feed = OStatus::Feed.from_url('test/example_feed.atom')
   end
 
+  describe "#initialize" do
+    it "should detect a feed URI in an HTML page" do
+      @feed = OStatus::Feed.from_url('test/example_page.html')
+      @feed.url.should == 'test/example_feed.atom'
+    end
+  end
+
   describe "#atom" do
     it "should return a String containing the atom information" do
       @feed.atom.start_with?("<?xml").should eql(true)

data/test/example_feed.atom

@@ -71,7 +71,40 @@ bar</poco:note>
 	<link href="http://identi.ca/api/statuses/user_timeline/141464.atom" rel="self" type="application/atom+xml"/>
 	<entry>
 		<activity:object-type>http://activitystrea.ms/schema/1.0/note</activity:object-type>
-		<activity:object>Foobar</activity:object>
+		<activity:object>
+			<activity:object-type>http://activitystrea.ms/schema/1.0/person</activity:object-type>
+			<uri>http://identi.ca/user/141464</uri>
+			<name>greenmanspirit</name>
+			<email>foo@example.com</email>
+			<link rel="alternate" type="text/html" href="http://identi.ca/greenmanspirit"/>
+			<link rel="avatar" type="image/jpeg" media:width="480" media:height="480" href="http://avatar.identi.ca/141464-480-20100607212940.jpeg"/>
+			<link rel="avatar" type="image/jpeg" media:width="96" media:height="96" href="http://avatar.identi.ca/141464-96-20100607212940.jpeg"/>
+			<link rel="avatar" type="image/jpeg" media:width="48" media:height="48" href="http://avatar.identi.ca/141464-48-20100607212940.jpeg"/>
+			<link rel="avatar" type="image/jpeg" media:width="24" media:height="24" href="http://avatar.identi.ca/141464-24-20100607212940.jpeg"/>
+			<georss:point>0 0</georss:point>
+			<poco:preferredUsername>greenmanspirit</poco:preferredUsername>
+			<poco:displayName>Adam Hobaugh</poco:displayName>
+			<poco:id>foobar</poco:id>
+			<poco:name>barbaz</poco:name>
+			<poco:nickname>spaz</poco:nickname>
+			<poco:published>2012-02-21T02:15:14+00:00</poco:published>
+			<poco:updated>2013-02-21T02:15:14+00:00</poco:updated>
+			<poco:birthday>2014-02-21</poco:birthday>
+			<poco:anniversary>2015-02-21</poco:anniversary>
+			<poco:gender>male</poco:gender>
+			<poco:note>foo
+				bar</poco:note>
+			<poco:utcOffset>-08:00</poco:utcOffset>
+			<poco:connected>true</poco:connected>
+			<poco:urls>
+				<poco:type>homepage</poco:type>
+				<poco:value>http://adamhobaugh.com</poco:value>
+				<poco:primary>true</poco:primary>
+			</poco:urls>
+
+			<statusnet:profile_info local_id="141464"></statusnet:profile_info>
+		</activity:object>
+
 		<activity:target>Barbaz</activity:target>
 		<id>http://identi.ca/notice/64991641</id>
 		<title>staples come out of the head tomorrow, oh yeah</title>

data/test/example_page.html

@@ -0,0 +1,4 @@
+<html>
+	<!-- This is very invalid on purpose -->
+	<a rel="alternate" type="application/atom+xml" href="example_feed.atom">
+</html>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Hackers of the Severed Hand
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-02 00:00:00 -04:00
+date: 2011-05-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: ratom
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -30,23 +30,10 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ratom
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -55,7 +42,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 description: This project is to be used to jumpstart OStatus related projects that implement the PubSubHubbub protocols by providing the common fundamentals of Atom parsing and OStatus object creation.
 email: 
 - hotsh@xomb.org
@@ -76,6 +63,8 @@ files:
 - lib/ostatus/entry.rb
 - lib/ostatus/feed.rb
 - lib/ostatus/portable_contacts.rb
+- lib/ostatus/salmon.rb
+- lib/ostatus/thread.rb
 - lib/ostatus/version.rb
 - ostatus.gemspec
 - spec/activity_spec.rb
@@ -87,6 +76,7 @@ files:
 - test/example_feed.atom
 - test/example_feed_empty_author.atom
 - test/example_feed_false_connected.atom
+- test/example_page.html
 has_rdoc: true
 homepage: http://github.com/hotsh/ostatus
 licenses: []
@@ -129,3 +119,4 @@ test_files:
 - test/example_feed.atom
 - test/example_feed_empty_author.atom
 - test/example_feed_false_connected.atom
+- test/example_page.html