Pinboard.Client

Config

fromApiToken :: String -> PinboardConfig

Create a default PinboardConfig using the supplied apiToken (ex: "use:ABCDEF0123456789ABCD")

defaultPinboardConfig :: PinboardConfig

The PinboardConfig provides authentication via apiToken

data PinboardConfig

Constructors

PinboardConfig

Fields

• apiToken :: !ByteString
• maxRequestRateMills :: !Int
• lastRequestTime :: IORef UTCTime
• doThreadDelay :: PinboardConfig -> IO ()
• execLoggingT :: ExecLoggingT
• filterLoggingT :: LogSource -> LogLevel -> Bool

Instances

Show PinboardConfig

Methods

showsPrec :: Int -> PinboardConfig -> ShowS

show :: PinboardConfig -> String

showList :: [PinboardConfig] -> ShowS

Monadic

runPinboard :: (MonadIO m, MonadCatch m, MonadErrorPinboard e) => PinboardConfig -> PinboardT m a -> m (e a)

Execute computations in the Pinboard monad

runPinboardE :: (MonadIO m, MonadCatch m, MonadErrorPinboard e) => PinboardEnv -> PinboardT m a -> m (e a)

Execute computations in the Pinboard monad (with specified http Manager)

pinboardJson :: (MonadPinboard m, FromJSON a) => PinboardRequest -> m a

Create a Pinboard value from a PinboardRequest w/ json deserialization

Single

runPinboardSingleRaw :: PinboardConfig -> PinboardRequest -> IO (Response ByteString)

runPinboardSingleRawBS :: MonadErrorPinboard e => PinboardConfig -> PinboardRequest -> IO (e ByteString)

runPinboardSingleJson :: (MonadErrorPinboard e, FromJSON a) => PinboardConfig -> PinboardRequest -> IO (e a)

Sending

sendPinboardRequest :: PinboardEnv -> PinboardRequest -> IO (Response ByteString)

Delaying

requestThreadDelay :: PinboardConfig -> IO ()

delays the thread, if the time since the previous request is less than the configured maxRequestRateMills

Manager (http-client)

newMgr :: IO Manager

mgrFail :: (Monad m, MonadErrorPinboard e) => PinboardErrorType -> SomeException -> m (e b)

JSON Handling

parseJSONResponse :: (MonadErrorPinboard e, FromJSON a) => Response ByteString -> e a

decodeJSONResponse :: (MonadErrorPinboard e, FromJSON a) => ByteString -> e a

Status Codes

checkStatusCodeResponse :: MonadErrorPinboard e => Response a -> e ()

checkStatusCode :: MonadErrorPinboard e => Int -> e ()

Error Helpers

addErrMsg :: Text -> PinboardError -> PinboardError

createParserErr :: Text -> PinboardError

httpStatusPinboardError :: MonadErrorPinboard e => PinboardErrorHTTPCode -> e a

Client Dependencies