Cut release from b0234b91c64d08f69e15c15bf6579f358c93ea94

LICENSE.txt

@@ -0,0 +1,188 @@
+                       Copyright (c) [2018] [Team Lightly]
+
+                        "Lightly-Modified Apache License"
+                         A Variant of the Apache License
+
+                          View the Apache License at:
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+                Our license adds clause 4.(e) to the Apache License
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. 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.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor 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
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You 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 the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You 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 such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+     (e) Any Derivative Works may not be configured to use the default server
+         provided by the Copyright holders. You must configure all Derivative
+         Works to use servers owned by You, or servers You are otherwise
+         authorized to use.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its 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. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -0,0 +1,75 @@
+# Tandem
+
+Tandem is an add-on for your favorite text editor that enables peer-to-peer
+collaborative editing across different editors.
+
+This repository contains code for the Neovim plugin. For more details on
+Tandem, visit [our website](http://typeintandem.com), or our [mono-repository
+containing all other source code.](https://github.com/typeintandem/tandem)
+
+## Installation
+To install, you will need to have a copy of the Neovim Python2 client.
+```
+pip install neovim
+```
+You must also have `python3` and `node.js` installed for the networking code to
+work.
+
+Neovim users have the option of installing in one of the following ways:
+- **[Recommended]** Using your favourite plugin manager (e.g. Vundle, vim-plug,
+  etc.) Tandem should be compatible with most popular plugin managers
+- Installing Tandem directly. You’ll need download this repository to
+  `~/.config/nvim/rplugin/python`.
+
+Whether you use a plugin manager or download directly, you will also need to
+complete an additional one-time step.  
+Tandem uses Neovim remote plugin functionality for thread-safety, so you will
+need to:
+- launch `nvim`
+- run `:UpdateRemotePlugins`
+- quit `nvim`
+
+You are now ready to use Tandem!
+
+## Usage
+Tandem users can choose either start a collaborative session or join an
+existing one. Starting a collaborative session will share the contents of your
+current buffer. Joining an existing session will open it’s contents in a new
+buffer.
+
+Please use one of the following commands:
+- `:Tandem` - creates a new tandem session and prints the session ID
+- `:Tandem <session_id>` - joins an existing tandem session with the specified
+  session ID
+- `:TandemStop` - leaves the current session
+- `:TandemSession` - prints the current session ID
+
+It is recommended to leave the session before exiting neovim, but that process
+should be automated.
+
+
+## License
+Copyright (c) 2018 Team Lightly
+
+Licensed under the "Lightly-Modified Apache License", a variant of the Apache
+License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. 
+
+See [LICENSE.txt](LICENSE.txt)
+
+This license is essentially the Apache License 2.0, except for an added a
+clause that requires you to use your own servers instead of ours if you do
+modify Tandem.  
+You can also modify this in the configuration file at:
+`agent/tandem/agent/configuration.py`
+
+## Authors
+Team Lightly  
+[Geoffrey Yu](https://github.com/geoffxy), [Jamiboy
+Mohammad](https://github.com/jamiboym) and [Sameer
+Chitley](https://github.com/rageandqq)
+
+We are a team of senior Software Engineering students at the University of
+Waterloo.  
+Tandem was created as our [Engineering Capstone Design
+Project](https://uwaterloo.ca/capstone-design).

rplugin/python/tandem_lib/agent/main.py

@@ -0,0 +1,56 @@
+import signal
+import logging
+import threading
+import argparse
+from tandem.agent.executables.agent import TandemAgent
+
+should_shutdown = threading.Event()
+
+
+def signal_handler(signal, frame):
+    global should_shutdown
+    should_shutdown.set()
+
+
+def set_up_logging(log_location):
+    logging.basicConfig(
+        level=logging.DEBUG,
+        format="%(asctime)s %(levelname)-8s %(message)s",
+        datefmt="%Y-%m-%d %H:%M",
+        filename=log_location,
+        filemode="w",
+    )
+
+
+def main():
+    signal.signal(signal.SIGINT, signal_handler)
+    signal.signal(signal.SIGTERM, signal_handler)
+
+    parser = argparse.ArgumentParser(description="Starts the Tandem agent.")
+    parser.add_argument(
+        "--host",
+        default="",
+        help="The host address to bind to.",
+    )
+    parser.add_argument(
+        "--port",
+        default=0,
+        type=int,
+        help="The port to listen on.",
+    )
+    parser.add_argument(
+        "--log-file",
+        default="/tmp/tandem-agent.log",
+        help="The location of the log file.",
+    )
+    args = parser.parse_args()
+
+    set_up_logging(args.log_file)
+
+    # Run the agent until asked to terminate
+    with TandemAgent(args.host, args.port):
+        should_shutdown.wait()
+
+
+if __name__ == "__main__":
+    main()

rplugin/python/tandem_lib/agent/tandem/agent/configuration.py

@@ -0,0 +1,29 @@
+import os
+import socket
+
+# Tandem will try to establish a direct connection with other peers in a
+# session. However, this is not always possible. When Tandem is unable to
+# establish a peer-to-peer connection, we will relay messages to each peer
+# through our servers. If this is undesirable for your use case, you can set
+# this flag to "False".
+#
+# Please note that with relay disabled, you will not be able to collaborate
+# with any peers that Tandem cannot reach directly. Tandem does not notify you
+# if a peer-to-peer connection cannot be established.
+USE_RELAY = True
+
+# DO NOT edit anything below this unless you know what you're doing!
+
+PROJECT_ROOT = os.path.join(
+    os.path.dirname(os.path.abspath(__file__)),
+    '..',
+    '..',
+    '..',
+)
+BASE_DIR = os.path.dirname(PROJECT_ROOT)
+CRDT_PATH = os.path.join(BASE_DIR, "..", "crdt")
+PLUGIN_PATH = os.path.join(BASE_DIR, "..", "plugins")
+RENDEZVOUS_ADDRESS = (
+    socket.gethostbyname("rendezvous.typeintandem.com"),
+    60000,
+)