redditkit 1.0.0

data/spec/redditkit/client/users_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Users, :vcr do
+
+  describe "#user" do
+    it "requests the correct resource" do
+      authenticated_client.user
+      expect(a_request(:get, "#{ RedditKit.api_endpoint }api/me.json")).to have_been_made
+    end
+
+    it "returns a specified user" do
+      user = authenticated_client.user 'amberlynns'
+      expect(user.name).to eq 'amberlynns'
+    end
+
+    it "returns the authenticated user" do
+      user = authenticated_client.user
+      expect(user.name).to eq redditkit_username
+    end
+  end
+
+  describe "#my_content" do
+    it "returns the user's content" do
+      content = authenticated_client.my_content :category => :overview
+      expect(content).to_not be_nil
+    end
+  end
+  
+  describe "#user_content" do
+    it "returns the user's content" do
+      content = RedditKit.user_content  redditkit_username, :category => :overview
+      expect(content).to_not be_nil
+    end
+  end
+  
+  describe "#friends" do
+    it "returns the user's friends" do
+      friends = authenticated_client.friends
+      expect(friends).to_not be_nil
+    end
+  end
+
+  describe "#friend" do
+    before do
+      stub_empty_post_request 'api/friend'
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.friend 'username'
+      expect(a_post('api/friend')).to have_been_made
+    end
+  end
+
+  describe "#unfriend" do
+    before do
+      stub_empty_post_request 'api/unfriend'
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.unfriend 'username'
+      expect(a_post('api/unfriend')).to have_been_made
+    end
+  end
+
+  describe "#username_available?" do
+    it "returns false for an unavailable username" do
+      client = RedditKit::Client.new
+      available = client.username_available? 'samsymons' 
+
+      expect(available).to_not be_true
+    end
+
+    it "returns true for an available username" do
+      client = RedditKit::Client.new
+      available = client.username_available? 'available_user' 
+
+      expect(available).to be_true
+    end
+  end
+
+  describe "#register" do
+    before do
+      stub_empty_post_request 'api/register'
+    end
+
+    it "requests the correct resource" do
+      RedditKit.register 'username', 'password'
+      expect(a_post('api/register')).to have_been_made
+    end
+  end
+
+end

data/spec/redditkit/client/voting_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Voting do
+  
+  describe "#upvote", :vcr do
+    context "with a comment full name passed" do
+      it "upvotes the comment" do
+        authenticated_client.upvote test_comment_full_name
+        expect(test_comment.upvoted?).to be_true
+      end
+    end
+    
+    context "with a link full name passed" do
+      it "upvotes the link" do
+        authenticated_client.upvote test_link_full_name
+        expect(test_link.upvoted?).to be_true
+      end
+    end
+
+    context "with a comment passed" do
+      it "upvotes the comment" do
+        authenticated_client.upvote test_comment
+        expect(test_comment.upvoted?).to be_true
+      end
+    end
+
+    context "with a link passed" do
+      it "upvotes the link" do
+        authenticated_client.upvote test_link
+        expect(test_link.upvoted?).to be_true
+      end
+    end
+  end
+
+  describe "#downvote", :vcr do
+    context "with a comment full name passed" do
+      it "downvotes the comment" do
+        authenticated_client.downvote test_comment_full_name
+        expect(test_comment.downvoted?).to be_true
+      end
+    end
+    
+    context "with a link full name passed" do
+      it "downvotes the link" do
+        authenticated_client.downvote test_link_full_name
+        expect(test_link.downvoted?).to be_true
+      end
+    end
+
+    context "with a comment passed" do
+      it "downvotes the comment" do
+        authenticated_client.downvote test_comment
+        expect(test_comment.downvoted?).to be_true
+      end
+    end
+
+    context "with a link passed" do
+      it "downvotes the link" do
+        authenticated_client.downvote test_link
+        expect(test_link.downvoted?).to be_true
+      end
+    end
+  end
+
+  describe "#withdraw_vote", :vcr do
+    context "with a comment full name passed" do
+      it "withdraws the vote on the comment" do
+        authenticated_client.withdraw_vote test_comment_full_name
+        expect(test_comment.upvoted?).to_not be_true
+        expect(test_comment.downvoted?).to_not be_true
+      end
+    end
+    
+    context "with a link full name passed" do
+      it "withdraws the vote on the link" do
+        authenticated_client.withdraw_vote test_link_full_name
+        expect(test_link.upvoted?).to_not be_true
+        expect(test_link.downvoted?).to_not be_true
+      end
+    end
+
+    context "with a comment passed" do
+      it "withdraws the vote on the comment" do
+        authenticated_client.withdraw_vote test_comment
+        expect(test_comment.upvoted?).to_not be_true
+        expect(test_comment.downvoted?).to_not be_true
+      end
+    end
+
+    context "with a link passed" do
+      it "withdraws the vote on the link" do
+        authenticated_client.withdraw_vote test_link
+        expect(test_link.upvoted?).to_not be_true
+        expect(test_link.downvoted?).to_not be_true
+      end
+    end
+  end
+
+end

data/spec/redditkit/client/wiki_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Wiki, :vcr do
+
+  describe "#add_wiki_editor" do
+    it "requests the correct resource" do
+      authenticated_client.add_wiki_editor redditkit_subreddit, 'samsymons', 'some page'
+      expect(a_post("r/#{redditkit_subreddit}/api/wiki/alloweditor/add")).to have_been_made
+    end
+  end
+
+  describe "#remove_wiki_editor" do
+    it "requests the correct resource" do
+      authenticated_client.remove_wiki_editor redditkit_subreddit, 'samsymons', 'some page'
+      expect(a_post("r/#{redditkit_subreddit}/api/wiki/alloweditor/del")).to have_been_made
+    end
+  end
+
+  describe "#edit_wiki_page" do
+    it "requests the correct resource" do
+      authenticated_client.edit_wiki_page :subreddit => redditkit_subreddit, :page => 'fake-page', :revision => '12345'
+      expect(a_post("r/#{redditkit_subreddit}/api/wiki/edit")).to have_been_made
+    end
+  end
+
+  describe "#hide_wiki_revision" do
+    it "requests the correct resource" do
+      authenticated_client.hide_wiki_revision :subreddit => redditkit_subreddit, :page => 'fake-page', :revision => '12345'
+      expect(a_post("r/#{redditkit_subreddit}/api/wiki/hide")).to have_been_made
+    end
+  end
+
+  describe "#revert_to_revision" do
+    it "requests the correct resource" do
+      authenticated_client.revert_to_revision :subreddit => redditkit_subreddit, :page => 'fake-page', :revision => '12345'
+      expect(a_post("r/#{redditkit_subreddit}/api/wiki/revert")).to have_been_made
+    end
+  end
+
+end

data/spec/redditkit/client_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe RedditKit::Client, :vcr do
+
+  it "can retrieve default options" do
+    expect(RedditKit.api_endpoint).to eq 'http://www.reddit.com/'
+    expect(RedditKit.user_agent).to eq "RedditKit.rb #{RedditKit::Version}"
+  end
+
+  it "can configure options" do
+    client = RedditKit::Client.new
+    client.api_endpoint = "http://github.com/"
+
+    expect(client.api_endpoint).to eq "http://github.com/"
+  end
+
+  it "should have a modhash and cookie after signing in" do
+    expect(authenticated_client.modhash).to_not be_nil
+    expect(authenticated_client.cookie).to_not be_nil
+  end
+
+  it "should raise an error with invalid credentials" do
+    client = RedditKit::Client.new
+    expect { client.sign_in "samsymons", "hunter2" }.to raise_error RedditKit::InvalidCredentials
+  end
+
+  it "should tell us whether it is signed in", :authenticated do
+    client = authenticated_client
+
+    expect(client.signed_in?).to be_true
+    client.sign_out
+    expect(client.signed_in?).to_not be_true
+  end
+
+  it "should be able to sign out", :authenticated do
+    client = authenticated_client
+
+    expect(client.modhash).to_not be_nil
+    expect(client.cookie).to_not be_nil
+
+    client.sign_out
+
+    expect(client.modhash).to be_nil
+    expect(client.cookie).to be_nil
+  end
+end

data/spec/redditkit/comment_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe RedditKit::Comment, :vcr do
+
+  it "should return replies" do
+    comments = RedditKit.comments '1n002d'
+    comment = comments.first
+
+    expect(comment.replies?).to be_true
+  end
+
+  it "should be deleted if both author and comment attributes are set to '[deleted]'" do
+    attributes = { :data => { :author => '[deleted]', :body => '[deleted]' } }
+    deleted_comment = RedditKit::Comment.new attributes
+
+    expect(deleted_comment.deleted?).to be_true
+  end
+
+  it "should not be deleted if neither author and comment attributes are set to '[deleted]'" do
+    comments = RedditKit.comments '1n002d'
+    comment = comments.first
+
+    expect(comment.deleted?).to_not be_true
+  end
+
+end

data/spec/redditkit/creatable_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe RedditKit::Creatable do
+
+  class CreatableClass
+    def initialize
+      @time = Time.new(2000)
+      @attributes = { :created_utc => @time.to_i }
+    end
+  end
+
+  before :all do
+    @creatable = CreatableClass.new
+    @creatable.extend RedditKit::Creatable
+  end
+
+  describe "#created_at" do
+    it "returns the time the object was created at" do
+      created_at = @creatable.created_at 
+      expect(created_at.year).to eq 2000
+    end
+  end
+
+end

data/spec/redditkit/error_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe RedditKit::Error do
+
+  describe "#from_status_code_and_body" do
+
+    it "returns no error for a valid body" do
+      error = RedditKit::Error.from_status_code_and_body(200, {})
+      expect(error).to be_nil
+    end
+
+    it "returns RedditKit::AuthenticationRequired for the USER_REQUIRED error" do
+      body = { :jquery => "USER_REQUIRED" }
+      error = RedditKit::Error.from_status_code_and_body(200, body)
+      expect(error).to eq RedditKit::AuthenticationRequired
+    end
+
+    it "returns RedditKit::AuthenticationRequired for the RATELIMIT error" do
+      body = { :jquery => "RATELIMIT" }
+      error = RedditKit::Error.from_status_code_and_body(200, body)
+      expect(error).to eq RedditKit::RateLimited
+    end
+
+    it "returns RedditKit::Archived for the TOO_OLD error" do
+      body = { :jquery => "TOO_OLD" }
+      error = RedditKit::Error.from_status_code_and_body(200, body)
+      expect(error).to eq RedditKit::Archived
+    end
+
+    it "returns RedditKit::PermissionDenied for status code 403" do
+      body = { :jquery => "ERROR" }
+      error = RedditKit::Error.from_status_code_and_body(403, body)
+      expect(error).to eq RedditKit::PermissionDenied
+    end
+
+    it "returns RedditKit::Conflict for status code 409" do
+      body = { :jquery => "ERROR" }
+      error = RedditKit::Error.from_status_code_and_body(409, body)
+      expect(error).to eq RedditKit::Conflict
+    end
+
+    it "returns RedditKit::InternalServerError for status code 500" do
+      body = { :jquery => "ERROR" }
+      error = RedditKit::Error.from_status_code_and_body(500, body)
+      expect(error).to eq RedditKit::InternalServerError
+    end
+
+    it "returns RedditKit::BadGateway for status code 502" do
+      body = { :jquery => "ERROR" }
+      error = RedditKit::Error.from_status_code_and_body(502, body)
+      expect(error).to eq RedditKit::BadGateway
+    end
+
+    it "returns RedditKit::ServiceUnavailable for status code 503" do
+      body = { :jquery => "ERROR" }
+      error = RedditKit::Error.from_status_code_and_body(503, body)
+      expect(error).to eq RedditKit::ServiceUnavailable
+    end
+  end
+
+end

data/spec/redditkit/link_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe RedditKit::Link do
+
+  before :all do
+    attributes = { :data => { :id => '12345', :url => 'http://example.com/test.png', :permalink => 'permalink', :created_utc => Time.now.to_i } }
+    @link = RedditKit::Link.new attributes
+
+    old_link_attributes = { :data => { :id => '12345', :url => 'http://example.com/test.png', :created_utc => Time.new(2000, 1, 1).to_i } }
+    @old_link = RedditKit::Link.new old_link_attributes
+  end
+
+  it "does not show the score for new links" do
+    expect(@link.showing_link_score?).to be_false
+  end
+
+  it "shows the score for old links" do
+    expect(@old_link.showing_link_score?).to be_true
+  end
+
+  it "determines whether the link has an image extension" do
+    expect(@link.image_link?).to be_true
+  end
+
+  it "returns the link's permalink" do
+    expect(@link.permalink).to eq 'http://reddit.com/permalink'
+  end
+
+  it "returns the link's short URL" do
+    expect(@link.short_link).to eq 'http://redd.it/12345'
+  end
+
+end

data/spec/redditkit/multireddit_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RedditKit::Multireddit do
+
+  before :all do
+    subreddits = []
+    subreddits << { :name => 'test1' }
+    subreddits << { :name => 'test2' }
+    subreddits << { :name => 'test3' }
+
+    attributes = { :data => { :id => '12345', :path => '/user/username/m/test', :subreddits => subreddits } }
+    @multireddit = RedditKit::Multireddit.new attributes
+  end
+
+  it "returns the multireddit's subreddits" do
+    subreddits = @multireddit.subreddits
+    result = subreddits.all? { |subreddit| subreddit.is_a? String }
+
+    expect(subreddits.length).to eq 3
+    expect(result).to be_true
+  end
+
+  it "returns the username of the multireddit's owner" do
+    expect(@multireddit.username).to eq 'username'
+  end
+
+end