redditkit 1.0.1 → 1.0.2

data/lib/redditkit/client/moderation.rb

@@ -28,7 +28,7 @@ module RedditKit
       # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link.
       def approve(link)
         full_name = extract_full_name link
-        post('api/approve', { :id => full_name, :api_type => :json })
+        post 'api/approve', { :id => full_name, :api_type => :json }
       end
 
       # Removes a link or comment.
@@ -36,7 +36,7 @@ module RedditKit
       # @param object [String, RedditKit::Comment, RedditKit::Link] The full name of a link/comment, a RedditKit::Comment, or a RedditKit::Link.
       def remove(object)
         full_name = extract_full_name object
-        post('api/remove', { :id => full_name, :api_type => :json })
+        post 'api/remove', { :id => full_name, :api_type => :json }
       end
 
       # Ignores the reports on a link or comment.
@@ -44,7 +44,7 @@ module RedditKit
       # @param object [String, RedditKit::Comment, RedditKit::Link] The full name of a link/comment, a RedditKit::Comment, or a RedditKit::Link.
       def ignore_reports(object)
         full_name = extract_full_name object
-        post('api/ignore_reports', { :id => full_name, :api_type => :json })
+        post 'api/ignore_reports', { :id => full_name, :api_type => :json }
       end
 
       # Unignores the reports on a link or comment.
@@ -52,7 +52,7 @@ module RedditKit
       # @param object [String, RedditKit::Comment, RedditKit::Link] The full name of a link/comment, a RedditKit::Comment, or a RedditKit::Link.
       def unignore_reports(object)
         full_name = extract_full_name object
-        post('api/unignore_reports', { :id => full_name, :api_type => :json })
+        post 'api/unignore_reports', { :id => full_name, :api_type => :json }
       end
 
       # Distinguishes a comment as being posted by a moderator or admin.
@@ -64,7 +64,7 @@ module RedditKit
         full_name = extract_full_name comment
         parameters = { :id => full_name, :api_type => :json }
 
-        post("api/distinguish/#{how}", parameters)
+        post "api/distinguish/#{how}", parameters
       end
 
       # Sets a post as have its contest mode enabled or disabled.
@@ -72,25 +72,19 @@ module RedditKit
       # @param link [String, RedditKit::Link] The full name of a link, or a RedditKit::Link.
       # @param contest_mode [Boolean] Whether to enable contest mode for the link's comments. Defaults to true.
       def set_contest_mode(link, contest_mode = true)
-        full_name = extract_full_name link
-        set_as_contest = contest_mode ? 'True' : 'False'
-
-        post('api/set_contest_mode', { :id => full_name, :state => set_as_contest, :api_type => :json })
+        set_boolean_on_link 'api/set_contest_mode', link, contest_mode
       end
-      
+
       # Sets a post as sticky within its parent subreddit. This will replace the existing sticky post, if there is one.
       #
       # @param link [String, RedditKit::Link] The full name of a link, or a RedditKit::Link.
       # @param sticky [Boolean] Whether to mark the post as sticky or unsticky. Defaults to true.
       def set_sticky_post(link, sticky = true)
-        full_name = extract_full_name link
-        set_as_sticky = sticky ? 'True' : 'False'
-
-        post('api/set_subreddit_sticky', { :id => full_name, :state => set_as_sticky, :api_type => :json })
+        set_boolean_on_link 'api/set_subreddit_sticky', link, sticky
       end
 
       # Get the moderators of a subreddit.
-      # 
+      #
       # @param subreddit [String, RedditKit::Subreddit] The display name of a subreddit, or a RedditKit::Subreddit.
       # @return [Array<OpenStruct>]
       def moderators_of_subreddit(subreddit)
@@ -98,7 +92,7 @@ module RedditKit
       end
 
       # Get the contributors to a subreddit.
-      # 
+      #
       # @param subreddit [String, RedditKit::Subreddit] The display name of a subreddit, or a RedditKit::Subreddit.
       # @return [Array<OpenStruct>]
       def contributors_to_subreddit(subreddit)
@@ -110,7 +104,7 @@ module RedditKit
       # @param subreddit [String, RedditKit::Subreddit] The display name of the subreddit, or a RedditKit::Subreddit.
       def accept_moderator_invitation(subreddit)
         subreddit_name = extract_string(subreddit, :display_name)
-        post('api/accept_moderator_invite', { :r => subreddit_name })
+        post 'api/accept_moderator_invite', :r => subreddit_name
       end
 
       # Resign as a contributor to a subreddit.
@@ -118,15 +112,15 @@ module RedditKit
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's full name, or a RedditKit::Subreddit.
       def resign_as_contributor(subreddit)
         full_name = extract_full_name subreddit
-        post('api/leavecontributor', { :id => full_name })
+        post 'api/leavecontributor', :id => full_name
       end
-      
+
       # Resign as a moderator of a subreddit.
       #
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's full name, or a RedditKit::Subreddit.
       def resign_as_moderator(subreddit)
         full_name = extract_full_name subreddit
-        post('api/leavemoderator', { :id => full_name })
+        post 'api/leavemoderator', :id => full_name
       end
 
       # Resets a subreddit's header image.
@@ -134,7 +128,7 @@ module RedditKit
       # @param subreddit [String, RedditKit::Subreddit] The display name of the subreddit, or a RedditKit::Subreddit.
       def reset_subreddit_header(subreddit)
         subreddit_name = extract_string(subreddit, :display_name)
-        post('api/delete_sr_header', { :r => subreddit_name })
+        post 'api/delete_sr_header', :r => subreddit_name
       end
 
       # Gets the moderation log for a subreddit.
@@ -173,6 +167,14 @@ module RedditKit
         members.collect { |member| OpenStruct.new(member) }
       end
 
+
+      def set_boolean_on_link(path, link, boolean)
+        full_name = extract_full_name link
+        boolean_as_string = boolean ? 'True' : 'False'
+
+        post path, { :id => full_name, :state => boolean_as_string, :api_type => :json }
+      end
+
     end
   end
 end

data/lib/redditkit/client/multireddits.rb

@@ -24,7 +24,7 @@ module RedditKit
       #   @param multireddit_name [String] The multireddit's name.
       # @return [RedditKit::Multireddit]
       def multireddit(*args)
-        path = "api/multi"
+        path = 'api/multi'
 
         if args.length == 1
           path << args.first
@@ -93,7 +93,7 @@ module RedditKit
       # @param subreddits [Array] An array of subreddit names or RedditKit::Subreddit objects.
       # @param visibility [public, private] An array of subreddit names to be added to the multireddit.
       def update_multireddit(multireddit, subreddits = [], visibility = 'private')
-        create_or_update_multireddit(:put, multireddit, subreddits, visibility)
+        create_or_update_multireddit :put, multireddit, subreddits, visibility
       end
 
       # Copies a multireddit.
@@ -162,7 +162,7 @@ module RedditKit
         path = "api/multi#{multireddit_path}/r/#{subreddit_name}"
         model = { :name => subreddit_name }
 
-        put(path, { :model => model.to_json })
+        put path, :model => model.to_json
       end
 
       # Removes a subreddit from a multireddit owned by the current user.
@@ -198,7 +198,7 @@ module RedditKit
 
         model = { :visibility => visibility, :subreddits => subreddit_hashes }
         parameters = { :multipath => multireddit_path, :model => model.to_json }
-        
+
         request(method, path, parameters, connection)
       end
 

data/lib/redditkit/client/private_messages.rb

@@ -2,7 +2,7 @@ require 'redditkit/private_message'
 
 module RedditKit
   class Client
-    
+
     # Methods for retrieving and sending private messages.
     module PrivateMessages
 
@@ -10,11 +10,13 @@ module RedditKit
       #
       # @option options [inbox, unread, sent, messages, mentions, moderator, comments, selfreply] :category The category from which to return messages.
       # @option options [1..100] :limit The number of messages to return.
-      # @option options [String] :before Only return subreddits before this id. 
+      # @option options [String] :before Only return subreddits before this id.
       # @option options [String] :after Only return subreddits after this id.
       # @option options [Boolean] :mark Whether to mark requested messages as read.
       # @return [RedditKit::PaginatedResponse]
       def messages(options = {})
+        options = options.clone
+
         category = options[:category] || 'inbox'
         path = "message/#{category}.json"
         options.delete :category
@@ -55,7 +57,7 @@ module RedditKit
       # Blocks the author of a private message or comment.
       # Users cannot be blocked based on username as reddit only allows you to block those who have harassed you (thus leaving a message in your inbox).
       #
-      # @param message [String, RedditKit::PrivateMessage] A private message's full name, or a RedditKit::PrivateMessage. 
+      # @param message [String, RedditKit::PrivateMessage] A private message's full name, or a RedditKit::PrivateMessage.
       def block_author_of_message(message)
         parameters = { :id => extract_full_name(message) }
         post('api/block', parameters)
@@ -63,7 +65,7 @@ module RedditKit
 
       # Unblocks a user.
       #
-      # @param user [String, RedditKit::User] A user's username, or a RedditKit::User. 
+      # @param user [String, RedditKit::User] A user's username, or a RedditKit::User.
       def unblock(user)
         enemy_name = extract_string(user, :username)
         friend_request 'unfriend', :container => current_user.full_name, :name => enemy_name, :type => :enemy

data/lib/redditkit/client/search.rb

@@ -12,7 +12,7 @@ module RedditKit
       # @option options [1..100] limit The number of links to return.
       # @option options [String] count The number of results to return before or after. This is different from `limit`.
       # @option options [relevance, new, hot, top, comments] sort The sorting order for search results.
-      # @option options [String] before Only return links before this full name. 
+      # @option options [String] before Only return links before this full name.
       # @option options [String] after Only return links after this full name.
       # @option options [cloudsearch, lucene, plain] syntax Specify the syntax for the search. Learn more: http://www.reddit.com/r/redditdev/comments/1hpicu/whats_this_syntaxcloudsearch_do/cawm0fe
       # @option options [hour, day, week, month, year, all] time Show results with a specific time period.

data/lib/redditkit/client/subreddits.rb

@@ -10,10 +10,12 @@ module RedditKit
       #
       # @option options [new, popular, banned] category The category of subreddits. Defaults to popular.
       # @option options [1..100] limit The number of subreddits to return.
-      # @option options [String] before Only return subreddits before this id. 
+      # @option options [String] before Only return subreddits before this id.
       # @option options [String] after Only return subreddits after this id.
       # @return [RedditKit::PaginatedResponse]
       def subreddits(options = {})
+        options = options.clone
+
         category = options[:category] or 'popular'
         path = "reddits/#{category}.json"
         options.delete :category
@@ -21,14 +23,16 @@ module RedditKit
         objects_from_response(:get, path, options)
       end
 
-      # Gets the current user's subscribed subreddits. 
+      # Gets the current user's subscribed subreddits.
       #
       # @option options [subscriber, contributor, moderator] category The category from which to return subreddits. Defaults to subscriber.
       # @option options [1..100] limit The number of subreddits to return.
-      # @option options [String] before Only return subreddits before this id. 
+      # @option options [String] before Only return subreddits before this id.
       # @option options [String] after Only return subreddits after this id.
       # @return [RedditKit::PaginatedResponse]
       def subscribed_subreddits(options = {})
+        options = options.clone
+
         category = options[:category] or 'subscriber'
         path = "subreddits/mine/#{category}.json"
         options.delete :category
@@ -52,7 +56,7 @@ module RedditKit
         full_name = extract_full_name subreddit
         parameters = { :action => 'sub', :sr => full_name }
 
-        post("api/subscribe", parameters)
+        post('api/subscribe', parameters)
       end
 
       # Unsubscribes from a subreddit.
@@ -62,7 +66,7 @@ module RedditKit
         full_name = extract_full_name subreddit
         parameters = { :action => 'unsub', :sr => full_name }
 
-        post("api/subscribe", parameters)
+        post('api/subscribe', parameters)
       end
 
       # Gets a random subreddit.
@@ -97,7 +101,7 @@ module RedditKit
         response = get('api/subreddits_by_topic.json', parameters)
         body =  response[:body]
 
-        body.collect { |subreddit| subreddit[:name] }
+        body.map { |subreddit| subreddit[:name] }
       end
 
       # Gets an array of recommended subreddits.
@@ -112,7 +116,7 @@ module RedditKit
         response = get('api/subreddit_recommendations.json', parameters)
         body =  response[:body]
 
-        body.collect { |subreddit| subreddit[:sr_name] }
+        body.map { |subreddit| subreddit[:sr_name] }
       end
 
     end

data/lib/redditkit/client/users.rb

@@ -11,23 +11,25 @@ module RedditKit
       # @param username [String] A reddit account's username. Gets the current user if this is nil.
       # @return [RedditKit::User]
       # @example current_user = client.user
-      # @example user = client.user 'amberlynns' 
+      # @example user = client.user 'amberlynns'
       def user(username = nil)
         if username
           object_from_response(:get, "user/#{username}/about.json", nil)
         else
-          object_from_response(:get, "api/me.json", nil)
+          object_from_response(:get, 'api/me.json', nil)
         end
       end
 
-      # Gets links and comments for the current user. 
+      # Gets links and comments for the current user.
       #
       # @option options [overview, comments, submitted, liked, disliked] :category The category from which to return links and comments. Defaults to overview.
       # @option options [1..100] :limit The number of links and comments to return.
-      # @option options [String] :before Only return links and comments before this id. 
+      # @option options [String] :before Only return links and comments before this id.
       # @option options [String] :after Only return links and comments after this id.
       # @return [RedditKit::PaginatedResponse]
       def my_content(options = {})
+        options = options.clone
+
         category = options[:category] || :overview
         path = "user/#{@username}/#{category}.json"
         options.delete :category
@@ -35,15 +37,16 @@ module RedditKit
         objects_from_response(:get, path, options)
       end
 
-      # Gets links and comments for a user. 
+      # Gets links and comments for a user.
       #
       # @option options [overview, comments, submitted, liked, disliked] :category The category from which to return links and comments. Defaults to overview.
       # @option options [1..100] :limit The number of links and comments to return.
-      # @option options [String] :before Only return links and comments before this id. 
+      # @option options [String] :before Only return links and comments before this id.
       # @option options [String] :after Only return links and comments after this id.
       # @return [RedditKit::PaginatedResponse]
       # @note Public access to the liked and disliked categories is disabled by default, so this will return an empty array for most users.
       def user_content(user, options = {})
+        options = options.clone
         username = user
 
         path = "user/#{username}/%s.json" % (options[:category] if options[:category])
@@ -60,7 +63,7 @@ module RedditKit
         body = response[:body]
         friends = body[0][:data][:children]
 
-        friends.collect { |friend| OpenStruct.new(friend) }
+        friends.map { |friend| OpenStruct.new(friend) }
       end
 
       # Adds a user to the current user's friend list.
@@ -71,25 +74,25 @@ module RedditKit
         friend_request 'friend', :container => current_user.full_name, :name => friend_name, :type => :friend
       end
 
-      # Removes a user from the current user's friend list. 
+      # Removes a user from the current user's friend list.
       #
-      # @param user [String, RedditKit::User] A user's ID, or a RedditKit::User. 
+      # @param user [String, RedditKit::User] A user's ID, or a RedditKit::User.
       def unfriend(user)
         friend_name = extract_string(user, :username)
         friend_request 'unfriend', :container => current_user.full_name, :name => friend_name, :type => :friend
       end
 
-      # Checks whether a specific username is available. 
+      # Checks whether a specific username is available.
       #
       # @param username [String] A username for which to check availability.
       # @return [Boolean]
-      # @example puts "Username is available" if client.username_available? 'some_username' 
+      # @example puts "Username is available" if client.username_available? 'some_username'
       def username_available?(username)
         response = get('api/username_available.json', :user => username)
-        available = response[:body]
+        response[:body]
       end
 
-      # Registers a new reddit account. 
+      # Registers a new reddit account.
       #
       # @option options [String] username The username to register.
       # @option options [String] password The password for the account.
@@ -98,7 +101,7 @@ module RedditKit
       # @option options [String] captcha The user's response to the CAPTCHA challenge.
       # @option options [Boolean] remember Whether to keep the user's session cookie beyond the current session.
       def register(username, password, options = {})
-        parameters = { :user => username, :passwd => password, :passwd2 => password, :captcha => options[:captcha], :iden => options[:captcha_identifier] }
+        parameters = { :user => username, :passwd => password, :passwd2 => password, :email => options[:email], :captcha => options[:captcha], :iden => options[:captcha_identifier] }
         post('api/register', parameters)
       end
 

data/lib/redditkit/client/utilities.rb

@@ -48,21 +48,21 @@ module RedditKit
       # @return [Class]
       def object_class_from_kind(kind)
         case kind
-        when "t1"
+        when 't1'
           RedditKit::Comment
-        when "t2"
+        when 't2'
           RedditKit::User
-        when "t3"
+        when 't3'
           RedditKit::Link
-        when "t4"
+        when 't4'
           RedditKit::PrivateMessage
-        when "t5"
+        when 't5'
           RedditKit::Subreddit
-        when "LabeledMulti"
+        when 'LabeledMulti'
           RedditKit::Multireddit
-        when "LabeledMultiDescription"
+        when 'LabeledMultiDescription'
           RedditKit::MultiredditDescription
-        when "modaction"
+        when 'modaction'
           RedditKit::ModeratorAction
         end
       end
@@ -124,6 +124,8 @@ module RedditKit
       # @param type [friend, unfriend] The type of request.
       # @param options Any parameters to send with the request.
       def friend_request(type, options)
+        options = options.clone
+
         if options[:subreddit]
           options[:r] = options[:subreddit]
           options.delete :subreddit

data/lib/redditkit/client/voting.rb

@@ -6,28 +6,28 @@ module RedditKit
 
       # Upvotes a link or comment.
       #
-      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment to upvote. 
+      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment to upvote.
       def upvote(link_or_comment)
         vote link_or_comment, 1
       end
 
-      # Downvotes a link or comment. 
+      # Downvotes a link or comment.
       #
-      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment to downvote. 
+      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment to downvote.
       def downvote(link_or_comment)
         vote link_or_comment, -1
       end
 
       # Withdraws a vote on a link or comment.
       #
-      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment from which to withdraw the vote. 
+      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment from which to withdraw the vote.
       def withdraw_vote(link_or_comment)
         vote link_or_comment, 0
       end
 
       # Votes on a link or comment.
       #
-      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment from which to withdraw the vote. 
+      # @param link_or_comment [String, RedditKit::Comment, RedditKit::Link] The link or comment from which to withdraw the vote.
       # @param direction [-1, 0, 1] Downvote, no vote, and upvote respectively.
       def vote(link_or_comment, direction)
         full_name = extract_full_name(link_or_comment)