Internal.hs

{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE OverloadedStrings #-}

module Data.Textocat.Internal where

import           Data.Aeson
import           Data.Aeson.Types
import           Data.ByteString (ByteString)
import           Data.Char
import qualified Data.Text as T
import           Data.Text (Text)
import           GHC.Generics

-- | Error message
type ErrorMsg = String

-- | API configuration. Currently only API key is saved
data Config = Config
    { apiKey :: ByteString -- ^ API key
    , hostName :: String -- ^ host name
    } deriving (Eq,Show)

-- | Document sent for analysis
data Document = Document
    { d_text :: Text -- ^ Text (less than 100 KB)
    , d_tag :: Maybe Text -- ^ Tag (say, user identifier of document)
    } deriving (Eq,Show,Generic)

documentOptions = defaultOptions
    { fieldLabelModifier = drop 2
    , constructorTagModifier = map toLower
    , omitNothingFields = True
    }

instance FromJSON Document where
  parseJSON = genericParseJSON documentOptions
instance ToJSON Document where
  toJSON = genericToJSON documentOptions

-- | Batch identifier (you get it after submitting documents)
newtype BatchID = BatchID
    { batch_id :: Text
    } deriving (Eq,Show,Read)

instance FromJSON BatchID where
  parseJSON (String t) = return $ BatchID t
  parseJSON _ = error "Expected string while reading status"
instance ToJSON BatchID where
  toJSON (BatchID x) = String x

-- | States of batch processing
data BatchState
    = FINISHED    -- ^ Batch is ready for retrieving
    | IN_PROGRESS -- ^ Batch is being processed
    deriving (Eq,Show,Read)

instance FromJSON BatchState where
  parseJSON (String t) = return $ read $ T.unpack t
  parseJSON _ = error "Expected string while reading status"
instance ToJSON BatchState where
  toJSON x = String $ T.pack $ show x

-- | Status of batch
data BatchStatus = BatchStatus
    { bs_batchId :: Text -- ^ Batch ID
    , bs_status :: BatchState -- ^ Batch status
    } deriving (Eq,Show,Generic)

bsOptions = defaultOptions
    { fieldLabelModifier = drop 3
    , constructorTagModifier = map toLower
    }

instance FromJSON BatchStatus where
  parseJSON = genericParseJSON bsOptions
instance ToJSON BatchStatus where
  toJSON = genericToJSON bsOptions

-- | States of document processing
data DocumentState
    = SUCCESS
    | INPUT_ERROR
    | SERVICE_ERROR
    deriving (Eq,Show,Read)

instance FromJSON DocumentState where
  parseJSON (String t) = return $ read $ T.unpack t
  parseJSON _ = error "Expected string while reading status"
instance ToJSON DocumentState where
  toJSON x = String $ T.pack $ show x

-- | Entity category
data Category
    = PERSON
    | ORGANIZATION
    | GPE
    | LOCATION
    | FACILITY
    | TIME
    | MONEY
    deriving (Eq,Ord,Show,Read)

instance FromJSON Category where
  parseJSON (String t) = return $ read $ T.unpack t
  parseJSON _ = error "Expected string when reading category"
instance ToJSON Category where
  toJSON x = String $ T.pack $ show x

data Entity = Entity
    { e_span :: Text
    , e_beginOffset :: Int
    , e_endOffset :: Int
    , e_category :: Category
    } deriving (Eq,Show,Generic)

entityOptions = defaultOptions
    { fieldLabelModifier = drop 2
    , constructorTagModifier = map toLower
    }

instance FromJSON Entity where
  parseJSON = genericParseJSON entityOptions
instance ToJSON Entity where
  toJSON = genericToJSON entityOptions

data AnnotatedDocument = AnnotatedDocument
    { ad_status :: DocumentState
    , ad_tag :: Maybe Text
    , ad_entities :: [Entity]
    } deriving (Eq,Show,Generic)

adOptions = defaultOptions
    { fieldLabelModifier = drop 3
    , constructorTagModifier = map toLower
    , omitNothingFields = True
    }

instance FromJSON AnnotatedDocument where
  parseJSON = genericParseJSON adOptions
instance ToJSON AnnotatedDocument where
  toJSON = genericToJSON adOptions

data Batch = Batch
    { b_batchIds :: [BatchID]
    , b_documents :: [AnnotatedDocument]
    } deriving (Eq,Show,Generic)

batchOptions = defaultOptions
    { fieldLabelModifier = drop 2
    , constructorTagModifier = map toLower
    }

instance FromJSON Batch where
  parseJSON = genericParseJSON batchOptions
instance ToJSON Batch where
  toJSON = genericToJSON batchOptions

data SearchResult = SearchResult
    { sr_searchQuery :: Text
    , sr_documents :: [AnnotatedDocument]
    } deriving (Eq,Show,Generic)

srOptions = defaultOptions
    { fieldLabelModifier = drop 3
    , constructorTagModifier = map toLower
    , omitNothingFields = True
    }

instance FromJSON SearchResult where
  parseJSON = genericParseJSON srOptions
instance ToJSON SearchResult where
  toJSON = genericToJSON srOptions
       
data ServiceStatus
    = ServiceOK
    | ServiceUnavailable
    deriving (Eq,Show)