bterlson-reddit 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-05-22
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Brian Terlson
+
+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/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/reddit.rb
+lib/reddit/article.rb
+lib/reddit/comment.rb
+lib/reddit/comment_list.rb
+lib/reddit/reddit.rb
+lib/reddit/resource_list.rb
+lib/reddit/session.rb
+lib/reddit/user.rb
+lib/reddit/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/reddit_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,66 @@
+= reddit
+
+* http://github.com/bterlson/reddit/
+
+== DESCRIPTION:
+
+An interface to the reddit API.
+
+== FEATURES/PROBLEMS:
+
+* Retreive articles and their comments
+* Retreive user pages
+
+== SYNOPSIS:
+
+require 'rubygems'
+require 'reddit'
+
+reddit = Reddit::Session.new
+
+reddit.main.articles.each do |article|
+  p article.url
+  
+  article.comments.each do |comment|
+    p comment.body
+  end
+end
+
+p reddit.subreddit("programming").articles[1].author
+
+reddit.user("radhruin").comments.each do |comment|
+  p comment.body
+end
+
+== REQUIREMENTS:
+
+* JSON >= 1.1.2 
+
+== INSTALL:
+
+* sudo gem install bterlson-reddit --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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,3 @@
+require 'rake/gempackagetask'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/reddit/article.rb

@@ -0,0 +1,44 @@
+module Reddit
+  # A reddit article or submission.
+  class Article
+    attr_reader :score, :name, :title, :comment_count, :ups, :downs, :url, :domain, :author, :id, :created_at
+    
+    # Initializes the data for the article.  Takes a hash of the various attributes as taken from the API.
+    def initialize(attributes)
+      @score = attributes['score']
+      @name = attributes['name']
+      @title = attributes['title']
+      @comment_count = attributes['num_comments']
+      @ups = attributes['ups']
+      @downs = attributes['downs']
+      @url = attributes['url']
+      @domain = attributes['domain']
+      @author = User.new(attributes['author']) unless attributes['author'].nil?
+      @id = attributes['id']
+      @created_at = Time.at(attributes['created']) unless attributes['created'].nil?
+      @saved = attributes['saved']
+      @clicked = attributes['clicked']
+      @hidden = attributes['hidden']
+    end
+    
+    # indicates if the current logged in user has saved the article.
+    def saved?
+      return @saved
+    end
+    
+    # indicates if the current logged in user has clicked the article.
+    def clicked?
+      return @clicked
+    end
+    
+    # indicates if the current logged in user has hidden the article.
+    def hidden?
+      return @hidden
+    end
+    
+    # returns a CommentList of this article's comments.
+    def comments
+      return CommentList.new(@id)
+    end
+  end
+end

data/lib/reddit/comment.rb

@@ -0,0 +1,33 @@
+module Reddit
+  
+  # A reddit comment.
+  class Comment
+    attr_reader :body, :name, :ups, :downs, :url, :domain, :author, :id, :created_at, :replies
+    
+    # Initializes the data for the comment.  Takes a hash of the various attributes as taken from the API.
+    def initialize(attributes)
+      @score = attributes['score']
+      @name = attributes['name']
+      @ups = attributes['ups']
+      @downs = attributes['downs']
+      @author = User.new(attributes['author']) unless attributes['author'].nil?
+      @id = attributes['id']
+      @created_at = Time.at(attributes['created']) unless attributes['created'].nil?
+      @body = attributes['body']
+      @replies = []
+      
+      unless attributes['replies'].nil?
+        attributes['replies']['data']['children'].each do |reply|
+          @replies << Comment.new(reply['data'])
+        end
+      end
+      
+    end
+    
+    # Returns the score for this comment.
+    def score
+      return @ups - @downs
+    end
+
+  end
+end

data/lib/reddit/comment_list.rb

@@ -0,0 +1,31 @@
+module Reddit
+  
+  # The list of comments found for an article.
+  class CommentList < ResourceList
+    
+    # Initializes a comments list.  Takes the ID of the article for which the comments belong to.
+    def initialize(article_id)
+      @article_id = article_id
+      @url = COMMENTS_URL.gsub('[id]', @article_id)
+    end
+    
+    # returns the top level comments for the thread.
+    def top_level
+      resources = get_resources(@url)
+      
+      comments = []
+      resources.each do |comment|
+        comments << Comment.new(comment['data'])
+      end
+      
+      return comments
+    end
+    
+    private
+    
+    # forward any method calls to the top level comments array.
+    def method_missing(meth, *args, &block)
+      top_level.send(meth, *args, &block)
+    end    
+  end
+end

data/lib/reddit/reddit.rb

@@ -0,0 +1,25 @@
+module Reddit
+  
+  # The main reddit or a subreddit.
+  class Reddit < ResourceList
+    
+    # Initialize the reddit.  If no name is specified, the reddit will be the main reddit.
+    def initialize(name = nil)
+      @name = name
+      @url = @name.nil? ? BASE_URL : SUBREDDIT_URL.gsub('[subreddit]', @name)
+    end
+    
+    # Returns the articles found in this reddit.
+    def articles      
+      resources = get_resources(@url)
+      
+      articles = []
+      
+      resources.each do |article|
+        articles << Article.new(article['data'])
+      end
+      
+      return articles
+    end
+  end
+end

data/lib/reddit/resource_list.rb

@@ -0,0 +1,27 @@
+module Reddit
+  
+  # A list of resources, such as a list of comments from an article or a user's page.
+  class ResourceList
+    attr_reader :url
+    
+    private
+    
+    # Grabs the resources at the URL and returns the parsed json.
+    def get_resources(url)
+      url = URI.parse(url)
+      
+      res = Net::HTTP.start(url.host, url.port) {|http|
+        http.get(url.path + ".json")
+      }
+      
+      raise SubredditNotFound if res.is_a?(Net::HTTPRedirection)
+      resources = JSON.parse(res.body, :max_nesting => 0)
+      
+      # comments pages are contained in an array where the first element is the article
+      # and the second is the actual comments.  This is hackish.
+      resources = resources.last if resources.is_a?(Array)
+      
+      return resources['data']['children']
+    end
+  end
+end

data/lib/reddit/session.rb

@@ -0,0 +1,41 @@
+module Reddit
+  BASE_URL = "http://www.beta.reddit.com/"
+  PROFILE_URL = BASE_URL + "user/[username]/"
+  SUBREDDIT_URL = BASE_URL + "r/[subreddit]/"
+  COMMENTS_URL = BASE_URL + "info/[id]/comments/"
+  
+  # raised when attempting to interact with a subreddit that doesn't exist.
+  class SubredditNotFound < StandardError; end
+  
+  # raised when attempting to interact with a profile that doesn't exist.
+  class ProfileNotFound < StandardError; end
+  
+  # raised when attempting to log in with incorrect credentials.
+  class AuthenticationException < StandardError; end
+  
+  # A reddit browsing session.
+  class Session
+
+    # initialize the session with a username and password.  Currently not used.
+    def initialize(username = "", password = "")
+      @username = username
+      @password = password
+    end
+    
+    # return the main reddit.
+    def main
+      return Reddit.new()
+    end
+    
+    # return a specific subreddit.
+    def subreddit(subreddit)
+      return Reddit.new(subreddit)
+    end
+    
+    # return a specific user's page.
+    def user(username)
+      return User.new(username)
+    end
+    
+  end
+end

data/lib/reddit/user.rb

@@ -0,0 +1,25 @@
+module Reddit
+  
+  # A user's page.
+  class User < ResourceList
+    attr_reader :name
+    
+    # Initialize based on the user's name.
+    def initialize(name)
+      @name = name
+      @url = PROFILE_URL.gsub('[username]', @name)
+    end
+    
+    # Get the user's comments.
+    def comments
+      resources = get_resources(@url)
+      
+      comments = []
+      resources.each do |comment|
+        comments << Comment.new(comment['data'])
+      end
+      
+      return comments
+    end
+  end
+end

data/lib/reddit/version.rb

@@ -0,0 +1,9 @@
+module Reddit #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/reddit.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'reddit/resource_list'
+require 'reddit/comment_list'
+require 'reddit/comment'
+require 'reddit/session'
+require 'reddit/version'
+require 'reddit/reddit'
+require 'reddit/article'
+require 'reddit/user'

data/spec/article_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::Article do
+  before do
+    @article = Reddit::Article.new({"id" => "id"})
+  end
+  
+  it "should be able to get the article's comments comments" do
+    Reddit::CommentList.should_receive(:new).with("id").and_return("reddit!")
+    @article.comments.should == "reddit!"
+  end
+end

data/spec/comment_list_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::CommentList do
+  before do
+    @comments_list = Reddit::CommentList.new('id')
+  end
+  
+  it "should know its url" do
+    @comments_list.url.should == Reddit::COMMENTS_URL.gsub('[id]', 'id')
+  end
+  
+  it "should fetch the top level comments" do
+    @comments_list.should_receive(:get_resources).and_return([
+        {:type => 't1', :data => {:attribute => 'value'}},
+        {:type => 't1', :data => {:attribute => 'value2'}}
+    ])
+    
+    mock_comment = mock(Reddit::Comment)
+    Reddit::Comment.should_receive(:new).twice.and_return(mock_comment)
+    
+    @comments_list.top_level.should == [mock_comment, mock_comment]
+  end
+  
+  it "should redirect method calls to the top level comments" do
+    top_level_mock = mock('top_level')
+    top_level_mock.should_receive(:[]).and_return("array")
+    @comments_list.stub!(:top_level).and_return(top_level_mock)
+    
+    @comments_list[1].should == "array"
+  end
+end

data/spec/comment_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::Comment do
+  before do
+    @comment = Reddit::Comment.new({
+      'ups' => 5,
+      'downs' => 6,
+      'replies' => {'data' => {'children' => [
+          {'data' => {'ups' => 1, 'downs' => 6}}
+        ]}}
+    })
+  end
+  
+  it "should have replies" do
+    @comment.replies.should_not be_nil
+  end
+  
+  it "should calculate its score" do
+    @comment.score.should == -1
+  end
+end

data/spec/reddit_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::Reddit do
+  before do
+    @reddit = Reddit::Reddit.new("programming")
+  end
+  
+  it "should know its url" do
+    @reddit.url.should == Reddit::SUBREDDIT_URL.gsub('[subreddit]', 'programming')
+  end
+  
+  it "should find the articles" do
+    @reddit.should_receive(:get_resources).and_return([
+        {:type => 't1', :data => {:attribute => 'value'}},
+        {:type => 't1', :data => {:attribute => 'value2'}}
+    ])
+    
+    mock_article = mock(Reddit::Article)
+    Reddit::Article.should_receive(:new).twice.and_return(mock_article)
+    
+    @reddit.articles.should == [mock_article, mock_article]
+  end
+end
+
+describe Reddit::Reddit, "With no subreddit specified" do
+  it "should use the main reddit" do
+    reddit = Reddit::Reddit.new()
+    reddit.url.should == Reddit::BASE_URL
+  end  
+end

data/spec/resource_list_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::ResourceList, ".get_resources" do
+  before do
+    @resource_list = Reddit::ResourceList.new
+    @http_mock = mock('http')
+    @http_mock.stub!(:get)
+    @response_mock = mock(Net::HTTPResponse)
+    @response_mock.stub!(:body).and_return('{"kind": "Listing", "data": {"children": [{"kind": "t3", "data": {"attribute": "value"}}]}}')
+    Net::HTTP.stub!(:start).and_yield(@http_mock).and_return(@response_mock)
+  end
+  
+  it "should get the resources from Reddit" do
+    Net::HTTP.should_receive(:start).and_yield(@http_mock).and_return(@response_mock)
+    @resource_list.send(:get_resources, "http://reddit.com")
+  end
+  
+  it "should parse the JSON" do
+    JSON.should_receive(:parse).and_return({'kind' => 'Listing', 'data' => {'children' => [{'data' => {'attribute' => 'value'}}]}})
+    @resource_list.send(:get_resources, "http://reddit.com")
+  end
+  
+  it "should raise an error when the subreddit is not found" do
+    reddit = Reddit::Reddit.new("not found")
+    @response_mock.stub!(:is_a?).and_return(Net::HTTPRedirection)
+    
+    proc {@resource_list.send(:get_resources, "http://reddit.com")}.should raise_error(Reddit::SubredditNotFound)
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::Session, "without logging in" do
+  
+  before(:each) do
+    @reddit = Reddit::Session.new()
+  end
+
+  it "should grab the main page" do
+    @reddit.main.should_not be_nil
+  end
+  
+  it "should grab a user's profile page" do
+    @reddit.user("radhruin").should_not be_nil
+  end
+  
+  it "should grab a subreddit" do
+    @reddit.subreddit("programming").should_not be_nil
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'reddit'

data/spec/user_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Reddit::User do
+  before do
+    @user = Reddit::User.new('radhruin')
+  end
+  
+  it "should know its url" do
+    @user.url.should == Reddit::PROFILE_URL.gsub('[username]', 'radhruin')
+  end
+  
+  it "should fetch the user's comments" do
+    @user.should_receive(:get_resources).and_return([
+        {:type => 't1', :data => {:attribute => 'value'}},
+        {:type => 't1', :data => {:attribute => 'value2'}}
+    ])
+    
+    mock_comment = mock(Reddit::Comment)
+    Reddit::Comment.should_receive(:new).twice.and_return(mock_comment)
+    
+    @user.comments.should == [mock_comment, mock_comment]
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: bterlson-reddit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Terlson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: 
+email: btthalion@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- History.txt
+- lib/reddit.rb
+- lib/reddit/article.rb
+- lib/reddit/comment.rb
+- lib/reddit/comment_list.rb
+- lib/reddit/reddit.rb
+- lib/reddit/resource_list.rb
+- lib/reddit/session.rb
+- lib/reddit/user.rb
+- lib/reddit/version.rb
+- License.txt
+- Manifest.txt
+- Rakefile
+- README.txt
+- spec/article_spec.rb
+- spec/comment_list_spec.rb
+- spec/comment_spec.rb
+- spec/reddit_spec.rb
+- spec/resource_list_spec.rb
+- spec/session_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/user_spec.rb
+- tasks/environment.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/bterlson/reddit/
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: Interface with the Reddit.com API.
+test_files: []
+