/README.md

http://github.com/biilmann/eventsource-broker · Markdown · 88 lines · 64 code · 24 blank · 0 comment · 0 complexity · 201100e17e3dd3e8ed3cf54fe4d32403 MD5 · raw file 

    

  1. EvenSource Broker
    2. 

  2. =================
    3. 

  3. 

  4. A simple bridge between EventSource and an AMQP fanout exchange.
    5. 

  5. 

  6. EventSource is a new browser standard released as part of the HTML5
    7. 

  7. spec.
    8. 

  8. 

  9. It lets the browser send a never-ending HTTP request to a server and
    10. 

  10. provides a javascript API for binding to events pushed from the server.
    11. 

  11. 

  12. EventSource is very handy when you don't need the full bidirectional
    13. 

  13. communication that Websockets offers. it plays well with load-balancers,
    14. 

  14. intermediary proxies and HTTPS termination.
    15. 

  15. 

  16. This library sets up an EventSource that clients can connect to
    17. 

  17. specifying a channel to listen to in the query string. The server
    18. 

  18. connects to a fanout AMQP exchange and routes AMQP messages as events to
    19. 

  19. the javascript clients.
    20. 

  20. 

  21. MongoDB is used to store user and connection information.
    22. 

  22. 

  23. The server expects the AMQP messages to be JSON following the format:
    24. 

  24. 

  25.     {
    26. 

  26.         "channel": "some-channel", // Required
    27. 

  27.         "data": "{/"msg/": /"data/"}", // Required
    28. 

  28.         "id": "event-id", // optional
    29. 

  29.         "name": "event-name" // optional
    30. 

  30.     }
    31. 

  31. 

  32. To open connections to a channel a user with an key and a secret is
    33. 

  33. expected to exist in the database. Before opening a connection a socket
    34. 

  34. id must be aquired from by calling POST /socket
    35. 

  35. 

  36. A simple example of how to interact with this API can be found in the
    37. 

  37. [https://github.com/eshq/eshq-gem](eshq ruby gem).
    38. 

  38. 

  39. Installation
    40. 

  40. ============
    41. 

  41. 

  42. Clone the repository, cd to the root of it and execute
    43. 

  43. 

  44.     cabal install
    45. 

  45. 

  46. Run as:
    47. 

  47. 

  48.     eventsource-broker -p <port>
    49. 

  49. 

  50. The broker will look for an AMQP_URL environment variable for a broker
    51. 

  51. to connect to. It also takes a MONGO_URL for configuring the database
    52. 

  52. connection and an ORIGIN variable that should be a url the server runs
    53. 

  53. on for cross domain requests.
    54. 

  54. 

  55. License
    56. 

  56. =======
    57. 

  57. 

  58. Copyright (c)2011, Mathias Biilmann <info@mathias-biilmann.net>
    59. 

  59. 

  60. All rights reserved.
    61. 

  61. 

  62. Redistribution and use in source and binary forms, with or without
    63. 

  63. modification, are permitted provided that the following conditions are met:
    64. 

  64. 

  65.     * Redistributions of source code must retain the above copyright
    66. 

  66.       notice, this list of conditions and the following disclaimer.
    67. 

  67. 

  68.     * Redistributions in binary form must reproduce the above
    69. 

  69.       copyright notice, this list of conditions and the following
    70. 

  70.       disclaimer in the documentation and/or other materials provided
    71. 

  71.       with the distribution.
    72. 

  72. 

  73.     * Neither the name of Mathias Biilman <info@mathias-biilmann.net>
    74. 

  74.       nor the names of other contributors may be used to endorse or
    75. 

  75.       promote products derived from this software without specific prior
    76. 

  76.       written permission.
    77. 

  77. 

  78. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    79. 

  79. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    80. 

  80. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    81. 

  81. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    82. 

  82. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    83. 

  83. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    84. 

  84. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    85. 

  85. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    86. 

  86. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    87. 

  87. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    88. 

  88. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
    89.