refactor to slim app

Author: jdpedrie

cloud_sql/mysql/pdo/README.md

@@ -2,22 +2,10 @@
 
 ## Before you begin
 
-1. Before you use this code sample, you need to have [Composer](https://getcomposer.org/) installed or downloaded into this folder. Download instructions can be found [here](https://getcomposer.org/download/).
+1. Before you use this code sample, you need to have [Composer](https://getcomposer.org/) installed or downloaded into this folder. Download instructions can be found [here](https://getcomposer.org/download/). Once you've installed composer, use it to install required dependencies by running `composer install`.
 2. Create a MySQL Cloud SQL Instance by following these [instructions](https://cloud.google.com/sql/docs/mysql/create-instance). Note the connection string, database user, and database password that you create.
 3. Create a database for your application by following these [instructions](https://cloud.google.com/sql/docs/mysql/create-manage-databases). Note the database name.
 4. Create a service account with the 'Cloud SQL Client' permissions by following these [instructions](https://cloud.google.com/sql/docs/mysql/connect-external-app#4_if_required_by_your_authentication_method_create_a_service_account). Download a JSON key to use to authenticate your connection.
-5. Use the information noted in the previous steps:
-
-```bash
-export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
-export CLOUD_SQL_CONNECTION_NAME='::'
-export DB_USER='my-db-user'
-export DB_PASS='my-db-pass'
-export DB_NAME='my-db-name'
-export DB_HOSTNAME='localhost'
-```
-
-Note: Saving credentials in environment variables is convenient, but not secure - consider a more secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
 
 ## Running Locally
 
@@ -45,6 +33,19 @@ $ ./cloud_sql_proxy \
     --credential_file=$GOOGLE_APPLICATION_CREDENTIALS
 ```
 
+Set the required environment variables for your connection to Cloud SQL. If you are using TCP mode as described above, do not set the `CLOUD_SQL_CONNECTION_NAME` variable.
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
+export CLOUD_SQL_CONNECTION_NAME='::'
+export DB_USER='my-db-user'
+export DB_PASS='my-db-pass'
+export DB_NAME='my-db-name'
+export DB_HOSTNAME='localhost'
+```
+
+Note: Saving credentials in environment variables is convenient, but not secure - consider a more secure solution such as [Secret Manager](https://cloud.google.com/secret-manager/) to help keep secrets safe.
+
 Execute the following:
 
 ```bash

cloud_sql/mysql/pdo/app.yaml

@@ -15,12 +15,13 @@
 runtime: php72
 
 # Remember - storing secrets in plaintext is potentially unsafe. Consider using
-# something like https://cloud.google.com/kms/ to help keep secrets secret.
+# something like https://cloud.google.com/secret-manager/ to help keep secrets
+# secret.
 env_variables:
   CLOUD_SQL_CONNECTION_NAME: ::
   DB_USER: my-db-user
   DB_PASS: my-db-pass
-  DB_NAME: my_db
+  DB_NAME: my-db
 
 # Defaults to "serve index.php" and "serve public/index.php". Can be used to
 # serve a custom PHP front controller (e.g. "serve backend/index.php") or to

cloud_sql/mysql/pdo/composer.json

@@ -0,0 +1,15 @@
+{
+    "name": "google/cloud-sql-mysql-example",
+    "autoload": {
+        "psr-4": {
+            "Google\\Cloud\\Samples\\CloudSQL\\MySQL\\": "src"
+        }
+    },
+    "require": {
+        "slim/slim": "^4.5",
+        "slim/twig-view": "^3.1",
+        "pimple/pimple": "^3.3",
+        "guzzlehttp/psr7": "^1.6",
+        "http-interop/http-factory-guzzle": "^1.0"
+    }
+}

cloud_sql/mysql/pdo/index.php

@@ -15,28 +15,36 @@
  * limitations under the License.
  */
 
-require_once 'src/DB.php';
-require_once 'src/Votes.php';
+declare(strict_types=1);
 
-use Google\Cloud\Samples\CloudSQL\MySQL\DB;
-use Google\Cloud\Samples\CloudSQL\MySQL\Votes;
+use GuzzleHttp\Psr7;
 
-$votes = new Votes(DB::createPdoConnection());
+include __DIR__ . '/vendor/autoload.php';
 
-if ($_SERVER['REQUEST_URI'] == '/' && $_SERVER['REQUEST_METHOD'] == 'GET') {
-    $list = $votes->list();
+$app = include __DIR__ . '/src/app.php';
 
-    $vote_count = $votes->count_candidates();
-    $tab_count = $vote_count['tabs'];
-    $space_count = $vote_count['spaces'];
+$app->get('/', function ($request, $response) {
+    return $this->get('view')->render($response, 'template.twig', [
+        'votes' => $this->get('votes')->listVotes(),
+        'tabCount' => $this->get('votes')->getCountByValue('TABS'),
+        'spaceCount' => $this->get('votes')->getCountByValue('SPACES'),
+    ]);
+});
 
-    include_once("./template.php");
-} elseif ($_SERVER['REQUEST_URI'] == '/' && $_SERVER['REQUEST_METHOD'] == 'POST') {
+$app->post('/', function ($request, $response) {
     $message = 'Invalid vote. Choose Between TABS and SPACES';
 
-    if (!empty($_POST['team']) && in_array($_POST['team'], ['SPACES', 'TABS'])) {
-        $message = $votes->save($_POST['team']);
+    $formData = $request->getParsedBody() + [
+        'voteValue' => ''
+    ];
+
+    if (in_array($formData['voteValue'], ['SPACES', 'TABS'])) {
+        $message = $this->get('votes')->insertVote($formData['voteValue'])
+            ? 'Vote cast for ' . $formData['voteValue']
+            : 'An error occurred';
     }
 
-    echo $message;
-}
+    return $response->withBody(Psr7\stream_for($message));
+});
+
+$app->run();

cloud_sql/mysql/pdo/src/DB.php

@@ -15,68 +15,89 @@
  * limitations under the License.
  */
 
+declare(strict_types=1);
+
 namespace Google\Cloud\Samples\CloudSQL\MySQL;
 
 use PDO;
 
+/**
+ * Manage votes using the Cloud SQL database.
+ */
 class Votes
 {
+    /**
+     * @var PDO
+     */
     private $connection;
 
+    /**
+     * @param PDO $connection A connection to the database.
+     */
     public function __construct(PDO $connection)
     {
         $this->connection = $connection;
-        $this->create_table();
+        $this->createTable();
     }
 
-    private function create_table()
+    /**
+     * Creates the table if it does not yet exist.
+     *
+     * @return void
+     */
+    private function createTable()
     {
         $sql = "CREATE TABLE IF NOT EXISTS votes (
             vote_id INT NOT NULL AUTO_INCREMENT,
             time_cast DATETIME NOT NULL,
-            candidate VARCHAR(6) NOT NULL,
+            vote_value VARCHAR(6) NOT NULL,
             PRIMARY KEY (vote_id)
         );";
 
         $this->connection->exec($sql);
     }
 
-    public function list()
+    /**
+     * Returns a list of the last five votes
+     *
+     * @return array
+     */
+    public function listVotes() : array
     {
-        $sql = "SELECT candidate, time_cast FROM votes ORDER BY time_cast DESC LIMIT 5";
+        $sql = "SELECT vote_value, time_cast FROM votes ORDER BY time_cast DESC LIMIT 5";
         $statement = $this->connection->prepare($sql);
         $statement->execute();
-        return $statement->fetchAll();
+        return $statement->fetchAll(PDO::FETCH_ASSOC);
     }
 
-    public function count_candidates()
+    /**
+     * Get the number of votes cast for a given value.
+     *
+     * @param string $value
+     * @param int
+     */
+    public function getCountByValue(string $value) : int
     {
-        $sql = "SELECT COUNT(vote_id) as voteCount FROM votes WHERE candidate = ?";
-        $count = [];
+        $sql = "SELECT COUNT(vote_id) as voteCount FROM votes WHERE vote_value = ?";
 
         $statement = $this->connection->prepare($sql);
+        $statement->execute([$value]);
 
-        //tabs
-        $statement->execute(['TABS']);
-        $count['tabs'] = $statement->fetch()[0];
-
-        //spaces
-        $statement->execute(['SPACES']);
-        $count['spaces'] = $statement->fetch()[0];
-
-        return $count;
+        return (int) $statement->fetch(PDO::FETCH_COLUMN);
     }
 
-    public function save($team)
+    /**
+     * Insert a new vote into the database
+     *
+     * @param string $value The value to vote for.
+     * @return boolean
+     */
+    public function insertVote(string $value) : bool
     {
-        $sql = "INSERT INTO votes (time_cast, candidate) VALUES (NOW(), :candidate)";
+        $sql = "INSERT INTO votes (time_cast, vote_value) VALUES (NOW(), :voteValue)";
         $statement = $this->connection->prepare($sql);
-        $statement->bindParam('candidate', $team);
-
-        if ($statement->execute()) {
-            return "Vote successfully cast for '$team'";
-        }
+        $statement->bindParam('voteValue', $value);
 
-        return print_r($statement->errorInfo(), true);
+        return $statement->execute();
     }
 }

cloud_sql/mysql/pdo/src/Votes.php

@@ -0,0 +1,86 @@
+
+/*
+ * Copyright 2020 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+use Google\Cloud\Samples\CloudSQL\MySQL\Votes;
+use Pimple\Container;
+use Pimple\Psr11\Container as Psr11Container;
+use Slim\Factory\AppFactory;
+use Slim\Views\Twig;
+use Slim\Views\TwigMiddleware;
+
+$container = new Container;
+AppFactory::setContainer(new Psr11Container($container));
+$app = AppFactory::create();
+
+$container['votes'] = function (Container $container) {
+    return new Votes($container['db']);
+};
+
+$container['db'] = function () {
+    $username = getenv("DB_USER");
+    $password = getenv("DB_PASS");
+    $schema = getenv("DB_NAME");
+    $hostname = getenv("DB_HOSTNAME") ?: "127.0.0.1";
+    $cloud_sql_connection_name = getenv("CLOUD_SQL_CONNECTION_NAME");
+
+    try {
+        // # [START cloud_sql_mysql_pdo_create]
+        // // $username = 'your_db_user';
+        // // $password = 'yoursupersecretpassword';
+        // // $schema = 'your_db_name';
+        // // $cloud_sql_connection_name = getenv("CLOUD_SQL_CONNECTION_NAME");
+
+        if ($cloud_sql_connection_name) {
+            // Connect using UNIX sockets
+            $dsn = sprintf(
+                'mysql:dbname=%s;unix_socket=/Users/jdp/cloudsql/%s',
+                $schema,
+                $cloud_sql_connection_name
+            );
+        } else {
+            // Connect using TCP
+            // $hostname = '127.0.0.1';
+            $dsn = sprintf('mysql:dbname=%s;host=%s', $schema, $hostname);
+        }
+
+        $conn = new PDO($dsn, $username, $password);
+        # [END cloud_sql_mysql_pdo_create]
+    } catch (PDOException $e) {
+        throw new RuntimeException(
+            "Could not connect to the Cloud SQL Database. " .
+            "Refer to https://cloud.google.com/sql/docs/mysql/connect-admin-proxy " .
+            "for more assistance. The PDO error was " . $e->getMessage(),
+            $e->getCode(),
+            $e
+        );
+    }
+
+    $conn->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+    return $conn;
+};
+
+$container['view'] = function() {
+    return Twig::create(__DIR__ . '/../views');
+};
+
+$app->add(TwigMiddleware::createFromContainer($app));
+
+$app->addErrorMiddleware(true, false, false);
+
+return $app;