MIT licensed by Naoto Shimazaki
Maintained by Naoto.Shimazaki@gmail.com

Module documentation for 0.1.0.3

cisco-spark-api

License: MIT Build Status Hackage Stackage Nightly Stackage LTS

A Haskell bindings for Cisco Webex Teams (formerly Cisco Spark) API

Cisco-spark-api package provides types and functions for accessing Cisco Webex Teams REST API. The detail of the API is available from developer site of Cisco Webex

This package is designed to improve type safety over the API. Each entity is separately typed. JSON messages contained in REST responses are decoded into appropriate type of Haskell record. JSON messages sent in REST requests are encoded only from correct type of record.

Some Webex Teams REST API return list of objects. Those APIs require HTTP Link Header based pagination. Haskell functions for those APIs automatically request subsequent pages as needed. Also those functions transform chunky response into seamless stream of elements.

This package also provides some sample usage in command line application style. See source under app directory of the source package.

Sample Usage

Sending a message to a Room.

    let auth        = Authorization "your authorization token"
        roomId      = RoomId "Room ID your message to be sent"
        messageText = MessageText "your message"
        message     = CreateMessage (Just roomId) Nothing Nothing (Just messageText) Nothing Nothing
    createEntity auth def createMessage >>= print . getResponseBody

Following example is calling List Membership API which returns membership between Rooms and users (Person). You can extract each Membership from Conduit pipe. The streamEntityWithFilter automatically performs pagenation when it is asked more element and last response indicated subsequent page in HTTP Link Header.

    let auth   = Authorization "your authorization token"
        filter = MembershipFilter yourRoomId Nothing Nothing
    runConduit $ streamEntityWithFilter auth def filter .| takeC 200 .| mapM_C print

You can find more examples in app/Main.hs

Support for Lens

This package provides many of records representing objects communicated via Webex Teams REST API. Those records are designed to allow create lenses by Control.Lens.TH.makeFields.

Following example creates overloaded accessors for ‘Person’, ‘Room’ and ‘Team’.

makeFields ''Person
makeFields ''Room
makeFields ''Team

You can access ‘personId’, ‘roomId’ and ‘teamId’ via overloaded accessor function ‘id’ like this.

    let yourPersonId = yourPerson ^. id
        yourRoomId = yourRoom ^. id
        yourTeamId = yourTeam ^. id

This package does not provide pre-generated lenses for you because not everyone need it but you can make it by yourself so easily as described.

Limitation

  • WebHook API is not yet implemented.
  • Relative reference in Link Header is not recognized as next page

Changes

Cisco-spark-api 0.1.0.3

  • Cisco Spark is now Cisco Webex Teams.

Cisco-spark-api 0.1.0.2

  • Catch up to conduit-1.3.0.

Cisco-spark-api 0.1.0.1

  • Put explicit upper bound for conduit.

Cisco-spark-api 0.1.0.0

  • Initial release.
comments powered byDisqus