Merge pull request #236 from spaceuptech/v0.9.0

V0.9.0

Author: Jayesh Choudhary

.gitignore

@@ -22,5 +22,8 @@ css
 space-cloud
 publish.sh
 
+test_config.yaml
+
 #IDEs
-.idea
+.idea
+.vscode

config/config.go

@@ -1,5 +1,7 @@
 package config
 
+import "github.com/spaceuptech/space-cloud/utils"
+
 // Config holds the entire configuration
 type Config struct {
 	Projects map[string]*Project `json:"projects" yaml:"projects"` // The key here is the project id
@@ -56,6 +58,8 @@ type Rule struct {
 	DB      string                 `json:"db" yaml:"db"`
 	Col     string                 `json:"col" yaml:"col"`
 	Find    map[string]interface{} `json:"find" yaml:"find"`
+	Service string                 `json:"service" yaml:"service"`
+	Func    string                 `json:"func" yaml:"func"`
 }
 
 // Auth holds the mapping of the sign in method
@@ -68,17 +72,22 @@ type AuthStub struct {
 	Secret  string `json:"secret" yaml:"secret"`
 }
 
-// Functions holds the config for the Functions module
+// Functions holds the config for the functions module
 type Functions struct {
-	Enabled bool   `json:"enabled" yaml:"enabled"`
-	Nats    string `json:"nats" yaml:"nats"`
+	Enabled bool         `json:"enabled" yaml:"enabled"`
+	Broker  utils.Broker `json:"broker" yaml:"broker"`
+	Conn    string       `json:"conn" yaml:"conn"`
+	Rules   FuncRules    `json:"rules" yaml:"rules"`
 }
 
+// FuncRules is the rules for the functions module
+type FuncRules map[string]map[string]*Rule // service -> function -> rule
+
 // Realtime holds the config for the realtime module
 type Realtime struct {
-	Enabled bool   `json:"enabled" yaml:"enabled"`
-	Broker  string `json:"broker" yaml:"broker"`
-	Conn    string `json:"Conn" yaml:"Conn"`
+	Enabled bool         `json:"enabled" yaml:"enabled"`
+	Broker  utils.Broker `json:"broker" yaml:"broker"`
+	Conn    string       `json:"conn" yaml:"conn"`
 }
 
 // FileStore holds the config for the file store module
@@ -97,8 +106,14 @@ type FileRule struct {
 
 // Static holds the config for the static files module
 type Static struct {
-	Enabled   bool   `json:"enabled" yaml:"enabled"`
+	Enabled bool           `json:"enabled" yaml:"enabled"`
+	Routes  []*StaticRoute `json:"routes" yaml:"routes"`
+}
+
+// StaticRoute holds the config for each route
+type StaticRoute struct {
 	Path      string `json:"path" yaml:"path"`
 	URLPrefix string `json:"prefix" yaml:"prefix"`
-	Gzip      bool   `json:"gzip" yaml:"gzip"`
+	Host      string `json:"host" yaml:"host"`
+	Proxy     string `json:"proxy" yaml:"proxy"`
 }

config/load.go

@@ -3,11 +3,34 @@ package config
 import (
 	"encoding/json"
 	"io/ioutil"
+	"os"
 	"strings"
 
 	"gopkg.in/yaml.v2"
 )
 
+func loadEnvironmentVariable(p *Project) {
+	if strings.HasPrefix(p.Secret, "$") {
+		tempString := strings.TrimPrefix(p.Secret, "$")
+		tempEnvVar, present := os.LookupEnv(tempString)
+
+		if present {
+			p.Secret = tempEnvVar
+		}
+	}
+
+	for _, value := range p.Modules.Crud {
+		if strings.HasPrefix(value.Conn, "$") {
+			tempStringC := strings.TrimPrefix(value.Conn, "$")
+			tempEnvVarC, presentC := os.LookupEnv(tempStringC)
+
+			if presentC {
+				value.Conn = tempEnvVarC
+			}
+		}
+	}
+}
+
 // LoadConfigFromFile loads the config from the provided file path
 func LoadConfigFromFile(path string) (*Project, error) {
 	// Load the file in memory
@@ -27,5 +50,6 @@ func LoadConfigFromFile(path string) (*Project, error) {
 		return nil, err
 	}
 
+	loadEnvironmentVariable(conf)
 	return conf, nil
 }

config/template.go

@@ -25,10 +25,16 @@ modules:
       enabled: false
   functions:
     enabled: false
-    nats: nats://localhost:4222
+    broker: nats
+    conn: nats://localhost:4222
+    rules:
+      service1:
+        function1:
+          rule: allow
   realtime:
     enabled: false
-    kafka: localhost
+    broker: nats
+    conn: nats://localhost:4222
   fileStore:
     enabled: false
     storeType: local
@@ -45,7 +51,7 @@ modules:
             rule: allow
   static:
     enabled: false
-    path: ./public
-    prefix: /
-    gzip: false
+    routes:
+    - prefix: /
+      path: ./public
 `

docs/config.json

@@ -65,6 +65,10 @@
         "read",
         "Read Data"
       ],
+      [
+        "live-query",
+        "Listening to real-time updates"
+      ],
       [
         "update",
         "Update Data"
@@ -73,22 +77,16 @@
         "delete",
         "Delete Data"
       ],
+      [
+        "transactions", 
+        "Transactions and batched mutations"
+      ],
       [
         "config",
         "Configuration"
       ]
     ]
   },
-  {
-    "name": "Realtime",
-    "url": "realtime",
-    "pages": [
-      [
-        "live-query",
-        "Listening to real-time updates"
-      ]
-    ]
-  },
   {
     "name": "File Storage",
     "url": "file-storage",
@@ -116,16 +114,16 @@
     ]
   },
   {
-    "name": "Functions",
+    "name": "Functions Mesh",
     "url": "functions",
     "pages": [
       [
-        "engine",
-        "Writing custom logic"
+        "service",
+        "Write functions"
       ],
       [
         "client",
-        "Accessing custom logic"
+        "Call functions"
       ]
     ]
   },
@@ -135,14 +133,23 @@
     "pages": [
       [
         "database",
-        "Database"
+        "Securing data"
       ],
       [
         "file-storage",
-        "File Storage"
+        "Securing files"
+      ],
+      [
+        "functions",
+        "Securing functions"
       ]
     ]
   },
+  {
+    "name": "Static hosting",
+    "url": "static",
+    "pages": []
+  },
   {
     "name": "Deploy",
     "url": "deploy",

docs/manual/database/config.md

@@ -7,7 +7,6 @@ modules:
   crud:
     mongo:
       conn: mongodb://localhost:27017
-      isPrimary: true
       collections:
         todos:
           isRealtimeEnabled: false
@@ -20,23 +19,48 @@ modules:
               rule: allow
             delete:
               rule: allow
+    sql-mysql:
+      conn: user:my-secret-pwd@/project
+      collections:
+        users:
+          isRealtimeEnabled: false
+          rules:
+            create:
+              rule: allow
+            read:
+              rule: allow
+            update:
+              rule: allow
+            delete:
+              rule: allow
 
   # Config for other modules go here
 ```
 
-As you can see `crud`, in this case has the key `mongo` which stands for the MongoDB database. You can have multiple databases in a single project by simply adding the config of each database under `crud`. The keys for the databases we currently support are `mongo` (for MongoDB), `sql-postgres` (for Postgres) and `sql-mysql` (for MySQL).
+The `crud` module in config specifies which databases to connect to and which collections to expose in that database along with the respective security rules. As you can see, you can have multiple databases in a single project by simply adding the config of each database under `crud`. The keys for the databases we currently support are `mongo` (for MongoDB), `sql-postgres` (for Postgres and Postgres compatible databases) and `sql-mysql` (for MySQL and MySQL compatible databases).
+
+# Enable the realtime module
+
+Here's a snippet showing how to **enable the realtime module**. This 4 line snippet will set up all the necessary routines required by the realtime module.
+
+```yaml
+modules:
+  realtime:
+    enabled: true    # Enable the realtime module globally
+    broker: nats     # Broker to be used as pub sub for realtime module
+    conn: nats://localhost:4222  #  Connection string of broker 
+```
 
-Here's a snippet configuring space cloud to use MongoDB and MySQL. MongoDB will hold the `todos` collection while MySQL has the `users` table.
+The realtime feature also needs to be enabled on a collection level for the collections that you want to sync in realtime. Here's a snippet configuring space cloud to use MongoDB and MySQL. MongoDB will hold the `todos` collection which will be synced in realtime while MySQL has the `users` table (not synced in realtime).
 
 ```yaml
 modules:
   crud:
     mongo:
       conn: mongodb://localhost:27017
-      isPrimary: false
       collections:
         todos:
-          isRealtimeEnabled: false
+          isRealtimeEnabled: true
           rules:
             create:
               rule: allow
@@ -48,7 +72,6 @@ modules:
               rule: allow
     sql-mysql:
       conn: user:my-secret-pwd@/project
-      isPrimary: true
       collections:
         users:
           isRealtimeEnabled: false
@@ -61,16 +84,17 @@ modules:
               rule: allow
             delete:
               rule: allow
-
-  # Config for other modules go here
+  realtime:
+    enabled: true
+    broker: nats
+    conn: nats://localhost:4222
 ```
 
 For each database, you need to specify the following fields:
 - **conn:** This is the connection string to connect to the database with.
-- **isPrimary:** Specifies if the database is to be used as the primary database. Note, you **cannot have more than one primary database**.
 - **collections:** These are the table / collections which need to be exposed via Space Cloud. They contain two sub fields `isRealtimeEnabled` and `rules`. `rules` are nothing but the [security rules](/docs/security/database), to control the database access.
 
-The snippet shown above configures Space Cloud to use `MongoDB` as the primary database present at `mongodb://localhost:27017`. It exposes a single collection `todos`. All types of operations (create, read, update and delete) are allowed on the `todos` collection. This implies that, any anonymous user will be able to perform any operations on the database. To expose more tables / collections, simply add new objects under the `collections` key.
+The snippet shown above configures Space Cloud to use `MongoDB` present at `mongodb://localhost:27017`. It exposes a single collection `todos`. All types of operations (create, read, update and delete) are allowed on the `todos` collection. This implies that, any anonymous user will be able to perform any operations on the database. To expose more tables / collections, simply add new objects under the `collections` key.
 
 Here's an example that has two collections `todos` and `users`. Note, updating and deleting users is denied.
 
@@ -111,13 +135,13 @@ modules:
 
 ## Next steps
 
-Now you know the basics of the database module. The next step would be checking out the realtime module to bring realtime updates to your app!
+Now you know the basics of the database module. The next step would be checking out the file storage module to bring files to your app!
 
 <div class="btns-wrapper">
-  <a href="/docs/database/delete" class="waves-effect waves-light btn primary-btn-border btn-small">
+  <a href="/docs/database/transactions" class="waves-effect waves-light btn primary-btn-border btn-small">
     <i class="material-icons btn-with-icon">arrow_back</i>Previous
   </a>
-  <a href="/docs/realtime/overview" class="waves-effect waves-light btn primary-btn-fill btn-small">
+  <a href="/docs/file-storage/overview" class="waves-effect waves-light btn primary-btn-fill btn-small">
     Next<i class="material-icons btn-with-icon">arrow_forward</i>
   </a>
 </div>