ruby_reddit_api 0.1.9

data/README

@@ -0,0 +1,47 @@
+Ruby Reddit Client v0.1.9
+==================
+Tested with 1.9.2
+
+Usage:
+=======
+> require "ruby_reddit_api"
+> r = Reddit::Api.new "user", "password"
+> results = r.browse "ruby"
+> results[0].upvote
+ 
+Features:
+========
+- Authentication
+- Parse submissions
+- Comments parsing
+- Vote on submission
+
+
+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.

data/features/api.feature

@@ -0,0 +1,10 @@
+Feature: Browsing
+  I want to be able to browse submissions
+
+  Scenario: Valid subreddit
+    Given I submit a valid subreddit
+    Then I should get back a listing of submissions
+
+  Scenario: Invalid subreddit
+    Given I submit a invalid subreddit
+    Then I should get back some error

data/features/base.feature

@@ -0,0 +1,15 @@
+Feature: Authentication
+  In order perform things like voting and commenting
+  As a Redditor
+  I want to be able to login in my step definitions
+
+  Scenario: Valid user and password
+    Given I have a valid user
+    And I send my user and password to the login API
+    Then I should have a valid cookie
+    And the stored headers should refer to the cookie
+
+  Scenario: Invalid user and password
+    Given I have a invalid user
+    And I send my user and password to the login API
+    Then I should not have a valid cookie

data/features/comment.feature

@@ -0,0 +1,40 @@
+Feature: Comments
+  I want to be able to comment on a comment
+  I want to be able to delete my comments
+
+  Scenario: Valid comment text
+    Given I enter some text
+    Then I should be able to add a comment
+
+  Scenario: I want to hide a comment
+    Given I have a comment
+    Then I should be able to hide the comment
+
+  Scenario: I want to remove a comment
+    Given I have a comment
+    Then I should be able to remove the comment
+
+  Scenario: I want to approve a comment
+    Given I have a comment
+    Then I should be able to approve the comment
+
+  Scenario: I want to edit a comment
+    Given I have a comment
+    Then I should be able to edit the comment
+
+  Scenario: I want to comment on a comment
+    Given I have a comment
+    Then I should be able to reply to the comment
+
+  Scenario: I want to moderator distinguish a comment
+    Given I have a comment
+    Then I should be able to moderator distinguish the comment
+
+  Scenario: I want to indistinguish a comment
+    Given I have a comment
+    Then I should be able to indistinguish the comment
+
+  Scenario: I want to admin distinguish a comment
+    Given I have a comment
+    Then I should be able to admin distinguish the comment
+

data/features/message.feature

@@ -0,0 +1,5 @@
+Feature: Messaging
+  Scenario: I want to be able to read my sent messages
+    Given I am logged in
+    When I go to the sent messages page
+    Then I should see a listing of messages

data/features/reddit.yml

@@ -0,0 +1,5 @@
+server:
+  address: "reddit.local"
+  port: 80
+  test_user: "reddit"
+  test_pass: "password"

data/features/step_definitions/api_steps.rb

@@ -0,0 +1,22 @@
+Given /^I submit a valid subreddit$/ do
+  Reddit::Api.base_uri "reddit.local"
+  @api = Reddit::Api.new "reddit", "password"
+  @subreddit = "reddit_test0"
+end
+
+Then /^I should get back a listing of submissions$/ do
+  results = @api.browse(@subreddit)
+  results[0].class.should == Reddit::Submission
+  results[0].author.should_not == nil
+end
+
+Given /^I submit a invalid subreddit$/ do
+  Reddit::Api.base_uri "reddit.local"
+  @api = Reddit::Api.new "reddit", "password"
+  @subreddit = "invalid_subreddit"
+end
+
+Then /^I should get back some error$/ do
+  results = @api.browse(@subreddit)
+  results.should == false
+end

data/features/step_definitions/base_steps.rb

@@ -0,0 +1,49 @@
+require File.join( File.dirname(__FILE__), "..", "..", "lib", "ruby_reddit_api.rb")
+Before do
+  Reddit::Base.instance_variable_set("@cookie", nil)
+  load_server_config
+  Reddit::Api.base_uri @address
+end
+
+Given /^I have a valid user$/ do
+  load_server_config
+end
+
+Given /^I have a invalid user$/ do
+  @user, @pass = "invalid", "user"
+end
+
+Given /^I send my user and password to the login API$/ do
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+Given /I'm logged in$/ do
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+Given /I'm not logged in$/ do
+  @api.logout if @api
+  @api = Reddit::Api.new @user, "bad pass"
+  @api.logout
+end
+
+Then /^I should have a valid cookie$/ do
+  @api.cookie.should_not == nil
+  @api.cookie.should     =~ /reddit_session/
+end
+
+Then /^I should not have a valid cookie$/ do
+  @api.cookie.should_not == nil
+  @api.cookie.should =~ /reddit_first/
+end
+
+Then /^I should not have a cookie$/ do
+  @api.cookie.should == nil
+end
+
+Then /^the stored headers should refer to the cookie$/ do
+  @api.base_headers["Cookie"].should == @api.cookie
+end
+

data/features/step_definitions/comment_steps.rb

@@ -0,0 +1,59 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::Submission.base_uri @address
+  Reddit::Comment.base_uri @address
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+  @submission ||= @api.browse("reddit_test0")[0]
+end
+
+Given /^I enter some text$/ do
+  @text = "SOME COMMENT"
+end
+
+Then /^I should be able to add a comment$/ do
+  @submission.add_comment(@text).should be true
+end
+
+Given /^I have a comment$/ do
+  @submission.add_comment("a comment")
+  @comment = @submission.comments.last
+end
+
+Then /^I should be able to hide the comment$/ do
+  @comment.hide
+end
+
+Then /^I should be able to remove the comment$/ do
+  @comment.remove
+end
+
+Then /^I should be able to approve the comment$/ do
+  @comment.approve
+end
+
+Then /^I should not be able to edit the comment$/ do
+  @comment.edit( "1234" ).should be false
+end
+
+Then /^I should be able to edit the comment$/ do
+  @comment.edit( "1234" ).should be true
+end
+
+Then /^I should be able to moderator distinguish the comment$/ do
+  pending #@comment.moderator_distinguish
+end
+
+Then /^I should be able to indistinguish the comment$/ do
+  pending #@comment.indistinguish
+end
+
+Then /^I should be able to admin distinguish the comment$/ do
+  pending #@comment.admin_distinguish
+end
+
+Then /^I should be able to reply to the comment$/ do
+  pending #@comment.reply("a reply").should be true
+end
+

data/features/step_definitions/message_steps.rb

@@ -0,0 +1,18 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::Message.base_uri @address
+end
+
+Given /^I am logged in$/ do
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+When /^I go to the sent messages page$/ do
+  @result = @api.sent_messages
+end
+
+Then /^I should see a listing of messages$/ do
+  @result.any?{|r| r.is_a?(Reddit::Message) == false}.should be false
+end

data/features/step_definitions/submission_steps.rb

@@ -0,0 +1,117 @@
+Given /^I have a submission$/ do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::Submission.base_uri @address
+  Reddit::Comment.base_uri @address
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+  @submission = @api.browse("reddit_test0")[0]
+  if @api.logged_in?
+    @submission.add_comment("STOP REPOSTING!!1") if @submission
+  else
+    raise "Can't run test. Submit failed.."
+  end
+end
+
+Then /^I should be able to see the author$/ do
+  @submission.author.should_not == nil
+end
+
+Then /^I should be able to see the title$/ do
+  @submission.title.should_not == nil
+end
+
+Then /^I should be able to see the selftext$/ do
+  @submission.selftext.should_not == nil
+end
+
+Then /^I should be able to see the url$/ do
+  @submission.url.should_not == nil
+end
+
+Then /^I should be able to see the up votes$/ do
+  @submission.ups.should_not == nil
+end
+
+Then /^I should be able to see the down votes$/ do
+  @submission.downs.should_not == nil
+end
+
+Then /^I should not be able to upvote it$/ do
+  @submission.upvote.should be false
+end
+
+Then /^I should not be able to downvote it$/ do
+  @submission.downvote.should be false
+end
+
+Then /^I should be able to upvote it$/ do
+  @submission.upvote.should be true
+end
+
+Then /^I should be able to downvote it$/ do
+  @submission.downvote.should be true
+end
+
+Then /^I should be able to see the comments$/ do
+  comments = @submission.comments
+  comments.size.should > 0
+end
+
+Then /^I should not be able to save the submission$/ do
+  @submission.save.should be false
+end
+
+Then /^I should not be able to unsave the submission$/ do
+  @submission.unsave.should be false
+end
+
+Then /^I should not be able to hide the submission$/ do
+  @submission.hide.should be false
+end
+
+Then /^I should not be able to unhide the submission$/ do
+  @submission.unhide.should be false
+end
+
+Then /^I should be able to save the submission$/ do
+  @submission.save.should be true
+end
+
+Then /^I should be able to unsave the submission$/ do
+  @submission.unsave.should be true
+end
+
+Then /^I should be able to hide the submission$/ do
+  result = @submission.hide
+  @submission.unhide if result
+  result.should be true
+end
+
+Then /^I should be able to unhide the submission$/ do
+  @submission.unhide.should be true
+end
+
+Then /^I should be able to report the submission$/ do
+  @submission.report.should be true
+end
+
+Then /^I should not be able to report the submission$/ do
+  @submission.report.should be false
+end
+
+Then /^I should be able to see more comments if needed$/ do
+  pending
+end
+
+Then /^I should be able to moderator distinguish the submission$/ do
+  @submission.moderator_distinguish
+end
+
+Then /^I should be able to admin distinguish the submission$/ do
+  @submission.admin_distinguish
+end
+
+Then /^I should be able to indistinguish the submission$/ do
+  @submission.indistinguish
+end

data/features/step_definitions/user_steps.rb

@@ -0,0 +1,25 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::Submission.base_uri @address
+  Reddit::Comment.base_uri @address
+  Reddit::User.base_uri @address
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+Given /^I select a redditor$/ do
+  @submission = @api.browse("reddit_test1")[0]
+  @user = @submission.author
+end
+
+Then /^I should be able to friend them$/ do
+  @user.friend.should be true
+end
+
+Then /^I should be able to unfriend them$/ do
+  @user.unfriend.should be true
+end
+
+
+

data/features/submission.feature

@@ -0,0 +1,58 @@
+Feature: Submissions
+  I want to be able to peruse the submission details
+  And I want to be able to up vote the submission
+  And I want to be able to down vote the submission
+  And I want to be able to save submissions I like
+  And I want to be able to unsave submissions
+
+
+  Scenario: Viewing a submission
+    Scenario: When not logged in
+      Given I have a submission
+      And I'm not logged in
+      Then I should be able to see the author
+      And I should be able to see the title
+      And I should be able to see the selftext
+      And I should be able to see the url
+      And I should be able to see the up votes
+      And I should be able to see the down votes
+      And I should be able to see the comments
+      But I should not be able to upvote it
+      But I should not be able to downvote it
+      But I should not be able to save the submission
+      But I should not be able to unsave the submission
+      But I should not be able to hide the submission
+      But I should not be able to unhide the submission
+      But I should not be able to report the submission
+      And I should be able to see more comments if needed
+
+    Scenario: When logged in
+      Given I have a submission
+      And I'm logged in
+      Then I should be able to see the author
+      And I should be able to see the title
+      And I should be able to see the selftext
+      And I should be able to see the url
+      And I should be able to see the up votes
+      And I should be able to see the down votes
+      And I should be able to see the comments
+      And I should be able to upvote it
+      And I should be able to downvote it
+      And I should be able to save the submission
+      And I should be able to unsave the submission
+      And I should be able to hide the submission
+      And I should be able to unhide the submission
+      And I should be able to report the submission
+      And I should be able to see more comments if needed
+
+    Scenario: I want to moderator distinguish a submission
+      Given I have a submission
+      Then I should be able to moderator distinguish the submission
+
+    Scenario: I want to admin distinguish a submission
+      Given I have a submission
+      Then I should be able to admin distinguish the submission
+
+    Scenario: I want to indistinguish a submission
+      Given I have a submission
+      Then I should be able to indistinguish the submission

data/features/support/base_helpers.rb

@@ -0,0 +1,17 @@
+module BaseHelpers
+  def load_server_config
+    @address, @post, @user, @pass = parse_config.compact
+  end
+
+  protected
+  def parse_config
+    file = File.exist?("features/reddit.yml") ? YAML.load_file("features/reddit.yml") : {}
+    server = file.fetch("server"){ server_defaults }
+    return [ server["address"], server["port"], server["test_user"], server["test_pass"] ]
+  end
+
+  def server_defaults
+    {"address" => "reddit.local", "port" => "80", "test_user" => "reddit", "test_pass" => "password"}
+  end
+end
+World(BaseHelpers)

data/features/user.feature

@@ -0,0 +1,11 @@
+@user
+Feature: User
+  In order have friends
+  As a Redditor
+  I want to be able to add and remove them
+
+  Scenario: Valid user and password
+    Given I select a redditor
+    Then I should be able to friend them
+    And I should be able to unfriend them
+

data/lib/ruby_reddit_api.rb

@@ -0,0 +1,17 @@
+$:.unshift File.dirname(__FILE__)
+
+module Reddit
+end
+
+require "httparty"
+require "json"
+require "reddit/version"
+require "reddit/base"
+require "reddit/json_listing"
+require "reddit/api"
+require "reddit/user"
+require "reddit/vote"
+require "reddit/submission"
+require "reddit/comment"
+require "reddit/message"
+

data/lib/ruby_reddit_api/api.rb

@@ -0,0 +1,46 @@
+module Reddit
+
+  class Api < Base
+    attr_reader :last_action, :debug
+
+    def initialize(user=nil,password=nil, options={})
+      @user     = user
+      @password = password
+      @debug    = StringIO.new
+    end
+
+    def inspect
+      "<Reddit::Api user='#{user}'>"
+    end
+
+    def browse(subreddit, options={})
+      subreddit = sanitize_subreddit(subreddit)
+      options.merge! :handler => "Submission"
+      if options[:limit]
+        options.merge!({:query => {:limit => options[:limit]}})
+      end
+      read("/r/#{subreddit}.json", options )
+    end
+
+    def sent_messages
+      messages :sent
+    end
+
+    def received_messages
+      messages :inbox
+    end
+
+    def comments
+      messages :comments
+    end
+
+    def post_replies
+      messages :selfreply
+    end
+
+    protected
+    def messages(kind)
+      read("/message/#{kind.to_s}.json", :handler => "Message")
+    end
+  end
+end

data/lib/ruby_reddit_api/base.rb

@@ -0,0 +1,109 @@
+module Reddit
+  class Base
+    include HTTParty
+
+    attr_reader :last_action, :debug
+    base_uri "www.reddit.com"
+    class << self; attr_reader :cookie, :modhash, :user_id, :user, end
+
+    def initialize(options={})
+      @debug    = StringIO.new
+    end
+
+    def inspect
+      "<Reddit::Base user='#{user}'>"
+    end
+
+    def login
+      capture_session(self.class.post( "/api/login", {:body => {:user => @user, :passwd => @password}, :debug_output => @debug} ) )
+      logged_in?
+    end
+
+    def logout
+      Reddit::Base.instance_variable_set("@cookie",nil)
+    end
+
+    def cookie
+      Reddit::Base.cookie
+    end
+
+    def modhash
+      Reddit::Base.modhash
+    end
+
+    def user_id
+      Reddit::Base.user_id
+    end
+
+    def user
+      Reddit::Base.user
+    end
+
+    def logged_in?
+      !!(cookie && (cookie =~ /reddit_session/) != nil)
+    end
+
+    def user_agent
+      self.class.user_agent
+    end
+
+    def base_headers
+      self.class.base_headers
+    end
+
+    def read(url, options={})
+      unless throttled?
+        @debug.rewind
+        verb      = (options[:verb] || "get")
+        param_key = (verb == "get") ? :query : :body
+        resp      = self.class.send( verb, url, {param_key => (options[param_key] || {}), :headers => base_headers, :debug_output => @debug})
+        if valid_response?(resp)
+          @last_action = Time.now
+          klass = Reddit.const_get(options[:handler] || "Submission")
+          resp  = klass.parse( JSON.parse(resp.body, :max_nesting => 9_999) )
+          return resp
+        else
+          return false
+        end
+      end
+    end
+
+    protected
+    def valid_response?(response)
+      response.code == 200 && response.headers["content-type"].to_s =~ /json/
+    end
+
+    def capture_session(response)
+      cookies = response.headers["set-cookie"]
+      Reddit::Base.instance_variable_set("@cookie", cookies)
+      Reddit::Base.instance_variable_set("@user",   @user)
+    end
+
+    def capture_user_id
+      return true if user_id
+      this_user = read("/user/#{user}/about.json", :handler => "User")
+      Reddit::Base.instance_variable_set("@user_id", this_user.id)
+    end
+
+    def throttled?
+      @last_action && ( ( Time.now - @last_action ) < 1.0 )
+    end
+
+    def sanitize_subreddit(subreddit)
+      subreddit.gsub!(/^\/?r\//,'')
+      subreddit.gsub!(/\.json\Z/,'')
+      subreddit
+    end
+
+    class << self
+
+      def base_headers
+        {'Cookie' => Reddit::Base.cookie.to_s, 'user-agent' => user_agent}
+      end
+
+      def user_agent
+        "Ruby Reddit Client v#{Reddit::VERSION}"
+      end
+    end
+  end
+end

data/lib/ruby_reddit_api/comment.rb

@@ -0,0 +1,86 @@
+module Reddit
+  class Comment < Api
+    include JsonListing
+    attr_reader :body, :subreddit_id, :name, :created, :downs, :author, :created_utc, :body_html, :link_id, :parent_id, :likes, :replies, :subreddit, :ups, :debug, :kind
+    def initialize(json)
+      parse(json)
+      @debug = StringIO.new
+    end
+
+    def inspect
+      "<Reddit::Comment author='#{@author}' body='#{short_body}'>"
+    end
+
+    def id
+      "#{kind}_#{@id}"
+    end
+
+    def author
+      @author_data ||= read("/user/#{@author}/about.json", :handler => "User")
+    end
+
+    def to_s
+      body
+    end
+
+    def edit(newtext)
+      resp=self.class.post("/api/editusertext", {:body => {:thing_id => id, :uh => modhash, :r => subreddit, :text => newtext }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def hide # soft delete?
+      resp=self.class.post("/api/del", {:body => {:id => id, :uh => modhash, :r => subreddit, :executed => "removed" }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def remove
+      resp=self.class.post("/api/remove", {:body => {:id => id, :uh => modhash, :r => subreddit}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def approve
+      resp=self.class.post("/api/approve", {:body => {:id => id, :uh => modhash, :r => subreddit}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def moderator_distinguish
+      add_distinction "yes"
+    end
+
+    def admin_distinguish
+      add_distinction "admin"
+    end
+
+    def indistinguish
+      add_distinction "no"
+    end
+
+    def reply(text)
+      resp = self.class.post("/api/comment", {:body => {:thing_id => id, :text => text, :uh => modhash, :r => subreddit }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def upvote
+      Vote.new(self).up
+    end
+
+    def downvote
+      Vote.new(self).down
+    end
+
+    def short_body
+      str = body.to_s
+      if str.size > 15
+        str[0..15] + "..."
+      else
+        body
+      end
+    end
+
+    def add_distinction(verb)
+      resp=self.class.post("/api/distinguish/#{verb}", {:body => {:id => id, :uh => modhash, :r => subreddit, :executed => "distinguishing..."}, :headers => base_headers, :debug_output => @debug })
+      puts resp.headers
+      resp.code == 200
+    end
+  end
+end

data/lib/ruby_reddit_api/json_listing.rb

@@ -0,0 +1,38 @@
+module Reddit
+  module JsonListing
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      def parse(json)
+        results = []
+        if json.is_a?(Array)
+          json.each do |j|
+            results << parse(j)
+          end
+        else
+          data     = json["data"]
+          Reddit::Base.instance_variable_set("@modhash", data["modhash"]) # Needed for api calls
+
+          children = data["children"]
+          children.each do |message|
+            kind     = message["kind"]
+            message["data"]["kind"] = kind
+            results << self.new(message["data"])
+          end
+        end
+
+        return results.flatten
+      end
+    end
+    module InstanceMethods
+      def parse(json)
+        json.keys.each do |key|
+          instance_variable_set("@#{key}", json[key])
+        end
+      end
+    end
+  end
+end

data/lib/ruby_reddit_api/message.rb

@@ -0,0 +1,30 @@
+module Reddit
+  class Message < Base
+    include JsonListing
+    attr_reader :body, :was_comment, :kind, :first_message, :name, :created, :dest, :created_utc, :body_html, :subreddit, :parent_id, :context, :replies, :subject, :debug
+    def initialize(json)
+      parse(json)
+      @debug    = StringIO.new
+    end
+
+    def id
+      "#{kind}_#{@id}"
+    end
+
+    def author
+      @author_data ||= read("/user/#{@author}/about.json", :handler => "User")
+    end
+
+    def inspect
+      "<Reddit::Message '#{short_body}'>"
+    end
+
+    def short_body
+      if body.size > 15
+        body[0..15]
+      else
+        body
+      end
+    end
+  end
+end

data/lib/ruby_reddit_api/submission.rb

@@ -0,0 +1,99 @@
+module Reddit
+  class Submission < Base
+    include JsonListing
+    attr_reader :domain, :media_embed, :subreddit, :selftext_html, :selftext, :likes, :saved, :clicked, :media, :score, :over_18, :hidden, :thumbnail, :subreddit_id, :downs, :is_self, :permalink, :name, :created, :url, :title, :created_utc, :num_comments, :ups, :kind, :last_comment_id
+
+    def initialize(data)
+      parse(data)
+      @debug    = StringIO.new
+    end
+
+    def inspect
+      "<Reddit::Submission id='#{id}' author='#{@author}' title='#{title}'>"
+    end
+
+    def id
+      "#{kind}_#{@id}"
+    end
+
+    def author
+      @author_data ||= read("/user/#{@author}/about.json", :handler => "User")
+    end
+
+    def add_comment(text)
+      resp = self.class.post("/api/comment", {:body => {:thing_id => id, :text => text, :uh => modhash, :r => subreddit }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def upvote
+      Reddit::Vote.new(self).up
+    end
+
+    def downvote
+      Reddit::Vote.new(self).down
+    end
+
+    def save
+      toggle :save
+    end
+
+    def unsave
+      toggle :unsave
+    end
+
+    def hide
+      toggle :hide
+    end
+
+    def unhide
+      toggle :unhide
+    end
+
+    def report
+      toggle :report
+    end
+
+    def moderator_distinguish
+      add_distinction "yes"
+    end
+
+    def admin_distinguish
+      add_distinction "admin"
+    end
+
+    def indistinguish
+      add_distinction "no"
+    end
+
+    def comments(more=false)
+      #TODO Get morechildren to work correctly
+      if more && last_comment_id
+        opts = {:handler => "Comment",
+                :verb => "post",
+                :body =>
+                  {:link_id => last_comment_id, :depth => 0, :r => subreddit, :uh => modhash, :renderstyle => "json", :pv_hex => "", :id => id}
+                }
+        return read("/api/morechildren", opts )
+
+      else
+        _comments = read( permalink + ".json", {:handler => "Comment", :query => {:limit => 50}} )
+        @last_comment_id = _comments.last.id if _comments && _comments.any?
+        return _comments
+      end
+    end
+
+    protected
+    def add_distinction(verb)
+      resp=self.class.post("/api/distinguish/#{verb}", {:body => {:id => id, :uh => modhash, :r => subreddit, :executed => "distinguishing..."}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def toggle(which)
+      return false unless logged_in?
+      mapping = {:save => "save", :unsave => "unsave", :hide => "hidden", :unhide => "unhidden", :report => "report"}
+      mode = mapping[which]
+      resp = self.class.post("/api/#{which}", {:body => {:id => id, :uh => modhash, :r => subreddit, :executed => mode }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+  end
+end

data/lib/ruby_reddit_api/user.rb

@@ -0,0 +1,47 @@
+
+module Reddit
+  class User < Api
+    attr_reader :name, :debug, :created, :created_utc, :link_karma, :comment_karma, :is_mod, :has_mod_mail, :kind
+    def initialize(json)
+      @debug = StringIO.new
+      parse(json)
+    end
+
+    def inspect
+      "<Reddit::User name='#{name}'>"
+    end
+
+    def id
+      "#{kind}_#{@id}"
+    end
+
+    def to_s
+      name
+    end
+
+    def friend
+      capture_user_id
+      resp=self.class.post("/api/friend", {:body => {:name => name, :container => user_id, :type => "friend", :uh => modhash}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def unfriend
+      capture_user_id
+      resp=self.class.post("/api/unfriend", {:body => {:name => name, :container => user_id, :type => "friend", :uh => modhash}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    protected
+    def parse(json)
+      json.keys.each do |key|
+        instance_variable_set("@#{key}", json[key])
+      end
+    end
+
+    def self.parse(json)
+      kind, data = json["kind"], json["data"]
+      data["kind"] = kind
+      return self.new(data)
+    end
+  end
+end

data/lib/ruby_reddit_api/version.rb

@@ -0,0 +1,3 @@
+module Reddit
+  VERSION = File.exist?("VERSION") ? File.read("VERSION").chomp : ""
+end

data/lib/ruby_reddit_api/vote.rb

@@ -0,0 +1,33 @@
+module Reddit
+  class Vote < Base
+    attr_reader :submission
+
+    def initialize(submission)
+      @submission = submission
+    end
+
+    def up
+      vote(:up)
+    end
+
+    def down
+      vote(:down)
+    end
+
+    def inspect
+      "<Reddit::Vote>"
+    end
+
+    protected
+    def vote(direction)
+      return false unless logged_in?
+      up_or_down = direction == :up ? 1 : -1
+      resp = self.class.post( "/api/vote", {:body => {:id => submission.id, :dir => up_or_down, :uh => modhash}, :headers => base_headers})
+      if resp.code == 200
+        return true
+      else
+        return false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: ruby_reddit_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 9
+  version: 0.1.9
+platform: ruby
+authors: 
+- James Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Wraps many reddit API functions such as submission and comments browsing, voting, messaging, friending, and more.
+email: 
+- jamecook@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ruby_reddit_api.rb
+- lib/ruby_reddit_api/user.rb
+- lib/ruby_reddit_api/comment.rb
+- lib/ruby_reddit_api/message.rb
+- lib/ruby_reddit_api/version.rb
+- lib/ruby_reddit_api/vote.rb
+- lib/ruby_reddit_api/submission.rb
+- lib/ruby_reddit_api/api.rb
+- lib/ruby_reddit_api/json_listing.rb
+- lib/ruby_reddit_api/base.rb
+- README
+- features/reddit.yml
+- features/submission.feature
+- features/comment.feature
+- features/user.feature
+- features/base.feature
+- features/message.feature
+- features/api.feature
+- features/step_definitions/message_steps.rb
+- features/step_definitions/submission_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: true
+homepage: http://github.com/jamescook/RubyRedditAPI
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper for reddit API
+test_files: 
+- features/reddit.yml
+- features/submission.feature
+- features/comment.feature
+- features/user.feature
+- features/base.feature
+- features/message.feature
+- features/api.feature
+- features/step_definitions/message_steps.rb
+- features/step_definitions/submission_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