Migrating to LTS 15.15

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*.{hs,hs-boot,yml,yaml,md}]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 100
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -1,5 +1,4 @@
 dist
-dmcc.cabal
 .cabal-sandbox
 cabal.sandbox.config
 .stack-work

.travis.yml

@@ -2,22 +2,28 @@ sudo: false
 
 language: c
 
-addons:
-  apt:
-    packages:
-    - libgmp-dev
+matrix:
+  include:
+    - env: FLAGS="" ARGS=""
+      compiler: ": #stack default"
+      addons: {apt: {packages: [libgmp-dev]}}
+    - env: FLAGS="" ARGS="--stack-yaml=stack-previous.yaml"
+      compiler: ": #stack previous"
+      addons: {apt: {packages: [libgmp-dev]}}
 
 before_install:
 - unset CC
-- mkdir -p ~/.local/bin
+- mkdir -p $HOME/.local/bin
 - export PATH=$HOME/.local/bin:$PATH
 - travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
-- stack $ARGS --no-terminal setup
 
 script:
 - curl -sL https://raw.github.com/ndmitchell/hlint/master/misc/travis.sh | sh -s .
-- stack $ARGS --no-terminal test $FLAGS --haddock
+- stack $ARGS --install-ghc --no-terminal build $FLAGS --pedantic --haddock --no-haddock-deps --test --bench
 
 cache:
   directories:
   - $HOME/.stack
+  - $HOME/.ghc
+  - $HOME/.cabal
+  - .stack-work

CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## [1.1.0.2] - 2020-02-05
+
+### Changed
+
+- Dependencies bump
+
+## [1.1.0.1] - 2019-02-08
+
+### Changed
+
+- Dependencies bump
+
+## [1.1.0.0] - 2018-11-04
+
+### Changed
+
+- GHC 8.6.x support
+
+### Removed
+
+- Plain unencrypted (non-TLS) connections to AES server are no longer supported
+
+## [1.0.0.1] - 2018-05-10
+
+### Changed
+
+- GHC 8.4.x support
+
+## [1.0.0.0] - 2018-05-10
+
+[1.1.0.2]: https://github.com/f-me/dmcc/compare/1.1.0.1...1.1.0.2
+[1.1.0.1]: https://github.com/f-me/dmcc/compare/1.1.0.0...1.1.0.1
+[1.1.0.0]: https://github.com/f-me/dmcc/compare/1.0.0.1...1.1.0.0
+[1.0.0.1]: https://github.com/f-me/dmcc/compare/1.0.0.0...1.0.0.1
+[1.0.0.0]: https://github.com/f-me/dmcc/tree/1.0.0.0

LICENSE

@@ -1,5 +1,6 @@
 Copyright (c) 2012, Max Taldykin, Timofey Cherganov
-Copyright (c) 2014, 2015, Dmitry Dzhus
+Copyright (c) 2014, 2015, 2016, 2017 Dmitry Dzhus
+Copyright (c) 2018, Dmitry Dzhus, Viacheslav Lotsmanov
 
 All rights reserved.
 

README.md

@@ -1,80 +1,122 @@
 # dmcc: AVAYA library for Haskell
 
 [![Travis CI build status](https://travis-ci.org/f-me/dmcc.svg)](https://travis-ci.org/f-me/dmcc)
+[![Hackage](https://img.shields.io/hackage/v/dmcc.svg?colorB=5e5184&style=flat)](https://hackage.haskell.org/package/dmcc)
+[![Hackage deps](https://img.shields.io/hackage-deps/v/dmcc.svg)](http://packdeps.haskellers.com/feed?needle=dmcc)
 
-This package contains a Haskell library which can be used to implement
-computer telephony integration using AVAYA DMCC XML API. A simple
-server (dmcc-ws) built atop the library is also included. The server
-allows clients to connect using WebSockets and exchange JSON messages
-with the server to control AVAYA agents and receive event
-notifications and agent state updates.
+This package contains a Haskell library which may be used to implement
+computer telephony integration using [AVAYA DMCC XML API][dmcc-api]. A
+simple server (dmcc-ws) built atop the library is also included. The
+server allows clients use JSON-over-WebSockets to control AVAYA
+agents, receive event notifications and agent state updates.
 
-The package uses third-party call control functions. There's no
-first-party call control support and no access to media streams.
+The package uses third-party call control functions of DMCC API.
+There's no first-party call control support and no access to media
+streams.
 
-AVAYA DMCC XML API is largely based on ECMA-354 (CSTA Phase III)
+AVAYA DMCC XML API is largely based on [ECMA-354][] (CSTA Phase III)
 standard, so in theory the package can be used with other compliant
 telephony solutions.
 
-# Installation-specific notes
+## Features
+
+- First-party interface for most of call control functions (making and
+  answering calls, hold, conference call, transfer, barge in, state
+  control).
+
+- State change events (implemented in the library using polling to
+  compensate for the lack of a native implementation in DMCC 6.x).
+
+- Webhook support (the library can send HTTP requests in response to
+  agent state change events).
+
+## Site-specific notes
 
 One basic TSAPI license is consumed for every agent controlled by
 the library.
 
 DMCC 6.x is supported. Consult your Avaya AES administration page to
 check for software versions and available licenses.
 
-# Haskell library
-
-Use Haddock to build docs.
-
-# dmcc-ws server
+## dmcc-ws server
 
 The server exposes portions of Haskell library interface via
 WebSockets using JSON messages for client-server exchange. Its purpose
 is to provide a clean agent-centric interface to DMCC API suitable for
 usage from client applications running in a browser.
 
-The server is invoked as `dmcc-ws dmcc-ws.cfg`. See example
-configuration file at `dmcc-ws/example.cfg`.
+Run the server as
+
+```
+dmcc-ws dmcc-ws.cfg
+```
 
-To start controlling an agent with extension XXX, connect to WebSocket
-URL `http://host:port/XXX`. The server accepts client commands in
-JSON:
+See example configuration file at `dmcc-ws/example.cfg`.
 
-    {"action":"MakeCall","number":989150603267}
+With `dmcc-ws` running, you may start controlling an agent with
+extension `XXX` by connecting to WebSocket URL `http://host:port/XXX`.
+The server accepts client commands in JSON:
 
-Consult `DMCC.Action` documentation in Haddock docs for DMCC library
+```json
+{"action":"MakeCall", "number":"989150603267"}
+```
+
+Consult [`DMCC.Action`][dmcc-actions] documentation in Haddock docs for DMCC library
 for supported commands.
 
 The server reports telephony events along with updated agent snapshot:
 
-    {
-      "newSnapshot": {
-        "state": ["Busy", ""],
-        "calls": {
-          "179": {
-            "failed": false,
-            "held": false,
-            "ucid": "00001001791428242051",
-            "interlocutors": [
-              "989150603267:ADACs8300::0"
-            ],
-            "start": "2015-04-05T13:52:52.803Z",
-            "direction": {
-              "contents": [],
-              "dir": "Out"
-            },
-            "answered": "2015-04-05T13:53:02.686Z"
-          }
-        }
-      },
-      "dmccEvent": {
-        "callId": "179",
-        "event": "EstablishedEvent"
-      },
-      "tag": "TelephonyEvent"
+```json
+{
+  "newSnapshot": {
+    "state": ["Busy", ""],
+    "calls": {
+      "179": {
+        "failed": false,
+        "held": false,
+        "ucid": "00001001791428242051",
+        "interlocutors": [
+          "989150603267:ADACs8300::0"
+        ],
+        "start": "2015-04-05T13:52:52.803Z",
+        "direction": {
+          "contents": [],
+          "dir": "Out"
+        },
+        "answered": "2015-04-05T13:53:02.686Z"
+      }
     }
+  },
+  "dmccEvent": {
+    "callId": "179",
+    "event": "EstablishedEvent"
+  },
+  "tag": "TelephonyEvent"
+}
+```
+
+Client applications may use events to update their UI incrementally or
+re-process the whole state every time an event arrives.
+
+## Build
+
+Use [Haskell Stack](https://www.haskellstack.org/) tool to build the
+library and `dmcc-ws`:
+
+```bash
+stack install
+```
+
+### Developing on macOS
+
+On macOS with `openssl` installed via Homebrew, build with
+
+```bash
+stack build --extra-include-dirs=/usr/local/opt/openssl/include/ --extra-lib-dirs=/usr/local/opt/openssl/lib/
+```
+
+[dmcc-api]: https://www.devconnectprogram.com/site/global/products_resources/avaya_aura_application_enablement_services/interfaces/dmcc/overview/index.gsp
+
+[ecma-354]: http://www.ecma-international.org/publications/standards/Ecma-354.htm
 
-Client applications may use events to update their interface or
-process the whole state every time an event arrives.
+[dmcc-actions]: https://hackage.haskell.org/package/dmcc/docs/DMCC-Agent.html#t:Action