redd 0.6.5 → 0.7.0

data/lib/redd/client/authenticated/account.rb

@@ -1,13 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to manage the logged-in user
-      module Account
-        # @return [Redd::Object::User] The logged-in user.
-        def me
-          object_from_response :get, "/api/me.json"
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/apps.rb

@@ -1,13 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with OAuth2 Apps
-      module Apps
-        # Low-Priority
-        #
-        # There should be very little reasons for bots to mess around with app
-        # settings, so this module might be worked on later or not at all.
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/flair.rb

@@ -1,71 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with link and user flairs.
-      module Flair
-        # Get a list of everbody on the subreddit with a user flair.
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   find the users in.
-        # @param params [Hash] A list of params to send with the request.
-        # @option params [String] :after Return results after the given
-        #   fullname.
-        # @option params [String] :before Return results before the given
-        #   fullname.
-        # @option params [Integer] :count (0) The number of items already seen
-        #   in the listing.
-        # @option params [1..1000] :limit (25) The maximum number of things to
-        #   return.
-        # @return [Array<Hash>] An array of users.
-        def get_flair_list(subreddit, params = {})
-          name = extract_attribute(subreddit, :display_name)
-
-          path = "/api/flairlist.json"
-          path = path.prepend("/r/#{name}")
-
-          get(path, params)[:users]
-        end
-
-        # Get the flair of a user.
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   find the user in.
-        # @param user [Redd::Object::User, String] The user to find.
-        # @return [Hash, nil] Flair info about the user or nil if nobody was
-        #   found.
-        def get_flair(subreddit, user)
-          display_name = extract_attribute(subreddit, :display_name)
-          username = extract_attribute(user, :name)
-          options = {name: username}
-
-          flair = get_flair_list(display_name, options).first
-          flair if flair[:user].casecmp(username.downcase) == 0
-        end
-
-        # Set the flair of a user or link.
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   find the user in.
-        # @param user_or_link [Redd::Object::Subreddit, Redd::Object::User]
-        #   The user or link to set the flair to.
-        # @param text [String] The text to set the flair to.
-        # @param css_class [String] The css_class of the flair.
-        def set_flair(subreddit, user_or_link, text = "", css_class = "")
-          name = extract_attribute(subreddit, :display_name)
-          path = "/r/#{name}/api/flair"
-          params = {api_type: "json", text: text, css_class: css_class}
-
-          case user_or_link
-          when Redd::Object::User
-            params[:name] = extract_attribute(user_or_link, :name)
-          when Redd::Object::Submission
-            params[:link] = extract_attribute(user_or_link, :display_name)
-          else
-            fail "You should provide a User or Submission object."
-          end
-
-          post path, params
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/gold.rb

@@ -1,13 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to gild a user, link or comment
-      module Gold
-        # Low-Priority
-        #
-        # Yeeaahh... Handing conrol of spending money to some code is pretty
-        # stupid. This might not be developed.
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/links_comments.rb

@@ -1,189 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to deal with comments and links
-      module LinksComments
-        # Submit a link or a text post to a subreddit.
-        #
-        # @param title [String] The title of the submission.
-        # @param kind [:self, :link] The type of submission to make.
-        # @param text_or_url [String] The url of the post if :link or the
-        #   content of the post if :text
-        # @param subreddit [Redd::Object::Submission, String] The subreddit
-        #   to submit to.
-        # @param captcha [String] A possible captcha result to send if one
-        #   is required.
-        # @param identifier [String] The identifier for the captcha if one
-        #   is required.
-        # @param options [Hash] A hash of additional options to send.
-        # @option options [Boolean] :resubmit (false) Whether to post a link
-        #   to a subreddit despite it having been posted there before.
-        # @option options [Boolean] :resubmit (false) Whether to automatically
-        #   save the post to the user's account after posting.
-        def submit(
-          title, kind, text_or_url, subreddit, captcha = nil, identifier = nil,
-          options = {}
-        )
-
-          params = {
-            api_type: "json", extension: "json", title: title, kind: kind
-          }
-          sr_name = extract_attribute(subreddit, :display_name)
-          params << {sr: sr_name}
-
-          case kind.to_sym
-          when :self
-            params[:text] = text_or_url
-          when :link
-            params[:url] = text_or_url
-          end
-
-          params << {captcha: captcha, iden: identifier} if captcha
-          params << options
-
-          post "/api/submit", params
-        end
-
-        # Add a comment to a link, reply to a comment or reply to a message.
-        # Bit of an all-purpose method, this one.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   Redd::Object::PrivateMessage, String] A thing to add a comment to.
-        # @param text [String] The text to comment.
-        def add_comment(thing, text)
-          fullname = extract_fullname(thing)
-          post "/api/comment", api_type: "json", text: text, thing_id: fullname
-        end
-
-        alias_method :reply, :add_comment
-
-        # Delete a thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A thing to delete.
-        def delete(thing)
-          fullname = extract_fullname(thing)
-          post "/api/del", id: fullname
-        end
-
-        # Edit a thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A thing to delete.
-        # @param text [String] The new text.
-        def edit(thing, text)
-          fullname = extract_fullname(thing)
-          post "/api/editusertext", api_type: "json",
-                                    thing_id: fullname,
-                                    text: text
-        end
-
-        # Hide a link from the logged-in user.
-        #
-        # @param thing [Redd::Object::Submission, String] A link to hide.
-        def hide(thing)
-          fullname = extract_fullname(thing)
-          post "/api/hide", id: fullname
-        end
-
-        # Unhide a previously hidden link.
-        #
-        # @param thing [Redd::Object::Submission, String] A link to show.
-        def unhide(thing)
-          fullname = extract_fullname(thing)
-          post "/api/unhide", id: fullname
-        end
-
-        # Mark a link as "NSFW" (Not Suitable For Work)
-        #
-        # @param thing [Redd::Object::Submission, String] A link to mark.
-        def mark_as_nsfw(thing)
-          fullname = extract_fullname(thing)
-          post "/api/marknsfw", id: fullname
-        end
-
-        # Remove the NSFW label from the link.
-        #
-        # @param thing [Redd::Object::Submission, String] A link to mark.
-        def unmark_as_nsfw(thing)
-          fullname = extract_fullname(thing)
-          post "/api/unmarknsfw", id: fullname
-        end
-
-        alias_method :mark_as_safe, :unmark_as_nsfw
-
-        # Report the link or comment to the subreddit moderators.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link to report.
-        def report(thing)
-          fullname = extract_fullname(thing)
-          post "/api/report", id: fullname
-        end
-
-        # Save a link or comment (if gilded) to the user's account.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link to save.
-        # @param category [String] A category to save to (if gilded).
-        def save(thing, category = nil)
-          fullname = extract_fullname(thing)
-          params = {id: fullname}
-          params << {category: category} if category
-          post "/api/save", params
-        end
-
-        # Remove the link or comment from the user's saved links.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link to unsave.
-        def unsave(thing)
-          fullname = extract_fullname(thing)
-          post "/api/unsave", id: fullname
-        end
-
-        # Upvote the thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link or comment to upvote.
-        # @see #vote
-        def upvote(thing)
-          vote(thing, 1)
-        end
-
-        # Downvote the thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link or comment to downvote.
-        # @see #vote
-        def downvote(thing)
-          vote(thing, -1)
-        end
-
-        # Clear the user's vote on the thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link or comment to remove the vote on.
-        # @see #vote
-        def unvote(thing)
-          vote(thing, 0)
-        end
-
-        alias_method :clear_vote, :unvote
-
-        private
-
-        # Set a vote on the thing.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment,
-        #   String] A link or comment to set a vote on.
-        # @note Votes must be cast by humans only! Your script can proxy a
-        #   user's actions, but it cannot decide what to vote.
-        def vote(thing, direction)
-          fullname = extract_fullname(thing)
-          post "/api/vote", id: fullname, dir: direction
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/live.rb

@@ -1,13 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with /r/live threads
-      module Live
-        # Low-priority
-        #
-        # When was this a thing? Let's just hope this doesn't become popular
-        # that quickly before I get to it.
-      end
-    end
-  end
-end

data/lib/redd/client/authenticated/moderation.rb

@@ -1,126 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods for moderating subreddits
-      module Moderation
-        # Approve a submission.
-        # @param thing [Redd::Object::Submission] The link to approve.
-        def approve(thing)
-          fullname = extract_fullname(thing)
-          post "/api/approve", id: fullname
-        end
-
-        # Remove a submission.
-        # @param thing [Redd::Object::Submission] The link to remove.
-        def remove(thing)
-          fullname = extract_fullname(thing)
-          post "/api/remove", id: fullname
-        end
-
-        # Distinguish a link or comment with a sigil to show that it has
-        # been created by a moderator.
-        #
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment]
-        #   The link or comment to distinguish.
-        # @param how [:yes, :no, :admin, :special] How to distinguish the
-        #   thing.
-        def distinguish(thing, how = :yes)
-          fullname = extract_fullname(thing)
-          post "/api/distinguish", api_type: "json", id: fullname, how: how
-        end
-
-        # Remove the sigil that shows a thing was created by a moderator.
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment]
-        #   The link or comment to undistinguish.
-        def undistinguish(thing)
-          distinguish(thing, :no)
-        end
-
-        # Accept a moderator invite from a subreddit.
-        # @param subreddit [Redd::Object::Subreddit] The subreddit to accept
-        #   the invitation from.
-        def accept_moderator_invite(subreddit)
-          name = extract_attribute(subreddit, :display_name)
-          post "/r/#{name}/api/accept_moderator_invite", api_type: "json"
-        end
-
-        # Stop being a contributor of the subreddit.
-        # @param subreddit [Redd::Object::Subreddit] The subreddit to stop
-        #   being a contributor of.
-        def leave_contributor_status(subreddit)
-          fullname = extract_fullname(subreddit)
-          post "/api/leavecontributor", id: fullname
-        end
-
-        # Stop being a moderator of the subreddit.
-        # @param subreddit [Redd::Object::Subreddit] The subreddit to stop
-        #   being a moderator of.
-        def leave_moderator_status(subreddit)
-          fullname = extract_fullname(subreddit)
-          post "/api/leavemoderator", id: fullname
-        end
-
-        # Stop getting any moderator-related reports on the thing.
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment]
-        #   The thing to stop getting reports on.
-        def ignore_reports(thing)
-          fullname = extract_fullname(thing)
-          post "/api/ignore_reports", id: fullname
-        end
-
-        # Start getting moderator-related reports on the thing again.
-        # @param thing [Redd::Object::Submission, Redd::Object::Comment]
-        #   The thing to start getting reports on.
-        def unignore_reports(thing)
-          fullname = extract_fullname(thing)
-          post "/api/unignore_reports", id: fullname
-        end
-
-        # @!method get_reports
-        # @!method get_spam
-        # @!method get_modqueue
-        # @!method get_unmoderated
-        #
-        # Get the appropriate listing.
-        # @param subreddit [Redd::Object::Subreddit] The subreddit to query.
-        # @param params [Hash] A list of params to send with the request.
-        #
-        # @see #get_submissions
-        %w(reports spam modqueue unmoderated).each do |sort|
-          define_method :"get_#{sort}" do |subreddit = nil, params = {}|
-            get_submissions(sort, subreddit, params)
-          end
-        end
-
-        private
-
-        # Get a listing to moderator-related subreddits.
-        #
-        # @param type [:reports, :spam, :modqueue, :unmoderated] How the
-        #   results are sorted.
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   query.
-        # @param params [Hash] A list of params to send with the request.
-        # @option params [String] :after Return results after the given
-        #   fullname.
-        # @option params [String] :before Return results before the given
-        #   fullname.
-        # @option params [Integer] :count (0) The number of items already seen
-        #   in the listing.
-        # @option params [1..100] :limit (25) The maximum number of things to
-        #   return.
-        # @option params :location No idea what this does.
-        # @option params [:links, :comments] :only The type of things to show.
-        # @return [Redd::Object::Listing] A listing of submissions or comments.
-        #
-        def get_submissions(type, subreddit = nil, params = {})
-          subreddit_name = extract_attribute(subreddit, :display_name)
-          path = "/about/#{type}.json"
-          path = path.prepend("/r/#{subreddit_name}") if subreddit_name
-
-          object_from_response :get, path, params
-        end
-      end
-    end
-  end
-end