Merge pull request #69 from machow/feat-rsc-title

feat(rsconnect): update pin title at content level

Author: machow

.github/workflows/ci.yml

@@ -11,7 +11,17 @@ on:
 jobs:
   tests:
     name: "Tests"
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: "macos-latest"
+            # ignore doctests, as they involve calls to github, and all mac machines
+            # use the same IP address
+            pytest_opts: "-k pins/tests"
+          - os: "ubuntu-latest"
+            pytest_opts:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -24,11 +34,12 @@ jobs:
           python -m pip install -e .
       - name: Run tests
         run: |
-          pytest pins -m 'not fs_rsc and not skip_on_github'
+          pytest pins -m 'not fs_rsc and not skip_on_github' $PYTEST_OPTS
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: "us-east-1"
+          PYTEST_OPTS: ${{ matrix.pytest_opts}}
 
   test-rsconnect:
     name: "Test RSConnect"
@@ -49,6 +60,7 @@ jobs:
           make dev
         env:
           RSC_LICENSE: ${{ secrets.RSC_LICENSE }}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
       # NOTE: edited to run checks for python package
       - name: Run tests

pins/boards.py

@@ -245,18 +245,29 @@ def pin_write(
             A date to store in the Meta.created field. This field may be used as
             part of the pin version name.
         """
+
+        pin_name = self.path_to_pin(name)
+
         # TODO(docs): describe options for type argument
         # TODO(docs): elaborate on default behavior for versioned parameter
         # TODO(compat): python pins added a created parameter above
         with tempfile.TemporaryDirectory() as tmp_dir:
             # create all pin data (e.g. data.txt, save object)
             meta = self.prepare_pin_version(
-                tmp_dir, x, name, type, title, description, metadata, versioned, created
+                tmp_dir,
+                x,
+                pin_name,
+                type,
+                title,
+                description,
+                metadata,
+                versioned,
+                created,
             )
 
             # move pin to destination ----
             # create pin version folder
-            dst_pin_path = self.construct_path([self.path_to_pin(name)])
+            dst_pin_path = self.construct_path([pin_name])
             dst_version_path = self.path_to_deploy_version(name, meta.version.version)
 
             try:
@@ -490,7 +501,7 @@ def keep_final_path_component(self, path):
 
     def sort_pin_versions(self, versions):
         # assume filesystem returned them with most recent last
-        return versions
+        return sorted(versions, key=lambda v: v.version)
 
     def prepare_pin_version(
         self,
@@ -523,10 +534,11 @@ def prepare_pin_version(
         p_obj = Path(pin_dir_path) / name
 
         # file is saved locally in order to hash, calc size
-        save_data(x, str(p_obj), type)
+        file_names = save_data(x, str(p_obj), type)
 
         meta = self.meta_factory.create(
-            str(p_obj),
+            pin_dir_path,
+            file_names,
             type,
             title=title,
             description=description,
@@ -556,8 +568,8 @@ class BoardManual(BaseBoard):
     Examples
     --------
     >>> import fsspec
+    >>> import os
     >>> fs = fsspec.filesystem("github", org = "machow", repo = "pins-python")
-
     >>> pin_paths = {"df_csv": "df_csv/20220214T163720Z-9bfad"}
     >>> board = BoardManual("pins/tests/pins-compat", fs, pin_paths=pin_paths)
 
@@ -650,6 +662,31 @@ def pin_list(self):
         names = [f"{cont['owner_username']}/{cont['name']}" for cont in results]
         return names
 
+    def pin_write(self, *args, **kwargs):
+
+        # run parent function ---
+
+        f_super = super().pin_write
+        meta = f_super(*args, **kwargs)
+
+        # update content title to reflect what's in metadata ----
+
+        # TODO(question): R pins updates this info before writing the pin..?
+        # bind the original signature to get pin name
+        sig = inspect.signature(f_super)
+        bind = sig.bind(*args, **kwargs)
+
+        pin_name = self.path_to_pin(bind.arguments["name"])
+        content = self.fs.info(pin_name)
+        self.fs.api.patch_content_item(
+            content["guid"],
+            title=meta.title,
+            description=meta.description or "",
+            # access_type = content.access_type
+        )
+
+        return meta
+
     def pin_search(self, search=None, as_df=True):
         from pins.rsconnect.api import RsConnectApiRequestError
 
@@ -742,10 +779,12 @@ def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwar
         # RSC pin names can have form <user_name>/<name>, but this will try to
         # create the object in a directory named <user_name>. So we grab just
         # the <name> part.
-        if "/" in name:
-            name = name.split("/")[-1]
+        short_name = name.split("/")[-1]
 
-        meta = super().prepare_pin_version(pin_dir_path, x, name, *args, **kwargs)
+        # TODO(compat): py pins always uses the short name, R pins uses w/e the
+        # user passed, but guessing people want the long name?
+        meta = super().prepare_pin_version(pin_dir_path, x, short_name, *args, **kwargs)
+        meta.name = name
 
         # copy in files needed by index.html ----------------------------------
         crnt_files = set([meta.file] if isinstance(meta.file, str) else meta.file)
@@ -765,7 +804,8 @@ def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwar
         pin_files = ", ".join(f"""<a href="{x}">{x}</a>""" for x in all_files)
 
         context = {
-            "pin_name": "TODO",
+            "date": meta.version.created.replace(microsecond=0),
+            "pin_name": self.path_to_pin(name),
             "pin_files": pin_files,
             "pin_metadata": meta,
         }

pins/constructors.py

@@ -150,7 +150,13 @@ def board_local(versioned=True, allow_pickle_read=None):
 
 
 def board_github(
-    org, repo, path="", versioned=True, cache=DEFAULT, allow_pickle_read=None
+    org,
+    repo,
+    path="",
+    token=None,
+    versioned=True,
+    cache=DEFAULT,
+    allow_pickle_read=None,
 ):
     """Returns a github pin board.
 
@@ -162,6 +168,8 @@ def board_github(
         Name of the repo.
     path:
         A subfolder in the github repo holding the board.
+    token:
+        An optional github token.
     **kwargs:
         Passed to the pins.board function.
 
@@ -173,6 +181,7 @@ def board_github(
     Examples
     --------
 
+    >>> import os
     >>> board = board_github("machow", "pins-python", "pins/tests/pins-compat")
     >>> board.pin_list()
     ['df_arrow', 'df_csv', 'df_rds', 'df_unversioned']
@@ -241,7 +250,7 @@ def board_urls(path: str, pin_paths: dict, cache=DEFAULT, allow_pickle_read=None
 
 
 def board_rsconnect(
-    versioned=True, server_url=None, api_key=None, cache=DEFAULT, allow_pickle_read=None
+    server_url=None, versioned=True, api_key=None, cache=DEFAULT, allow_pickle_read=None
 ):
     """Create a board to read and write pins from an RStudio Connect instance.
 

pins/drivers.py

@@ -6,6 +6,8 @@
 from .meta import Meta
 from .errors import PinsInsecureReadError
 
+from typing import Sequence
+
 # TODO: move IFileSystem out of boards, to fix circular import
 # from .boards import IFileSystem
 
@@ -69,7 +71,9 @@ def load_data(
     raise NotImplementedError(f"No driver for type {meta.type}")
 
 
-def save_data(obj, fname, type=None):
+def save_data(
+    obj, fname, type=None, apply_suffix: bool = True
+) -> "str | Sequence[str]":
     # TODO: extensible saving with deferred importing
     # TODO: how to encode arguments to saving / loading drivers?
     #       e.g. pandas index options
@@ -79,6 +83,9 @@ def save_data(obj, fname, type=None):
     if type == "csv":
         import pandas as pd
 
+        if apply_suffix:
+            fname = f"{fname}.{type}"
+
         if not isinstance(obj, pd.DataFrame):
             raise NotImplementedError(
                 "Currently only pandas.DataFrame can be saved to a CSV."
@@ -87,10 +94,15 @@ def save_data(obj, fname, type=None):
     elif type == "joblib":
         import joblib
 
+        if apply_suffix:
+            fname = f"{fname}.{type}"
+
         joblib.dump(obj, fname)
     else:
         raise NotImplementedError(f"Cannot save type: {type}")
 
+    return fname
+
 
 def default_title(obj, type):
     if type == "csv":

pins/meta.py

@@ -1,5 +1,6 @@
 from typing import ClassVar
 from dataclasses import dataclass, asdict, field
+from pathlib import Path
 
 import yaml
 
@@ -163,6 +164,7 @@ def get_version_for_meta(self, api_version) -> Version:
 
     def create(
         self,
+        base_folder: "str | Path",
         files: Sequence[StrOrFile],
         type,
         # TODO: when files is a string name should be okay as None
@@ -181,6 +183,8 @@ def create(
             version = Version.from_files([files], created)
             p_file = Path(files)
             file_size = p_file.stat().st_size
+            file_name = str(Path(files).relative_to(Path(base_folder)))
+
         elif isinstance(files, IOBase):
             # TODO: in theory can calculate size from a file object, but let's
             # wait until it's clear how calculating file size fits into pins
@@ -198,7 +202,7 @@ def create(
         return Meta(
             title=title,
             description=description,
-            file=name,  # TODO: FINISH
+            file=file_name,  # TODO: FINISH
             file_size=file_size,
             pin_hash=version.hash,
             created=version.render_created(),

pins/rsconnect/api.py

@@ -314,6 +314,11 @@ def post_content_item_deploy(self, guid: str, bundle_id: "str | None" = None):
         return self.query_v1(f"content/{guid}/deploy", "POST", json=json)
 
     def patch_content_item(self, guid, **kwargs) -> Content:
+        """Update a content item (e.g. its title or description).
+
+        See post_content_item method for possible arguments.
+        """
+
         # see https://docs.rstudio.com/connect/api/#patch-/v1/content/{guid}
         result = self.query_v1(f"content/{guid}", "PATCH", json=kwargs)
 

pins/tests/_snapshots/test_board_pin_write_rsc_index_html/data.txt

@@ -1,7 +1,7 @@
 api_version: 1
 created: 20200113T235859Z
 description: some description
-file: test_rsc_pin
+file: test_rsc_pin.csv
 file_size: 23
 pin_hash: 60d4c36d7138cb6c
 title: some pin

pins/tests/_snapshots/test_board_pin_write_rsc_index_html/index.html

@@ -30,21 +30,21 @@
   <body>
 
     <section>
-       <h3>TODO</h3>
+       <h3>derek/test_rsc_pin</h3>
 
        <p>
-         
+         <b>Last updated:</b> 2020-01-13 23:58:59 &bull;
          <b>Format:</b> csv &bull;
          <b>API:</b> v1
        </p>
        <p>some description</p>
-       <p>Download data: <a href="test_rsc_pin">test_rsc_pin</a></p>
+       <p>Download data: <a href="test_rsc_pin.csv">test_rsc_pin.csv</a></p>
        <details>
          <summary>Raw metadata</summary>
          <pre>api_version: 1
 created: 20200113T235859Z
 description: some description
-file: test_rsc_pin
+file: test_rsc_pin.csv
 file_size: 23
 pin_hash: 60d4c36d7138cb6c
 title: some pin
@@ -62,7 +62,7 @@ <h3>Code</h3>
 
       <pre id="pin-r" class="pin-code"><code class="r">library(pins)
 board <- 
-pin_read(board, "TODO")</code></pre>
+pin_read(board, "derek/test_rsc_pin")</code></pre>
 
     !-->
 

pins/tests/_snapshots/test_board_pin_write_rsc_index_html/test_rsc_pin renamed to pins/tests/_snapshots/test_board_pin_write_rsc_index_html/test_rsc_pin.csv

@@ -181,7 +181,8 @@ def create_tmp_board(self, src_board=None):
 
             shutil.copytree(src_board, p_root)
 
-            for pin_entry in p_root.glob("*/*"):
+            # note that glob order is technically arbitrary
+            for pin_entry in sorted(p_root.glob("*/*"), key=lambda x: str(x)):
                 # two key points:
                 #   1. username is required when putting content bundles up
                 #   2. the version must be removed.