Reddit

This module should be most of what you need to operate the library. It exports functionality for running built RedditT actions, as well as re-exporting a few helpful types from around the library. Not every type is exported, however, due to clashing record fields. It's recommended to import modules from Reddit.Types.* qualified so that you can use all the record fields without having to deal with ambiguous functions.

Documentation

runReddit :: MonadIO m => Text -> Text -> ClientParams -> RedditT m a -> m (Either (APIError RedditError) a)

Run a Reddit action (or a RedditT transformer action). This uses the default logged-in settings for RedditOptions: rate limiting enabled, default manager, login via username and password, and the default user-agent. You should change the user agent if you're making anything more complex than a basic script, since Reddit's API policy says that you should have a uniquely identifiable user agent.

runRedditAnon :: MonadIO m => RedditT m a -> m (Either (APIError RedditError) a)

Run a Reddit action (or a RedditT transformer action). This uses the default logged-out settings, so you won't be able to do anything that requires authentication (like checking messages or making a post). At the moment, authentication isn't statically checked, so it'll return a runtime error if you try to do anything you don't have permissions for.

runRedditWith :: MonadIO m => RedditOptions -> RedditT m a -> m (Either (APIError RedditError) a)

Run a Reddit or RedditT action with custom settings. You probably won't need this function for most things, but it's handy if you want to persist a connection over multiple Reddit sessions or use a custom user agent string.

runResumeRedditWith :: MonadIO m => RedditOptions -> RedditT m a -> m (Either (APIError RedditError, Maybe (RedditT m a)) a)

Run a Reddit or RedditT action with custom settings. You probably won't need this function for most things, but it's handy if you want to persist a connection over multiple Reddit sessions or use a custom user agent string.

interpretIO :: MonadIO m => RedditState -> RedditT m a -> m (Either (APIError RedditError, Maybe (RedditT m a)) a)

data RedditOptions

Options for how we should run the Reddit action.

• rateLimitingEnabled: True if the connection should be automatically rate-limited and should pause when we hit the limit, False otherwise. Default is True.
• connectionManager: Just x if the connection should use the Manager x, Nothing if we should create a new one for the connection. Default is Nothing.
• loginMethod: The method we should use for authentication, described in LoginMethod. Default is Anonymous.
• customUserAgent: Just "string" if the connection should use the user agent "string", Nothing if it should use the default agent. Default is Nothing.

Constructors

RedditOptions

Fields

• rateLimitingEnabled :: Bool
• connectionManager :: Maybe Manager
• loginMethod :: LoginMethod
• customUserAgent :: Maybe ByteString

Instances

Default RedditOptions

Defined in Reddit

Methods

def :: RedditOptions

defaultRedditOptions :: RedditOptions

The default set of options

data LoginMethod

Should we log in to Reddit? If so, should we use a stored set of credentials or get a new fresh set?

Constructors

Anonymous

Don't login, instead use an anonymous account

Credentials Text Text ClientParams

Login using the specified username and password

StoredDetails LoginDetails

Login using a stored set of credentials. Usually the best way to get these is to do runRedditAnon $ login user pass.

Instances

Show LoginMethod

Defined in Reddit

Methods

showsPrec :: Int -> LoginMethod -> ShowS

show :: LoginMethod -> String

showList :: [LoginMethod] -> ShowS

Default LoginMethod

Defined in Reddit

Methods

def :: LoginMethod

Re-exports

data APIError a

Error type for the API, where a is the type that should be returned when something goes wrong on the other end - i.e. any error that isn't directly related to this library.

Constructors

APIError a

A type that represents any error that happens on the API end. Define your own custom type with a FromJSON instance if you want to handle them, or you can use () if you just want to ignore them all.

HTTPError HttpException

Something went wrong when we tried to do a HTTP operation.

InvalidURLError

You're trying to create an invalid URL somewhere - check your Builder's base URL and your Routes.

ParseError String

Failed when parsing the response, and it wasn't an error on their end.

EmptyError

Empty error to serve as a zero element for Monoid.

Instances

Eq a => Eq (APIError a)

Defined in Network.API.Builder.Error

Methods

(==) :: APIError a -> APIError a -> Bool

(/=) :: APIError a -> APIError a -> Bool

Show a => Show (APIError a)

Defined in Network.API.Builder.Error

Methods

showsPrec :: Int -> APIError a -> ShowS

show :: APIError a -> String

showList :: [APIError a] -> ShowS

Semigroup (APIError a)

Defined in Network.API.Builder.Error

Methods

(<>) :: APIError a -> APIError a -> APIError a

sconcat :: NonEmpty (APIError a) -> APIError a

stimes :: Integral b => b -> APIError a -> APIError a

Monoid (APIError a)

Defined in Network.API.Builder.Error

Methods

mempty :: APIError a

mappend :: APIError a -> APIError a -> APIError a

mconcat :: [APIError a] -> APIError a

module Reddit.Actions

module Reddit.Types

module Reddit.Types.Error

data ClientParams

Constructors

ClientParams Text Text

Instances

Eq ClientParams

Defined in Reddit.Types.Reddit

Methods

(==) :: ClientParams -> ClientParams -> Bool

(/=) :: ClientParams -> ClientParams -> Bool

Ord ClientParams

Defined in Reddit.Types.Reddit

Methods

compare :: ClientParams -> ClientParams -> Ordering

(<) :: ClientParams -> ClientParams -> Bool

(<=) :: ClientParams -> ClientParams -> Bool

(>) :: ClientParams -> ClientParams -> Bool

(>=) :: ClientParams -> ClientParams -> Bool

max :: ClientParams -> ClientParams -> ClientParams

min :: ClientParams -> ClientParams -> ClientParams

Read ClientParams

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS ClientParams

readList :: ReadS [ClientParams]

readPrec :: ReadPrec ClientParams

readListPrec :: ReadPrec [ClientParams]

Show ClientParams

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> ClientParams -> ShowS

show :: ClientParams -> String

showList :: [ClientParams] -> ShowS

data RateLimitInfo

Constructors

RateLimitInfo

Fields

• used :: Integer
• remaining :: Integer
• resetTime :: UTCTime

Instances

Eq RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

(==) :: RateLimitInfo -> RateLimitInfo -> Bool

(/=) :: RateLimitInfo -> RateLimitInfo -> Bool

Read RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS RateLimitInfo

readList :: ReadS [RateLimitInfo]

readPrec :: ReadPrec RateLimitInfo

readListPrec :: ReadPrec [RateLimitInfo]

Show RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> RateLimitInfo -> ShowS

show :: RateLimitInfo -> String

showList :: [RateLimitInfo] -> ShowS

type ShouldRateLimit = Bool

data RateLimits

Constructors

RateLimits ShouldRateLimit (Maybe RateLimitInfo)

Instances

Eq RateLimits

Defined in Reddit.Types.Reddit

Methods

(==) :: RateLimits -> RateLimits -> Bool

(/=) :: RateLimits -> RateLimits -> Bool

Read RateLimits

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS RateLimits

readList :: ReadS [RateLimits]

readPrec :: ReadPrec RateLimits

readListPrec :: ReadPrec [RateLimits]

Show RateLimits

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> RateLimits -> ShowS

show :: RateLimits -> String

showList :: [RateLimits] -> ShowS

newtype POSTWrapped a

Constructors

POSTWrapped a

Instances

Functor POSTWrapped

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> POSTWrapped a -> POSTWrapped b

(<$) :: a -> POSTWrapped b -> POSTWrapped a

Eq a => Eq (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

(==) :: POSTWrapped a -> POSTWrapped a -> Bool

(/=) :: POSTWrapped a -> POSTWrapped a -> Bool

Read a => Read (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS (POSTWrapped a)

readList :: ReadS [POSTWrapped a]

readPrec :: ReadPrec (POSTWrapped a)

readListPrec :: ReadPrec [POSTWrapped a]

Show a => Show (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> POSTWrapped a -> ShowS

show :: POSTWrapped a -> String

showList :: [POSTWrapped a] -> ShowS

FromJSON (POSTWrapped [CommentReference])

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped [CommentReference])

parseJSONList :: Value -> Parser [POSTWrapped [CommentReference]]

FromJSON (POSTWrapped CaptchaID)

Defined in Reddit.Types.Captcha

Methods

parseJSON :: Value -> Parser (POSTWrapped CaptchaID)

parseJSONList :: Value -> Parser [POSTWrapped CaptchaID]

FromJSON (POSTWrapped PostID)

Defined in Reddit.Types.Post

Methods

parseJSON :: Value -> Parser (POSTWrapped PostID)

parseJSONList :: Value -> Parser [POSTWrapped PostID]

FromJSON (POSTWrapped Comment)

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped Comment)

parseJSONList :: Value -> Parser [POSTWrapped Comment]

FromJSON (POSTWrapped CommentID)

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped CommentID)

parseJSONList :: Value -> Parser [POSTWrapped CommentID]

FromJSON (POSTWrapped MessageID)

Defined in Reddit.Types.Message

Methods

parseJSON :: Value -> Parser (POSTWrapped MessageID)

parseJSONList :: Value -> Parser [POSTWrapped MessageID]

data LoginDetails

Constructors

LoginDetails Modhash CookieJar

Instances

Show LoginDetails

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> LoginDetails -> ShowS

show :: LoginDetails -> String

showList :: [LoginDetails] -> ShowS

Receivable LoginDetails

Defined in Reddit.Types.Reddit

Methods

receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) LoginDetails

newtype Modhash

Constructors

Modhash Text

Instances

Eq Modhash

Defined in Reddit.Types.Reddit

Methods

(==) :: Modhash -> Modhash -> Bool

(/=) :: Modhash -> Modhash -> Bool

Read Modhash

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS Modhash

readList :: ReadS [Modhash]

readPrec :: ReadPrec Modhash

readListPrec :: ReadPrec [Modhash]

Show Modhash

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> Modhash -> ShowS

show :: Modhash -> String

showList :: [Modhash] -> ShowS

FromJSON Modhash

Defined in Reddit.Types.Reddit

Methods

parseJSON :: Value -> Parser Modhash

parseJSONList :: Value -> Parser [Modhash]

newtype RedditT m a

Constructors

RedditT (FreeT (RedditF m) m a)

Instances

MonadTrans RedditT

Defined in Reddit.Types.Reddit

Methods

lift :: Monad m => m a -> RedditT m a

Monad m => Monad (RedditT m)

Defined in Reddit.Types.Reddit

Methods

(>>=) :: RedditT m a -> (a -> RedditT m b) -> RedditT m b

(>>) :: RedditT m a -> RedditT m b -> RedditT m b

return :: a -> RedditT m a

Monad m => Functor (RedditT m)

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> RedditT m a -> RedditT m b

(<$) :: a -> RedditT m b -> RedditT m a

Monad m => Applicative (RedditT m)

Defined in Reddit.Types.Reddit

Methods

pure :: a -> RedditT m a

(<*>) :: RedditT m (a -> b) -> RedditT m a -> RedditT m b

liftA2 :: (a -> b -> c) -> RedditT m a -> RedditT m b -> RedditT m c

(*>) :: RedditT m a -> RedditT m b -> RedditT m b

(<*) :: RedditT m a -> RedditT m b -> RedditT m a

MonadIO m => MonadIO (RedditT m)

Defined in Reddit.Types.Reddit

Methods

liftIO :: IO a -> RedditT m a

data RedditF m a where

Constructors

FailWith :: APIError RedditError -> RedditF m a

Nest :: RedditT m b -> (Either (APIError RedditError) b -> a) -> RedditF m a

NestResuming :: RedditT m b -> (Either (APIError RedditError, Maybe (RedditT m b)) b -> a) -> RedditF m a

ReceiveRoute :: Receivable b => Route -> (b -> a) -> RedditF m a

RunRoute :: FromJSON b => Route -> (b -> a) -> RedditF m a

WithBaseURL :: Text -> RedditT m b -> (b -> a) -> RedditF m a

WithHeaders :: ([Header] -> [Header]) -> RedditT m b -> (b -> a) -> RedditF m a

Instances

Functor (RedditF m)

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> RedditF m a -> RedditF m b

(<$) :: a -> RedditF m b -> RedditF m a

type Reddit a = RedditT IO a

runRoute :: (FromJSON a, Monad m) => Route -> RedditT m a

receiveRoute :: (Receivable a, Monad m) => Route -> RedditT m a

nest :: Monad m => RedditT m a -> RedditT m (Either (APIError RedditError) a)

withBaseURL :: Monad m => Text -> RedditT m a -> RedditT m a

withHeaders :: Monad m => ([Header] -> [Header]) -> RedditT m a -> RedditT m a

failWith :: Monad m => APIError RedditError -> RedditT m a

headersToRateLimitInfo :: ResponseHeaders -> UTCTime -> Maybe RateLimitInfo

mkClientParamsHeader :: ClientParams -> (HeaderName, ByteString)

addAPIType :: Route -> Route

mainBaseURL :: Text

loginBaseURL :: Text