Merge branch 'master' into gh-pages

Author: perki

.gitignore

@@ -1 +1,2 @@
+.DS_Store
 .idea

README.md

@@ -1,6 +1,6 @@
-# bridge-tableau
+# Tableau integration for Pryv - Proof of Concept
 
-Tableau Web data connector ([WDC](http://tableau.github.io/webdataconnector/docs/)) implementation for Pryv.IO.
+Tableau Web data connector ([WDC](http://tableau.github.io/webdataconnector/docs/)) implementation for Pryv.io.
 
 The connector uses WDC Version 2.2 and targets Tableau 10.0 and later.
 
@@ -14,30 +14,24 @@ _NOTE: Tableau refers either to [Tableau Desktop](https://www.tableau.com/produc
 
 2. A new window opens, paste the following URL and press _Enter_ :
 
-   > https://pryv.github.io/bridge-tableau/
+   > https://pryv.github.io/poc-integration-tableau/
    
    ![Login](./screenshots/connector.png)
 
 3. _(Optional)_ You can adapt the previous URL in order to pass custom settings:
 
-   * If you already have a valid Pryv.IO access (it skips steps 4 and 5) :
+   If you want to change the Pryv.IO platform (default is _pryv.me_) :
 
-     > https://pryv.github.io/bridge-tableau/?username=YOURUSER&auth=YOURTOKEN
-
-   * If you want to change the Pryv.IO domain (default is _pryv.me_) :
-
-     > https://pryv.github.io/bridge-tableau/?domain=YOURDOMAIN
-
-   * Or both :
-
-     > https://pryv.github.io/bridge-tableau/?username=YOURUSER&auth=YOURTOKEN&domain=YOURDOMAIN
+   `https://pryv.github.io/poc-integration-tableau/?pryvServiceInfoUrl=https://reg.{YOURDOMAIN}/service/info`
 
 4. Connect a Pryv.io account, you have two possibilities here :
 
   * Use the **Sign in** button to login to your Pryv.IO account and authorize Tableau to access it.
 
-  * Use Pryv.io sharing(s) by pasting the link(s) in the appropriate input field and click on **Use sharings**.
-  
+  * Use Pryv.io apiEndpoint(s) by pasting the link(s) in the appropriate input field and click on **Use apiEndpoints**.
+
+  * You may want to load credentials contained into events of type: `'credentials/pryv-api-endpoint'` from these accounts with "Look for extra crendentials into these accounts"
+
   ![Login](./screenshots/login.png)
 
 5. Some selectors (time range, measurements limit) appear, you can use them to filter the data to be retrieved from Pryv.IO, then click on **Get Data**.
@@ -168,55 +162,19 @@ The exact implementation of the retrieval methods will be covered in the Pryv.IO
 For Pryv.IO logic, we import our javascript library in the **index.html** :
 
 ```html
-<script type="text/javascript" src="https://api.pryv.com/lib-javascript/latest/pryv.js"></script>
+<script type="text/javascript" src="https://api.pryv.com/lib-js/latest/pryv.js"></script>
 ```
 
 It gives access to a pryv.io object that will be used for authentication/connection to Pryv.IO as well as for some utility functions.
 
-We also add a login button that will allow the user to authenticate with a Pryv.IO account, as well as a logout button :
+We also add a login button that will allow the user to authenticate with a Pryv.IO account, as well as a resetState button :
 
 ```html
 <!-- It does not look like a button yet, onclick event will be affected to it later. -->
 <span id="pryv-button"></span>
-<button id="pryv-logout">Logout</button>
+<button id="pryv-resetState">resetState</button>
 ```
 
-#### Initialization
-
-In a first step, we configure some settings for Pryv.IO authentication (see [Authorize your app in API reference](http://api.pryv.com/getting-started/javascript/#authorize-your-app)):
-
-* **Domain** corresponding to the Pryv.IO platform on which the user is registered.
-* **Id** of the application (connector).
-* Array of **Permissions** to be granted to the connector, where each **Permission** indicates:
-  * **streamId**: an ids array of Pryv streams that we want to access from Tableau.
-  * **level**: the access level we will grant (read/manage/contribute).
-* A set of **callbacks** that will be called during the authentication process (see [Pryv.IO authentication](#authentication)).
-
-Finally, the utility function `getSettingsFromURL` loads custom parameters that the user may provide in the connector URL to further configure the Pryv.IO authentication (see [Usage](#usage), step 3).
-
-#### Authentication
-
-As soon as the Tableau connector opens, it will start the Pryv.IO authentication flow by calling `pryvAuthSetup`. Two situations can be observed:
-
-* If the user provided an existing Pryv.IO access through the connector URL or use a sharing link (see [Usage](#usage), step 3), it will bypass Pryv login.
-* Otherwise, it will call `pryv.Auth.setup(authSettings)`, which will activate the Pryv.IO login button and start the authentication flow using the settings prepared previously.
-
-##### Phase 1: needSignin
-
-The first callback that will trigger is **needSignin**, which indicates that the user did not authorize the Tableau connector to access the Pryv account yet. In this phase, we simply reset the authentication state (`resetAuthState`, in case a previous session still exists) and tell Tableau to abort its current phase for custom authentication (`tableau.abortForAuth`).
-
-From there, the connector will just wait until the user logs in with a Pryv.IO account. On sucessful login, the user will be asked to accept the permissions requested by Tableau.
-
-##### Phase 2: signedIn
-
-Once the user accepts, an access will be granted and it will trigger **the signedIn** callback, which receives the newly opened Pryv.IO connection and shows the Pryv.IO logout button.
-
-Finally, connection to Pryv.IO is cached using  `getPYConnection` function, which serves in fact three roles:
-
-* If a Pryv.IO connection is already open, it stores the corresponding Pryv.IO credentials as Tableau credentials, so that the session persists during phases and navigation in Tableau.
-* If Tableau credentials exists but we lost the connection to Pryv:IO, it opens a new Pryv connection using the same credentials.
-* Finally, it returns the current Pryv.IO connection.
-
 #### Data gathering
 
 We implemented three functions that define how Tableau will collect data and fill each table we previously declared during [schema definition](#schema-definition).
@@ -244,6 +202,21 @@ var postFilter = function (event) {
 
 While Pryv.IO Filters will perform the filtering on the API side, the post-filtering are applied by the connector, after the Events have been retrieved from Pryv. 
 
+## Dev 
+
+To develop and debug the app you may want to use the following scheme 
+ Looks at options [Debugging tableau remotely with Chromium](https://tableau.github.io/webdataconnector/docs/wdc_debugging.html#start-tableau-with-remote-debugging-enabled-macos)
+
+1. use [rec.la](https://www.rec.la) - install in local with `npm install rec.la -g` and run `rec.la ./`
+
+2. From tableau or the simulator open the WebData Connector pane
+
+3. Use `https://l.rec.la:4443` as source link
+
+## Support and warranty
+
+Pryv provides this software for educational and demonstration purposes with no support or warranty.
+
 ## License
 
 [Revised BSD license](https://github.com/pryv/documents/blob/master/license-bsd-revised.md)