chore: add storage docs snippets (#205)

* chore: add storage client doc snippets

* chore: AUTH_TOKEN -> API_KEY and add missing examples to CI

* fix: fix example script name in CI

* chore: add client cheat sheet

* chore: fix snippet name

.github/workflows/on-pull-request.yaml

@@ -52,11 +52,14 @@ jobs:
 
       - name: Run examples
         env:
-          MOMENTO_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+          MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
         working-directory: ./examples
         run: |
           composer install
           php ./example.php
           php ./dictionary-example.php
           php ./list-example.php
           php ./set-example.php
+          php ./doc-examples-php-apis.php
+          php ./storage-example.php
+          php ./psr16-example.php

.github/workflows/on-push-to-main.yaml

@@ -30,14 +30,17 @@ jobs:
 
       - name: Run examples
         env:
-          MOMENTO_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+          MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
         working-directory: ./examples
         run: |
           composer install
           php ./example.php
           php ./dictionary-example.php
           php ./list-example.php
           php ./set-example.php
+          php ./doc-examples-php-apis.php
+          php ./storage-example.php
+          php ./psr16-example.php
 
       - name: Generate README
         uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2

.github/workflows/on-push-to-release.yaml

@@ -39,14 +39,17 @@ jobs:
 
       - name: Run examples
         env:
-          MOMENTO_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+          MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
         working-directory: ./examples
         run: |
           composer install
           php ./example.php
           php ./dictionary-example.php
           php ./list-example.php
           php ./set-example.php
+          php ./doc-examples-php-apis.php
+          php ./storage-example.php
+          php ./psr16-example.php
 
   release:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -21,6 +21,6 @@ You will likely need to run this only once:
 ## Run Integration Test
 
 ```bash
-export TEST_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
+export TEST_AUTH_TOKEN=<YOUR_API_KEY>
 ./dev-run-integration-tests.sh
 ```

README-logging.md

@@ -36,7 +36,7 @@ called:
 ```php
 $myLogger = new My\Favorite\Logger("channel_name");
 $loggerFactory = new Momento\Logging\PassthroughLoggerFactory($myLogger);
-$authProvider = new EnvMomentoTokenProvider("MOMENTO_AUTH_TOKEN");
+$authProvider = new EnvMomentoTokenProvider("MOMENTO_API_KEY");
 // All logging internal to the Momento client will use this factory to gain
 // access to a reference to $myLogger.
 $configuration = Laptop::latest()->withLoggerFactory($loggerFactory);

README-proxying.md

@@ -13,7 +13,7 @@ configured to connect to. If you're using a JWT to authenticate with Momento, yo
 control plane (cp) and cache plane (c) with the following shell command:
 
 ```shell
-echo $MOMENTO_AUTH_TOKEN | awk -F . {'print $2}' | base64 -d
+echo $MOMENTO_API_KEY | awk -F . {'print $2}' | base64 -d
 ```
 
 A sample configuration (using nonexistent server hostnames) is as follows:
@@ -47,7 +47,7 @@ provider. Using the `EnvMomentoTokenProvider`, which reads the token from an env
 
 ```php
 $authProvider = new EnvMomentoTokenProvider(
-  envVariableName: "MOMENTO_AUTH_TOKEN",
+  envVariableName: "MOMENTO_API_KEY",
   controlEndpoint: "localhost:4443",
   cacheEndpoint: "localhost:4444",
   trustedControlEndpointCertificateName: "control.some-control-cell-name.momentohq.com",

README.ja.md

@@ -66,7 +66,7 @@ $KEY = "MyKey";
 $VALUE = "MyValue";
 
 // Setup
-$authProvider = CredentialProvider::fromEnvironmentVariable("MOMENTO_AUTH_TOKEN");
+$authProvider = CredentialProvider::fromEnvironmentVariable("MOMENTO_API_KEY");
 $configuration = Laptop::latest(new StderrLoggerFactory());
 $client = new CacheClient($configuration, $authProvider, $ITEM_DEFAULT_TTL_SECONDS);
 $logger = $configuration->getLoggerFactory()->getLogger("ex:");

README.md

@@ -35,7 +35,7 @@ use Momento\Cache\CacheClient;
 use Momento\Config\Configurations\Laptop;
 
 $client = new CacheClient(
-    Laptop::latest(), CredentialProvider::fromEnvironmentVariable("MOMENTO_AUTH_TOKEN"), 60
+    Laptop::latest(), CredentialProvider::fromEnvironmentVariable("MOMENTO_API_KEY"), 60
 );
 $client->createCache("cache");
 $client->set("cache", "myKey", "myValue");

examples/README.md

@@ -29,7 +29,7 @@ The Docker way:
 Set required environment variables:
 
 ```bash
-export MOMENTO_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
+export MOMENTO_API_KEY=<YOUR_API_KEY>
 ```
 
 To run the simple set/get example:

examples/composer.json

@@ -1,6 +1,6 @@
 {
   "require": {
-    "momentohq/client-sdk-php": "1.9.1",
+    "momentohq/client-sdk-php": "1.11.1",
     "monolog/monolog": "^2.5"
   }
 }

examples/dictionary-example.php

@@ -19,7 +19,7 @@
 $ITEM_DEFAULT_TTL_SECONDS = 60;
 
 // Setup
-$authProvider = CredentialProvider::fromEnvironmentVariable("MOMENTO_AUTH_TOKEN");
+$authProvider = CredentialProvider::fromEnvironmentVariable("MOMENTO_API_KEY");
 
 $configuration = Laptop::latest(new StderrLoggerFactory());
 $client = new CacheClient($configuration, $authProvider, $ITEM_DEFAULT_TTL_SECONDS);

examples/doc-example-files/storage-cheat-sheet.php

@@ -0,0 +1,10 @@
+<?php
+require "vendor/autoload.php";
+use Momento\Auth\CredentialProvider;
+use Momento\Config\Configurations\Storage\Laptop;
+use Momento\Storage\PreviewStorageClient;
+
+$storageClient = new PreviewStorageClient(
+    Laptop::latest(),
+    CredentialProvider::fromEnvironmentVariable("MOMENTO_API_KEY")
+);