AMPJS

A Javascript WEB-STOMP-based client for AMP

Usage

To use the AmpJS client you need to both install it into your project and then configure it for your STOMP broker. ###Installation### This project is packaged as a BOWER module but is not listed in the bower repo. To install a particular version (in this case version 0.0.5) of this project through bower you will need run a command like this: bower install https://github.com/Berico-Technologies/ampjs.git#0.0.5

The package is written as a RequireJS module and has a number of dependencies on other supporting libraries. All required dependencies should be brought into the project as part of the initial bower install, however you will need to define the installed libraries with appropriate keys for AmpJS to find them:

paths:{

    i18n: 'vendor/managed/requirejs-i18n/i18n',
    domReady: 'vendor/managed/requirejs-domready/domReady',
    modernizr: 'vendor/managed/modernizr/modernizr',
    stomp: 'vendor/managed/stomp-websocket/dist/stomp',
    underscore: 'vendor/managed/underscore-amd/underscore',
    sockjs: 'vendor/managed/sockjs/sockjs',
    flog: 'vendor/managed/flog/flog',
    uuid: 'vendor/managed/node-uuid/uuid',
    jshashes: 'vendor/managed/jsHashes/hashes',
    jquery: 'vendor/managed/jquery/jquery'
},
shim:{
    'modernizr':{
        exports: 'Modernizr'
    },
    'stomp':{
        exports: 'Stomp'
    },
    'sockjs':{
        exports: 'SockJS'
    },
    'uuid':{
        exports: 'uuid'
    },
    'jquery':{
        exports: 'jquery'
    }
}

###Configuration### Assuming you have installed and aliased AmpJS to 'amp,' here is how you would instantiate the client and publish / subscribe to a topic. Note that in this example messages are not published on the topic until the subscriber's deferred is resolved. Any messages published on the topic before the subscriber is initialized will not be received by the client

define [
  'amp/factory/ShortBus'
],
(ShortBus)->

  publishAMessage:->
    shortBus = ShortBus.getBus({
      publishTopicOverride: "my.cool.topic.123"
    })
    shortBus.subscribe({
      getEventType: ->
        return "my.cool.topic.123"
      handle: (arg0, arg1)->
        console.log arg0.data

      handleFailed: (arg0, arg1)->
      }).then ->
        shortBus.publish({data: 'interesting stuff'})

Running Tests

1. Compile the source code. We're using mimosa, so either have the project running 'mimosa watch -s' or compile the code 'mimosa build'

2. Once the code is compiled you should be able to run the unit tests 'karma start'

   **NOTE: the project does not currently include phantomjs. **You need to download it yourself and set the PHANTOMJS_BIN environement variable like this:

   export PHANTOMJS_BIN=/Applications/phantomjs-1.9.0-macosx/bin/phantomjs