PART 4: Implement full bi-directional communication over WebSocket/LP/SSE

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 FeedLabs
+Copyright (c) 2015 FeedLabs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,20 @@
+TEST?=./...
+
+default: test
+
+bin:
+	@sh -c "$(CURDIR)/scripts/build.sh"
+
+dev:
+	@TF_DEV=1 sh -c "$(CURDIR)/scripts/build.sh"
+
+test:
+	go test $(TEST) $(TESTARGS) -timeout=10s
+
+testrace:
+	go test -race $(TEST) $(TESTARGS)
+
+updatedeps:
+	go get -d -v -p 2 ./...
+
+.PHONY: bin default test updatedeps

README.md

@@ -6,14 +6,58 @@ elasticfeed
 #### Internal workflow
 ![elasticfeed-overview - mission](https://cloud.githubusercontent.com/assets/1843523/7103001/212978e0-e095-11e4-8b23-091adefe3cb7.png)
 
-#### Development
+#### Development environment
 Create symbolic link from you directory to `GOPATH`
 ```
 cd to-your-project
 mkdir -p $GOPATH/src/github.com/feedlabs
 ln -s $(pwd) $GOPATH/src/github.com/feedlabs/elasticfeed
 ```
 
+#### Developing Elasticfeed
+If you wish to work on Elasticfeed itself or any of its built-in providers,
+you'll first need [Go](http://www.golang.org) installed (version 1.2+ is
+_required_). Make sure Go is properly installed, including setting up
+a [GOPATH](http://golang.org/doc/code.html#GOPATH).
+
+Next, install the following software packages, which are needed for some dependencies:
+
+- [Bazaar](http://bazaar.canonical.com/en/)
+- [Git](http://git-scm.com/)
+- [Mercurial](http://mercurial.selenic.com/)
+
+Then, install [Gox](https://github.com/mitchellh/gox), which is used
+as a compilation tool on top of Go:
+
+    $ go get -u github.com/mitchellh/gox
+
+Next, clone this repository into `$GOPATH/src/github.com/elasticfeed/elasticfeed`.
+Install the necessary dependencies by running `make updatedeps` and then just
+type `make`. This will compile some more dependencies and then run the tests. If
+this exits with exit status 0, then everything is working!
+
+    $ make updatedeps
+    ...
+    $ make
+    ...
+
+To compile a development version of Elasticfeed and the built-in plugins,
+run `make dev`. This will put Elasticfeed binaries in the `bin` folder:
+
+    $ make dev
+    ...
+    $ bin/elasticfeed
+    ...
+
+
+If you're developing a specific package, you can run tests for just that
+package by specifying the `TEST` variable. For example below, only
+`elasticfeed` package tests will be run.
+
+    $ make test TEST=./elasticfeed
+    ...
+
+
 #### Run
 `go run api.go`
 
@@ -31,7 +75,7 @@ $ npm install apidoc -g
 ##### Generate
 
 ```
-$ apidoc -i public/ -o docs/api
+$ apidoc -i service/db -o docs/api
 ```
 
 ##### View

api.go

@@ -1,10 +1,21 @@
 package main
 
 import (
-	_ "github.com/feedlabs/elasticfeed/service"
-	"github.com/feedlabs/feedify"
+	"github.com/feedlabs/elasticfeed/service"
+	"github.com/feedlabs/elasticfeed/plugin"
+	"github.com/feedlabs/elasticfeed/workflow"
+	"github.com/feedlabs/elasticfeed/event"
+	"github.com/feedlabs/elasticfeed/resource"
+	"github.com/feedlabs/elasticfeed/elasticfeed"
 )
 
 func main() {
-	feedify.Run()
+	rm := resource.NewResourceManager()
+	em := event.NewEventManager()
+	pm := plugin.NewPluginManager(rm)
+	wm := workflow.NewWorkflowManager(nil, pm, em)
+	sm := service.NewServiceManager()
+
+	ServerEngine := elasticfeed.NewElasticfeed(rm, em, sm, pm, wm)
+	ServerEngine.Run()
 }

apidoc.json

@@ -6,11 +6,11 @@
   "url": "https://api.feedlabs.com/v1/",
   "header": {
     "title": "Principles",
-    "filename": "docs/apidoc-header.md"
+    "filename": "docs/apidoc/apidoc-header.md"
   },
   "footer": {
     "title": "Appendix",
-    "filename": "docs/apidoc-footer.md"
+    "filename": "docs/apidoc/apidoc-footer.md"
   },
   "order": [
     "Application",

helper/auth.go → common/auth.go

@@ -1,10 +1,10 @@
-package helper
+package common
 
 import (
 	auth "github.com/abbot/go-http-auth"
 	"github.com/astaxie/beego/context"
 	"github.com/feedlabs/elasticfeed/resource"
-	"github.com/feedlabs/elasticfeed/helper/config"
+	"github.com/feedlabs/elasticfeed/common/config"
 )
 
 var (

helper/crypt.go → common/crypt.go

@@ -1,4 +1,4 @@
-package helper
+package common
 
 import (
 	"crypto/md5"

helper/ids.go → common/ids.go

@@ -1,4 +1,4 @@
-package helper
+package common
 
 import (
 	"github.com/feedlabs/elasticfeed/resource"

helper/net.go → common/net.go

@@ -1,4 +1,4 @@
-package helper
+package common
 
 import (
 	"net"

common/uuid/uuid.go

@@ -0,0 +1,24 @@
+package uuid
+
+import (
+	"crypto/rand"
+	"fmt"
+	"time"
+)
+
+// Generates a time ordered UUID. Top 32 bits are a timestamp,
+// bottom 96 are random.
+func TimeOrderedUUID() string {
+	unix := uint32(time.Now().UTC().Unix())
+
+	b := make([]byte, 12)
+	n, err := rand.Read(b)
+	if n != len(b) {
+		err = fmt.Errorf("Not enough entropy available")
+	}
+	if err != nil {
+		panic(err)
+	}
+	return fmt.Sprintf("%08x-%04x-%04x-%04x-%04x%08x",
+		unix, b[0:2], b[2:4], b[4:6], b[6:8], b[8:])
+}

common/uuid/uuid_test.go

@@ -0,0 +1,12 @@
+package uuid
+
+import (
+	"testing"
+)
+
+func TestTimeOrderedUuid(t *testing.T) {
+	uuid := TimeOrderedUUID()
+	if len(uuid) != 36 {
+		t.Fatalf("bad: %s", uuid)
+	}
+}