Merge pull request #5 from cloudevents/develop

Develop

Author: fabiojose

.travis.yml

@@ -1,29 +1,31 @@
 language: node_js
 node_js:
-  - 8
-  - 7
-  - 6
-
+- 8
+- 7
+- 6
 cache: npm
-
 jobs:
   include:
-    - stage: github release
-      node_js: "6"
-      deploy:
-        provider: releases
-        api_key: 
-          secure: "ls/IjZdRpFZlEQsZrsmXn7h7QTZuM8x4gZq3r75sOyTWcmKgZLN27hYCtk8SPcuNbt+ZA3otQEQJvDuGTCAwtbU4lxQjfXswP9M/om01hf3J7uTcjtol4XOsmBFqMCktW94pVH4U7Q18IHeP5JBnlfLzAY/YifRKKNWNrsI6bbnfcGgsFJYvICwKL5LEj7bxtJk156lBBJm9TscMX48BFsUBvnCNTDEBYNaaGkoCz6DPM0Da7QPF5exHcNiiF9SoR60WeGI1q+MdZyE+1AG0VpUp7sMxJafXSBbgYquPEZmG9ScZbkVyWP7ps3sgkqDkxtH4kNe9zF4PySRYfxYKJ03ECwbSmj9gxsIc8o2zhrLFinmHydLxoOEh5EygB2euekgMhoEKL0kA8bteaaqmD+3sna8MbXG4HhvIrEAspNtOFZyUm/SmgvXXxaKiDtwTw/5CvPCc7VH51NuC5QZi0UehLzatDpDNsj/ffMwDp5F4SBIZgUUmmIWfnAODNGwSwBKxdPVS3etkTeiBxerw2uzC6qjNW1QJyb9s+iU3rC59IEAuq6u4ymv3caDIHLnJbCMHRHQoIbq86oErqb8DhH6KrTlBnwlGBpUVhdpYMt0QX2Uncu9uHMBZ2CQNZ819PJa4QWvc1Ixoj3auKqvoMfPNQFOskMWnrnxkOokyPZg="
-        skip_cleanup: true
-        on:
-          tags: true
-    - stage: npm release
-      node_js: "6"
-      deploy:
-        provider: npm
-        email: [email protected]
-        api_key:
-          secure: "o5aF53FTPUSiJBbCZ/anBWQCgEJCctpxuTgGJbO1NpiheOM/xENiSmv+n2a5sGrhhqT0h7k15mE/ZgtL8TnM+45AHOg3EGez5JoR1XMIXnSeCno1GFK4waHDcEn3eLW9P35r1S5/RMTqbEUvqpyK/fzVZ4ecyh9t7dVvJV8MyQGo+r+oO3SLYEIt7YC6vZRh+dV3cK8jr7MHkHmQfZ6tZrALMKsj6QNTUtmk+IU52WHi4oe1iPuypS5dlaVdmanX7ZRtC7gR0Dko2/wja+DPOAKgG/S0aS794cxal7P5k/K34mvqT8iaCl4vN5uIcRsipgsprIahk2G2NgnIVCetBda9LhpMNUdn3j+v4T0lx3jiqP1eq01nk8YFpTV4Xz9VlYHK/E6NYQhUmd7N6WO9vXmOEDGBvWrDfQ1QMx+/TM9r3vzK9ps3sjkDFaAtJ2ZQ0pvFMEQTaLKak24ntWltSWZKvxdjYnS+bcfyIQQGagvqgZsnkKzeudO9N9Atp4OGcst9CAvvykDsfmLlARAiyvpuDVyUivuaOlCB9J7VBt1sbBfsiHpnJcSsMVz1OMRX5EGewbla530guoePhjTUDVit3NyUMz3ZQQTN9VSK3tA+NLyR0Ex8Oel+byHJDYyf+36GCDvoXagaPUVk5M5BINiCw2IWhxDgRGrcEp9JIUI="
-        skip_cleanup: true
-        on:
-          tags: true
+  - stage: github release
+    node_js: '6'
+    deploy:
+      provider: releases
+      api_key:
+        secure: ls/IjZdRpFZlEQsZrsmXn7h7QTZuM8x4gZq3r75sOyTWcmKgZLN27hYCtk8SPcuNbt+ZA3otQEQJvDuGTCAwtbU4lxQjfXswP9M/om01hf3J7uTcjtol4XOsmBFqMCktW94pVH4U7Q18IHeP5JBnlfLzAY/YifRKKNWNrsI6bbnfcGgsFJYvICwKL5LEj7bxtJk156lBBJm9TscMX48BFsUBvnCNTDEBYNaaGkoCz6DPM0Da7QPF5exHcNiiF9SoR60WeGI1q+MdZyE+1AG0VpUp7sMxJafXSBbgYquPEZmG9ScZbkVyWP7ps3sgkqDkxtH4kNe9zF4PySRYfxYKJ03ECwbSmj9gxsIc8o2zhrLFinmHydLxoOEh5EygB2euekgMhoEKL0kA8bteaaqmD+3sna8MbXG4HhvIrEAspNtOFZyUm/SmgvXXxaKiDtwTw/5CvPCc7VH51NuC5QZi0UehLzatDpDNsj/ffMwDp5F4SBIZgUUmmIWfnAODNGwSwBKxdPVS3etkTeiBxerw2uzC6qjNW1QJyb9s+iU3rC59IEAuq6u4ymv3caDIHLnJbCMHRHQoIbq86oErqb8DhH6KrTlBnwlGBpUVhdpYMt0QX2Uncu9uHMBZ2CQNZ819PJa4QWvc1Ixoj3auKqvoMfPNQFOskMWnrnxkOokyPZg=
+      skip_cleanup: true
+      on:
+        tags: true
+  - stage: npm release
+    node_js: '6'
+    deploy:
+      provider: npm
+      email: [email protected]
+      api_key:
+        secure: o5aF53FTPUSiJBbCZ/anBWQCgEJCctpxuTgGJbO1NpiheOM/xENiSmv+n2a5sGrhhqT0h7k15mE/ZgtL8TnM+45AHOg3EGez5JoR1XMIXnSeCno1GFK4waHDcEn3eLW9P35r1S5/RMTqbEUvqpyK/fzVZ4ecyh9t7dVvJV8MyQGo+r+oO3SLYEIt7YC6vZRh+dV3cK8jr7MHkHmQfZ6tZrALMKsj6QNTUtmk+IU52WHi4oe1iPuypS5dlaVdmanX7ZRtC7gR0Dko2/wja+DPOAKgG/S0aS794cxal7P5k/K34mvqT8iaCl4vN5uIcRsipgsprIahk2G2NgnIVCetBda9LhpMNUdn3j+v4T0lx3jiqP1eq01nk8YFpTV4Xz9VlYHK/E6NYQhUmd7N6WO9vXmOEDGBvWrDfQ1QMx+/TM9r3vzK9ps3sjkDFaAtJ2ZQ0pvFMEQTaLKak24ntWltSWZKvxdjYnS+bcfyIQQGagvqgZsnkKzeudO9N9Atp4OGcst9CAvvykDsfmLlARAiyvpuDVyUivuaOlCB9J7VBt1sbBfsiHpnJcSsMVz1OMRX5EGewbla530guoePhjTUDVit3NyUMz3ZQQTN9VSK3tA+NLyR0Ex8Oel+byHJDYyf+36GCDvoXagaPUVk5M5BINiCw2IWhxDgRGrcEp9JIUI=
+      skip_cleanup: true
+      on:
+        tags: true
+env:
+  global:
+    secure: t0A5/Fk1Qj8WkAk0ZuQqpFjrpINV6gfL+d1fXgq03EOAG/7FEyyz+AKkYaLT6avp26VWBzLgEoWC3RNmWD0v1/Ruckb95YpQcb5e4JotAce1ZsHgGTgx0UO146tkyGvXBw6MmO2nX2O/sHzkmyR6rlKkBi9LEKokJ9OFd6fi9nNtksgUDxkqNlNTu100fIQAV2RcN47C6iUx+gJIa+H/8QX/Cz02MyheXLe8a763wMQapz5GHrk2KuVY6FpylcAlSi2so+PjEGfKq3MWaQnTPkevkRDLtGcecVtFAq/0VbvoKc97PHoVT0x+nf48k1gj2VnQtYj6EVB74yRvqM9KkNOsfAQ0z9zF5wXMRs11SZywSViLQsnD9Ue6eYbYmodOKn4DFlLtoRyLBUspzLuoL76lERGe2cHU+Ebz2Nb9jL88o+SjfGrSJQEJU7SLZLbzJ7T/3SspWcAlo+Fo9UTCOB4/yL22Yge/SWQkdd1orBhohpjpyrU9Z1+IRvVoU1EICr04zSFUwEwn6Yxbt0ArgTZBEf11bf+YpCo+rBXNAd+XbZ79PGOEppFb+Hxrt9i1S1RnesDJnwC0k7cswU55Rv5gcNCo9lC+N4ZwS5y+5r6DsBfB+12YdsFORFyNbClECro1ODv4STf3rBBnjL8+ziPFjP4d4OwiGY+vG8bvLXY=
+script: npm run coverage

README.md

@@ -1,29 +1,32 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/bd66e7c52002481993cd6d610534b0f7)](https://www.codacy.com/app/fabiojose/sdk-javascript?utm_source=github.com&utm_medium=referral&utm_content=cloudevents/sdk-javascript&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/bd66e7c52002481993cd6d610534b0f7)](https://www.codacy.com/app/fabiojose/sdk-javascript?utm_source=github.com&utm_medium=referral&utm_content=cloudevents/sdk-javascript&utm_campaign=Badge_Coverage)
 [![Build Status](https://travis-ci.org/cloudevents/sdk-javascript.svg?branch=master)](https://travis-ci.org/cloudevents/sdk-javascript)
 
 # sdk-javascript
-Javascript SDK for CloudEvents
 
-> This is a WIP
+Official CloudEvents' SDK for JavaScript.
+
+<img src="https://raw.githubusercontent.com/cncf/artwork/master/cloudevents/horizontal/color/cloudevents-horizontal-color.png" width="300" height="58" alt="CloudEvents logo">
 
 ## Installation
 
 This CloudEvents SDK requires nodejs 6.11+
 
 ### Nodejs
 
-```
+```sh
 npm install cloudevents-sdk
 ```
 ## Specification Support
 
 These are the supported specifications by this version.
 
-| **Specifications**         | **v0.1** | **v0.2** |
-|----------------------------|----------|----------|
-| CloudEvents                | yes      | yes      |
-| HTTP Transport Binding     | yes      | yes      |
-| JSON Event Format          | yes      | yes      |
+| **Specifications**                    | **v0.1** | **v0.2** |
+|---------------------------------------|----------|----------|
+| CloudEvents                           | yes      | yes      |
+| HTTP Transport Binding  - Structured  | yes      | yes      |
+| HTTP Transport Binding  - Binary      | yes      | yes      |
+| JSON Event Format                     | yes      | yes      |
 
 ## How to use
 
@@ -39,7 +42,7 @@ Cloudevent(spec, format);
 
 ```
 
-### How to construct instances?
+### Usage
 
 ```js
 var Cloudevent = require("cloudevents-sdk");
@@ -59,7 +62,8 @@ cloudevent01
   .source("urn:event:from:myapi/resourse/123");
 
 /*
- * Backward compatibility by injecting methods from spec implementation to Cloudevent
+ * Backward compatibility to spec 0.1 by injecting methods from spec implementation 
+ * to Cloudevent
  */
 cloudevent01
  .eventTypeVersion("1.0");
@@ -69,7 +73,7 @@ cloudevent01
  *   - Spec 0.2
  *   - JSON Format 0.1
  */
-var cloudevent02 = new Cloudevent(Cloudevent.specs['0.2']);
+var cloudevent02 = new Cloudevent(Cloudevent.specs["0.2"]);
 
 /*
  * Different specs, but the same API.
@@ -80,23 +84,27 @@ cloudevent02
 
 ```
 
-### How to get the formatted payload?
+#### Formatting
 
 ```js
 var Cloudevent = require("cloudevents-sdk");
 
-var cloudevent = new Cloudevent()
-                       .type("com.github.pull.create")
-                       .source("urn:event:from:myapi/resourse/123");
+/*
+ * Creates an instance with default spec and format
+ */
+var cloudevent = 
+  new Cloudevent()
+        .type("com.github.pull.create")
+        .source("urn:event:from:myapi/resourse/123");
 
 /*
- * Format the payload and return it.
+ * Format the payload and return it
  */
 var formatted = cloudevent.format();
 
 ```
 
-### How to emit an event?
+#### Emitting
 
 ```js
 var Cloudevent = require("cloudevents-sdk");
@@ -108,12 +116,12 @@ var cloudevent = new Cloudevent()
 
 // The binding configuration using POST
 var config = {
-  method: 'POST',
-  url   : 'https://mywebhook.com'
+  method: "POST",
+  url   : "https://myserver.com"
 };
 
 // The binding instance
-var binding = Cloudevent.bindings['http-structured0.1'](config);
+var binding = Cloudevent.bindings["http-structured0.1"](config);
 
 // Emit the event using Promise
 binding.emit(cloudevent)
@@ -134,45 +142,20 @@ binding.emit(cloudevent)
 ├── lib
 │   ├── bindings
 │   │   └── http
-│   │       └── structured_0_1.js
 │   ├── cloudevent.js
 │   ├── format
-│   │   └── json_0_1.js
 │   └── specs
-│       ├── spec_0_1.js
-│       └── spec_0_2.js
 ├── LICENSE
 ├── package.json
 ├── README.md
-└── test
-    ├── cloudevent_spec_0_1.js
-    ├── cloudevent_spec_0_2.js
-    └── http_binding_0_1.js
 ```
 
-* `index.js`: library exports
-
-* `lib/bindings`: every binding implementation goes here
-
-* `lib/bindings/http`: every http binding implementation goes here
-
-* `lib/bindings/http/structured_0_1.js`: implementation of structured HTTP Binding  
-
-* `lib/cloudevent.js`: implementation of Cloudevent, an interface
-
-* `lib/format/`: every format implementation goes here
-
-* `lib/format/json_0_1.js`: implementation for JSON formatting [version 0.1](https://github.com/cloudevents/spec/blob/v0.1/json-format.md)
-
-* `lib/specs/`: every spec implementation goes here
-
-* `lib/specs/spec_0_1.js`: implementation for spec [version 0.1](https://github.com/cloudevents/spec/blob/v0.1/spec.md)
-
-* `lib/specs/spec_0_2.js`: implementation for spec [version 0.2](https://github.com/cloudevents/spec/blob/v0.2/spec.md)
-
-* `test/cloudevent_spec_0_1.js`: unit testing for spec 0.1
-
-* `test/cloudevent_spec_0_2.js`: unit testing for spec 0.2
+- `index.js`: library exports
+- `lib/bindings`: every binding implementation goes here
+- `lib/bindings/http`: every http binding implementation goes here
+- `lib/cloudevent.js`: implementation of Cloudevent, an interface
+- `lib/format/`: every format implementation goes here
+- `lib/specs/`: every spec implementation goes here
 
 ## Unit Testing
 

index.js

@@ -1,4 +1,3 @@
-var Cloudevent = require('./lib/cloudevent.js');
+var Cloudevent = require("./lib/cloudevent.js");
 
 module.exports = Cloudevent;
-

lib/bindings/http/binary_0_1.js

@@ -0,0 +1,42 @@
+var axios = require("axios");
+
+function HTTPBinary(configuration){
+  this.config = configuration;
+
+  this.config["headers"] = {
+    "Content-Type":"application/cloudevents+json; charset=utf-8"
+  };
+}
+
+HTTPBinary.prototype.emit = function(cloudevent){
+
+  // Create new request object
+  var _config = JSON.parse(JSON.stringify(this.config));
+
+  // Always set stuff in _config
+  var _headers = _config["headers"];
+
+  if(cloudevent.getContenttype()) {
+    _headers["Content-Type"] = cloudevent.getContenttype();
+  }
+
+  _headers["CE-EventType"] = cloudevent.getType();
+  if(cloudevent.getEventTypeVersion()) {
+    _headers["CE-EventTypeVersion"] = cloudevent.getEventTypeVersion();
+  }
+  _headers["CE-CloudEventsVersion"] = cloudevent.getSpecversion();
+  _headers["CE-Source"] = cloudevent.getSource();
+  _headers["CE-EventID"] = cloudevent.getId();
+  if(cloudevent.getTime()) {
+    _headers["CE-EventTime"] = cloudevent.getTime();
+  }
+  _headers["CE-SchemaURL"] = cloudevent.getSchemaurl();
+
+  // Set the cloudevent payload
+  _config["data"] = cloudevent.format().data;
+
+  // Return the Promise
+  return axios.request(_config);
+};
+
+module.exports = HTTPBinary;

lib/bindings/http/binary_0_2.js

@@ -0,0 +1,46 @@
+var axios = require("axios");
+var empty = require("is-empty");
+
+function HTTPBinary(configuration){
+  this.config = configuration;
+
+  this.config["headers"] = {
+    "Content-Type":"application/cloudevents+json; charset=utf-8"
+  };
+}
+
+HTTPBinary.prototype.emit = function(cloudevent){
+
+  // Create new request object
+  var _config = JSON.parse(JSON.stringify(this.config));
+
+  // Always set stuff in _config
+  var _headers = _config["headers"];
+
+  if(cloudevent.getContenttype()) {
+    _headers["Content-Type"] = cloudevent.getContenttype();
+  }
+
+  _headers["ce-type"] = cloudevent.getType();
+  _headers["ce-specversion"] = cloudevent.getSpecversion();
+  _headers["ce-source"] = cloudevent.getSource();
+  _headers["ce-id"] = cloudevent.getId();
+  if(cloudevent.getTime()) {
+    _headers["ce-time"] = cloudevent.getTime();
+  }
+  _headers["ce-schemaurl"] = cloudevent.getSchemaurl();
+
+  // Set the cloudevent payload
+  _config["data"] = cloudevent.format().data;
+
+  // Have extensions?
+  var exts = cloudevent.getExtensions(); 
+  for(var ext in exts){
+    _headers["ce-" + ext] = exts[ext];
+  }
+
+  // Return the Promise
+  return axios.request(_config);
+};
+
+module.exports = HTTPBinary;

lib/bindings/http/structured_0_1.js

@@ -3,8 +3,8 @@ var axios = require("axios");
 function HTTPStructured(configuration){
   this.config = configuration;
 
-  this.config['headers'] = {
-    'Content-Type':'application/cloudevents+json; charset=utf-8' 
+  this.config["headers"] = {
+    "Content-Type":"application/cloudevents+json; charset=utf-8"
   };
 }
 
@@ -14,11 +14,10 @@ HTTPStructured.prototype.emit = function(cloudevent){
   var _config = JSON.parse(JSON.stringify(this.config));
 
   // Set the cloudevent payload
-  _config['data'] = cloudevent.format();
+  _config["data"] = cloudevent.format();
 
   // Return the Promise
   return axios.request(_config);
-}
+};
 
 module.exports = HTTPStructured;
-

lib/bindings/http/structured_0_2.js

@@ -0,0 +1,23 @@
+var axios = require("axios");
+
+function HTTPStructured(configuration){
+  this.config = configuration;
+
+  this.config["headers"] = {
+    "Content-Type":"application/cloudevents+json; charset=utf-8"
+  };
+}
+
+HTTPStructured.prototype.emit = function(cloudevent){
+
+  // Create new request object
+  var _config = JSON.parse(JSON.stringify(this.config));
+
+  // Set the cloudevent payload
+  _config["data"] = cloudevent.format();
+
+  // Return the Promise
+  return axios.request(_config);
+};
+
+module.exports = HTTPStructured;