Refactor project and add terrapipe spec

CLA-draft.md

@@ -0,0 +1,30 @@
+# Individual Contributor License Agreement
+Adapted from http://www.apache.org/licenses/icla.txt © The Apache Software Foundation
+
+Thank you for your interest in Terrabase (the "Company"). In order to clarify the intellectual property license granted with Contributions from any person or entity, the Company must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the Company and its users; it does not change your rights to use your own Contributions for any other purpose.
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Company. In return, the Company shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its bylaws in effect at the time of the Contribution. Except for the license granted herein to the Company and recipients of software distributed by the Company, You reserve all right, title, and interest in and to Your Contributions.
+
+1. Definitions.
+
+    - "You" (or "Your")
+    
+        "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Company. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+    - "Contribution"
+    
+        "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Company for inclusion in, or documentation of, any of the products owned or managed by the Company (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Company or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Company for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Company and to recipients of software distributed by the Company a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Company and to recipients of software distributed by the Company a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Company, or that your employer has executed a separate Corporate CLA with the Company.
+
+5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7. Should You wish to submit work that is not Your original creation, You may submit it to the Company separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
+
+8. You agree to notify the Company of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

Cargo.lock

@@ -1,5 +1,14 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
 [[package]]
-name = "terrabase"
+name = "libcore"
 version = "0.1.0"
+
+[[package]]
+name = "terrabase-cli"
+version = "0.1.0"
+
+[[package]]
+name = "terrabase-server"
+version = "0.1.0"
+

Cargo.toml

@@ -1,9 +1,6 @@
-[package]
-name = "terrabase"
-version = "0.1.0"
-authors = ["Sayan Nandan <nandansayan@outlook.com>"]
-edition = "2018"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
+[workspace]
+members = [
+    "cli",
+    "server",
+    "libcore"
+]

cli/Cargo.lock

@@ -0,0 +1,5 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+[[package]]
+name = "terrabase"
+version = "0.1.0"

cli/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "terrabase-cli"
+version = "0.1.0"
+authors = ["Sayan Nandan <nandansayan@outlook.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

libcore/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "libcore"
+version = "0.1.0"
+authors = ["Sayan Nandan <nandansayan@outlook.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

libcore/src/lib.rs

@@ -0,0 +1,22 @@
+/*
+ * Created on Thu Jul 02 2020
+ *
+ * This file is a part of the source code for the Terrabase database
+ * Copyright (c) 2020 Sayan Nandan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+*/
+
+mod terrapipe;

libcore/src/terrapipe.rs

@@ -0,0 +1,21 @@
+/*
+ * Created on Thu Jul 02 2020
+ *
+ * This file is a part of the source code for the Terrabase database
+ * Copyright (c) 2020 Sayan Nandan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+*/
+

libcore/terrapipe-spec.md

@@ -0,0 +1,101 @@
+# Terrapipe
+
+> Date: 2<sup>nd</sup> July, 2020<br>Copyright &copy; 2020 Sayan Nandan
+
+Terrapipe is a protocol that is used by Terrabase for data transfer. It is an application layer
+protocol that builds on top of TCP. Just like HTTP's request/response action, Terrapipe (i.e tp://)
+also makes use of  a query/result action.
+From now on, I will refer to Terrapipe as _TP_ or _tp_.
+
+TP makes use of two packets:
+
+1. **The `Q` uery packet**: This is sent by the client
+2. **The `R` esult packet**: This is sent by the server
+
+## The `Q` uery packet
+
+The `Q` uery packet has the following structure:
+
+``` 
+TP <VERSION>/Q <QTYPE>/<LENGTH>
+\n
+--------------- DATA ----------
+```
+
+**Note:** The first line, is followed by a line break, and then the subsequent lines.
+
+### Line 1: Meta frame
+
+The first line is called the meta frame. The `<VALUES>` and their corresponding meanings are as follows:
+- **`VERSION`**: The version of the protocol, in semver form, i.e `major.minor.patch`.
+An example can be: `0.1.0`
+- **`QTYPE`**: This is the type of query. It can have the following values:
+    - `GET`: For `GET` operations
+    - `SET`: For `SET` operations
+    - `UPDATE`: For `UDPATE` operations
+    - `DEL`: For `DEL` operations
+- **`LENGTH`**: The number of bytes that are being transmitted. This is useful for preallocating buffers for copying the data.
+
+#### Example meta frame
+```
+TP 0.1.0/Q GET/15
+```
+
+### Line 2: Line break
+This is a line break that separates the meta frame from the data frame.
+
+### Line 3: Data frame
+The data frame doesn't have any defined format. It can be anything that can be transferred over TCP - that is, well, anything: letters, numbers or vaguely bytes.
+
+## The `R`esult packet
+The `R`esult packet has the following structure:
+```
+TP <VERSION>/R <QTYPE>/<RESPONSECODE>/<LENGTH>
+\n
+--------------------- DATA -------------------
+```
+**Note:** The first line is followed by a line break, and then the subsequent lines.
+
+### Line 1: Meta frame
+Just like the `Q`uery packet, the first line is called the meta frame.
+The `<VALUES>` and their corresponding meanings are as follows:
+- **`VERSION`**: The version of the protocol, in semver form, i.e `major.minor.patch`.
+An example can be: `0.1.0`
+- **`QTYPE`**: This is the type of query. It can have the following values:
+    - `GET`: For responses to `GET` operations
+    - `SET`: For responses to `SET` operations
+    - `UPDATE`: For responses to `UPDATE` operations
+    - `DEL`: For response to `DEL` operations
+    
+    This must match with the initial query packet.
+- **`RESPONSECODE`**: This is the outcome of the query. It can have the following values:
+    - 0: Okay
+    - 1: Not found
+    - 2: Method not allowed
+    - 3: Server error
+    - 4: Corrupt byte
+    - 5: Protocol version mismatch
+- **`LENGTH`**: The number of bytes that are being transmitted. This is useful for preallocating buffers for copying the data.
+
+#### Example data frame
+```
+sayan is writing a protocol
+```
+
+## An example of a query/result
+Let us assume a key called `sayan` with a value of '17' exists on the database.
+Our client, uses `0.1.0` version of tp and sends a `GET` request for the key to our server which also uses version `0.1.0` of tp.
+
+### The `Q`uery packet
+```
+TP 0.1.0/Q GET/5
+\n
+sayan
+```
+
+### The `R`esult packet
+```
+TP 0.1.0/R GET/0/2
+\n
+17
+```

server/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "terrabase-server"
+version = "0.1.0"
+authors = ["Sayan Nandan <nandansayan@outlook.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

server/src/main.rs

@@ -0,0 +1,24 @@
+/*
+ * Created on Thu Jul 02 2020
+ *
+ * This file is a part of the source code for the Terrabase database
+ * Copyright (c) 2020 Sayan Nandan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+*/
+
+fn main() {
+    println!("Hello, world!");
+}