Network.CiscoSpark.Internal

Implements some internal functions for Cisco Spark API.

Documentation

dropAndLow

Arguments

:: Int

Number of characters to drop

-> String

Field name to be modified to JSON field name

-> String

Drop given number of characters from the given String then change first character of the remaining string to lowercase. This function is intended to be used for fieldLabelModifier and constructorTagModifier argument of DeriveJSON from DATA.Aeson.TH. You can find how this function is used in CiscoSpark source code.

data LinkParam

Parsed Link header parameter. Convert only rel param to Rel and keeps other params as-is.

Constructors

Rel

Other ByteString

Instances

Eq LinkParam

Defined in Network.CiscoSpark.Internal

Methods

(==) :: LinkParam -> LinkParam -> Bool

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

Show LinkParam

Defined in Network.CiscoSpark.Internal

Methods

showsPrec :: Int -> LinkParam -> ShowS

show :: LinkParam -> String

showList :: [LinkParam] -> ShowS

data LinkHeader

Parsed entire Link header value. It keeps URI-Reference part untouched for farther processing in different way.

Constructors

LinkHeader

Fields

• linkHeaderUrl :: ByteString
• linkHeaderParams :: [(LinkParam, ByteString)]

Instances

Eq LinkHeader

Defined in Network.CiscoSpark.Internal

Methods

(==) :: LinkHeader -> LinkHeader -> Bool

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

Show LinkHeader

Defined in Network.CiscoSpark.Internal

Methods

showsPrec :: Int -> LinkHeader -> ShowS

show :: LinkHeader -> String

showList :: [LinkHeader] -> ShowS

dQuote :: Parser Word8

Matches to double quote.

semicolon :: Parser Word8

Matches to semicolon.

equalChar :: Parser Word8

Matches to equal character.

lessThan :: Parser Word8

Matches to less-than character.

greaterThan :: Parser Word8

Matches to greater-than character.

skipSpace :: Parser ()

Skips white spaces.

token :: Parser ByteString

Parse RFC7230 token.

quotedPair :: Parser Word8

Parse RFC7230 quoted-pair.

quotedString :: Parser ByteString

Parse RFC7230 quoted-string.

paramValue :: Parser ByteString

Parse a parameter value in Link header.

paramName :: ByteString -> LinkParam

Convert parameter name string to LinkParam.

param :: Parser (LinkParam, ByteString)

Parse parameter part of Link header.

linkHeader :: Parser LinkHeader

Attoparsec parser of RFC5988 HTTP Link Header. Link header is defined in RFC5988 https://tools.ietf.org/html/rfc5988. This parser doesn't parse complete spec of RFC5988 but only parses rel="next" link for simple pagination. It doesn't parse obs-fold defined in RFC7230 https://tools.ietf.org/html/rfc7230. It assumes Header in Response never contains CRLF or LF.

extractNextUrl :: [ByteString] -> [ByteString]

Accept all RFC5988 Link HTTP header, filter first header containing rel="next" param, parse URL part.

getNextUrl :: Response a -> Maybe ByteString

Return URL for next page if it exists in given response.

validateUrl :: String -> URIAuth -> ByteString -> Maybe ByteString

Validate extracted URL from HTTP Link Header by getNextUrl. Check if it has same scheme and URI authority as original request.