bterlson-reddit 0.2.1 → 0.3.0

data/lib/reddit/article.rb

@@ -15,6 +15,7 @@ module Reddit
       @domain = attributes['domain']
       @author = User.new(attributes['author']) unless attributes['author'].nil?
       @id = attributes['id']
+      # Reddit's created_at timestamps are currently wonky, so this will return the wrong time.
       @created_at = Time.at(attributes['created']) unless attributes['created'].nil?
       @saved = attributes['saved']
       @clicked = attributes['clicked']
@@ -37,8 +38,9 @@ module Reddit
     end
     
     # returns a CommentList of this article's comments.
-    def comments
-      return CommentList.new(@id)
+    def comments(options = {})
+      @comments_list ||= CommentList.new(@id)
+      return @comments_list.top_level(options)
     end
   end
 end

data/lib/reddit/comment.rb

@@ -1,5 +1,4 @@
 module Reddit
-  
   # A reddit comment.
   class Comment
     attr_reader :body, :name, :ups, :downs, :url, :domain, :author, :id, :created_at, :replies
@@ -21,7 +20,6 @@ module Reddit
           @replies << Comment.new(reply['data'])
         end
       end
-      
     end
     
     # Returns the score for this comment.
@@ -29,5 +27,9 @@ module Reddit
       return @ups - @downs
     end
 
+    # returns a number representing how controversial this comment is
+    def controversy_score
+      (@ups + @downs).to_f / [score.abs, 1].max
+    end
   end
 end

data/lib/reddit/comment_list.rb

@@ -10,15 +10,10 @@ module Reddit
     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'])
+    def top_level(options = {})
+      get_resources(@url, :querystring => options[:querystring], :count => options[:count]) do |resource_json|
+        comment = Comment.new(resource_json['data'])
       end
-      
-      return comments
     end
     
     private
@@ -26,6 +21,6 @@ module Reddit
     # 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
 end

data/lib/reddit/reddit.rb

@@ -9,33 +9,37 @@ module Reddit
       @url = @name.nil? ? BASE_URL : SUBREDDIT_URL.gsub('[subreddit]', @name)
     end
     
-    def hot
-      articles 'hot'
+    def hot(options = {})
+      articles 'hot', options
     end
     
-    def top
-      articles 'top'
+    def top(options = {})
+      articles 'top', options
     end
     
-    def new
-      articles 'new'
+    def new(options = {})
+      options[:querystring] = 'sort=new'
+      articles 'new', options
     end
     
-    def controversial
-      articles 'controversial'
+    def rising(options = {})
+      options[:querystring] = 'sort=rising'
+      articles 'new', options
+    end
+    
+    def controversial(options = {})
+      articles 'controversial', options
     end
     
     # Returns the articles found in this reddit.
-    def articles(page = 'hot')
-      resources = get_resources("#{@url}#{page}/")
-      
-      articles = []
-      
-      resources.each do |article|
-        articles << Article.new(article['data'])
+    # Options are:
+    #   Count: Return at least this many articles.
+    #   Querystring: Querystring to append to resource request
+    
+    def articles(page = 'hot', options = {})
+      get_resources("#{@url}#{page}", options) do |resource_json|
+        Article.new(resource_json['data'])
       end
-      
-      return articles
     end
   end
 end

data/lib/reddit/resource_list.rb

@@ -7,22 +7,36 @@ module Reddit
     private
     
     # Grabs the resources at the URL and returns the parsed json.
-    def get_resources(url)
-      puts "Getting URL: #{url}"
+    def get_resources(url, options = {}, &block)
+      querystring = options.delete(:querystring) || ''
+      count = options.delete(:count) || 25
       url = URI.parse(url)
+      items = []
+      after = ''
       
-      res = Net::HTTP.start(url.host, url.port) {|http|
-        http.get(url.path + ".json")
-      }
+      while items.size < count
+        res = Net::HTTP.start(url.host, url.port) {|http|
+          http.get("#{url.path}.json?#{querystring}&after=#{after}&limit=#{count - items.size}")
+        }
       
-      raise SubredditNotFound if res.is_a?(Net::HTTPRedirection)
-      resources = JSON.parse(res.body, :max_nesting => 0)
+        raise SubredditNotFound if res.is_a?(Net::HTTPRedirection)
       
-      # 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)
+        resources = JSON.parse(res.body, :max_nesting => 0)
       
-      return resources['data']['children']
+        # 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)
+        resources = resources['data']['children']
+        break if resources.size == 0
+        resources.each do |resource|
+          items << yield(resource)
+        end
+        
+        after = items.last.name
+      end
+      
+      items
     end
   end
+  
 end

data/lib/reddit/session.rb

@@ -2,7 +2,7 @@ module Reddit
   BASE_URL = "http://www.reddit.com/"
   PROFILE_URL = BASE_URL + "user/[username]/"
   SUBREDDIT_URL = BASE_URL + "r/[subreddit]/"
-  COMMENTS_URL = BASE_URL + "info/[id]/comments/"
+  COMMENTS_URL = BASE_URL + "comments/[id]/"
   
   # raised when attempting to interact with a subreddit that doesn't exist.
   class SubredditNotFound < StandardError; end

data/lib/reddit/user.rb

@@ -11,15 +11,12 @@ module Reddit
     end
     
     # Get the user's comments.
-    def comments
-      resources = get_resources(@url)
-      
-      comments = []
-      resources.each do |comment|
-        comments << Comment.new(comment['data'])
+    # Options can include a limit, which sets the number of comments to return.
+    
+    def comments(options = {})
+      get_resources("#{@url}comments/", :querystring => options[:querystring], :count => options[:count]) do |resource_json|
+        Comment.new(resource_json['data'])
       end
-      
-      return comments
     end
   end
 end

data/lib/reddit/version.rb

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

data/spec/article_spec.rb

@@ -6,7 +6,7 @@ describe Reddit::Article do
   end
   
   it "should be able to get the article's comments comments" do
-    Reddit::CommentList.should_receive(:new).with("id").and_return("reddit!")
+    Reddit::CommentList.should_receive(:new).with("id").and_return(mock(Reddit::CommentList, :top_level => "reddit!"))
     @article.comments.should == "reddit!"
   end
 end

data/spec/comment_list_spec.rb

@@ -10,13 +10,9 @@ describe Reddit::CommentList do
   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.should_receive(:get_resources).and_return([mock_comment, mock_comment])
     
     @comments_list.top_level.should == [mock_comment, mock_comment]
   end

data/spec/reddit_spec.rb

@@ -17,18 +17,15 @@ describe Reddit::Reddit do
   end
   
   it "should find the articles" do
-    @reddit.should_receive(:get_resources).and_return(test_articles)
-    
     mock_article = mock(Reddit::Article)
-    Reddit::Article.should_receive(:new).twice.and_return(mock_article)
-    
+    @reddit.should_receive(:get_resources).and_return([mock_article, mock_article])
     @reddit.articles.should == [mock_article, mock_article]
   end
   
   it "should find top articles" do
     mock_article = mock(Reddit::Article)
     
-    @reddit.should_receive(:articles).with('top').and_return([mock_article, mock_article])
+    @reddit.should_receive(:articles).with('top', {}).and_return([mock_article, mock_article])
     
     @reddit.top.should == [mock_article, mock_article]
   end
@@ -36,15 +33,23 @@ describe Reddit::Reddit do
   it "should find new articles" do
     mock_article = mock(Reddit::Article)
     
-    @reddit.should_receive(:articles).with('new').and_return([mock_article, mock_article])
+    @reddit.should_receive(:articles).with('new', {:querystring => 'sort=new'}).and_return([mock_article, mock_article])
     
     @reddit.new.should == [mock_article, mock_article]
   end
   
+  it "should find rising articles" do
+    mock_article = mock(Reddit::Article)
+    
+    @reddit.should_receive(:articles).with('new',  {:querystring => 'sort=rising'}).and_return([mock_article, mock_article])
+    
+    @reddit.rising.should == [mock_article, mock_article]
+  end
+  
   it "should find controversial articles" do
     mock_article = mock(Reddit::Article)
     
-    @reddit.should_receive(:articles).with('controversial').and_return([mock_article, mock_article])
+    @reddit.should_receive(:articles).with('controversial', {}).and_return([mock_article, mock_article])
     
     @reddit.controversial.should == [mock_article, mock_article]
   end
@@ -52,7 +57,7 @@ describe Reddit::Reddit do
   it "should find hot articles" do
     mock_article = mock(Reddit::Article)
     
-    @reddit.should_receive(:articles).with('hot').and_return([mock_article, mock_article])
+    @reddit.should_receive(:articles).with('hot', {}).and_return([mock_article, mock_article])
     
     @reddit.hot.should == [mock_article, mock_article]
   end

data/spec/resource_list_spec.rb

@@ -12,12 +12,23 @@ describe Reddit::ResourceList, ".get_resources" do
   
   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")
+    @resource_list.send(:get_resources, "http://reddit.com", :count => 1) do
+      mock('object', :name => "object_name")
+    end
+  end
+  
+  it "should get the specified number of resources" do
+    Net::HTTP.should_receive(:start).exactly(:twice).and_yield(@http_mock).and_return(@response_mock)
+    @resource_list.send(:get_resources, "http://reddit.com", :count => 2) do
+      mock('object', :name => "object_name")
+    end
   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")
+    @resource_list.send(:get_resources, "http://reddit.com", :count => 1) do
+      mock('object', :name => "object_name")
+    end
   end
   
   it "should raise an error when the subreddit is not found" do

data/spec/user_spec.rb

@@ -10,14 +10,8 @@ describe Reddit::User do
   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.should_receive(:get_resources).and_return([mock_comment, mock_comment])
     @user.comments.should == [mock_comment, mock_comment]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bterlson-reddit
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brian Terlson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-13 00:00:00 -07:00
+date: 2008-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Interface with the Reddit.com API.

data/README.txt

@@ -1,66 +0,0 @@
-= 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.