ruby_reddit_api 0.2.2 → 0.2.3

data/README.rdoc

@@ -0,0 +1,25 @@
+== Ruby Reddit Client v0.2.3
+Tested with ruby 1.8.7 & 1.9.2
+
+== Usage
+  require "ruby_reddit_api"
+  r = Reddit::Api.new "user", "password"
+  results = r.browse "ruby"
+  results[0].upvote
+ 
+== Features
+* Authentication
+* Browse subreddits
+* Searching
+* Read & reply to comments
+* Friend & unfriend redditors
+* Comment & submission voting
+
+
+== Running Tests
+1. Set up the reddit VM (http://blog.reddit.com/2010/05/admins-never-do-what-you-want-now-it-is.html)
+2. Ensure your hosts file has reddit.local pointing to the VM
+3. rake cucumber
+
+== License
+Ruby Reddit API is released under the MIT License.

data/features/search.feature

@@ -0,0 +1,6 @@
+Feature: Searching
+  I want to be able to search submissions
+
+  Scenario: Valid subreddit
+    Given I search 'test' with 'test'
+    Then I should get back search results

data/features/step_definitions/search_steps.rb

@@ -0,0 +1,13 @@
+Given /^I search '([^']+)' with '([^']+)'$/ do |subreddit, terms|
+  # FIXME searching isnt working for me by default in the reddit vm
+  Reddit::Base.base_uri "reddit.com"
+  Reddit::Api.base_uri "reddit.com"
+  @api       = Reddit::Api.new
+  @subreddit = subreddit
+  @terms     = terms
+end
+
+Then /^I should get back search results$/ do
+  results = @api.search(@terms, :in => @subreddit)
+  results[0].class.should == Reddit::Submission
+end

data/lib/ruby_reddit_api/api.rb

@@ -2,6 +2,7 @@ module Reddit
 
   # @author James Cook
   class Api < Base
+    attr_accessor :user, :password
     attr_reader :last_action, :debug
 
     def initialize(user=nil,password=nil, options={})
@@ -11,7 +12,7 @@ module Reddit
     end
 
     def inspect
-      "<Reddit::Api user='#{user}'>"
+      "<Reddit::Api>"
     end
 
     # Browse submissions by subreddit
@@ -26,6 +27,28 @@ module Reddit
       read("/r/#{subreddit}.json", options )
     end
 
+    # Search reddit
+    # @param [String, Hash] Search terms and options
+    # @example
+    #   search("programming", :in => "ruby", :sort => "relevance")
+    # @return [Array<Reddit::Submission>]
+    def search(terms=nil, options={})
+      http_options = {:verb => "get", :query => {}}
+      subreddit    = options[:in]
+      sort         = options.fetch(:sort){ "relevance" }
+      http_options[:query].merge!({:sort => sort})
+
+      if subreddit
+        http_options[:query].merge!({:restrict_sr => "1"})
+      end
+
+      if terms
+        http_options[:query].merge!({:q => terms})
+      end
+      path = subreddit.to_s == "" ? "/r/search.json" : "/r/#{subreddit}/search.json"
+      read(path, http_options)
+    end
+
     # Read sent messages
     # @return [Array<Reddit::Message>]
     def sent_messages

data/lib/ruby_reddit_api/base.rb

@@ -7,7 +7,7 @@ module Reddit
 
     attr_reader :last_action, :debug
     base_uri "www.reddit.com"
-    class << self; attr_reader :cookie, :modhash, :user_id, :user, end
+    class << self; attr_reader :cookie, :modhash, :user_id, :user end
 
     def initialize(options={})
       @debug    = StringIO.new
@@ -15,7 +15,7 @@ module Reddit
 
     # @return [String]
     def inspect
-      "<Reddit::Base user='#{user}'>"
+      "<Reddit::Base>"
     end
 
     # Login to Reddit and capture the cookie

data/lib/ruby_reddit_api/comment.rb

@@ -95,10 +95,12 @@ module Reddit
     def short_body
       str = body.to_s.strip
       if str.size > 15
-        str[0..15] + "..."
+        sb = str[0..15] + "..."
       else
-        body
+        sb = body
       end
+
+      sb.gsub(/[\n\r]/,'\n')
     end
 
     def add_distinction(verb)

data/lib/ruby_reddit_api/submission.rb

@@ -58,6 +58,7 @@ module Reddit
     def comments
       _comments = read( permalink + ".json", {:handler => "Comment", :query => {:limit => 250}} )
       @last_comment_id = _comments.last.id if _comments && _comments.any?
+      _comments.shift # First 'comment' is actually the submission
       return _comments
     end
 

data/lib/ruby_reddit_api/thing.rb

@@ -17,7 +17,8 @@ module Reddit
     # The author of the entity. The data is lazy-loaded and cached on the object
     # @return [Reddit::User]
     def author
-      @author_data ||= read("/user/#{@author}/about.json", :handler => "User")[0]
+      response = read("/user/#{@author}/about.json", :handler => "User") if @author
+      @author_data ||= response[0] if response
     end
 
     # Upvote thing

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - James Cook
@@ -64,22 +64,24 @@ files:
 - lib/ruby_reddit_api/api.rb
 - lib/ruby_reddit_api/json_listing.rb
 - lib/ruby_reddit_api/base.rb
-- README
+- README.rdoc
 - features/reddit.yml
 - features/submission.feature
 - features/comment.feature
 - features/user.feature
 - features/base.feature
 - features/message.feature
+- features/search.feature
 - features/api.feature
 - features/step_definitions/message_steps.rb
 - features/step_definitions/submission_steps.rb
+- features/step_definitions/search_steps.rb
 - features/step_definitions/api_steps.rb
 - features/step_definitions/user_steps.rb
 - features/step_definitions/comment_steps.rb
 - features/step_definitions/base_steps.rb
 - features/support/base_helpers.rb
-has_rdoc: false
+has_rdoc: yard
 homepage: http://github.com/jamescook/RubyRedditAPI
 licenses: []
 
@@ -94,8 +96,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -108,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: ruby_reddit_api
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
@@ -120,9 +124,11 @@ test_files:
 - features/user.feature
 - features/base.feature
 - features/message.feature
+- features/search.feature
 - features/api.feature
 - features/step_definitions/message_steps.rb
 - features/step_definitions/submission_steps.rb
+- features/step_definitions/search_steps.rb
 - features/step_definitions/api_steps.rb
 - features/step_definitions/user_steps.rb
 - features/step_definitions/comment_steps.rb

data/README

@@ -1,48 +0,0 @@
-Ruby Reddit Client v0.2.2
-==================
-Tested with ruby 1.9.2
-
-Usage:
-=======
-> require "ruby_reddit_api"
-> r = Reddit::Api.new "user", "password"
-> results = r.browse "ruby"
-> results[0].upvote
- 
-Features:
-========
-- Authentication
-- Browse submissions
-- Read comments
-- Friend/unfriend redditors
-- Comment & submission voting
-
-
-Running Tests:
-=============
-- Set up the reddit VM (http://blog.reddit.com/2010/05/admins-never-do-what-you-want-now-it-is.html)
-- Ensure your hosts file has reddit.local pointing to the VM
-- rake cucumber
-
-License
-(The MIT License)
-
-Copyright (c) 2010 James Cook
-
-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.