redditkit 1.0.0

data/spec/redditkit/base_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe RedditKit::Base do
+
+  before do
+    @base = RedditKit::Base.new(:kind => 't1', :data => {:id => '12345'})
+    @thing = RedditKit::Thing.new(:kind => 't1', :data => {:id => '12345'})
+  end
+
+  describe "#attributes" do
+    it "return a hash of attributes" do
+      expect(@base.attributes).to eq(:kind => 't1', :id => '12345')
+    end
+  end
+
+  describe "calling methods" do
+    context "attribute method" do
+      it "can access attribute methods" do
+        expect(@thing.id).to eq '12345'
+      end
+    end
+
+    context "predicate method" do
+      it "can access predicate methods" do
+        expect(@thing.id?).to be_true
+      end
+    end
+
+    context "#[]" do
+      it "can call methods using strings" do
+        expect(@base['object_id']).to be_an Integer
+      end
+
+      it "can call methods using symbols" do
+        expect(@base[:object_id]).to be_an Integer
+      end
+
+      it "returns nil for nonexistent methods" do
+        expect(@base['missing']).to be_nil
+        expect(@base[:missing]).to be_nil
+      end
+    end
+  end
+
+end

data/spec/redditkit/client/account_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Account, :vcr do
+
+  describe "#sign_in" do
+    it "signs the user in" do
+      client = RedditKit::Client.new redditkit_username, redditkit_password
+
+      expect(client.signed_in?).to be_true
+      expect(client.user).to_not be_nil
+    end
+  end
+
+  describe "#signed_in?" do
+    it "determines whether there is a user signed in" do
+      expect(authenticated_client.signed_in?).to be_true
+    end
+  end
+
+  describe "#sign_out" do
+    it "signs the current user out" do
+      client = RedditKit::Client.new :username => redditkit_username, :password => redditkit_password
+      client.sign_out
+
+      expect(client.signed_in?).to_not be_true
+    end
+  end
+
+  describe "#update_account" do
+    before do
+      stub_empty_post_request 'api/update'
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.update_account :current_password => redditkit_password, :new_password => redditkit_password
+      expect(a_post('api/update')).to have_been_made
+    end
+  end
+
+  describe "#update_session" do
+    it "updates the current session" do
+      client = RedditKit::Client.new redditkit_username, redditkit_password
+      old_cookie = client.cookie
+
+      new_cookie = client.update_session redditkit_password
+      expect(old_cookie).to_not eq new_cookie
+    end
+  end
+
+end

data/spec/redditkit/client/apps_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Apps, :vcr do
+
+  describe "#create_app" do
+    before do
+      stub_empty_post_request('api/updateapp')
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.create_app 'Test app', :description => 'Some test app'
+      expect(a_post('api/updateapp')).to have_been_made
+    end
+  end
+
+  describe "#delete_app" do
+    before do
+      stub_empty_post_request('api/deleteapp')
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.delete_app 'fake-identifier'
+      expect(a_post('api/deleteapp')).to have_been_made
+    end
+  end
+
+  describe "#revoke_app" do
+    before do
+      stub_empty_post_request('api/revokeapp')
+    end
+    it "requests the correct resource" do
+      authenticated_client.revoke_app 'fake-identifier'
+      expect(a_post('api/revokeapp')).to have_been_made
+    end
+  end
+
+  describe "#add_developer" do
+    before do
+      stub_empty_post_request('api/adddeveloper')
+    end
+    it "requests the correct resource" do
+      authenticated_client.add_developer 'fake-user', 'fake-identifier'
+      expect(a_post('api/adddeveloper')).to have_been_made
+    end
+  end
+  
+  describe "#remove_developer" do
+    before do
+      stub_empty_post_request('api/removedeveloper')
+    end
+
+    it "requests the correct resource" do
+      authenticated_client.remove_developer 'fake-user', 'fake-identifier'
+      expect(a_post('api/removedeveloper')).to have_been_made
+    end
+  end
+
+end

data/spec/redditkit/client/captcha_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Captcha, :vcr do
+
+  describe "#needs_captcha?" do
+    it "checks if the current account needs a CAPTCHA" do
+      authenticated_client.needs_captcha?
+      expect(a_get('api/needs_captcha.json')).to have_been_made
+    end
+  end
+
+  describe "#new_captcha_identifier" do
+    it "returns a new CAPTCHA identifier" do
+      identifier = RedditKit.new_captcha_identifier
+
+      expect(a_post('api/new_captcha')).to have_been_made
+      expect(identifier).to be_kind_of String
+    end
+  end
+
+  describe "#captcha_url" do
+    it "returns a CAPTCHA url from an identifier" do
+      identifier = RedditKit.new_captcha_identifier
+      captcha_url = RedditKit.captcha_url identifier
+
+      expect(captcha_url).to eq "http://reddit.com/captcha/#{identifier}.png"
+    end
+  end
+
+end

data/spec/redditkit/client/comments_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Comments, :vcr do
+
+  describe "#comments" do
+    context "with a link identifier" do
+      it "returns comments on a link" do
+        comments = RedditKit.comments '1n002d'
+        expect(comments).to_not be_nil
+      end
+    end
+
+    context "with a RedditKit::Link" do
+      it "returns comments on a link" do
+        link = RedditKit.link test_link_full_name
+        comments = RedditKit.comments link
+        expect(comments).to_not be_nil
+      end
+    end
+  end
+
+  describe "#comment" do
+    it "requests the correct resource" do
+      comment = RedditKit.comment test_comment_full_name
+      expect(comment).to_not be_nil
+    end
+  end
+
+  describe "#submit_comment" do
+    it "requests the correct resource" do
+      comment = authenticated_client.submit_comment test_link_full_name, 'Comment submission test' 
+
+      expect(a_post('api/comment')).to have_been_made
+      expect(comment.text).to eq 'Comment submission test'
+
+      authenticated_client.delete comment
+    end
+  end
+
+end

data/spec/redditkit/client/flair_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Flair, :vcr do
+
+  describe "#flair_list" do
+    it "returns the list of flair" do
+      authenticated_client.flair_list redditkit_subreddit
+      
+      path = subreddit_url redditkit_subreddit, 'api/flairlist.json'
+      expect(a_request(:get, path)).to have_been_made
+    end
+  end
+  
+  describe "#create_flair_template" do
+    it "creates a flair template" do
+      authenticated_client.create_flair_template redditkit_subreddit, :user, :text => 'Test', :css_class => 'some-class', :user_editable => false
+      expect(a_post('api/flairtemplate')).to have_been_made
+    end
+
+    it "raises InvalidClassName" do
+      options = { :text => 'Invalid', :css_class => 'some_class!', :user_editable => false }
+      expect { authenticated_client.create_flair_template(redditkit_subreddit, :user, options) }.to raise_error RedditKit::InvalidClassName
+    end
+
+    it "raises TooManyClassNames" do
+      options = { :text => 'Invalid', :css_class => 'one two three four five six seven eight nine ten eleven', :user_editable => false }
+      expect { authenticated_client.create_flair_template(redditkit_subreddit, :user, options) }.to raise_error RedditKit::TooManyClassNames
+    end
+  end
+
+  describe "#delete_flair_template" do
+    before do
+      stub_empty_post_request 'api/deleteflairtemplate'
+    end
+
+    it "deletes a flair template" do
+      authenticated_client.delete_flair_template redditkit_subreddit, '12345'
+      expect(a_post('api/deleteflairtemplate')).to have_been_made
+    end
+  end
+
+  describe "#toggle_flair" do
+    it "requests the correct resource" do
+      authenticated_client.toggle_flair redditkit_subreddit, true
+      expect(a_post('api/setflairenabled')).to have_been_made
+    end
+  end
+
+  describe "#set_flair" do
+    it "requests the correct resource" do
+      authenticated_client.set_flair :subreddit => 'RedditKitTesting', :text => 'Test flair', :css_class => 'testclass', :link => test_link_full_name
+      expect(a_post('api/flair')).to have_been_made
+    end
+  end
+
+  describe "#set_flair_with_csv" do
+    it "requests the correct resource" do
+      authenticated_client.set_flair_with_csv redditkit_subreddit, 'samsymons,Test CSV,csvclass'
+      expect(a_post('api/flaircsv')).to have_been_made
+    end
+  end
+
+  describe "#delete_user_flair" do
+    it "requests the correct resource" do
+      authenticated_client.delete_user_flair redditkit_subreddit, 'samsymons'
+    end
+  end
+
+  describe "#clear_flair_templates" do
+    it "clears flair templates" do
+      authenticated_client.clear_flair_templates :subreddit => redditkit_subreddit, :type => :user
+      expect(a_request(:post, reddit_url('api/clearflairtemplates'))).to have_been_made 
+    end
+  end
+
+  describe "#apply_flair_template" do
+    it "clears flair templates" do
+      authenticated_client.apply_flair_template :subreddit => redditkit_subreddit, :template_id => '12345', :link => test_link_full_name
+      expect(a_request(:post, reddit_url('api/selectflair'))).to have_been_made 
+    end
+  end
+
+  describe "#set_flair_options" do
+    it "sets flair options" do
+      parameters = { flair_enabled: 'true', flair_position: 'right', link_flair_position: 'right', flair_self_assign_enabled: 'true', link_flair_self_assign_enabled: 'true' }
+      authenticated_client.set_flair_options redditkit_subreddit, parameters
+
+      expect(a_request(:post, reddit_url('api/flairconfig'))).to have_been_made
+    end
+  end
+
+end

data/spec/redditkit/client/links_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Links, :vcr do
+
+  describe "#front_page" do
+    it "requests the correct resource" do
+      RedditKit.front_page
+      expect(a_get('hot.json')).to have_been_made
+    end
+
+    it "requests the correct category" do
+      RedditKit.front_page :category => :rising
+      expect(a_get('rising.json')).to have_been_made
+    end
+  end
+
+  describe "#links" do
+    it "requests front page links if no subreddit is present" do
+      RedditKit.links nil
+      expect(a_get('hot.json')).to have_been_made
+    end
+
+    it "requests the correct subreddit and category" do
+      RedditKit.links 'programming', :category => :hot
+      expect(a_get('r/programming/hot.json')).to have_been_made
+    end
+
+    it "requests links with the correct time frame" do
+      RedditKit.links 'programming', :category => :top, :time => :year
+      expect(a_get('r/programming/top.json?t=year')).to have_been_made
+    end
+
+    it "requests a certain number of links" do
+      links = RedditKit.links 'programming', :limit => 10
+      expect(links.length).to eq 10
+    end
+
+    it "contains pagination information" do
+      links = RedditKit.links 'programming'
+
+      expect(links.after).to_not be_nil
+      expect(links.results).to_not be_empty
+    end
+  end
+
+  describe "#link" do
+    it "returns a link" do
+      link = RedditKit.link "t3_1n002d"
+      expect(link).to_not be_nil
+    end
+  end
+
+  describe "#links_with_domain" do
+    it "returns links with a specific domain" do
+      links = RedditKit.links_with_domain "github.com"
+      result = links.all? { |link| link.domain == 'github.com' }
+
+      expect(result).to be_true
+    end
+  end
+
+  describe "#submit" do
+    it "raises RedditKit::InvalidCaptcha if no CAPTCHA is filled out" do
+      expect { authenticated_client.submit 'Test', redditkit_subreddit, :text => 'Test post' }.to raise_error RedditKit::InvalidCaptcha
+    end
+  end
+
+  describe "#mark_nsfw" do
+    it "requests the correct resource" do
+      authenticated_client.mark_nsfw test_link_full_name
+      expect(a_post('api/marknsfw')).to have_been_made
+    end
+  end
+
+  describe "#unmark_nsfw" do
+    it "requests the correct resource" do
+      authenticated_client.unmark_nsfw test_link_full_name
+      expect(a_post('api/unmarknsfw')).to have_been_made
+    end
+  end
+
+  describe "#hide" do
+    it "requests the correct resource" do
+      authenticated_client.hide test_link_full_name
+      expect(a_post('api/hide')).to have_been_made
+    end
+  end
+
+  describe "#unhide" do
+    it "requests the correct resource" do
+      authenticated_client.unhide test_link_full_name
+      expect(a_post('api/unhide')).to have_been_made
+    end
+  end
+
+  describe "#random_link" do
+    it "returns a random link" do
+      link = RedditKit.random_link
+      expect(link).to_not be_nil
+    end
+  end
+
+end

data/spec/redditkit/client/miscellaneous_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe RedditKit::Client::Miscellaneous, :vcr do
+
+  describe "#edit" do
+    it "requests the correct resource" do
+      authenticated_client.edit 'fake-full-name', :text => 'New text'
+      expect(a_post('api/editusertext')).to have_been_made
+    end
+  end
+
+  describe "#delete" do
+    it "requests the correct resource" do
+      authenticated_client.delete 'fake-full-name'
+      expect(a_post('api/del')).to have_been_made
+    end
+  end
+
+  describe "#save" do
+    it "saves an object" do
+      authenticated_client.save test_link_full_name
+      expect(a_post('api/save')).to have_been_made
+    end
+  end
+
+  describe "#unsave" do
+    it "unsaves an object" do
+      authenticated_client.unsave test_link_full_name
+      expect(a_post('api/unsave')).to have_been_made
+    end
+  end
+
+  describe "#unsave" do
+    it "unsaves an object" do
+      authenticated_client.report 'fake-full-name'
+      expect(a_post('api/report')).to have_been_made
+    end
+  end
+
+end