ruby-reddit 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 / 2008-01-22
+
+* 1 minor enhancement
+  * 1st release. Link scraping from reddit's hot and new pages.
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ruby-reddit
+lib/reddit.rb
+test/test_helper.rb
+test/test_reddit.rb

data/README.txt

@@ -0,0 +1,60 @@
+ruby-reddit
+    by Julia West
+    http://ruby-reddit.rubyforge.org
+
+== DESCRIPTION:
+  
+Interact with reddit.com. Read links and post links (coming soon!).
+
+== FEATURES/PROBLEMS:
+  
+* Scrapes links from reddit's hot page and new page.
+
+== SYNOPSIS:
+	
+	# Get all the "hot" links on the first page
+	links = Reddit::Data.read :hot, :page => 0
+	
+	# Check out the links!
+	for link in links
+		puts link.rank
+		puts link.site_id
+		puts link.url
+		puts link.title
+		puts link.date
+	end
+
+== REQUIREMENTS:
+
+* hpricot
+* open-uri
+* mechanize
+
+== INSTALL:
+
+* sudo gem install ruby-reddit
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Julia West
+
+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/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/reddit.rb'
+
+Hoe.new('ruby-reddit', Reddit::VERSION) do |p|
+  p.rubyforge_name = 'ruby-reddit'
+  p.author = 'Julia West'
+  p.email = 'juliamae@gmail.com'
+  p.summary = 'Plug reddit.com into your ruby apps.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/reddit.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby
+
+require "rubygems"
+require "hpricot"
+require "open-uri"
+require "mechanize"
+
+module Reddit
+  
+  VERSION = '0.1.0'
+  
+  DefaultOptions = {
+    :page => 0
+  }
+  
+  Subreddits = %w{programming science politics business gadgets sports gaming entertainment netsec}
+  
+  class Data
+    
+    def self.read(section, options)
+      conf = Reddit::DefaultOptions.update options
+      reader = Reader.new section, conf[:page]
+      reader.links
+    end
+    
+    def self.subreddit_url(subreddit)
+      "http://reddit.com/r/#{subreddit}/.rss"
+    end
+        
+  end
+  
+  class Reader
+    GuidRegExp        = /id=t3_(.+)$/
+    DescriptionRegExp = /href="(.+)">\[link\]/
+    
+    Urls = {
+      :hot  => "http://reddit.com/.rss",
+      :new  => "http://reddit.com/new.rss",
+    }
+        
+    def initialize(section, page)
+      @section  = section
+      @page     = page
+    end
+    
+    def links
+      index=0
+      collection = (page_data/:item).map do |item|
+        rank        = link_start + (index += 1)
+        site_id     = parse_guid((item/:guid).inner_html)
+        title       = (item/:title).inner_html
+        date        = (item/:"dc:date").inner_html
+        url         = parse_description((item/:description).inner_html)
+        
+        Link.new(rank, site_id, title, date, url)
+      end      
+    end
+    
+    def parse_guid(guid)
+      GuidRegExp.match(guid)[1]
+    end
+    
+    def parse_description(description)
+      DescriptionRegExp.match(description)[1]
+    end
+    
+    def page_data
+      params = "?count=#{link_start}"
+      doc = Hpricot.XML(open("#{Urls[@section]}#{params}"))
+    end
+    
+    def link_start
+      @page * 25
+    end
+  end
+  
+  class Link
+    attr_accessor :rank, :site_id, :url, :title, :date, :points, :author
+  
+    def initialize(rank, site_id, url, title, date, points=nil, author=nil)
+      @rank     = rank
+      @site_id  = site_id
+      @url      = url
+      @title    = title
+      @date     = date
+      @points   = points
+      @author   = author
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/reddit'

data/test/test_reddit.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RedditTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def assert_not_blank(attribute)
+    !attribute.nil? && attribute != ""
+  end
+  
+  def test_main_urls
+    for section, url in Reddit::Reader::Urls
+      page = open(url)  
+      assert_equal "200", page.status[0]
+    end
+  end
+  
+  def test_subreddit_urls
+    # First assert a bad subreddit will throw an HTTPError
+    assert_raise OpenURI::HTTPError do
+      page = open(Reddit::Data.subreddit_url("thefakestsubreddit"))
+    end
+    
+    # Now make sure these are all 200s
+    for subreddit in Reddit::Subreddits
+      page = open(Reddit::Data.subreddit_url(subreddit))  
+      assert_equal "200", page.status[0]
+    end
+  end
+  
+  def test_get_hot_links    
+    links = Reddit::Data.read :hot, :page => 0
+    
+    assert_equal 25, links.length
+    links.each_with_index do |link, index|
+      assert_equal index + 1, link.rank
+      assert_not_blank link.site_id
+      assert_not_blank link.url
+      assert_not_blank link.title
+      assert_not_blank link.date
+    end
+  end
+  
+  def test_parse_guid
+    reader      = Reddit::Reader.new :hot, 0
+    link_start  = reader.link_start
+    page_data   = reader.page_data
+    
+    item    = (page_data/:item)[0]
+    site_id = reader.parse_guid((item/:guid).inner_html)
+    
+    assert_not_blank site_id
+    assert site_id.length >= 4
+    assert /^[a-zA-Z0-9]+$/.match(site_id)
+  end
+  
+  def test_parse_description
+    reader      = Reddit::Reader.new :hot, 0
+    link_start  = reader.link_start
+    page_data   = reader.page_data
+    
+    (page_data/:item).each do |item|
+      assert URI.parse(reader.parse_description((item/:description).inner_html))
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-reddit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Julia West
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "== FEATURES/PROBLEMS:  * Scrapes links from reddit's hot page and new page.  == SYNOPSIS:  # Get all the \"hot\" links on the first page links = Reddit::Data.read :hot, :page => 0  # Check out the links! for link in links puts link.rank puts link.site_id puts link.url puts link.title puts link.date end  == REQUIREMENTS:  * hpricot * open-uri * mechanize"
+email: juliamae@gmail.com
+executables: 
+- ruby-reddit
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ruby-reddit
+- lib/reddit.rb
+- test/test_helper.rb
+- test/test_reddit.rb
+has_rdoc: true
+homepage: "    by Julia West"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: ruby-reddit
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Plug reddit.com into your ruby apps.
+test_files: 
+- test/test_helper.rb
+- test/test_reddit.rb