ruby_reddit_api-h 0.2.7

data/README.rdoc

@@ -0,0 +1,27 @@
+== Ruby Reddit Client v0.2.6
+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. gem install bundler
+4. bundle install
+5. rake
+
+== License
+Ruby Reddit API is released under the MIT License.

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,19 @@
+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
+
+  Scenario: I want to change message read status
+    Given I am logged in
+    And I have received messages
+    When I go to the received messages page
+    Then I should be able to mark them as unread
+    And I should be able to mark them as read
+
+  Scenario: I want to be able to read my unread messages
+    Given I am logged in
+    And I have unread messages
+    When I go to the unread messages page
+    Then I should see a listing of messages

data/features/message_group.feature

@@ -0,0 +1,14 @@
+Feature: Message Group
+  I want to be able to mark multiple messages as read or unread
+
+  Scenario: Mark multiple messages read
+    Given I am logged in
+    And I have unread messages
+    When I mark all unread messages read
+    Then I should have no unread messages
+
+  Scenario: Mark multiple messages unread
+    Given I am logged in
+    And I have unread messages
+    When I mark all read messages unread
+    Then I should have no read messages

data/features/reddit.yml

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

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/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_group_steps.rb

@@ -0,0 +1,30 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::MessageGroup.base_uri @address
+  Reddit::Base.instance_variable_set("@throttle_duration", 0)
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+When /^I mark all unread messages read$/ do
+  group = Reddit::MessageGroup.new
+  messages = @api.unread_messages
+  result   = group.mark_read messages
+  result.should be true
+end
+
+When /^I mark all read messages unread$/ do
+  group = Reddit::MessageGroup.new
+  messages = @api.received_messages
+  result   = group.mark_unread messages
+  result.should be true
+end
+
+Then /^I should have no unread messages$/ do
+  @api.unread_messages.should == []
+end
+
+Then /^I should have no read messages$/ do
+  @api.received_messages.select{|m| !m.was_comment}.map(&:read?).uniq.should  == [false]
+end

data/features/step_definitions/message_steps.rb

@@ -0,0 +1,68 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::Message.base_uri @address
+  Reddit::Base.instance_variable_set("@throttle_duration", 0)
+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
+
+When /^I go to the unread messages page$/ do
+  @result = @api.unread_messages
+end
+
+When /^I go to the received messages page$/ do
+  @result = @api.received_messages
+end
+
+Then /^I should see a listing of messages$/ do
+  @result.any?{|r| r.is_a?(Reddit::Message) == false}.should be false
+end
+
+Given /^I have received messages$/ do
+  @api.received_messages.size.should be > 0
+end
+
+Given /^I have unread messages$/ do
+  unread = @api.unread_messages
+  unless unread.size > 0
+    @api.received_messages[0].mark_unread
+  end
+end
+
+Then /^I should be able to mark them as unread/ do
+  unread = @api.unread_messages
+  unread.each do |m|
+    m.mark_read
+  end
+
+  received = @api.received_messages
+  received[0].mark_unread
+
+  r = @api.unread_messages
+  r.size.should == 1
+end
+
+Then /^I should be able to mark them as read$/ do
+  received = @api.received_messages
+  received.each do |m|
+    m.mark_unread
+  end
+  unread = @api.unread_messages
+
+  unread.size.should be > 0
+
+  unread.each do |m|
+    m.mark_read
+  end
+  
+  r = @api.unread_messages
+  r.size.should == 0
+end

data/features/step_definitions/search_steps.rb

@@ -0,0 +1,12 @@
+Given /^I search '([^']+)' with '([^']+)'$/ do |subreddit, terms|
+  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/features/step_definitions/submission_steps.rb

@@ -0,0 +1,118 @@
+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 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
+
+Then /^I should be able to see the comments$/ do
+  @submission.instance_variable_set("@last_action", Time.now - 60) if @submission
+  comments = @submission.comments
+  comments.size.should > 0
+end

data/features/step_definitions/user_steps.rb

@@ -0,0 +1,27 @@
+Before do
+  load_server_config
+  Reddit::Base.base_uri @address
+  Reddit::Api.base_uri @address
+  Reddit::Thing.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
+