WIP - Policy backend branch part of issue #24

.github/workflows/edisonCI.yml

@@ -1,3 +1,4 @@
+
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 

.gitignore

@@ -1,3 +1,4 @@
+
 # Vagrant stuff
 acceptance_config.yml
 boxes/*
@@ -13,9 +14,11 @@ test/vagrant-spec/.vagrant/
 # IDE
 _pycache_/
 .idea/*
+.DS_Store
 
 # Python
 *.pyc
 *.orig
 *.pyc.*
 /.cache
+

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Roni Rushkin Elharar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Roni Rushkin Elharar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,57 +1,57 @@
-# Edison - Automated house managment
-
-### Overview
-
-Edison is an open-source home management system.  
-In its core, Edison is a regular automatic home management system: it reads data from humidity and light sensors and decides when to turn on the air condition and turn on the lights in different rooms. 
-
-Edison allows users to write their own house management plans.   
-Users can share their management plans through the Edison network and users can also download and review plans from other users.
-
-Edison can also manage different sensors from different rooms with different management plans for each room.
-
-## How to spin and tear down the environment
-
-Edison makes the initial setup easy for you by including a provisioner file that runs automatically on **`vagrant up`**.  
-You will have a fully ready-to-go work environment with a single command.
-
-### How to get started
-
-- Download the proper [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and [Vagrant](https://www.vagrantup.com/downloads.html) package for your operating system and architecture.
-- Download Edison to your machine and then open a console window on *edison* folder.
- - Write **`vagrant up`** and press enter.
- - That's it! Your virtual machine is up and running.  
- You can enter your virtual machine with **`vagrant ssh`**.
- > **Important!** In case that, after `vagrant ssh`, your virtual machine asks for a password the default  password is `vagrant`.
-
- ### How to save virtual machine state
-
- In order for your next **`vagrant up`** to execute quicker you should save your virtual machine state into a box file format.
-
- - If you are inside the virtual machine write **`exit`** and press enter. Now you are back on your host command line. 
- - Write **`vagrant halt`** and press enter.
- > **Note:** It will shut down the running machine Vagrant is managing.
- - Write **`vagrant package --output box-name.box`** and press enter. You can replace *box-name* with any name you want.
-> **Note:** It will output your virtual machine into a box file format with .box extension.
-- Write **`vagrant box add box-name box-name.box`** and press enter.  
-  Make sure you replaced *box-name* with the name you have chosen on the previous step.
-- Edit *Vagrantfile* inside the *edison* folder.  
-Change the following line `config.vm.box = "ubuntu/xenial64"` to `config.vm.box = "box-name"` (replace *box-name* with the name of the box you have created).
-- Run **`vagrant up --no-provision`** on future spins.
-
-### How to tear down the environment
-
-- If you are inside your virtual machine execute the **`exit`** command so you would get back to your host command line.
-- Write **`vagrant destroy -f`** and press enter. It sould terminate your virtual machine.
-> **Important!** If you have some unsaved work on your virtual machine your data will be lost! In order to save your data you should follow the steps we provided on **How to save virtual machine state**.
-
-## FAQ
-
-Here are some answers to some frequently asked questions:
-
-**Why does `vagrant up` take so long ?**  
-If you don't have a box to spin your environment from, **`vagrant up`** will take longer to be done.  
-As part of this command execution our included file `setup.sh` starts to execute and configure Edison environment inside the virtual machine. It downloads all the dependencies Edison requires to run.
-
-**What is box file format ?**  
+# Edison - Automated house managment
+
+### Overview
+
+Edison is an open-source home management system.  
+In its core, Edison is a regular automatic home management system: it reads data from humidity and light sensors and decides when to turn on the air condition and turn on the lights in different rooms. 
+
+Edison allows users to write their own house management plans.   
+Users can share their management plans through the Edison network and users can also download and review plans from other users.
+
+Edison can also manage different sensors from different rooms with different management plans for each room.
+
+## How to spin and tear down the environment
+
+Edison makes the initial setup easy for you by including a provisioner file that runs automatically on **`vagrant up`**.  
+You will have a fully ready-to-go work environment with a single command.
+
+### How to get started
+
+- Download the proper [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and [Vagrant](https://www.vagrantup.com/downloads.html) package for your operating system and architecture.
+- Download Edison to your machine and then open a console window on *edison* folder.
+ - Write **`vagrant up`** and press enter.
+ - That's it! Your virtual machine is up and running.  
+ You can enter your virtual machine with **`vagrant ssh`**.
+ > **Important!** In case that, after `vagrant ssh`, your virtual machine asks for a password the default  password is `vagrant`.
+ 
+ ### How to save virtual machine state
+ 
+ In order for your next **`vagrant up`** to execute quicker you should save your virtual machine state into a box file format.
+ 
+ - If you are inside the virtual machine write **`exit`** and press enter. Now you are back on your host command line. 
+ - Write **`vagrant halt`** and press enter.
+ > **Note:** It will shut down the running machine Vagrant is managing.
+ - Write **`vagrant package --output box-name.box`** and press enter. You can replace *box-name* with any name you want.
+> **Note:** It will output your virtual machine into a box file format with .box extension.
+- Write **`vagrant box add box-name box-name.box`** and press enter.  
+  Make sure you replaced *box-name* with the name you have chosen on the previous step.
+- Edit *Vagrantfile* inside the *edison* folder.  
+Change the following line `config.vm.box = "ubuntu/xenial64"` to `config.vm.box = "box-name"` (replace *box-name* with the name of the box you have created).
+- Run **`vagrant up --no-provision`** on future spins.
+
+### How to tear down the environment
+
+- If you are inside your virtual machine execute the **`exit`** command so you would get back to your host command line.
+- Write **`vagrant destroy -f`** and press enter. It sould terminate your virtual machine.
+> **Important!** If you have some unsaved work on your virtual machine your data will be lost! In order to save your data you should follow the steps we provided on **How to save virtual machine state**.
+
+## FAQ
+
+Here are some answers to some frequently asked questions:
+
+**Why does `vagrant up` take so long ?**  
+If you don't have a box to spin your environment from, **`vagrant up`** will take longer to be done.  
+As part of this command execution our included file `setup.sh` starts to execute and configure Edison environment inside the virtual machine. It downloads all the dependencies Edison requires to run.
+
+**What is box file format ?**  
 Please read [box file format](https://www.vagrantup.com/docs/boxes/format.html) documentation for more information.

Vagrantfile

@@ -1,37 +1,37 @@
-db_file_exists    = "test -f /vagrant/edison/db.sql"
-restore_db        = "sudo -u postgres psql edison < /vagrant/edison/db.sql"
-db_restored_msg   = "echo \"Database restored.\""
-db_not_exists_msg = "echo \"db.sql not exists.\""
-try_restore_db    = "bash -c '#{db_file_exists} && #{restore_db} && #{db_restored_msg} || #{db_not_exists_msg}'"
-save_db_data      = "sudo -u postgres pg_dump edison > /vagrant/edison/db.sql"
-
-Vagrant.configure("2") do |config|
-  config.trigger.before :destroy do |trigger|
-    trigger.info = "Saving database data inside synced folder..."
-    trigger.run_remote = {inline: "#{save_db_data}"}
-  end
-
-  config.trigger.after :up do |trigger|
-    trigger.info = "Trying to restore database from /vagrant/edison/db.sql..."
-    trigger.run_remote = {inline: "#{try_restore_db}"}
-  end
-
-  config.vm.box = "ubuntu/bionic64"
-  config.vm.provision :shell, path: "setup.sh"
-  config.vm.network "private_network", type: "dhcp"
-  config.vm.provider "virtualbox" do |v|
-    v.gui = false
-    v.name = "Edison_test"
-    v.memory = 1024
-    v.cpus = 2
-  end 
-
-end
-
-# Fixes a dhcp configuration conflict of the private network.
-# Issue: https://github.com/hashicorp/vagrant/issues/8878
-class VagrantPlugins::ProviderVirtualBox::Action::Network
-  def dhcp_server_matches_config?(dhcp_server, config)
-    true
-  end
-end
+db_file_exists    = "test -f /vagrant/edison/db.sql"
+restore_db        = "sudo -u postgres psql edison < /vagrant/edison/db.sql"
+db_restored_msg   = "echo \"Database restored.\""
+db_not_exists_msg = "echo \"db.sql not exists.\""
+try_restore_db    = "bash -c '#{db_file_exists} && #{restore_db} && #{db_restored_msg} || #{db_not_exists_msg}'"
+save_db_data      = "sudo -u postgres pg_dump edison > /vagrant/edison/db.sql"
+
+Vagrant.configure("2") do |config|
+  config.trigger.before :destroy do |trigger|
+    trigger.info = "Saving database data inside synced folder..."
+    trigger.run_remote = {inline: "#{save_db_data}"}
+  end
+
+  config.trigger.after :up do |trigger|
+    trigger.info = "Trying to restore database from /vagrant/edison/db.sql..."
+    trigger.run_remote = {inline: "#{try_restore_db}"}
+  end
+
+  config.vm.box = "ubuntu/bionic64"
+  config.vm.provision :shell, path: "setup.sh"
+  config.vm.network "private_network", type: "dhcp"
+  config.vm.provider "virtualbox" do |v|
+    v.gui = false
+    v.name = "Edison_test"
+    v.memory = 1024
+    v.cpus = 2
+  end 
+
+end
+
+# Fixes a dhcp configuration conflict of the private network.
+# Issue: https://github.com/hashicorp/vagrant/issues/3083
+class VagrantPlugins::ProviderVirtualBox::Action::Network
+  def dhcp_server_matches_config?(dhcp_server, config)
+    true
+  end
+end

edison/__init__.py

@@ -1,12 +1,12 @@
-import os
-
-from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
-from edison.config import get_config_object
-
-
-# Put app here so the entire app could import it.
-app = Flask(__name__)
-app.config.from_object(get_config_object(app.config["ENV"]))
-basedir = os.path.abspath(os.path.dirname(__file__))
-db = SQLAlchemy(app)
+import os
+
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+from edison.config import get_config_object
+
+
+# Put app and db here so the entire app could import them.
+app = Flask(__name__)
+app.config.from_object(get_config_object(app.config["ENV"]))
+basedir = os.path.abspath(os.path.dirname(__file__))
+db = SQLAlchemy(app)