activity_streams 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ruben Fonseca
+
+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.

data/README.rdoc

@@ -0,0 +1,35 @@
+= activity_streams
+
+Very early activitystream parser (http://activitystrea.ms/). The goal is to eat XML or JSON
+descriptions of ActivityStreams and give a common interface to query the information on them.
+More source formats may be included in the future.
+
+Example usage:
+  require 'rubygems'
+  require 'activity_streams'
+  require 'open-uri'
+  
+  twitter = 'http://api.cliqset.com/feed/?svcuser=rubenfonseca&feedid=twitternotesposted'
+  feed = ActivityStreams::Feed.from_xml(open(twitter).read)
+  feed.entries.size #=> 20
+  feed.entries.first.verbs.size #=> 1
+  feed.entries.first.verbs.first #=> "http://activitystrea.ms/schema/1.0/post"
+  ...
+
+This module is in the very early stages, alpha quality :) Have fun!
+
+If you have any question, start by looking into the _spec_ directory.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ruben Fonseca. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activity_streams"
+    gem.summary = %Q{Ruby module to eat and parse ActivityStreams in various formats}
+    gem.description = %Q{Ruby module to eat and parse ActivityStreams in various formats}
+    gem.email = "root@cpan.org"
+    gem.homepage = "http://github.com/rubenfonseca/activity_streams"
+    gem.authors = ["Ruben Fonseca"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    
+    gem.add_dependency "sax-machine", ">= 0.0.15"
+    gem.add_dependency "feedzirra"
+    gem.add_dependency "json"
+    gem.add_dependency "hashie"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/activity_streams.rb

@@ -0,0 +1,137 @@
+require 'rubygems'
+require 'feedzirra'
+require 'json'
+require 'hashie'
+
+require 'activity_streams/feedzirra_patches'
+require 'activity_streams/common_fields'
+require 'activity_streams/portable_contact'
+
+module ActivityStreams
+  class Object
+    include CommonFields
+  end
+  
+  class Actor
+    include CommonFields
+  end
+  
+  class Target
+    include CommonFields
+  end
+  
+  class Context
+    include CommonFields
+  end
+  
+  class Feed < Hashie::Dash
+    attr_accessor :entries
+    attr_accessor :raw_structure
+    
+    # Creates a new Feed instance by parsing the XML string as an Atom feed with ActivityStreams
+    # extensions.
+    #
+    # @param [String] xml string representing an Atom feed with ActivityStreams extensions
+    # @return [Feed] a new instance filled with the data found on the XML string
+    def self.from_xml(xml)
+      unless defined?(@@_feedzirra_init)
+        @@_feedzirra_init = true
+        Feedzirra::Feed.add_common_feed_entry_elements("activity:verb", :as => :activity_verbs)
+        Feedzirra::Feed.add_common_feed_entry_elements("activity:object", :as => :activity_objects, :class => ActivityStreams::Object)
+        Feedzirra::Feed.add_common_feed_entry_element("activity:actor", :as => :activity_actor, :class => ActivityStreams::Actor)
+        Feedzirra::Feed.add_common_feed_entry_element("activity:target", :as => :activity_target, :class => ActivityStreams::Target)
+        Feedzirra::Feed.add_common_feed_entry_element("activity:context", :as => :activity_context, :class => ActivityStreams::Context)
+      end
+
+      res = Feed.new
+      res.raw_structure = Feedzirra::Feed.parse(xml)
+      res.entries = []
+      
+      res.raw_structure.entries.each do |entry|
+        e = Hashie::Mash.new
+        
+        # verbs
+        e.verbs = []
+        entry.activity_verbs.each do |verb|
+          e.verbs << verb
+        end
+        
+        # actor, target, context
+        [:actor, :target, :context].each do |area|
+          e[:actor]   ||= Hashie::Mash.new
+          e[:target]  ||= Hashie::Mash.new
+          e[:context] ||= Hashie::Hash.new
+          
+          [:id, :links, :object_types, :title, :author, :content].each do |attr|
+            unless entry.send("activity_#{area}").nil?
+              e.send(:[], area).send(:[]=, attr, entry.send("activity_#{area}").send(attr))
+            end
+          end
+        end
+        
+        # objects
+        e.objects = []
+        entry.activity_objects.each do |object|
+          o = Hashie::Mash.new
+          [:id, :links, :object_types, :title, :author, :content].each do |attr|
+            o[attr] = object.send(attr)
+          end
+          e.objects << o
+        end
+        
+        res.entries << e
+      end
+      
+      return res
+    end
+    
+    # Creates a new Feed instance by parsing the JSON string a list of JSON encoded ActivityStreams
+    #
+    # @param [String] json string representing a list of JSON encoded ActivityStreams
+    # @return [Feed] a new instance filled with the data found on the JSON string
+    def self.from_json(json)
+      res = Feed.new
+      res.raw_structure = JSON.parse(json)
+      res.entries = []
+      
+      res.raw_structure.map { |x| x['activity'] }.delete_if(&:nil?).each do |entry|
+        e = Hashie::Mash.new
+        
+        # verbs
+        e.verbs = []
+        entry['verbs'] && entry['verbs'].each do |verb|
+          e.verbs << verb
+        end
+        
+        # actor, target, context
+        [:actor, :target, :context].each do |area|
+          e[:actor]   ||= Hashie::Mash.new
+          e[:target]  ||= Hashie::Mash.new
+          e[:context] ||= Hashie::Hash.new
+          
+          [:id, :links, :object_types, :title, :author, :content].each do |attr|
+            unless entry.send(:[], area.to_s).nil?
+              json_attr = attr.to_s.gsub(/\_(\w)/) { $1.upcase }
+              e.send(:[], area).send(:[]=, attr, entry.send(:[], area.to_s).send(:[], json_attr))
+            end
+          end
+        end
+        
+        # objects
+        e.objects = []
+        entry['objects'] && entry['objects'].each do |object|
+          o = Hashie::Mash.new
+          [:id, :links, :object_types, :title, :author, :content].each do |attr|
+            json_attr = attr.to_s.gsub(/\_(\w)/) { $1.upcase }
+            o[attr] = object.send(:[], json_attr)
+          end
+          e.objects << o
+        end
+        
+        res.entries << e
+      end
+      
+      return res
+    end
+  end
+end

data/spec/activity_streams_spec.rb

@@ -0,0 +1,153 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActivityStreams", "twitter" do
+  before :all do
+    @twitter_xml = IO.read(File.expand_path(File.dirname(__FILE__) + "/twitter.xml"))
+    @feed = ActivityStreams::Feed.from_xml(@twitter_xml)
+  end
+  
+  it "should parse twitter example" do
+    @feed.should_not be_nil
+  end
+  
+  it "should have 20 entries" do
+    @feed.entries.size.should == 20
+  end
+  
+  it "should have a list of activity:verb on the first entry" do
+    verbs = @feed.entries.first.verbs
+    verbs.class.should == Array
+    verbs.size.should == 1
+    verbs.first.should =~ /post/
+  end
+  
+  it "should have a list of activity:object on the first entry" do
+    objects = @feed.entries.first.objects
+    objects.class.should == Array
+    objects.size.should == 1
+  end
+  
+  it "should parse a proper activity:object" do
+    object = @feed.entries.first.objects.first
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /note/
+    object.content.should == "rubenfonseca: @microft humm what about dropbox?"
+    
+    object.links.size.should == 1
+    object.links.first.should == "http://twitter.com/rubenfonseca/statuses/9108531677"
+  end
+  
+  it "should have an activity:actor on the first entry" do
+    object = @feed.entries.first.actor
+    object.should_not be_nil
+  end
+  
+  it "should parse a proper activity:actor" do
+    object = @feed.entries.first.actor
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /person/
+    object.title.should == "rubenfonseca"
+  end
+end
+
+describe "ActivityStreams", "lastfm" do
+  before :all do
+    @lastfm_xml = IO.read(File.expand_path(File.dirname(__FILE__) + "/lastfm.xml"))
+    @feed = ActivityStreams::Feed.from_xml(@lastfm_xml)
+  end
+  
+  it "should parse lastfm example" do
+    @feed.should_not be_nil
+  end
+  
+  it "should have 10 entries" do
+    @feed.entries.size.should == 10
+  end
+  
+  it "should have a list of activity:verb on the first entry" do
+    verbs = @feed.entries.first.verbs
+    verbs.class.should == Array
+    verbs.size.should == 1
+    verbs.first.should =~ /play/
+  end
+  
+  it "should have a list of activity:object on the first entry" do
+    objects = @feed.entries.first.objects
+    objects.class.should == Array
+    objects.size.should == 1
+  end
+  
+  it "should parse a proper activity:object" do
+    object = @feed.entries.first.objects.first
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /song/
+    object.title.should == "Sure Looks Good To Me"
+    object.author.should == "Alicia Keys"
+    
+    object.links.size.should == 1
+    object.links.first.should == "http://www.last.fm/music/Alicia+Keys/_/Sure+Looks+Good+To+Me"
+  end
+  
+  it "should have an activity:actor on the first entry" do
+    object = @feed.entries.first.actor
+    object.should_not be_nil
+  end
+  
+  it "should parse a proper activity:actor" do
+    object = @feed.entries.first.actor
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /person/
+    object.title.should == "krani1"
+  end
+end
+
+describe ActivityStreams, "myspace" do
+  before :all do
+    @myspace_json = IO.read(File.expand_path(File.dirname(__FILE__) + "/myspace.json"))
+    @feed = ActivityStreams::Feed.from_json(@myspace_json)
+  end
+  
+  it "should parse myspace example" do
+    @feed.should_not be_nil
+  end
+  
+  it "should have 1 entry" do
+    @feed.entries.size.should == 1
+  end
+  
+  it "should have a list of activity:verb on the first entry" do
+    verbs = @feed.entries.first.verbs
+    verbs.class.should == Array
+    verbs.size.should == 1
+    verbs.first.should =~ /post/
+  end
+  
+  it "should have a list of activity:object on the first entry" do
+    objects = @feed.entries.first.objects
+    objects.class.should == Array
+    objects.size.should == 1
+  end
+  
+  it "should parse a proper activity:object" do
+    object = @feed.entries.first.objects.first
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /photo/
+    object.title.should == ""
+    object.author.should == nil
+    
+    object.links.size.should == 1
+    object.links.first.should == "http://c2.ac-images.myspacecdn.com/images02/6/s_be8bb90eebb4c8725724f66dcb9414f1.png"
+  end
+  
+  it "should have an activity:actor on the first entry" do
+    object = @feed.entries.first.actor
+    object.should_not be_nil
+  end
+  
+  it "should parse a proper activity:actor" do
+    object = @feed.entries.first.actor
+    object.object_types.size.should == 1
+    object.object_types.first.should =~ /person/
+    object.title.should == "Brandon Black"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'activity_streams'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: activity_streams
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ruben Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sax-machine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.15
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: feedzirra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby module to eat and parse ActivityStreams in various formats
+email: root@cpan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/activity_streams.rb
+- spec/activity_streams_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubenfonseca/activity_streams
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby module to eat and parse ActivityStreams in various formats
+test_files: 
+- spec/activity_streams_spec.rb
+- spec/spec_helper.rb