Safe Haskell	None
Language	Haskell98

HipBot

Documentation

data HipBot m Source

Instances

HasHipBotAPI (HipBot m) m

data HipBotAPI m Source

Constructors

HipBotAPI
Fields apiInsertRegistration :: Registration -> AccessToken -> m () apiDeleteRegistration :: OAuthId -> m () apiLookupRegistration :: OAuthId -> m (Maybe (Registration, AccessToken)) apiUpdateAccessToken :: OAuthId -> AccessToken -> m ()

Instances

HasHipBotAPI (HipBotAPI m) m

newHipBot :: HipBotAPI m -> AddOn -> IO (HipBot m) Source

hipBotResources :: (Applicative m, MonadCatch m, MonadIO m) => HipBot m -> Dispatcher (WaiResource m) Source

configResource :: (Applicative m, Monad m) => HipBot m -> (Registration -> WaiCrankT m Body) -> WaiResource m Source

verifySignature :: (Applicative m, Monad m) => HipBot m -> HaltT (WaiCrankT m) Registration Source

sendNotification :: (Applicative m, MonadCatch m, MonadIO m) => HipBot m -> OAuthId -> Either RoomName RoomId -> Notification -> m (Maybe NotificationError) Source

parseAbsoluteURI :: String -> Maybe AbsoluteURI Source

appendPath :: AbsoluteURI -> [Text] -> AbsoluteURI Source

relPath :: [Text] -> String Source

relativeTo :: [Text] -> AbsoluteURI -> AbsoluteURI Source

data AddOn Source

Constructors

AddOn
Fields _addOnKey :: Text _addOnName :: Text _addOnDescription :: Text _addOnLinks :: Links _addOnCapabilities :: Maybe Capabilities _addOnVendor :: Maybe Vendor

addOn Source

Arguments

:: Text	key
-> Text	name
-> Text	description
-> Links
-> AddOn

data Links Source

Constructors

Links
Fields _linksSelf :: AbsoluteURI _linksHomepage :: Maybe AbsoluteURI

Instances

Eq Links
Show Links
ToJSON Links
FromJSON Links
HasLinks AddOn Links
HasSelf Links AbsoluteURI
HasHomepage Links (Maybe AbsoluteURI)

defaultLinks Source

Arguments

:: AbsoluteURI	self
-> Links

defaultCapabilities :: Capabilities Source

data Installable Source

Constructors

Installable
Fields _installableCallbackUrl :: Maybe AbsoluteURI _installableAllowRoom :: Bool _installableAllowGlobal :: Bool

defaultInstallable :: Installable Source

data APIConsumer Source

Constructors

APIConsumer
Fields _apiScopes :: [APIScope] _apiFromName :: Maybe Text

Instances

Eq APIConsumer
Show APIConsumer
ToJSON APIConsumer
FromJSON APIConsumer
HasHipchatApiConsumer Capabilities (Maybe APIConsumer)
HasScopes APIConsumer [APIScope]
HasFromName APIConsumer (Maybe Text)

defaultAPIConsumer :: APIConsumer Source

data APIScope Source

Constructors

AdminGroup
AdminRoom
ManageRooms
SendMessage
SendNotification
ViewGroup
ViewMessages

Instances

Eq APIScope
Show APIScope
ToJSON APIScope
FromJSON APIScope
HasScopes APIConsumer [APIScope]

apiScopeStr :: IsString a => APIScope -> a Source

data Webhook Source

Constructors

Webhook
Fields _webhookUrl :: AbsoluteURI _webhookPattern :: Maybe Text _webhookEvent :: RoomEvent

Instances

Eq Webhook
Show Webhook
ToJSON Webhook
FromJSON Webhook
HasWebhooks Capabilities [Webhook]

data RoomEvent Source

Constructors

RoomMessage
RoomNotification
RoomExit
RoomEnter
RoomTopicChange

Instances

Eq RoomEvent
Show RoomEvent
ToJSON RoomEvent
FromJSON RoomEvent

data Configurable Source

Constructors

Configurable
Fields _configurableUrl :: AbsoluteURI

Instances

Eq Configurable
Show Configurable
ToJSON Configurable
FromJSON Configurable
HasUrl Configurable AbsoluteURI
HasConfigurable Capabilities (Maybe Configurable)

data Vendor Source

Constructors

Vendor
Fields _vendorUrl :: AbsoluteURI _vendorName :: Text

Instances

Eq Vendor
Show Vendor
ToJSON Vendor
FromJSON Vendor
HasVendor AddOn (Maybe Vendor)

type OAuthId = Text Source

type RoomId = Int Source

type RoomName = Text Source

data AccessToken Source

Constructors

AccessToken
Fields _accessTokenAccessToken :: Text _accessTokenExpires :: UTCTime

Instances

HasExpires AccessToken UTCTime
HasAccessToken AccessToken Text

data Notification Source

Constructors

TextNotification Text
HtmlNotification Text

class HasCapabilities s a | s -> a where Source

Methods

capabilities :: Lens' s a Source

Instances

HasCapabilities AddOn (Maybe Capabilities)

class HasDescription s a | s -> a where Source

Methods

description :: Lens' s a Source

Instances

HasDescription AddOn Text

class HasKey s a | s -> a where Source

Methods

key :: Lens' s a Source

Instances

HasKey AddOn Text

class HasLinks s a | s -> a where Source

Methods

links :: Lens' s a Source

Instances

HasLinks AddOn Links

class HasName s a | s -> a where Source

Methods

name :: Lens' s a Source

Instances

HasName AddOn Text

class HasVendor s a | s -> a where Source

Methods

vendor :: Lens' s a Source

Instances

HasVendor AddOn (Maybe Vendor)

class HasHomepage s a | s -> a where Source

Methods

homepage :: Lens' s a Source

Instances

HasHomepage Links (Maybe AbsoluteURI)

class HasSelf s a | s -> a where Source

Methods

self :: Lens' s a Source

Instances

HasSelf Links AbsoluteURI

class HasConfigurable s a | s -> a where Source

Methods

configurable :: Lens' s a Source

Instances

HasConfigurable Capabilities (Maybe Configurable)

class HasHipchatApiConsumer s a | s -> a where Source

Methods

hipchatApiConsumer :: Lens' s a Source

Instances

HasHipchatApiConsumer Capabilities (Maybe APIConsumer)

class HasInstallable s a | s -> a where Source

Methods

installable :: Lens' s a Source

Instances

HasInstallable Capabilities (Maybe Installable)

class HasOauth2Provider s a | s -> a where Source

Methods

oauth2Provider :: Lens' s a Source

Instances

HasOauth2Provider Capabilities (Maybe OAuth2Provider)

class HasWebhooks s a | s -> a where Source

Methods

webhooks :: Lens' s a Source

Instances

HasWebhooks Capabilities [Webhook]

class HasAllowGlobal s a | s -> a where Source

Methods

allowGlobal :: Lens' s a Source

Instances

HasAllowGlobal Installable Bool

class HasAllowRoom s a | s -> a where Source

Methods

allowRoom :: Lens' s a Source

Instances

HasAllowRoom Installable Bool

class HasCallbackUrl s a | s -> a where Source

Methods

callbackUrl :: Lens' s a Source

Instances

HasCallbackUrl Installable (Maybe AbsoluteURI)

class HasFromName s a | s -> a where Source

Methods

fromName :: Lens' s a Source

Instances

HasFromName APIConsumer (Maybe Text)

class HasScopes s a | s -> a where Source

Methods

scopes :: Lens' s a Source

Instances

HasScopes APIConsumer [APIScope]

class HasAuthorizationUrl s a | s -> a where Source

Methods

authorizationUrl :: Lens' s a Source

Instances

HasAuthorizationUrl OAuth2Provider AbsoluteURI

class HasTokenUrl s a | s -> a where Source

Methods

tokenUrl :: Lens' s a Source

Instances

HasTokenUrl OAuth2Provider AbsoluteURI

class HasUrl s a | s -> a where Source

Methods

url :: Lens' s a Source

Instances

HasUrl Configurable AbsoluteURI

class HasCapabilitiesUrl s a | s -> a where Source

Methods

capabilitiesUrl :: Lens' s a Source

Instances

HasCapabilitiesUrl Registration AbsoluteURI

class HasGroupId s a | s -> a where Source

Methods

groupId :: Lens' s a Source

Instances

HasGroupId Registration Int

class HasOauthId s a | s -> a where Source

Methods

oauthId :: Lens' s a Source

Instances

HasOauthId Registration OAuthId

class HasOauthSecret s a | s -> a where Source

Methods

oauthSecret :: Lens' s a Source

Instances

HasOauthSecret Registration Text

class HasRoomId s a | s -> a where Source

Methods

roomId :: Lens' s a Source

Instances

HasRoomId Registration (Maybe RoomId)

class HasAccessToken s a | s -> a where Source

Methods

accessToken :: Lens' s a Source

Instances

HasAccessToken AccessToken Text

class HasExpires s a | s -> a where Source

Methods

expires :: Lens' s a Source

Instances

HasExpires AccessToken UTCTime

Eq OAuth2Provider
Show OAuth2Provider
ToJSON OAuth2Provider
FromJSON OAuth2Provider
HasTokenUrl OAuth2Provider AbsoluteURI
HasAuthorizationUrl OAuth2Provider AbsoluteURI
HasOauth2Provider Capabilities (Maybe OAuth2Provider)

Eq AbsoluteURI
Show AbsoluteURI
IsString AbsoluteURI
ToJSON AbsoluteURI
FromJSON AbsoluteURI
HasSelf Links AbsoluteURI
HasTokenUrl OAuth2Provider AbsoluteURI
HasAuthorizationUrl OAuth2Provider AbsoluteURI
HasUrl Configurable AbsoluteURI
HasCapabilitiesUrl Registration AbsoluteURI
HasHomepage Links (Maybe AbsoluteURI)
HasCallbackUrl Installable (Maybe AbsoluteURI)

Eq AddOn
Show AddOn
ToJSON AddOn
FromJSON AddOn
HasName AddOn Text
HasLinks AddOn Links
HasKey AddOn Text
HasDescription AddOn Text
HasVendor AddOn (Maybe Vendor)
HasCapabilities AddOn (Maybe Capabilities)

Capabilities
Fields _capabilitiesInstallable :: Maybe Installable _capabilitiesHipchatApiConsumer :: Maybe APIConsumer _capabilitiesOauth2Provider :: Maybe OAuth2Provider _capabilitiesWebhooks :: [Webhook] _capabilitiesConfigurable :: Maybe Configurable

Eq Capabilities
Show Capabilities
ToJSON Capabilities
FromJSON Capabilities
HasCapabilities AddOn (Maybe Capabilities)
HasWebhooks Capabilities [Webhook]
HasOauth2Provider Capabilities (Maybe OAuth2Provider)
HasInstallable Capabilities (Maybe Installable)
HasHipchatApiConsumer Capabilities (Maybe APIConsumer)
HasConfigurable Capabilities (Maybe Configurable)

Eq Installable
Show Installable
ToJSON Installable
FromJSON Installable
HasAllowRoom Installable Bool
HasAllowGlobal Installable Bool
HasInstallable Capabilities (Maybe Installable)
HasCallbackUrl Installable (Maybe AbsoluteURI)

OAuth2Provider
Fields _oAuth2ProviderAuthorizationUrl :: AbsoluteURI _oAuth2ProviderTokenUrl :: AbsoluteURI

Registration
Fields _registrationOauthId :: OAuthId _registrationCapabilitiesUrl :: AbsoluteURI _registrationRoomId :: Maybe RoomId _registrationGroupId :: Int _registrationOauthSecret :: Text

ToJSON Registration
FromJSON Registration
HasOauthSecret Registration Text
HasOauthId Registration OAuthId
HasGroupId Registration Int
HasCapabilitiesUrl Registration AbsoluteURI
HasRoomId Registration (Maybe RoomId)