WIP: metaevent in demo 3

Author: seba1rx

.vscode/launch.json

@@ -0,0 +1,48 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for Xdebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9003
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 0,
+            "runtimeArgs": [
+                "-dxdebug.start_with_request=yes"
+            ],
+            "env": {
+                "XDEBUG_MODE": "debug,develop",
+                "XDEBUG_CONFIG": "client_port=${port}"
+            }
+        },
+        {
+            "name": "Launch Built-in web server",
+            "type": "php",
+            "request": "launch",
+            "runtimeArgs": [
+                "-dxdebug.mode=debug",
+                "-dxdebug.start_with_request=yes",
+                "-S",
+                "http://www.thruway_examples.local/metaevents.php:0"
+            ],
+            "program": "",
+            "cwd": "${workspaceRoot}",
+            "port": 9003,
+            "serverReadyAction": {
+                "pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
+                "uriFormat": "http://www.thruway_examples.local/metaevents.php:%s",
+                "action": "openExternally"
+            }
+        }
+    ]
+}

Demo/InternalClient.php DEMO1/InternalClient.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Demo;
+namespace DEMO1;
 
 use MockModel\MyMockModel;
 // use MyApp\Models\MyModel;

Demo/InternalClient2.php DEMO1/InternalClient2.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Demo;
+namespace DEMO1;
 
 /**
  * this is the internal client 2, this class should be used

Demo/SimpleAuthProviderClient.php DEMO1/SimpleAuthProviderClient.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Demo;
+namespace DEMO1;
 
 /**
  * Class SimpleAuthProviderClient

Demo/SimpleClientAuth.php DEMO1/SimpleClientAuth.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Demo;
+namespace DEMO1;
 
 use Thruway\Message\ChallengeMessage;
 

bin/launchInternalClient.php DEMO1/bin/launchInternalClient.php

@@ -1,9 +1,9 @@
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
-use Demo\InternalClient;
-use Demo\SimpleClientAuth;
+use DEMO1\InternalClient;
+use DEMO1\SimpleClientAuth;
 
 $client = new InternalClient('somerealm');
 

bin/launchInternalClient2.php DEMO1/bin/launchInternalClient2.php

@@ -1,9 +1,9 @@
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
-use Demo\InternalClient2;
-use Demo\SimpleClientAuth;
+use DEMO1\InternalClient2;
+use DEMO1\SimpleClientAuth;
 
 $client2 = new InternalClient2('somerealm');
 

bin/launchInternalClientAsClientObject.php DEMO1/bin/launchInternalClientAsClientObject.php

@@ -1,11 +1,11 @@
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
 use Thruway\ClientSession;
 use Thruway\Peer\Client as ThruwayPeerClient;
 use Thruway\Transport\PawlTransportProvider;
-use Demo\SimpleClientAuth;
+use DEMO1\SimpleClientAuth;
 
 /**
  * this acts like an internal client 2 using a procedural style

bin/launchInternalClientAsConnectionObject.php DEMO1/bin/launchInternalClientAsConnectionObject.php

@@ -1,6 +1,6 @@
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
 use Thruway\ClientSession;
 use Thruway\Connection;
@@ -50,9 +50,7 @@
 
 /**
  * please note that if you want to keep the client connected
- * you have to delete $connection->close()
- *
- * this is not the case, since we want to execute this code to make the RPC call and obtain the response.
+ * you have to delete $connection->close(). This is not the case, since we want to execute this code to make the RPC call and obtain the response.
  * An example scenario would be to make an XHR request from the browser using something like jquery ajax, then
  * a file containing this code will act as a client connecting to the router and make the RPC call, obtaining
  * whaterver data you need, then disconnect and return the obtained data. If you delete $connection->close()

bin/SimpleWsRouter.php DEMO1/bin/router.php

@@ -1,13 +1,19 @@
 <?php
 
-require_once __DIR__ . "/../vendor/autoload.php";
+require_once __DIR__ . "/../../vendor/autoload.php";
 
 use Thruway\Peer\Router;
 use Thruway\Transport\RatchetTransportProvider;
-use Demo\SimpleAuthProviderClient;
+use DEMO1\SimpleAuthProviderClient;
+
+
+/**
+ * this script is based on:
+ * https://github.com/voryx/Thruway/blob/master/Examples/Authentication/StartRouter.php
+ *
+ */
 
 $router = new Router();
-$loop = $router->getLoop(); //so far not used
 
 $router->registerModule(new \Thruway\Authentication\AuthenticationManager());
 

DEMO1/readme.md

@@ -0,0 +1,55 @@
+# DEMO 1:
+
+##### Purpose: have a router, have a realm with authentication, internal client registering RPC methods, call the RPC methos usin internal client 2 and browser client.
+
+**This demo consists of:**
+
+* Router: based on Examples/SimpleWsRouter.php
+* Realm Authentication: based on Examples/Authentication/SimpleAuthProviderClient.php
+* Internal Client 1: based on Examples/ClientClass/FreeSpaceClient.php
+* Autobahn client: based on the autobahn-js [repo](https://github.com/crossbario/autobahn-js) and Examples/Authentication/simpleAutobahnAuth.html
+* Internal Client 2 (connection object): based on Examples/SimpleClient.php
+
+
+### How to use demo 1
+
+Open 3 terminals and a browser tab with console in js option (F12 in Chrome, select js tab)
+
+navigate to root dir, at the same level of composer.json,
+so if you do ls/dir command, you should see composer.json
+
+**in terminal 1:**
+
+> php DEMO1/bin/router.php
+
+This will launch the router, add auth manager and auth client, and add transport provider.
+
+
+**in terminal 2:**
+
+> php DEMO1/bin/launchInternalClient.php
+
+This will start the internal client using an instance of the InternalClient.php, using a client authenticator to enter the realm.
+
+
+**in terminal 3**, choose one of the following, but try them all at least once:
+
+All of these act like a second internal client. the idea is that internal client 2 can be used by the main app to interface with the WAMP server.
+
+
+**option 1**, using use Thruway\Connection object:
+
+> php DEMO1/bin/launchInternalClientAsConnectionObject.php
+
+
+**option 2**, using Thruway\Peer\Client object:
+
+> php DEMO1/bin/launchInternalClientAsClientObject.php
+
+
+**option 3** using Thruway\Peer\Client subclass:
+
+> php bin/launchInternalCLient2.php
+
+**in browser:** in file index.php in a script tag there is a function defined, in the console in JS tab, call the function
+> runConnectionObjectUsingAjax();

Demo/AuthProviderClient.php DEMO2/AuthProviderClient.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Demo;
+namespace DEMO2;
 
 use Thruway\Logging\Logger;
 

DEMO2/InternalClient.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace DEMO2;
+
+use MockModel\MyMockModel;
+// use MyApp\Models\MyModel;
+// use MyApp\Mailer\MyMailer;
+
+/**
+ * this is the internal client 1
+ *
+ * here you should create methods that interface with your main app or query the loop object
+ */
+class InternalClient extends \Thruway\Peer\Client
+{
+
+    /**
+     * @return array
+     */
+    public function getFreeSpace()
+    {
+        return ["Free space: " . (string)disk_free_space('/')]; // wsl or linux
+        // return [disk_free_space('c:')]; // use c: for you windowers
+    }
+
+    /**
+     * Example methods interfacing with your main app
+     */
+    // public function sendMail($args): array
+    // {
+    //     $someData = MyModel::getSomeData($args);
+    //     return MyMailer::sendMailUsingThisData($someData);
+    // }
+    // public function getSomeDataFromApp(): array
+    // {
+    //         $someData = MyModel::getUsefulData();
+    //         return $someData;
+    // }
+
+    /**
+     * example returning mock data
+     */
+    public function getMockData(): array
+    {
+        return MyMockModel::getMyMockData();
+    }
+
+    /**
+     * @param \Thruway\ClientSession $session
+     * @param \Thruway\Transport\TransportInterface $transport
+     */
+    public function onSessionStart($session, $transport)
+    {
+        $session->register('com.example.getfreespace', [$this, 'getFreeSpace']);
+        $session->register('com.example.getMockData', [$this, 'getMockData']);
+        // $session->register('com.example.sendMail', [$this, 'sendMail']); //RPC example
+        // $session->register('com.example.getSomeDataFromApp', [$this, 'getSomeDataFromApp']); //RPC example
+    }
+
+}
+