DESCRIPTION

Reddit::Client provides methods and object wrappers for objects exposed by the Reddit API. This module handles HTTP communication, oauth session management, and communication with Reddit's external API. For more information about the Reddit API, see https://github.com/reddit/reddit/wiki/API.

Beginning August 3rd, 2015, the Reddit API requires Oauth authentication. This amounts to two extra arguments at the beginning of your script; in exchange you you twice as many requests per minute as before (60 vs 30) and some added convenience on the back end.

To get Oauth keys, visit your apps page: https://www.reddit.com/prefs/apps. Choose a "script" type app. None of the other fields are needed for a script type app; you can put in 127.0.0.1 for the URLs or whatever you like.

Every account that uses this script must have permission to use it. So for example if you were to check the inboxes of your various accounts, each one would need permission. To add accounts click "add developer" on the right, after you've created the app.

CONSTANTS

VIEW_HOT "Hot" links feed
VIEW_NEW "New" links feed
VIEW_RISING "Rising" links feed
VIEW_CONTROVERSIAL "Controversial" links feed
VIEW_TOP "Top" links feed
VIEW_DEFAULT Default feed if not specified (VIEW_HOT)
DEFAULT_LIMIT The default number of links to be retried (25)
VOTE_UP Up vote
VOTE_DOWN Down vote
VOTE_NONE Remove any vote
SUBREDDITS_HOME List reddits on the homepage
SUBREDDITS_POPULAR List popular reddits
SUBREDDITS_NEW List new reddits
SUBREDDITS_MINE List reddits for which the logged in user is subscribed
SUBREDDITS_CONTRIB List reddits for which the logged in user is a contributor
SUBREDDITS_MOD List reddits for which the logged in user is a moderator

GLOBALS

SUBROUTINES/METHODS

Creates a new Reddit::Client object. Optionally authenticates at the same time. If any of the four optional arguments are used, all are required.

get_token(client_id =>, secret =>, username=>, password =>)

Get an Oauth token from Reddit. The client ID and secret come from your apps page, where you will first have to register the script: https://www.reddit.com/prefs/apps. Only the account that created the app and accounts that are registered as developers for the app will be able to use it.

For a Perl script, select a "script" type app. The "about url" and "redirect uri" can be any address; they are not used for scripts.

has_token

Return true if a valid Oauth token exists.

me

Returns a Reddit::Client::Account object.

info($fullname)

Returns a hash of information about $item_id, which must be a fullname (i.e. the combination of a thing's ID and its prefix: "t3_xxxxx". A list of prefixes can be found at https://www.reddit.com/dev/api).

list_subreddits($type)

Returns a list of Reddit::Client::SubReddit objects for $type, where $type is a SUBREDDITS_* constant. A number of alias functions are available:

Returns a list of Link objects. To get at the posts, iterate the items array.

All arguments are optional. If subreddit is specified, the list of links is returned from the desired subreddit or multi (i.e. "pics+new"). Otherwise, the links will be from the front page of the authenticated user (i.e. what you would see as the front page if you logged in as that user) . view specifieds the feed (e.g. VIEW_NEW or VIEW_HOT). limit may be used to limit the number of objects returned; Reddit returns a maximum of 100. before and after denote the placeholders for slicing the feed up, just as the reddit urls themselves do. Data is returned as a hash with three keys, before, after, and items.

Return a list of Reddit::Client::Comment objects from a subreddit or multi. All arguments are optional. If subreddit is ommitted, a multi of the subscribed subreddits from the authenticating account will be returned (i.e. what you see when you visit reddit.com's from page and are logged in). If limit is ommitted, Reddit's default limit of 25 is used. If limit is present but false, this is interpreted as no limit and the maximum is returned (100).

submit_comment(parent_id => ..., text => ...)

Submits a new comment underneath parent_id. parent_id must be a fullname.

vote(item_id => ..., direction => ...)

Votes for item_id. direction is one of VOTE_UP, VOTE_DOWN, or VOTE_NONE. item_id must be a fullname.

save($item_id)

Saves $item_id under the user's account. item_id must be a fullname.

unsave($item_id)

Unsaves $item_id under the user's account. item_id must be a fullname.

hide($item_id)

Hides $<item_id>. Throws an error if the user does not have permission to hide the item in question. item_id must be a fullname.

unhide($item_id)

Unhides $<item_id>. Throws an error if the user does not have permission to unhide the item in question. item_id must be a fullname.

INTERNAL ROUTINES

DEBUG

When $Reddit::Client::DEBUG is true, acts as syntactic sugar for warn(sprintf(@_)). Used to provided logging.

subreddit

Strips slashes and leading /r from a subreddit to ensure that only the "display name" of the subreddit is returned.

request

Performs a request to reddit's servers using LWP. If the user is logged in, adds the "uh" and "modhash" parameters to POST queries as well as adding the reddit-specified cookie value for reddit_session.

json_request

Wraps request, configuring the parameters to perform the request with an api_type of "json". After the request is complete, parses the JSON result and throws and error if one is specified in the result contents. Otherwise, returns the json data portion of the result.

As a valued partner and proud supporter of MetaCPAN, StickerYou is
happy to offer a 10% discount on all Custom Stickers,
Business Labels, Roll Labels,
Vinyl Lettering or Custom Decals. StickerYou.com
is your one-stop shop to make your business stick.
Use code METACPAN10 at checkout to apply your discount.