Merge pull request #2 from fabiojose/start

The start of JavaScript SDK

Author: fabiojose

.gitignore

@@ -0,0 +1,77 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+# FuseBox cache
+.fusebox/
+

README.md

@@ -1,2 +1,234 @@
 # sdk-javascript
 Javascript SDK for CloudEvents
+
+> This is a WIP
+
+# Repository Structure
+
+```text
+├── index.js
+├── 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/master/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
+
+# Unit Testing
+
+The unit test checks the result of formatted payload and the constraints.
+
+```bash
+
+npm test
+
+```
+
+# The API
+
+## `Cloudevent` class
+
+```js
+
+/*
+ * Format the payload and return an Object.
+ */
+Object Cloudevent.format()
+
+/*
+ * Format the payload as String.
+ */
+String Cloudevent.toString()
+
+```
+
+## `Formatter` classes
+
+Every formatter class must implement these methods to work properly.
+
+```js
+
+/*
+ * Format the Cloudevent payload argument and return an Object.
+ */
+Object Formatter.format(payload)
+
+/*
+ * Format the Cloudevent payload as String.
+ */
+String Formatter.toString(payload)
+
+```
+
+## `Spec` classes
+
+Every Spec class must implement these methods to work properly.
+
+```js
+
+/*
+ * The constructor must receives the Cloudevent type.
+ */
+Spec(Cloudevent)
+
+/*
+ * Checks the spec constraints, throwing an error if do not pass.
+ */
+Spec.check()
+
+```
+## `Binding` classes
+
+Every Binding class must implement these methods to work properly.
+
+```js
+
+/* 
+ * The constructor must receives the map of configurations.
+ */
+Binding(config)
+
+/* 
+ * Emits the event using an instance of Cloudevent.
+ */
+Binding.emit(cloudevent)
+
+```
+
+# How to use
+
+The `Cloudevent` constructor arguments.
+
+```js
+
+/*
+ * spec  : if is null, set the spec 0.1 impl
+ * format: if is null, set the JSON Format 0.1 impl
+ */
+Cloudevent(spec, format);
+
+```
+
+## How to construct instances?
+
+```js
+/* 
+ * Constructs a default instance with:
+ *   - Spec 0.1
+ *   - JSON Format 0.1
+ */
+var cloudevent01 = new Cloudevent();
+
+/*
+ * Implemented using Builder Design Pattern
+ */
+cloudevent01
+  .type("com.github.pull.create")
+  .source("urn:event:from:myapi/resourse/123");
+
+/*
+ * Backward compatibility by injecting methods from spec implementation to Cloudevent
+ */
+cloudevent01
+ .eventTypeVersion("1.0");
+
+/*
+ * Constructs an instance with:
+ *   - Spec 0.2
+ *   - JSON Format 0.1 
+ */
+var cloudevent02 = new Cloudevent(Cloudevent.specs['0.2']);
+
+/*
+ * Different specs, but the same API.
+ */
+cloudevent02
+  .type("com.github.pull.create")
+  .source("urn:event:from:myapi/resourse/123");
+
+```
+
+## How to get the formatted payload?
+
+```js
+var cloudevent = new Cloudevent()
+                       .type("com.github.pull.create")
+                       .source("urn:event:from:myapi/resourse/123");
+
+/*
+ * Format the payload and return it.
+ */
+var formatted = cloudevent.format();
+ 
+```
+
+## How to emit an event?
+
+```js
+// The event
+var cloudevent = new Cloudevent()
+                       .type("com.github.pull.create")
+                       .source("urn:event:from:myapi/resourse/123");
+
+// The binding configuration using POST
+var config = {
+  method: 'POST',
+  url   : 'https://mywebhook.com'
+};
+
+// The binding instance
+var binding = Cloudevent.bindings['http-structured0.1'](config);
+
+// Emit the event using Promise
+binding.emit(cloudevent)
+  .then(response => {
+    // Treat the response
+    console.log(response.data);
+
+  }).catch(err => {
+    // Treat the error
+    console.error(err);
+  });
+```
+
+> See how to implement the method injection [here](lib/specs/spec_0_1.js#L17)
+>
+> Learn about [Builder Design Pattern](https://en.wikipedia.org/wiki/Builder_pattern)
+> 
+> Check out the produced event payload using this [tool](https://webhook.site)

index.js

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

lib/bindings/http/structured_0_1.js

@@ -0,0 +1,24 @@
+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;
+