Copyright	(c) 2022 Edward Yang
License	MIT
Safe Haskell	None
Language	Haskell2010

Captcha.CapMonster

Description

This module exports functions that follow the pvp versioning policies.

Documentation

data CapMonsterErrorCode Source #

An error code returned by the CapMonster API.

Constructors

KeyDoesNotExist	The provided API key does not exist.
ZeroCaptchaFileSize	The size of the captcha must be 100 bytes or larger.
TooBigFileSize	The size of the captcha must be less than 50,000 bytes.
ZeroBalance	Your CapMonster balance is empty.
IpNotAllowed	Requests from your current API key is not allowed from your ip.
CaptchaUnsolvable	The captcha cannot be solved. Perhaps it's a corrupted image, or contains too much noise?
InvalidCaptchaId	The captcha id does not exist. Is the captcha older than 5 minutes?
CaptchaNotReady	The captcha has not been solved yet.
IpBanned	You have sent too many requests with an incorrect API key. Try again later.
NoSuchMethod	The requested method does not exist. You should not ever have to see this error as a user. If this is ever seen, please open an issue: https://github.com/qwbarch/captcha-haskell/issues
TooManyRequests	You are being rate limited. Try not to request the result of a captcha more than 1 time per 2 seconds.
DomainNotAllowed	The specified domain cannot be solved by CapMonster.
NoSlotAvailable	The captcha could not be solved due to no available captcha workers.

Instances

Instances details

Bounded CapMonsterErrorCode Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods minBound :: CapMonsterErrorCode # maxBound :: CapMonsterErrorCode #
Enum CapMonsterErrorCode Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods succ :: CapMonsterErrorCode -> CapMonsterErrorCode # pred :: CapMonsterErrorCode -> CapMonsterErrorCode # toEnum :: Int -> CapMonsterErrorCode # fromEnum :: CapMonsterErrorCode -> Int # enumFrom :: CapMonsterErrorCode -> [CapMonsterErrorCode] # enumFromThen :: CapMonsterErrorCode -> CapMonsterErrorCode -> [CapMonsterErrorCode] # enumFromTo :: CapMonsterErrorCode -> CapMonsterErrorCode -> [CapMonsterErrorCode] # enumFromThenTo :: CapMonsterErrorCode -> CapMonsterErrorCode -> CapMonsterErrorCode -> [CapMonsterErrorCode] #
Eq CapMonsterErrorCode Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods (==) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool # (/=) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool #
Ord CapMonsterErrorCode Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods compare :: CapMonsterErrorCode -> CapMonsterErrorCode -> Ordering # (<) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool # (<=) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool # (>) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool # (>=) :: CapMonsterErrorCode -> CapMonsterErrorCode -> Bool # max :: CapMonsterErrorCode -> CapMonsterErrorCode -> CapMonsterErrorCode # min :: CapMonsterErrorCode -> CapMonsterErrorCode -> CapMonsterErrorCode #
Show CapMonsterErrorCode Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods showsPrec :: Int -> CapMonsterErrorCode -> ShowS # show :: CapMonsterErrorCode -> String # showList :: [CapMonsterErrorCode] -> ShowS #

data CapMonsterError Source #

All possible errors when solving a captcha using CapMonster.

Constructors

CapMonsterResponseError CapMonsterErrorCode	An error returned by the CapMonster API.
UnknownResponseError Text Text	An error returned by the CapMonster API that does not exist as a `CapMonsterErrorCode` yet. This error holds the error code, followed by its description.
UnknownError Text	An unknown error occurred. Check the message for more details. This should never occur. Please report this issue on github if this happens to you.
NetworkError HttpException	An error when sending the http request.
TimeoutError	The captcha took to long to solve and was timed out.

Instances

Instances details

Show CapMonsterError Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods showsPrec :: Int -> CapMonsterError -> ShowS # show :: CapMonsterError -> String # showList :: [CapMonsterError] -> ShowS #
Exception CapMonsterError Source #
Instance details Defined in Captcha.CapMonster.Internal.Error Methods toException :: CapMonsterError -> SomeException # fromException :: SomeException -> Maybe CapMonsterError # displayException :: CapMonsterError -> String #

data CapMonster Source #

Used for picking MonadCaptcha instances for CapMonster.

Instances

Instances details

CaptchaResponse CapMonster HCaptcha Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.HCaptcha Methods parseResult :: Value -> Maybe Value #
CaptchaResponse CapMonster ReCaptchaV3 Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.ReCaptchaV3 Methods parseResult :: Value -> Maybe Value #
CaptchaResponse CapMonster ReCaptchaV2 Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.ReCaptchaV2 Methods parseResult :: Value -> Maybe Value #
CaptchaResponse CapMonster FunCaptcha Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.FunCaptcha Methods parseResult :: Value -> Maybe Value #
CaptchaResponse CapMonster ImageCaptcha Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.Image Methods parseResult :: Value -> Maybe Value #
(HasCaptchaEnv r, MonadReader r m, MonadUnliftIO m) => MonadCaptcha CapMonster r m Source #
Instance details Defined in Captcha.CapMonster.Internal Associated Types type CaptchaError CapMonster r m # Methods createTask :: CaptchaRequest CapMonster ctx r m => ctx -> m (Either (CaptchaError CapMonster r m) (CaptchaId ctx)) # getTask :: CaptchaResponse CapMonster ctx => Text -> CaptchaId ctx -> m (Either (CaptchaError CapMonster r m) Text) # solve :: (CaptchaRequest CapMonster ctx r m, CaptchaResponse CapMonster ctx, HasApiKey ctx Text, HasPollingInterval ctx (Maybe (Time Millisecond)), HasTimeoutDuration ctx (Maybe (Time Millisecond))) => ctx -> m (Either (CaptchaError CapMonster r m) Text) #
(HasCaptchaEnv r, MonadReader r m, MonadIO m) => CaptchaRequest CapMonster HCaptcha r m Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.HCaptcha Methods request :: HCaptcha -> Text -> m (Response ByteString) #
(HasCaptchaEnv r, MonadReader r m, MonadIO m) => CaptchaRequest CapMonster ReCaptchaV3 r m Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.ReCaptchaV3 Methods request :: ReCaptchaV3 -> Text -> m (Response ByteString) #
(HasCaptchaEnv r, MonadReader r m, MonadIO m) => CaptchaRequest CapMonster ReCaptchaV2 r m Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.ReCaptchaV2 Methods request :: ReCaptchaV2 -> Text -> m (Response ByteString) #
(HasCaptchaEnv r, MonadReader r m, MonadIO m) => CaptchaRequest CapMonster FunCaptcha r m Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.FunCaptcha Methods request :: FunCaptcha -> Text -> m (Response ByteString) #
(HasCaptchaEnv r, MonadReader r m, MonadIO m) => CaptchaRequest CapMonster ImageCaptcha r m Source #
Instance details Defined in Captcha.CapMonster.Internal.Types.Image Methods request :: ImageCaptcha -> Text -> m (Response ByteString) #
type CaptchaError CapMonster r m Source #
Instance details Defined in Captcha.CapMonster.Internal type CaptchaError CapMonster r m = CapMonsterError