purescript_linked_in/src/LinkedIn.purs

module LinkedIn (APIError(..), encodeToJson, getContext, getContextJson, extractFromDocument, extractFromDocumentJson, forceExtract, loopUntilElementAppears) where

import Prelude

import Control.Monad.Except (ExceptT, lift, runExceptT, throwError, withExceptT)
import Data.Argonaut.Core (Json)
import Data.Argonaut.Encode (class EncodeJson, encodeJson)
import Data.Argonaut.Encode.Generic (genericEncodeJson)
import Data.Either (Either(..))
import Data.Generic.Rep (class Generic)
import Data.Maybe (Maybe(..))
import Data.Show.Generic (genericShow)
import Data.Traversable (class Traversable)
import Effect (Effect)
import LinkedIn.CanBeQueried (class CanBeQueried)
import LinkedIn.Extractible (class Extractible)
import LinkedIn.Loadable (waitFor)
import LinkedIn.Output (OutputError, run, toOutput)
import LinkedIn.Output.Types (Output)
import LinkedIn.PageUrl (PageUrl, pageUrlP)
import Parsing (runParser)
import Promise.Aff (Promise, fromAff)
import Type.Proxy (Proxy)
import Web.DOM (Document)
import Web.DOM.Document (url)
import Web.URL as U

data APIError =
  ErrorExtraction OutputError
  | ErrorInvalidUrl
  | ErrorUnexpectedUrl

derive instance Generic APIError _
instance Show APIError where show = genericShow
instance EncodeJson APIError where encodeJson a = genericEncodeJson a

getContext ∷ Document → Effect (Either APIError PageUrl)
getContext = runExceptT <<< getContext'

getContextJson ∷ Document → Effect Json
getContextJson d = getContext d >>= (pure <<< encodeJson)

getContext' ∷ Document → ExceptT APIError Effect PageUrl
getContext' dom = do
  u <- lift $ url dom
  case U.fromAbsolute u of
    Nothing -> throwError ErrorInvalidUrl
    Just u' ->  case runParser (U.pathname u') pageUrlP of
      Left _ -> throwError ErrorUnexpectedUrl
      Right page -> pure page

extractFromDocument :: Document -> Effect (Either APIError Output)
extractFromDocument = runExceptT <<< extractFromDocument'

extractFromDocumentJson ∷ Document → Effect Json
extractFromDocumentJson d = extractFromDocument d >>= (pure <<< encodeJson)

extractFromDocument' ∷ Document → ExceptT APIError Effect Output
extractFromDocument' dom = do
  ctx <- getContext' dom
  toOutput' ctx dom

toOutput' ∷ PageUrl → Document → ExceptT APIError Effect Output
toOutput' ctx dom = withExceptT (\err -> ErrorExtraction err) $ toOutput ctx dom

encodeToJson :: Either String Output -> Json
encodeToJson = encodeJson

loopUntilElementAppears ∷ String → Document → Effect (Promise Boolean)
loopUntilElementAppears selector q = fromAff $ waitFor 200 50 selector q

-- | Force extraction of data from a page, when the context given by the URL is imprecise
-- | or plain wrong (e.g. for local files).
-- | Can be call e.g. `forceExtract (Proxy :: Proxy JobOfferPage) dom`
forceExtract ∷ ∀ root t.
  Traversable t
  ⇒ CanBeQueried root t
  ⇒ Extractible t
  ⇒ Proxy t
  → root
  → Effect (Either OutputError Output)
forceExtract p = runExceptT <<< run p