init

.travis.yml

@@ -0,0 +1,6 @@
+language: erlang
+otp_release:
+  - 18.1
+script: "./rebar3 eunit"
+notifications:
+  slack: cytoscape:jnbsb3KMMTjJtFBGKWYPPn6t

Dockerfile

@@ -0,0 +1,13 @@
+FROM erlang
+
+ADD . /elsa
+WORKDIR /elsa
+
+RUN  mv /elsa/config/sys.config.docker /elsa/config/sys.config
+
+RUN /elsa/rebar3 release
+
+ENTRYPOINT ["/elsa/_build/default/rel/elsa/bin/elsa"]
+
+EXPOSE 8080
+CMD ["foreground"]

Dockerfile.develop

@@ -0,0 +1,13 @@
+FROM erlang
+
+ADD . /elsa
+WORKDIR /elsa
+
+RUN  mv /elsa/config/sys.config.docker /elsa/config/sys.config
+
+RUN /elsa/rebar3 compile
+
+ENTRYPOINT ["/elsa/rebar3"]
+
+EXPOSE 8080
+CMD ["shell']

LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -0,0 +1,109 @@
+ELSA: The ErLang Submit Agent
+=====
+
+[![Build Status](https://travis-ci.org/cytoscape-ci/elsa.svg)](https://travis-ci.org/cytoscape-ci/elsa) [![GitHub version](https://badge.fury.io/gh/cytoscape-ci%2Felsa.svg)](https://badge.fury.io/gh/cytoscape-ci%2Felsa)
+
+This node connects clients and services running across a network, and provides a mechanism for handling long running services. Elsa nodes connect together to form a relay network, where client calls route to agents that have the required services to fufill their request. For services that take longer than the tolerated time of the client, responses enter a buffer that the agent handles, and await client pickup at a later time. Please see below for instructions on how to deploy an agent, make calls through the agent as a client, and register with an agent as a service.
+
+Getting Started
+-----
+
+Elsa uses Docker Hub automated builds for production use: [Elsa on Docker Hub](https://hub.docker.com/r/cytoscape/elsa).
+
+You will need a Docker daemon to deploy the agent. Once you have docker installed, run:
+
+``` docker run -p 8080:8080 cytoscape/elsa #Runs elsa in a container on port 8080 ```
+
+This will bring up the agent on port 8080. Services and clients can now use the agent.
+
+Releases and Production Deployments
+-----
+Releases are built automatically using Docker Hub automated builds. Images follow a master and tag scheme:
+
+```
+docker run cytoscape/elsa:latest #Run the container built off of master's last commit. Same as cytoscape/elsa with no tag.
+docker run cytoscape/elsa:tag #Where tag is a release tag such as cytoscape/elsa:v0.1.0 for the v0.1.0 version of elsa.
+```
+
+For maximum stabability in production deployments, use a version tag. For the latest features and bug fixs, use the latest tag. You can also build your own release of elsa using the primary Dockerfile:
+
+```
+docker build -t elsa .
+```
+
+Clients
+-----
+
+####Request
+
+A client can reach a registered service by calling:
+
+``` www.domain.com:port/service/version/endpoint ```
+
+For example, with an agent connect to port 8080 on an instance called elsa, and trying to reach version one of the service test's status endpoint the call would look like this:
+
+``` curl http://elsa:8080/test/v1/status ```
+
+####Response
+
+A client may include an optional *X-ELSA-TIMEOUT* header in the request. If the service responds within a number of milliseconds specified in this header, the client will receive its data as it normally would as though it had called the service directly. This field defaults to 5 seconds.
+
+If the service misses the timeout window, the agent sends back a 300 status code and a url that the client may check periodically to retrieve its data. When it quieries this url, it will receive one of the following:
+
+```
+    404 - Task not found. #The task either failed to complete, or the task does not exist.
+    204 - Task not yet completed. Please try again later. #The agent still awaits data from the service. Retry later.
+    200 #Your task completed successfully, this response contains the response of the service.
+```
+
+Services
+-----
+A service must send a JSON document called it's registration to an agent in order to receive forwarded calls from clients. When a service shuts down, it should then send its registration to the agent with a DELETE request:
+
+```
+POST elsa:8080/registration #Registers the instance if its registration document is valid.
+DELETE elsa:8080/registration #Unregisters the instance if its registration document is valid.
+
+```
+
+For the format of a registration document, please reference the  [registration](https://github.com/cytoscape-ci/elsa/blob/master/REGISTRATION.md) spec.
+
+
+Development
+------
+You can develop through either docker or by running the agent on an Erlang virtual machine.
+
+####Erlang Virtual Machine Development
+First install the latest version of the Erlang virtual machine. Clone the repo, and then use the rebar3 script to
+develop with the agent:
+
+```
+git clone https://github.com/cytoscape-ci/elsa.git && cd elsa
+
+    ./rebar3 shell   #Run elsa in an interactive shell.
+    ./rebar3 eunit   #Run the eunit test framework
+    ./rebar3 release #Create a release of elsa
+
+```
+
+####Docker Container Development
+
+To develop in a container, you should build your changes with the devleopment Dockerfile:
+
+```
+docker build -f Dockerfile.develop -t elsa .
+```
+
+You can then run any rebar3 command by appending it to docker run like so:
+
+```
+docker run -it elsa shell #Equivelant to ./rebar3 shell
+```
+
+Contributing
+------
+Contributions are welcome in the form of issues or pull requests. For code changes, please submit unit tests in the tests directory. These tests may either use Common Test or Eunit.
+
+Licensing
+=========
+You can find the LGPL License for elsa [here](https://github.com/cytoscape-ci/elsa/blob/master/LICENSE.txt).

REGISTRATION.md

@@ -0,0 +1,87 @@
+Registration
+=====
+
+There are three primary fields:
+
+- service: The name of the service as a string
+- version: The version of the service API as a string, should be of the form ("v1", "v2", "vN"...)
+- instances: An list containing instance objects
+
+An instance object has two fields
+- location: This should be a domain name or ip address. http:// will be appended if
+the protocol is not specified. This will also make the default port 80.
+- capacity: An integer or the string "infinity", this tells the agent how many concurrent
+requests your service can handle. Infinity means that your service can handle an unlimited
+number of concurrent connections.
+
+This is a minimum registration document.
+-----
+
+```json
+{
+  "service": "service1",
+  "version": "v1",
+  "instances": [
+    {
+      "location": "https://1.1.1.1:8080",
+      "capacity": "infinity"
+    }
+  ]
+}
+```
+
+One service with multiple instances.
+-----
+
+```json
+{
+  "service": "service1",
+  "version": "v1",
+  "instances": [
+    {
+      "capacity": "1.1.1.1",
+      "capacity": "infinity"
+    },
+    {
+      "location": "1.1.1.2",
+      "capacity": 44
+    }
+  ]
+}
+```
+
+Multiple service versions (or services) with multiple instances.
+----
+
+```json
+[
+  {
+    "service": "service1",
+    "version": "v1",
+    "instances": [
+      {
+        "location": "1.1.1.1:3000",
+        "capacity": "infinity"
+      },
+      {
+        "location": "1.1.1.2",
+        "capacity": 44
+      }
+    ]
+  },
+  {
+    "service": "service2",
+    "version": "v1",
+    "instances": [
+      {
+        "location": "1.1.1.6",
+        "capacity": "infinity"
+      },
+      {
+        "location": "1.1.1.9:80",
+        "capacity": 44
+      }
+    ]
+  }
+]
+```