Captcha.Internal.Monad.Class

This module is for internal-use and does not follow pvp versioning policies.

Documentation

class Monad m => MonadCaptcha api r m where

Abstracts over a captcha solving service.

Associated Types

type CaptchaError api r m

An error specific to the captcha solving service.

Methods

createTask

Arguments

:: CaptchaRequest api ctx r m

=> ctx

The captcha to be solved.

-> m (Either (CaptchaError api r m) (CaptchaId ctx))

Captcha id to be used with getTask.

Submit a task to be solved by the api service.

getTask

Arguments

:: CaptchaResponse api ctx

=> Text

The captcha service's API key.

-> CaptchaId ctx

The captcha to check the answer of.

-> m (Either (CaptchaError api r m) Text)

The captcha's solution.

Attempt to retrieve the answer of the captcha.

solve

Arguments

:: (CaptchaRequest api ctx r m, CaptchaResponse api ctx, HasApiKey ctx Text, HasPollingInterval ctx (Maybe (Time Millisecond)), HasTimeoutDuration ctx (Maybe (Time Millisecond)))

=> ctx

Captcha to be solved.

-> m (Either (CaptchaError api r m) Text)

The captcha's solution.

Solves a captcha by submitting it with createTask and then polling with getTask until the answer is ready.

This will poll until the configured timeout duration is past. Its default value depends on the captcha service.

class CaptchaRequest api ctx r m where

Different captcha services have different request formats. This abstracts over it and sends the correct HTTP request.

Methods

request

Arguments

:: ctx

The captcha to be solved.

-> Text

The url to send the request to.

-> m (Response ByteString)

Send a request using the given captcha context.

class CaptchaResponse api ctx where

Different captcha services have different response formats. This abstracts over it and provides the captcha result.

Methods

parseResult :: Value -> Maybe Value

Parse the captcha result from the given json.

newtype CaptchaId ctx

Identifier for retrieving a captcha's answer.

Constructors

CaptchaId

Fields

• unCaptchaId :: Integer

Instances

Eq (CaptchaId ctx)

Defined in Captcha.Internal.Monad.Class

Methods

(==) :: CaptchaId ctx -> CaptchaId ctx -> Bool

(/=) :: CaptchaId ctx -> CaptchaId ctx -> Bool

Ord (CaptchaId ctx)

Defined in Captcha.Internal.Monad.Class

Methods

compare :: CaptchaId ctx -> CaptchaId ctx -> Ordering

(<) :: CaptchaId ctx -> CaptchaId ctx -> Bool

(<=) :: CaptchaId ctx -> CaptchaId ctx -> Bool

(>) :: CaptchaId ctx -> CaptchaId ctx -> Bool

(>=) :: CaptchaId ctx -> CaptchaId ctx -> Bool

max :: CaptchaId ctx -> CaptchaId ctx -> CaptchaId ctx

min :: CaptchaId ctx -> CaptchaId ctx -> CaptchaId ctx

Show (CaptchaId ctx)

Defined in Captcha.Internal.Monad.Class

Methods

showsPrec :: Int -> CaptchaId ctx -> ShowS

show :: CaptchaId ctx -> String

showList :: [CaptchaId ctx] -> ShowS