dropbox-sign 1.0.0.pre.beta2301

data/bin/generate-examples.php

@@ -0,0 +1,269 @@
+#!/usr/bin/env php
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Symfony\Component\Yaml\Yaml;
+
+ini_set('display_errors', 1);
+ini_set('display_startup_errors', 1);
+error_reporting(E_ALL);
+
+set_error_handler(function ($level, $msg) {
+    echo "Error: {$msg}";
+    exit(1);
+});
+
+/**
+ * Read code samples and unescaped descriptions from OAS file and injects the
+ * data into Markdown documentation.
+ *
+ * When openapi-generator generates the SDK code, all markdown documentation
+ * files will contain escaped descriptions for method parameters. This is due
+ * to parameter documentation existing within markdown tables, surrounded by
+ * pipes `|`. Markdown table rows must contain all data in a single line, but
+ * unescaped descriptions will often contain linebreaks, list items, etc, that
+ * cannot correctly be displayed in markdown tables.
+ *
+ * This tool replaces linebreaks with `<br>`, fixes list items, fixes broken
+ * anchor links for specific parameter definitions.
+ */
+class GenerateExamples
+{
+    /**
+     * @var Array<string, string>
+     */
+    protected array $codeSamples = [];
+
+    /**
+     * openapi-generator considers array of array of object to be a primitive
+     * type so it does not create a link to the doc file.
+     *
+     * Array<string, string>
+     */
+    protected array $extraReplace = [];
+
+    /**
+     * Languages of the code samples we are looking for. Usually will be a single
+     * language, ["PHP"], but the javascript SDK can generate both typescript and
+     * javascript.
+     *
+     * @var string[]
+     */
+    protected array $languages = [];
+
+    /**
+     * Our OAS in array form
+     *
+     * @var array
+     */
+    protected array $openapi;
+
+    /**
+     * Search and replace all files in these directories
+     *
+     * @var string[]
+     */
+    protected array $replaceInDirectories = [];
+
+    /**
+     * Target specific files for search and replace
+     *
+     * @var string[]
+     */
+    protected array $replaceInFiles = [];
+
+    protected bool $useSnakeCase = false;
+
+    public function __construct(
+        array $openapi,
+        array $languages,
+        array $replaceInDirectories,
+        array $replaceInFiles,
+        array $extraReplace = []
+    ) {
+        $this->openapi = $openapi;
+        $this->languages = $languages;
+        $this->replaceInDirectories = $replaceInDirectories;
+        $this->replaceInFiles = $replaceInFiles;
+        $this->extraReplace = $extraReplace;
+    }
+
+    public function setUseSnakeCase(bool $flag): void
+    {
+        $this->useSnakeCase = $flag;
+    }
+
+    public function run(): void
+    {
+        $this->getCodeSamples();
+
+        foreach ($this->replaceInDirectories as $directory) {
+            $this->replaceInDirectory($directory);
+        }
+
+        foreach ($this->replaceInFiles as $file) {
+            $this->replaceInFile($file);
+        }
+    }
+
+    /**
+     * Reads OAS file and grabs code samples related to chosen languages,
+     * defined in Redocly's custom `x-codeSamples` spec extension:
+     *
+     * x-codeSamples:
+         -
+           lang: PHP
+           label: PHP
+           source:
+             $ref: examples/AccountCreate.php
+     *
+     * @return void
+     * @see https://redoc.ly/docs/api-reference-docs/specification-extensions/x-code-samples/
+     */
+    protected function getCodeSamples(): void
+    {
+        foreach ($this->openapi['paths'] as $paths) {
+            foreach ($paths as $action) {
+                if (empty($action['x-codeSamples'])) {
+                    continue;
+                }
+
+                foreach ($action['x-codeSamples'] as $sample) {
+                    if (!in_array($sample['lang'], $this->languages, true)) {
+                        continue;
+                    }
+
+                    $id = $action['operationId'];
+
+                    if (empty($this->codeSamples[$id])) {
+                        $this->codeSamples[$id] = [];
+                    }
+
+                    $contents = file_get_contents(
+                        __DIR__ . "/../{$sample['source']['$ref']}"
+                    );
+
+                    $this->codeSamples[$id][$sample['lang']] = $contents;
+                }
+            }
+        }
+    }
+
+    /**
+     * Scans provided directories for markdown (.md) files to inject code
+     * samples and documentation into
+     *
+     * @param string $directory
+     * @return void
+     */
+    protected function replaceInDirectory(string $directory): void
+    {
+        /** @var DirectoryIterator $fileInfo */
+        foreach (new DirectoryIterator($directory) as $fileInfo) {
+            if (
+                $fileInfo->isDir()
+                || $fileInfo->isDot()
+                || $fileInfo->getExtension() !== 'md'
+            ) {
+                continue;
+            }
+
+            $this->replaceInFile($fileInfo->getPathname());
+        }
+    }
+
+    /**
+     * Injects code samples into provided files. Not limited to markdown (.md)
+     * files, can be anything. But usually markdown files.
+     *
+     * @param string $filepath
+     * @return void
+     */
+    protected function replaceInFile(string $filepath): void
+    {
+        $fileContents = file_get_contents($filepath);
+
+        $fileContents = $this->replaceCodeSample($fileContents);
+        $fileContents = $this->replaceDocumentation($fileContents);
+
+        file_put_contents($filepath, $fileContents);
+    }
+
+    protected function replaceCodeSample(string $fileContents): string
+    {
+        foreach ($this->codeSamples as $operationId => $codeSamples) {
+            foreach ($codeSamples as $language => $codeSample) {
+                $toReplace = $this->getReplaceCodeString($operationId, $language);
+
+                $fileContents = str_replace(
+                    $toReplace,
+                    $codeSample,
+                    $fileContents,
+                );
+            }
+        }
+
+        return $fileContents;
+    }
+
+    public function replaceDocumentation(string $fileContents): string
+    {
+        $search = "/(REPLACE_ME_WITH_DESCRIPTION_BEGIN)([\s\S][^|]*)(REPLACE_ME_WITH_DESCRIPTION_END)/";
+        $fileContents = preg_replace_callback(
+            $search,
+            function ($matches) {
+                $edited = str_replace("\n\n", '<br><br>', $matches[2]);
+                // Handles bullet lists
+                $edited = str_replace("\n*", '<br>*', $edited);
+                $edited = str_replace("\n", ' ', $edited);
+
+                return $edited;
+            },
+            $fileContents,
+        );
+
+        $fileContents = str_replace('&#x60;', '`', $fileContents);
+
+        foreach ($this->extraReplace as $k => $v) {
+            $fileContents = str_replace($k, $v, $fileContents, );
+        }
+
+        return $fileContents;
+    }
+
+    /**
+     * Our templates initially generate markdown documentation files with
+     * REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_{language}_CODE
+     * in place of the actual auto-generated examples that openapi-generator
+     * would usually generate.
+     *
+     * We simply search for this string and replace with associated code sample.
+     *
+     * Ex: REPLACE_ME_WITH_EXAMPLE_FOR__accountCreate_PHP_CODE
+     *
+     * @param string $operationId
+     * @param string $language
+     * @return string
+     */
+    protected function getReplaceCodeString(
+        string $operationId,
+        string $language
+    ): string {
+        $operationId = $this->useSnakeCase
+            ? strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $operationId))
+            : $operationId;
+
+        return "REPLACE_ME_WITH_EXAMPLE_FOR__{$operationId}_{$language}_CODE";
+    }
+}
+
+$generate = new GenerateExamples(
+    Yaml::parse(file_get_contents(__DIR__ . '/../openapi-sdk.yaml')),
+    ['Ruby'],
+    [__DIR__ . '/../docs'],
+    [__DIR__ . '/../README.md'],
+);
+$generate->setUseSnakeCase(true);
+
+$generate->run();

data/bin/php

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Warning: You should run this from rootless Docker (or Podman, or other)
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+ROOT_DIR="${DIR}/.."
+WORKING_DIR="/app/ruby"
+
+docker run --rm \
+  -v "${ROOT_DIR}:${WORKING_DIR}" \
+  -v "dropbox-sign-sdk-composer-cache:/.composer" \
+  -w "${WORKING_DIR}" \
+  -u root:root \
+  jtreminio/php-cli:7.4 "$@"

data/bin/replace

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+ROOT_DIR="${DIR}/.."
+
+printf "\nRemoving AllOf references ...\n"
+perl -pi -e 's/(.*)AllOf.md\)\n//g' "${ROOT_DIR}/README.md"
+perl -pi -e "s#require '(.*)/models/(.*)_all_of'\n##g" \
+  "${ROOT_DIR}/lib/dropbox-sign.rb"

data/bin/ruby

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+ROOT_DIR="${DIR}/.."
+WORKING_DIR="/app/ruby"
+
+docker run --rm \
+  -e GEM_HOME="/.gem-cache" \
+  -e BUNDLE_PATH="/.bundle-cache" \
+  -v "${ROOT_DIR}:${WORKING_DIR}" \
+  -v "dropbox-sign-sdk-gem-cache:/.gem-cache" \
+  -v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \
+  -w "${WORKING_DIR}" \
+  ruby:3.1 "$@"

data/bin/scan_for

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+ROOT_DIR="${DIR}/.."
+
+scan_for () {
+  SEARCH_STRING=$1
+  SCAN_TARGETS=( "docs" "lib/dropbox-sign/api" "lib/dropbox-sign/models" "README.md" )
+
+  printf "Scanning for '${SEARCH_STRING}': "
+
+  set +e
+  for i in "${SCAN_TARGETS[@]}"
+  do
+    grep -ilr "${SEARCH_STRING}" "${ROOT_DIR}/${i}"
+    if [ $? -eq 0 ]; then
+      printf "Error: ${SEARCH_STRING} found in ${i}\n"
+      exit 1
+    fi
+  done
+
+  printf "'${SEARCH_STRING}' not found\n"
+  set -e
+}
+
+scan_for "allof"
+scan_for "oneof"
+scan_for "REPLACE_ME_WITH_DESCRIPTION"
+scan_for "REPLACE_ME_WITH_EXAMPLE_FOR"
+printf "\n"

data/composer.json

@@ -0,0 +1,10 @@
+{
+    "config": {
+        "platform": {
+            "php": "7.3"
+        }
+    },
+    "require": {
+        "symfony/yaml": "^5.4"
+    }
+}

data/composer.lock

@@ -0,0 +1,246 @@
+{
+    "_readme": [
+        "This file locks the dependencies of your project to a known state",
+        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
+        "This file is @generated automatically"
+    ],
+    "content-hash": "f151997e05eedbc2c00d43200bfd3910",
+    "packages": [
+        {
+            "name": "symfony/deprecation-contracts",
+            "version": "v2.5.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/deprecation-contracts.git",
+                "reference": "6f981ee24cf69ee7ce9736146d1c57c2780598a8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/6f981ee24cf69ee7ce9736146d1c57c2780598a8",
+                "reference": "6f981ee24cf69ee7ce9736146d1c57c2780598a8",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=7.1"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-main": "2.5-dev"
+                },
+                "thanks": {
+                    "name": "symfony/contracts",
+                    "url": "https://github.com/symfony/contracts"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "function.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Nicolas Grekas",
+                    "email": "p@tchwork.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "A generic function and convention to trigger deprecation notices",
+            "homepage": "https://symfony.com",
+            "support": {
+                "source": "https://github.com/symfony/deprecation-contracts/tree/v2.5.0"
+            },
+            "funding": [
+                {
+                    "url": "https://symfony.com/sponsor",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/fabpot",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2021-07-12T14:48:14+00:00"
+        },
+        {
+            "name": "symfony/polyfill-ctype",
+            "version": "v1.24.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/polyfill-ctype.git",
+                "reference": "30885182c981ab175d4d034db0f6f469898070ab"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/30885182c981ab175d4d034db0f6f469898070ab",
+                "reference": "30885182c981ab175d4d034db0f6f469898070ab",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=7.1"
+            },
+            "provide": {
+                "ext-ctype": "*"
+            },
+            "suggest": {
+                "ext-ctype": "For best performance"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-main": "1.23-dev"
+                },
+                "thanks": {
+                    "name": "symfony/polyfill",
+                    "url": "https://github.com/symfony/polyfill"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Polyfill\\Ctype\\": ""
+                },
+                "files": [
+                    "bootstrap.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Gert de Pagter",
+                    "email": "BackEndTea@gmail.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony polyfill for ctype functions",
+            "homepage": "https://symfony.com",
+            "keywords": [
+                "compatibility",
+                "ctype",
+                "polyfill",
+                "portable"
+            ],
+            "support": {
+                "source": "https://github.com/symfony/polyfill-ctype/tree/v1.24.0"
+            },
+            "funding": [
+                {
+                    "url": "https://symfony.com/sponsor",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/fabpot",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2021-10-20T20:35:02+00:00"
+        },
+        {
+            "name": "symfony/yaml",
+            "version": "v5.4.3",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/yaml.git",
+                "reference": "e80f87d2c9495966768310fc531b487ce64237a2"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/yaml/zipball/e80f87d2c9495966768310fc531b487ce64237a2",
+                "reference": "e80f87d2c9495966768310fc531b487ce64237a2",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=7.2.5",
+                "symfony/deprecation-contracts": "^2.1|^3",
+                "symfony/polyfill-ctype": "^1.8"
+            },
+            "conflict": {
+                "symfony/console": "<5.3"
+            },
+            "require-dev": {
+                "symfony/console": "^5.3|^6.0"
+            },
+            "suggest": {
+                "symfony/console": "For validating YAML files using the lint command"
+            },
+            "bin": [
+                "Resources/bin/yaml-lint"
+            ],
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Yaml\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Loads and dumps YAML files",
+            "homepage": "https://symfony.com",
+            "support": {
+                "source": "https://github.com/symfony/yaml/tree/v5.4.3"
+            },
+            "funding": [
+                {
+                    "url": "https://symfony.com/sponsor",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/fabpot",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2022-01-26T16:32:32+00:00"
+        }
+    ],
+    "packages-dev": [],
+    "aliases": [],
+    "minimum-stability": "stable",
+    "stability-flags": [],
+    "prefer-stable": false,
+    "prefer-lowest": false,
+    "platform": [],
+    "platform-dev": [],
+    "platform-overrides": {
+        "php": "7.3"
+    },
+    "plugin-api-version": "2.0.0"
+}