atome 0.1.00009 → 0.4.5.4

data/documentation/framework/buld_the_gem.md

@@ -0,0 +1,52 @@
+
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+
+
+**How to build ans publish the gem**
+-
+
+Build
+-
+
+At the root of the gem folder type:
+
+         gem build 
+
+Install 
+-
+
+At the root of the gem folder type:
+
+         gem install atome 
+
+publish
+-
+
+At the root of the gem folder, assuming you've just build the 1.01 version of atome and you have a rubygems account (https://rubygems.org), type:
+
+         gem push atome-1.01.gem 
+
+**[- What's in the box](./box_content.md)**
+-
+
+Guideline and philosophy
+-
+
+to keep this concept working we must follow the following rules during atome development :
+
+- All Apis must run of all targeted platform (their should be no difference from one platform to another.)
+- Any property or new api must always work on any type of atome, to keep the consistency of the "atome uniq object"
+
+
+**[- atome explained](./atome_explained.md)**
+-
+
+**[- Architecture of the folders](./folder_architecture.md)**
+-
+
+**[- logic and datas flows](./datas_flows.md)**
+-

data/documentation/framework/datas_flows.md

@@ -0,0 +1,28 @@
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+<span align="left">
+
+[back](./what_is_it.md)
+
+</span>
+
+atome object hierarchy  :
+-
+ 
+- Universe
+- Users
+- Devices
+- Intuition
+- Views
+- Molecules
+- Atomes
+ 
+
+From top to bottom, the layer above  contain the layer below. Universe contains Users, User have Devices and so on...  
+Universe << Users << Devices << Intuition << Views << Molecules << Atomes
+
+Please note that Universe is Unique and Intuition is unique on each user/device pair.
+Intuition is a special layer that hold all the tools needed to treat items found in the view.

data/documentation/framework/enhance_atome.md

@@ -0,0 +1,79 @@
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+<span align="left">
+
+[back](./tutorials.md)
+
+</span>
+
+How to enhance the framework :
+-
+**guideline**
+
+
+the ruby scripting layer hold all the apis available to developers 
+
+those API must remain consistent all along the way and must be available on any atome even if it produce no result  
+
+the tool and API should never alter the original atome in order to stay non destructive  
+
+the renderer should always be abstracted from the ruby code 
+
+to do so we have a folder containing the different renderers available   you'll find the render controller in atome/lib/atome/renderers
+
+
+
+
+Build a new atome
+-
+- create a new type of atome 
+
+let's create a new glow effect:
+in the scripts/properties_generator.rb file in the method named "atome_methods" add your new atome in the corresponding category here the effect category
+we add "glow" to this list.
+
+the method named "types" is used when we create a new type of atome which is not the case here
+
+the method named "is_atome" is used when the new atome create an object this is also not the case as we create a property for now
+
+the method named  "need_pre_processing" is used idf we want some special treatment before rendering the object, this is not the case
+
+the method named "need_processing" is used idf we want some special treatment after rendering the object, this is not the case
+
+the method named  "getter_need_processing"is used if we want some special treatment when getting the value the the atome
+
+the method named "no_rendering" is used if the atome doesn't need to be rendered, this is not the case
+
+Other methods in the "properties_generator" file can be ignored for now
+
+Now next time we'll run the framework the necessary file will be created
+
+if you try to run your application with the following code:
+
+    
+    b=box
+    b.glow(6)
+
+you'll have error in the browser console saying : "glow_html: undefined method `glow_html' for..."
+
+
+atome framework is looking for the rendering  method named "glow_html" we explain the multi-render mechanism in an other document
+
+
+Finally we have to manually create the rendering method in our renderer by default the HTML render is used
+
+so we have to go to "atome/lib/atome/renderers/html/properties/" the  open "effect.rb" as we want to create an effect renderer 
+
+So in the "effect.rb" file we had the method name "glow_html" (the newly atome name suffixed with "_html" for html rendering)
+
+    def glow(val)
+      jq_get(atome_id).css('filter', "drop-shadow(  0px 0px #{val}px white )")
+    end
+      
+That's it you've created your first atome!!
+
+Build a new tool
+  -

data/documentation/framework/folder_architecture.md

@@ -0,0 +1,47 @@
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+<span align="left">
+
+[back](./what_is_it.md)
+
+</span>
+
+Architecture of the folders :
+-
+
+The folders dedicated to the atome framework are :
+
+1- The app folder : contain only temp files for now
+
+2- The atome folder : it contain the atome ruby's gem, this is basically the heart of the framework
+
+3- The documentations folder : it contains infos and documentations of the framework ( how to install it , enhance it or use it )
+
+4- Hook folder : (parts of Cordova no use for us right now)
+
+5- platforms : (parts of Cordova used for cross platform code generation, no use for us right now))
+
+6- plugins : (Hold Cordova's plugins no use for us right now)
+
+7- resources : (parts of Cordova , used to store application icons and splashscreen)
+
+8- scripts :  contains four files
+- Bootstrap automatise the install of atome framework
+- demo_generator : used to generate files for the basic demo used to test atome's APIs
+- minifier : to minify some generated js files when used in production mode
+- properties_generator : a script to help you to generate new atomes
+
+9 - tasks : todos and done feature
+
+10 - Work&research : R&D test files
+
+11 - Rakefile :  used to automatise framework startup
+
+12 - reactomic : a work in progress 
+
+All other files/folders are either used for Github or Cordova
+
+

data/documentation/framework/technical/rendering_flow.md

@@ -0,0 +1,18 @@
+ex: a.color(:red)
+
+property received is "color"
+value received is: "red" 
+
+if nil => the method become a getter 
+ex : a.color => {value :red}
+
+else : 
+ the methods chain the following treatment : 
+
+1- Check if property received is an Array to sanitize (add an automatically generated id to the value hash if not supply by the user )
+1- Add the property and its value to the history Array
+1- send the value in the pre-processor if needed
+1- store the property/value key pair in class variable
+1- send the value in the processor if needed
+1- send property/value key pair to the renderer
+1- format the return value differently it the atome is a property or a whole atome 

data/documentation/framework/technical/technical_description.md

@@ -0,0 +1,23 @@
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+
+
+Technical:
+-
+
+**[I - Flows and diagrams](./what_is_it.md)**
+
+**[II - Init sequence](./installation/kickstart.md)**
+
+**[III - Rendering](./technical/rendering_flow.md)**
+
+**[IV - Abstraction mode](./tutorials/tutorials.md)**
+
+**[V - Server, O.S. Application and web mode](../tutorials/tutorials.md)**
+
+**[VI - full server Installation](./installation/atome_server.md)**
+
+ 

data/documentation/framework/what_is_it.md

@@ -0,0 +1,65 @@
+
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+
+
+**what is (an) atome?**
+-
+
+The concept
+-
+
+atome object is the uniq object that can hold any type of data!
+
+Think pdf but collaborative, truly multimedia and editable!
+-
+
+An atome can be anything from a single property to a full blown document.
+
+Per example an atome can hold a simple property such as a color, or an image,a text, an effect, a video, a script, a group of objects or a complex document mixing many types, even tools that create and modify atomes are atomes!
+
+Say goodbye to apps : any atome can be modified by any tools created for them.
+-
+
+The idea behind atome is to have a uniq file type, so any tool applied on a given atome will lead to an action whatever the atome type is.
+The benefits are:
+
+- Simplify the automation of batch process, as objects always have a similar architecture whatever it's type (from a simple box thru a video montage to a complex page description) it's always an atome)
+- Simplify the development and tests of new tools. Ruby language allow you to script anything on the fly
+- Reduce development time due to Ruby language simplicity and the similar structure of atomes and APIs
+- Easy debug due to high level of readability of ruby
+- Reduce the number of tools needed for an application. (you dont ever have to wrote a specific tool for a specific medias anymore, as the same tool can be applied onto any atome).
+- and many many other advantages inherent to the atome architecture ...
+
+
+Say goodbye to file format: here any tools can alter any data.
+-
+
+- No filetype but instead a unique objet call  "atome" 
+- Any atome can then be modified by any available api or tool.
+- Only one type means no more file format, this is the guaranty that documents can always be open, shared and edited.
+
+
+**[- What's in the box](./box_content.md)**
+-
+
+Guideline and philosophy
+-
+
+to keep this concept working we must follow the following rules during atome development :
+
+- All Apis must run of all targeted platform (their should be no difference from one platform to another.)
+- Any property or new api must always work on any type of atome, to keep the consistency of the "atome uniq object"
+
+
+**[- atome explained](./atome_explained.md)**
+-
+
+**[- Architecture of the folders](./folder_architecture.md)**
+-
+
+**[- logic and datas flows](./datas_flows.md)**
+-

data/documentation/framework/what_it_can_do.md

@@ -0,0 +1,25 @@
+- image and text manipulation
+- Batch treatment
+- Home automation
+- coding 
+- education
+- Music
+- VJ
+- drawing
+- photo editing
+- Collaboration
+- Voice recognition
+- voice synthesis
+- Context and internalisation translation
+- Payment
+- Scheduling with calendar
+- remote computing and rendering
+- Audio and synthesis generator
+- Video effects
+- Video editing
+- animation
+- interactive document production
+- Visio conference
+- applications
+- web site
+

data/documentation/images/atome.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg id="atome" width="100%" height="100%" viewBox="0 0 237 237" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <g transform="matrix(0.0267056,0,0,0.0267056,18.6376,20.2376)">
+        <g id="shapePath1" transform="matrix(4.16667,0,0,4.16667,-377.307,105.632)">
+            <path d="M629.175,81.832C740.508,190.188 742.921,368.28 634.565,479.613C526.209,590.945 348.116,593.358 236.784,485.002C125.451,376.646 123.038,198.554 231.394,87.221C339.75,-24.111 517.843,-26.524 629.175,81.832Z" style="fill:rgb(201,12,125);"/>
+        </g>
+        <g id="shapePath2" transform="matrix(4.16667,0,0,4.16667,-377.307,105.632)">
+            <path d="M1679.33,410.731C1503.98,413.882 1402.52,565.418 1402.72,691.803C1402.91,818.107 1486.13,846.234 1498.35,1056.78C1501.76,1313.32 1173.12,1490.47 987.025,1492.89C257.861,1502.39 73.275,904.061 71.639,735.381C70.841,653.675 1.164,647.648 2.788,737.449C12.787,1291.4 456.109,1712.79 989.247,1706.24C1570.67,1699.09 1982.31,1234 1965.76,683.236C1961.3,534.95 1835.31,407.931 1679.33,410.731Z" style="fill:rgb(201,12,125);"/>
+        </g>
+    </g>
+</svg>

data/documentation/images/logos/roda.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 235.04 61.6"><defs><style>.cls-1{fill:#ef4348;}.cls-2{fill:#ef8689;}.cls-3{fill:#ef7579;}.cls-4{fill:#ef9e89;}</style></defs><title>Asset 2</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M42.94,22.23C42.94,9.76,35,1,19.09,1H0V60.67H10.52V43.36h6.54c1.86,0,3.64-.08,5.34-.25L35,60.67H47.35L32.07,40.48C39.54,37,42.94,30.46,42.94,22.23ZM18.33,34H10.52V10.69h7.81c9.93,0,13.24,5,13.24,11.54S28.17,34,18.33,34Z"/><path class="cls-1" d="M81.63,0C63.73,0,49.81,13.58,49.81,30.8c0,17.65,13.58,30.8,31.82,30.8s31.9-13.23,31.9-30.8C113.53,13,100.13,0,81.63,0Z"/><path class="cls-1" d="M145,1H122.53V60.67H145c18.24,0,31.9-12.81,31.9-29.87C176.92,13.49,163.51,1,145,1Zm.08,50h-12V10.69h12c12,0,20.53,8.57,20.53,20.28S156.64,51,145.1,51Z"/><path class="cls-1" d="M210,0c-15.53,0-24.69,8.32-24.69,26.64v34h10.61V46.42h28.51V60.67H235v-34C235,8.32,225.54,0,210,0Zm14.43,38c-2.8,0-23.25,0-28.51.09V26.64c0-12,5.94-17,14.25-17S224.44,14,224.44,26.73Z"/><g id="_3fPAnj" data-name="3fPAnj"><path class="cls-2" d="M82.55,50.93,72.89,29H92.2Z"/><path class="cls-3" d="M58.86,28.92c3.62,0,7,0,10.34,0,.58,0,.69.38.87.76L78.8,48.88a5.92,5.92,0,0,1,.53,1.57Z"/><path class="cls-3" d="M105.53,28.92,85.73,50.49l-.11-.06q1-2.31,2.09-4.62c2.44-5.37,4.89-10.74,7.3-16.13a1.11,1.11,0,0,1,1.2-.78C99.22,28.93,102.24,28.92,105.53,28.92Z"/><path class="cls-4" d="M91.28,26h-17l8.52-8.9Z"/><path class="cls-2" d="M71.34,25.45l-4-9.15H80.09Z"/><path class="cls-2" d="M93.89,25.15l-8.45-8.83H97.77C96.48,19.25,95.21,22.13,93.89,25.15Z"/><path class="cls-3" d="M105.58,26H96.64L100.19,18Z"/><path class="cls-3" d="M68.46,26.05H59.65L65,18.15Z"/></g></g></g></svg>

data/documentation/installation/atome_server.md

@@ -0,0 +1,184 @@
+<span align="right">
+
+[Main menu](../atome.md)
+-
+</span>
+<span align="left">
+
+[back](./kickstart.md)
+
+</span>
+
+
+Install atome infrastructure
+-
+
+add an entry to the DNS to accept websocket eg : ws.atome.one pkg install nginx mkdir /usr/local/etc/nginx/vdomain
+
+ create dir :
+
+    mkdir /usr/local/etc/nginx/vdomain
+
+    cd /usr/local/etc/nginx/vdomain
+
+create atome.conf
+
+    ee atome.conf
+
+ copy in atome.conf:
+
+    server {
+    listen 80;
+    server_name ws.atome.one;
+    
+        location / {
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header Host $host;
+    
+          proxy_pass http://ws.atome.one;
+    
+          proxy_http_version 1.1;
+          proxy_set_header Upgrade $http_upgrade;
+          proxy_set_header Connection "upgrade";
+        }
+    }
+    
+    upstream ws.atome.one {
+    # enable sticky session based on IP
+    ip_hash;
+    
+        server localhost:9292;
+    }
+
+cp ws.atome.one.conf atome.one.conf
+
+ee atome.one.conf
+
+copy in atome.one.conf :
+
+    server {
+    listen 80;
+    server_name atome.one;
+    
+        location / {
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header Host $host;
+    
+          proxy_pass http://atome.one;
+    
+          proxy_http_version 1.1;
+          proxy_set_header Upgrade $http_upgrade;
+          proxy_set_header Connection "upgrade";
+        }
+    }
+    
+    upstream atome.one {                                             
+    # enable sticky session based on IP                            
+    ip_hash;
+    
+        server localhost:9292;                                         
+    }                                                                 
+
+ee /usr/local/etc/nginx/nginx.conf
+
+[comment]: <> (add at the end of the file inside the bracket: )
+
+[comment]: <> (include "vdomain/*.conf";)
+
+Type the command : 
+
+    sysrc nginx_enable="YES"
+
+
+pkg install py37-certbot
+
+pkg install py37-certbot-nginx
+
+certbot --nginx -d atome.one -d ws.atome.one
+
+add your address and follow instructions
+
+    crontab -e o
+
+add the line below: 
+
+    0 0 * * * /usr/local/bin/certbot renew
+
+
+
+to restart nginx type :
+
+        service nginx restart
+
+Install fsu
+-
+
+[comment]: <> (deprecated )
+
+[comment]: <> (Install docker on machine then run &#40;after having updated <your_ip_address>&#41;:)
+
+[comment]: <> (    docker run --name=mediasoup-demo -p 4443:4443/tcp -p 2000-2020:2000-2020/udp -p 2000-2020:2000-2020/tcp -p 3000-3001:3000-3001/tcp --init -e DEBUG="mediasoup:INFO* WARN ERROR" -e PROTOO_LISTEN_PORT="4443" -e MEDIASOUP_LISTEN_IP="0.0.0.0" -e MEDIASOUP_ANNOUNCED_IP="<your_ip_address>" -e MEDIASOUP_MIN_PORT="2000" -e MEDIASOUP_MAX_PORT="2020" -e MEDIASOUP_USE_VALGRIND="false" -e MEDIASOUP_VALGRIND_OPTIONS="--leak-check=full --track-fds=yes --log-file=/storage/mediasoup_valgrind_%p.log" vanjoge/mediasoup-demo:v3)
+    
+
+to install mediasoup clone the atome_sfu_soup repository :
+
+    git clone https://github.com/atomecorp/atome_sfu_soup.git
+
+create "certs" folder inside the "server" folder of mediasoup
+    
+    mkdir certs
+    cd certs
+
+Generate a certificate and private key for localhost and store it  in "certs" folder inside "server" folder
+
+    openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost'
+
+or using Windows
+
+     MSYS_NO_PATHCONV=1 openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost'  
+  
+in "server" folder change config.js to use certificate and key, to do so : 
+    remplace `${__dirname}/certs/fullchain.pem` and  `${__dirname}/certs/privkey.pem` by the geneated files found in "certs" folder
+example :
+        `${__dirname}/certs/fullchain.pem`
+with:
+        `${__dirname}/certs/localhost.crt`
+also
+        `${__dirname}/certs/privkey.pem`
+with:
+        `${__dirname}/certs/localhost.key`
+
+In the "server" folder :
+    
+    npm install
+    npm start
+
+In the  app folder: cd ../
+
+    npm install --legacy-peer-deps
+    npm start
+
+in app/lib/RoomClient.js
+change atome.one address of server if necessary
+
+    this.url = "wss://ws.mediasoup.atome.one:443/?roomId=0&peerId=" + peerId;
+    
+Test with Firefox and safari. Chrome and edge doesn't accept wss without a valid certificate.
+
+Connect on port 443 with HTTPS to accept wss certificate.
+
+[comment]: <> (Connect on port 3002 to run the client.)
+    
+
+[comment]: <> (Deprecated below: )
+
+[comment]: <> (Generate a docker of the server after renamimg  config.example.js with config.js)
+
+[comment]: <> (    \mediasoup-demo\server\docker\build.sh)
+    
+[comment]: <> (run  docker run the following command  &#40;example using Windows&#41;)
+
+[comment]: <> (    docker run --name=mediasoup-demo -p 4443:4443/tcp -p 40000-49999:40000-49999/udp -p 40000-49999:40000-49999/tcp -p 3000-3001:3000-3001/tcp --init -v c:/Tmp/mediasoup/certs:/service/certs -e HTTPS_CERT_FULLCHAIN="/service/certs/fullchain.pem" -e HTTPS_CERT_PRIVKEY="/service/certs/privkey.pem" -e MEDIASOUP_ANNOUNCED_IP="192.168.103.92" -e MEDIASOUP_LISTEN_IP="0.0.0.0" mediasoup-demo:v3)
+    
+    
+[comment]: <> (Wait 10 mn for server starting...)