Safe Haskell	None
Language	Haskell98

HipBot

Documentation

data HipBot m Source

data HipBotAPI m Source

Constructors

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

newHipBot :: HipBotAPI m -> AddOn -> OnUninstall m -> 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

defaultAddOn Source

Arguments

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

data Links Source

Constructors

Links
Fields _linksSelf :: AbsoluteURI _linksHomepage :: Maybe AbsoluteURI

Instances

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

defaultLinks Source

Arguments

:: AbsoluteURI	self
-> Links

defaultCapabilities :: Capabilities Source

defaultInstallable :: Installable Source

data APIConsumer Source

Constructors

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

defaultAPIConsumer :: APIConsumer Source

data APIScope Source

Constructors

AdminGroup
AdminRoom
ManageRooms
SendMessage
SendNotification
ViewGroup
ViewMessages

Instances

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

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

data Webhook Source

Constructors

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

Instances

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

data RoomEvent Source

Constructors

RoomMessage
RoomNotification
RoomExit
RoomEnter
RoomTopicChange

Instances

Eq RoomEvent Source
Show RoomEvent Source
ToJSON RoomEvent Source
FromJSON RoomEvent Source

data Configurable Source

Constructors

Configurable
Fields _configurableUrl :: AbsoluteURI

data Vendor Source

Constructors

Vendor
Fields _vendorUrl :: AbsoluteURI _vendorName :: Text

Instances

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

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 Source
HasAccessToken AccessToken Text Source

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) Source

class HasDescription s a | s -> a where Source

Methods

description :: Lens' s a Source

Instances

HasDescription AddOn Text Source

class HasKey s a | s -> a where Source

Methods

key :: Lens' s a Source

Instances

HasKey AddOn Text Source

class HasLinks s a | s -> a where Source

Methods

links :: Lens' s a Source

Instances

HasLinks AddOn Links Source

class HasName s a | s -> a where Source

Methods

name :: Lens' s a Source

Instances

HasName AddOn Text Source

class HasVendor s a | s -> a where Source

Methods

vendor :: Lens' s a Source

Instances

HasVendor AddOn (Maybe Vendor) Source

class HasHomepage s a | s -> a where Source

Methods

homepage :: Lens' s a Source

Instances

HasHomepage Links (Maybe AbsoluteURI) Source

class HasSelf s a | s -> a where Source

Methods

self :: Lens' s a Source

Instances

HasSelf Links AbsoluteURI Source

class HasConfigurable s a | s -> a where Source

Methods

configurable :: Lens' s a Source

Instances

HasConfigurable Capabilities (Maybe Configurable) Source

class HasHipchatApiConsumer s a | s -> a where Source

Methods

hipchatApiConsumer :: Lens' s a Source

Instances

HasHipchatApiConsumer Capabilities (Maybe APIConsumer) Source

class HasInstallable s a | s -> a where Source

Methods

installable :: Lens' s a Source

Instances

HasInstallable Capabilities (Maybe Installable) Source

class HasOauth2Provider s a | s -> a where Source

Methods

oauth2Provider :: Lens' s a Source

Instances

HasOauth2Provider Capabilities (Maybe OAuth2Provider) Source

class HasWebhooks s a | s -> a where Source

Methods

webhooks :: Lens' s a Source

Instances

HasWebhooks Capabilities [Webhook] Source

class HasAllowGlobal s a | s -> a where Source

Methods

allowGlobal :: Lens' s a Source

Instances

HasAllowGlobal Installable Bool Source

class HasAllowRoom s a | s -> a where Source

Methods

allowRoom :: Lens' s a Source

Instances

HasAllowRoom Installable Bool Source

class HasCallbackUrl s a | s -> a where Source

Methods

callbackUrl :: Lens' s a Source

Instances

HasCallbackUrl Installable (Maybe AbsoluteURI) Source

class HasFromName s a | s -> a where Source

Methods

fromName :: Lens' s a Source

Instances

HasFromName APIConsumer (Maybe Text) Source

class HasScopes s a | s -> a where Source

Methods

scopes :: Lens' s a Source

Instances

HasScopes APIConsumer [APIScope] Source

class HasAuthorizationUrl s a | s -> a where Source

Methods

authorizationUrl :: Lens' s a Source

Instances

HasAuthorizationUrl OAuth2Provider AbsoluteURI Source

class HasTokenUrl s a | s -> a where Source

Methods

tokenUrl :: Lens' s a Source

Instances

HasTokenUrl OAuth2Provider AbsoluteURI Source

class HasUrl s a | s -> a where Source

Methods

url :: Lens' s a Source

Instances

HasUrl Configurable AbsoluteURI Source

class HasCapabilitiesUrl s a | s -> a where Source

Methods

capabilitiesUrl :: Lens' s a Source

Instances

HasCapabilitiesUrl Registration AbsoluteURI Source

class HasGroupId s a | s -> a where Source

Methods

groupId :: Lens' s a Source

Instances

HasGroupId Registration Int Source

class HasOauthId s a | s -> a where Source

Methods

oauthId :: Lens' s a Source

Instances

HasOauthId Registration OAuthId Source

class HasOauthSecret s a | s -> a where Source

Methods

oauthSecret :: Lens' s a Source

Instances

HasOauthSecret Registration Text Source

class HasRoomId s a | s -> a where Source

Methods

roomId :: Lens' s a Source

Instances

HasRoomId Registration (Maybe RoomId) Source

class HasAccessToken s a | s -> a where Source

Methods

accessToken :: Lens' s a Source

Instances

HasAccessToken AccessToken Text Source

class HasExpires s a | s -> a where Source

Methods

expires :: Lens' s a Source

Instances

HasExpires AccessToken UTCTime Source

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

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

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

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

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

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

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

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

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

OAuth2Provider
Fields _oAuth2ProviderAuthorizationUrl :: AbsoluteURI _oAuth2ProviderTokenUrl :: AbsoluteURI

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

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