node package manager

sphere-message-processing

This node.js library is designed to provide an easy way to write a SPHERE.IO message processors.

sphere-message-processing

Build Status NPM version Coverage Status Dependency Status devDependency Status

Service listens for line item state change messages in some project and replicates them to another SPHERE.IO project.

Getting Started

Install the module with: npm install sphere-message-processing

Setup

  • create config.js

    • make create_config.shexecutable

      chmod +x create_config.sh
    • run script to generate config.js

      ./create_config.sh
  • configure github/hipchat integration (see project settings in guthub)

  • install travis gem gem install travis

  • add encrpyted keys to .travis.yml

  • add sphere project credentials to .travis.yml

     ```
     travis encrypt [xxx] --add SPHERE_PROJECT_KEY
     travis encrypt [xxx] --add SPHERE_CLIENT_ID
     travis encrypt [xxx] --add SPHERE_CLIENT_SECRET
     ```
    
  • add hipchat credentials to .travis.yml

    ```
    travis encrypt [xxx]@Sphere --add notifications.hipchat.rooms
    ```
    

Documentation

(Coming soon)

Tests

Tests are written using jasmine (behavior-driven development framework for testing javascript code). Thanks to jasmine-node, this test framework is also available for node.js.

To run tests, simple execute the test task using grunt.

$ grunt test

Examples

(Coming soon)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. More info here

Releasing

Releasing a new version is completely automated using the Grunt task grunt release.

grunt release // patch release 
grunt release:minor // minor release 
grunt release:major // major release 

Styleguide

We <3 CoffeeScript here at commercetools! So please have a look at this referenced coffeescript styleguide when doing changes to the code.

License

Copyright (c) 2014 Oleg Ilyenko Licensed under the MIT license.