lifestream 0.1.0

data/Rakefile

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'rake'
+
+require(File.join(File.dirname(__FILE__), 'lib', 'lifestream'))
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name              = "lifestream"
+    gem.summary           = %Q{downloads and parses lifestream information from sources like facebook and twitter}
+    gem.email             = "adamhunter@me.com"
+    gem.homepage          = "http://github.com/adamhunter/lifestream"
+    gem.authors           = ["Adam Hunter"]
+    #gem.rubyforge_project = "lifestream"
+    gem.files             = FileList["[A-Z]*", "{lib,test}/**/*"]
+    
+    #gem.add_dependency('httparty', '0.4.3')
+    
+    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('redgreen', '1.0.0')
+  end
+  
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lifestream #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :lifestream do
+  
+  desc "Generate lifestream.yml file"
+  task :configure do
+    
+  end
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/lifestream.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'erb'
+
+module Lifestream
+  
+  # Provides configurability to Lifestream. There are a number of options available, such as:
+  # * whiny: Will raise an error if Lifestream cannot process a given feed.  
+  #   Defaults to true 
+  # * config: Path to the lifestream.yml file that contains the feeds to download.
+  #   Defaults to gem location, you will probably want to set this
+  def self.options
+    @options ||= {
+      :config => File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lifestream.yml'),
+      :whiny  => true
+    }
+  end
+  
+  # Generates a Lifestream::Stream which contains all the channels
+  # with their branches parsed from the feeds in the lifestream.yml file, 
+  # ordered by their published_at date.
+  def self.run(preload = false)
+    lifestream = Lifestream::Stream.new
+    ensure_configuration_exists
+    
+    feeds = YAML.load(File.open(options[:config]))
+    feeds.each_pair do |name, options|
+      klass = Lifestream::Channel.const_get(options['format'])
+      channel = klass.new(name, options['url'])
+      channel.branches if preload
+      lifestream.channels << channel
+    end
+    lifestream
+  end
+  
+  protected
+  
+  def self.ensure_configuration_exists
+    raise Lifestream::NoConfiguration.new("You must provide a configuration file") unless File.exists?(options[:config])
+  end
+  
+  class NoConfiguration < StandardError; end
+  
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+# yes most of these are all named after parts of a stream
+# http://en.wikipedia.org/wiki/Stream#Parts_of_a_stream
+require File.join(directory, 'lifestream', 'branch')
+require File.join(directory, 'lifestream', 'channel')
+require File.join(directory, 'lifestream', 'channel', 'rss2')
+require File.join(directory, 'lifestream', 'request')
+require File.join(directory, 'lifestream', 'source')
+require File.join(directory, 'lifestream', 'stream')
+

data/lib/lifestream/branch.rb

@@ -0,0 +1,11 @@
+module Lifestream
+  class Branch
+    
+    attr_accessor :published_at, :title, :body
+    
+    def initialize published_at, title, body = nil
+      @published_at, @title, @body = published_at, title, body
+    end
+    
+  end
+end

data/lib/lifestream/channel.rb

@@ -0,0 +1,55 @@
+module Lifestream
+  class Channel
+    
+    attr_accessor :name, :branches, :raw_text, :feed
+    
+    def initialize name, url
+      @name, @branches, @request = name, [], Lifestream::Request.new(url)
+    end
+    
+    def branches
+      create_branches if @branches.empty?
+      @branches
+    end
+    
+    protected
+    
+    def download
+      response = @request.get
+      raise unless response.kind_of?(Net::HTTPSuccess)
+      @raw_data = response.body
+    rescue => e
+      Lifestream::Channel::DownloadError.new("The URL #{@request.url} failed to download") if Lifestream.options[:whiny]
+    end
+    
+    def create_branches
+      download
+      parse
+      feed_to_a.each do |item|
+        @branches << to_branch(item)
+      end
+    end
+    
+    def parse
+      raise_method_error :parse
+    end
+    
+    def feed_to_a
+      raise_method_error :feed_to_a
+    end
+    
+    def to_branch
+      raise_method_error :to_branch
+    end
+    
+    private
+    
+    def raise_method_error method
+      raise Lifestream::Channel::MethodError, "Method `#{method}` must be overriden in the child class"
+    end
+    
+    class MethodError < StandardError; end
+    class DownloadError < StandardError; end
+    
+  end
+end

data/lib/lifestream/channel/rss2.rb

@@ -0,0 +1,26 @@
+require 'rss/1.0'
+require 'rss/2.0'
+
+module Lifestream
+  class Channel::Rss2 < Lifestream::Channel
+   
+    protected
+  
+    def parse
+      @feed = RSS::Parser.parse(@raw_data, false)
+    rescue => e
+      raise Lifestream::Channel::Rss2::MalformedFeed.new("The feed from #{@url} could not be parsed") if Lifestream.options[:whiny]
+    end
+  
+    def feed_to_a
+      @feed.items || []
+    end
+  
+    def to_branch(branch)
+      Lifestream::Branch.new(branch.pubDate, branch.title, branch.description)
+    end
+  
+    class MalformedFeed < StandardError; end
+    
+  end
+end

data/lib/lifestream/request.rb

@@ -0,0 +1,42 @@
+module Lifestream
+  class Request
+    
+    attr_accessor :url, :max_redirects
+  
+    def initialize(url, options = {})
+      @url = url
+      options[:max_redirects] ||= 5
+      @max_redirects = options[:max_redirects]
+    end
+    
+    def get(url = @url)
+      check_max_redirects
+      url, request = build_request(url)
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.request(request)
+      end
+      if response.kind_of?(Net::HTTPRedirection)
+        @redirect += 1
+        get(response.header['location'])
+      else
+        response
+      end
+    end
+    
+    protected
+    
+    def build_request(url)
+       url = URI.parse(url)
+       request  = Net::HTTP::Get.new("#{url.path}?#{url.query}", {'User-Agent' => 'Gecko'})
+       return url, request
+    end
+    
+    def check_max_redirects
+      @redirect ||= 0
+      raise TooManyRedirects if @redirect > @max_redirects
+    end
+    
+    class TooManyRedirects < StandardError; end
+    
+  end
+end

data/lib/lifestream/source.rb

@@ -0,0 +1,13 @@
+module Lifestream
+  class Source
+    
+    # TODO: Implement this
+    def self.configure
+      yaml = ERB.new <<-EOF
+        
+      EOF
+      yaml.result
+    end
+    
+  end
+end

data/lib/lifestream/stream.rb

@@ -0,0 +1,20 @@
+module Lifestream
+  class Stream
+  
+    attr_accessor :channels
+  
+    def initialize channels = []
+      @channels = channels
+    end
+    
+    def branches
+      @branches ||= []
+      return @branches unless @branches.empty?
+      @channels.each do |channel|
+        channel.branches.each { |b| @branches << b }
+      end
+      @branches.sort { |a,b| a.published_at <=> b.published_at }.reverse
+    end
+    
+  end
+end

data/test/lifestream.yml

@@ -0,0 +1,9 @@
+facebook : 
+  url : http://www.facebook.com/feeds/status.php?id=778750315&viewer=778750315&key=110b5987c2&format=rss20
+  format : Rss2
+pandora : 
+  url : http://feeds.pandora.com/feeds/people/ah125i/favorites.xml
+  format : Rss2
+twitter : 
+  url : http://twitter.com/statuses/user_timeline/15344521.rss
+  format : Rss2

data/test/lifestream/stream_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class StreamTest < Test::Unit::TestCase
+  
+  context "A Lifestream::Stream instance" do
+    
+    setup { @lifestream = Lifestream.run }
+    
+    should "return its branches in descending chronological order" do
+      @lifestream.branches.should_not be_nil
+      @lifestream.branches[0].published_at.should > @lifestream.branches[1].published_at
+    end
+    
+  end
+  
+end

data/test/lifestream_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class LifestreamTest < Test::Unit::TestCase
+  
+  context "The Lifestream module" do
+    
+    should "create a Lifestream::Stream instance with all of its channels and branches" do
+      @lifestream = Lifestream::run
+      @lifestream.channels.size.should == 3
+      @lifestream.channels.each { |c| c.should_not be_nil }
+      @lifestream.channels.each { |c| c.should be_a(Lifestream::Channel::Rss2) }
+      @lifestream.channels.each do |c| 
+        c.branches.each { |b| b.should_not be_nil }
+        c.branches.each { |b| b.should be_a(Lifestream::Branch) }
+      end
+    end
+    
+    should "set the configuration file to the provided path" do
+      original_path = Lifestream.options[:config]
+      test_config_path = 'some/config'
+      Lifestream.options[:config] = test_config_path
+      Lifestream.options[:config].should == test_config_path
+      Lifestream.options[:config] = original_path
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'rubygems'
+
+gem 'thoughtbot-shoulda', '>= 2.10.1'
+gem 'jnunemaker-matchy', '0.4.0'
+gem 'mocha', '0.9.7'
+gem 'redgreen', '>= 1.0.0'
+
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+require 'fakeweb'
+require 'redgreen' unless ENV['TM_FILENAME']
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+require File.join(directory, '..', 'lib', 'lifestream')
+
+Lifestream.options[:config] = 'lifestream.yml'
+
+class Test::Unit::TestCase
+  
+  custom_matcher :be_nil do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be nil but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be nil but it was"
+    receiver.nil?
+  end
+  
+  custom_matcher :be_a do |receiver, matcher, args|
+    receiver.class == args[0]
+  end
+  
+  custom_matcher :be_empty do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be empty but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be empty but it was"
+    receiver.empty?
+  end
+  
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: lifestream
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: 
+email: adamhunter@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- lib/lifestream.rb
+- lib/lifestream/branch.rb
+- lib/lifestream/channel.rb
+- lib/lifestream/channel/rss2.rb
+- lib/lifestream/request.rb
+- lib/lifestream/source.rb
+- lib/lifestream/stream.rb
+- test/lifestream.yml
+- test/lifestream/branch_test.rb
+- test/lifestream/channel_test.rb
+- test/lifestream/source_test.rb
+- test/lifestream/stream_test.rb
+- test/lifestream_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/adamhunter/lifestream
+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: downloads and parses lifestream information from sources like facebook and twitter
+test_files: 
+- test/lifestream/branch_test.rb
+- test/lifestream/channel_test.rb
+- test/lifestream/source_test.rb
+- test/lifestream/stream_test.rb
+- test/lifestream_test.rb
+- test/test_helper.rb