Merge branch 'master' into hooks

Author: willingc

CHANGELOG.md

@@ -1,10 +1,32 @@
 # Change Log
 
+## 2.3.0 [Unreleased](https://github.com/nteract/bookstore/compare/2.2.1...HEAD)
 
-[Unreleased](https://github.com/nteract/bookstore/compare/0.2.1...HEAD)
+[2.3.0 on Github](https://github.com/nteract/bookstore/releases/tag/2.3.0)
 
-[2.1.0](https://github.com/nteract/bookstore/releases/tag/2.1.0)
+### Significant changes
 
-[2.0.0](https://github.com/nteract/bookstore/releases/tag/2.0.0)
+Validation information is now exposed as a dict at the /api/bookstore endpoint.
 
-[0.1](https://github.com/nteract/bookstore/releases/tag/0.1)
+This allows us to distinguish whether different features have been enabled on bookstore.
+
+The structure now is 
+
+```python
+    validation_checks = {
+        "bookstore_valid": all(general_settings),
+        "archive_valid": all(archive_settings),
+        "publish_valid": all(published_settings),
+    }
+```
+## Releases prior to 2.3.0
+
+[2.2.1 (2019-02-03)](https://github.com/nteract/bookstore/releases/tag/2.2.1)
+
+[2.2.0 (2019-01-29)](https://github.com/nteract/bookstore/releases/tag/2.2.0)
+
+[2.1.0 (2018-11-20)](https://github.com/nteract/bookstore/releases/tag/2.1.0)
+
+[2.0.0 (2018-11-13)](https://github.com/nteract/bookstore/releases/tag/2.0.0)
+
+[0.1 (2018=10-16)](https://github.com/nteract/bookstore/releases/tag/0.1)

CONTRIBUTING.md

@@ -30,12 +30,9 @@ in the nteract world? Here's a quick rundown!
 
 5. Make the appropriate changes for the issue you are trying to address or the
    feature that you want to add.
-6. Confirm that unit tests and linting still pass successfully with:
-   
-       yarn test
-   
-   If tests fail, don't hesitate to ask for help.
-
+6. You can run python unit tests using `pytest`. Running integration tests
+   locally requires a more complicated setup. This setup is described in
+   [running_ci_locally.md](./running_ci_locally.md)
 7. Add and commit the changed files using `git add` and `git commit`.
 8. Push the changes to the remote repository using:
 

MANIFEST.in

@@ -15,6 +15,7 @@ include *.md
 include *.toml
 
 include bookstore/_version.py
+include bookstore/clone.html
 include .coveragerc
 
 # Documentation
@@ -24,4 +25,4 @@ prune docs/_build
 # exclude sample notebooks for binder
 prune binder/
 # Scripts
-graft scripts
+graft scripts

README.md

@@ -90,3 +90,11 @@ c.BookstoreSettings.s3_bucket = "<bucket-name>"
 c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID>
 c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>
 ```
+
+## Developing
+
+If you are developing on bookstore you will want to run the ci tests locally and to make releases.
+
+Use [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about contributing.
+Use [running_ci_locally.md](./running_ci_locally.md) to learn more about running ci tests locally. 
+Use [RELEASING.md](./RELEASING.md) to learn more about releasing bookstore. 

bookstore/__init__.py

@@ -1,3 +1,9 @@
+import os
+
+PACKAGE_DIR: str = os.path.realpath(os.path.dirname(__file__))
+
+del os
+
 from .archive import BookstoreContentsArchiver
 from .bookstore_config import BookstoreSettings
 from .handlers import load_jupyter_server_extension

bookstore/client/__init__.py

@@ -0,0 +1 @@
+from .bookstore import BookstoreClient

bookstore/client/bookstore.py

@@ -1,36 +1,38 @@
-# # Building a Notebook client
-#
-# We want to test our bookstore endpoints, but it's no fun having to do this in an insecure fashion. Better would be to have some security in place.
-#
-#
-# ## Example notebook config
-#
-#
-# ```
-# [{'base_url': '/',
-#   'hostname': 'localhost',
-#   'notebook_dir': '/Users/mpacer/jupyter/eg_notebooks',
-#   'password': False,
-#   'pid': 96033,
-#   'port': 8888,
-#   'secure': False,
-#   'token': '',
-#   'url': 'http://localhost:8888/'}]
-# ```
-
+"""Client to test bookstore endpoints from within a notebook.
+
+
+TODO: (Clarify) We want to test our bookstore endpoints, but it's no fun having
+to do this in an insecure fashion. Better would be to have some security in
+place.
+
+Example
+-------
+
+[{'base_url': '/',
+  'hostname': 'localhost',
+  'notebook_dir': '/Users/mpacer/jupyter/eg_notebooks',
+  'password': False,
+  'pid': 96033,
+  'port': 8888,
+  'secure': False,
+  'token': '',
+  'url': 'http://localhost:8888/'}]
+"""
 import os
-
-import requests
-
+import re
+import json
 from copy import deepcopy
 from typing import NamedTuple
 
-
+import requests
+from IPython import get_ipython
 from notebook.notebookapp import list_running_servers
 
 
 def extract_kernel_id(connection_file):
-    return os.path.basename(connection_file).lstrip('kernel-').rstrip('.json')
+    connection_filename = os.path.basename(connection_file)
+    kernel_id = re.sub(r"kernel-(.*)\.json", r"\1", connection_filename)
+    return kernel_id
 
 
 class LiveNotebookRecord(NamedTuple):
@@ -58,30 +60,52 @@ class KernelInfo:
     #     execution_state: str #'idle',
     #     connections: int # 0
     def __init__(self, *args, id, name, last_activity, execution_state, connections):
+        self.model = {
+            "id": id,
+            "name": name,
+            "last_activity": last_activity,
+            "execution_state": execution_state,
+            "connections": connections,
+        }
         self.id = id
         self.name = name
         self.last_activity = last_activity
         self.execution_state = execution_state
         self.connections = connections
 
+    def __repr__(self):
+        return json.dumps(self.model, indent=2)
+
 
 class NotebookSession:  # (NamedTuple):
     #     id: str #'68d9c58f-c57d-4133-8b41-5ec2731b268d',
     #     path: str #'Untitled38.ipynb',
     #     name: str #'',
     #     type: str #'notebook',
     #     kernel: KernelInfo
-    #     notebook: dict # {'path': 'Untitled38.ipynb', 'name': ''}}}
+    #     notebook: dict # deprecated API {'path': 'Untitled38.ipynb', 'name': ''}}}
 
     def __init__(self, *args, path, name, type, kernel, notebook, **kwargs):
+        self.model = {
+            "path": path,
+            "name": name,
+            "type": type,
+            "kernel": kernel,
+            "notebook": notebook,
+        }
         self.path = path
         self.name = name
         self.type = type
         self.kernel = KernelInfo(**kernel)
         self.notebook = notebook
 
+    def __repr__(self):
+        return json.dumps(self.model, indent=2)
+
 
 class NotebookClient:
+    """Client used to interact with bookstore from within a running notebook UI"""
+
     def __init__(self, nb_config):
         self.nb_config = nb_config
         self.nb_record = LiveNotebookRecord(**self.nb_config)
@@ -110,7 +134,9 @@ def setup_request_sessions(self):
     def sessions(self):
         """Current notebook sessions. Reissues request on each call.
         """
-        return {session['kernel']['id']: session for session in self.get_sessions()}
+        return {
+            session['kernel']['id']: NotebookSession(**session) for session in self.get_sessions()
+        }
 
     @property
     def headers(self):
@@ -139,10 +165,14 @@ def kernels_endpoint(self):
         return f"{self.url}{api_endpoint}"
 
     def get_kernels(self):
-        target_url = f"{self.sessions_endpoint}"
+        target_url = f"{self.kernels_endpoint}"
         resp = self.req_session.get(target_url)
         return resp.json()
 
+    @property
+    def kernels(self):
+        return self.get_kernels()
+
     @property
     def contents_endpoint(self):
         api_endpoint = "/api/contents/"
@@ -154,40 +184,38 @@ def get_contents(self, path):
         return resp.json()
 
 
-def python_compat_session(session):
-    deepcopy(session)
-
-
 class NotebookClientCollection:
+    """Representation of a collection of notebook clients"""
+
+    # TODO: refactor from lambda to a def
     nb_client_gen = lambda: (NotebookClient(x) for x in list_running_servers())
     sessions = {x.url: x.sessions for x in nb_client_gen()}
 
     @classmethod
     def current_server(cls):
+        """class method for current notebook server"""
+
+        current_kernel_id = extract_kernel_id(get_ipython().parent.parent.connection_file)
         for server_url, session_dict in cls.sessions.items():
             for session_id, session in session_dict.items():
-                python_compat_session(session)
-                if NotebookSession(**session).kernel.id == extract_kernel_id(
-                    get_ipython().parent.parent.connection_file
-                ):
-                    #                 if session['kernel']['id'] == extract_kernel_id(get_ipython().parent.parent.connection_file):
-
+                if session.kernel.id == current_kernel_id:
                     return next(
                         client for client in cls.nb_client_gen() if client.url == server_url
                     )
 
 
 class CurrentNotebookClient(NotebookClient):
+    """Represents the currently active notebook client"""
+
     def __init__(self):
         self.nb_client = NotebookClientCollection.current_server()
         super().__init__(self.nb_client.nb_config)
         self.session = self.sessions[self.kernel_id]
-        self.notebook = NotebookSession(**self.session).notebook
 
     @property
     def connection_file(self):
         return get_ipython().parent.parent.connection_file
 
     @property
     def kernel_id(self):
-        return os.path.basename(self.connection_file).lstrip('kernel-').rstrip('.json')
+        return extract_kernel_id(self.connection_file)

bookstore/client/notebook.py bookstore/client/nb_client.py

@@ -0,0 +1,43 @@
+"""Client to interact with the notebook store"""
+import requests
+
+from .nb_client import CurrentNotebookClient
+
+
+class BookstoreClient(CurrentNotebookClient):
+    """Represents a bookstore client that corresponds to the active nb client"""
+
+    def __init__(self, s3_bucket=""):
+        if s3_bucket:
+            self.default_bucket = s3_bucket
+        super().__init__()
+
+    @property
+    def publish_endpoint(self):
+        api_endpoint = "/api/bookstore/published/"
+        return f"{self.url}{api_endpoint}"
+
+    def publish(self, path=None):
+        """Publish notebook to bookstore"""
+        if path is None:
+            path = self.session.path
+        nb_json = self.get_contents(self.session.path)['content']
+        json_body = {"type": "notebook", "content": nb_json}
+
+        target_url = f"{self.publish_endpoint}{self.session.path}"
+
+        resp = self.req_session.put(target_url, json=json_body)
+        return resp
+
+    @property
+    def clone_endpoint(self):
+        api_endpoint = "/api/bookstore/cloned/"
+        return f"{self.url}{api_endpoint}"
+
+    def clone(self, s3_bucket="", s3_key="", target_path=""):
+        s3_bucket = s3_bucket or self.default_bucket
+        json_body = {"s3_bucket": s3_bucket, "s3_key": s3_key, "target_path": target_path}
+        target_url = f"{self.clone_endpoint}"
+        # TODO: Add a check for success
+        resp = self.req_session.post(target_url, json=json_body)
+        return resp