nutella_framework 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e2c581262282b014fb5dc0911616b442534da8c
-  data.tar.gz: 3908173709fc9ee02ba4cd339615dde180e4776c
+  metadata.gz: 4fa6667c9ae02d2334bae79b81176c8297cb4d60
+  data.tar.gz: 8a7cbbb915d58d5a7c1de1e4010647a7ef618cd0
 SHA512:
-  metadata.gz: 5715373d4edeac20b922d507261b496bb961bc71c3d812e3d5ffd74ddf5ed0904cf096b8929e10788bdae78750e39b40427af224ca65bf46386e3956c8aa0872
-  data.tar.gz: d7e8d4b278eb8df7275f209cc21828bad2e678ee0116c3d45556245713b8d835256285df2522ded4487607ec0cbf14f22ff95409b2270c4b04bb343861728d11
+  metadata.gz: 5fcc6cab7b5665c59329d0e5ed75265094ec763ad7ed20578411696424e90f89ad1a2be1bfffddcaa6366370c6b69109c0ceb381f094d651eb3841696e5f8e87
+  data.tar.gz: 42b82c3abefeb8145934b03729b4f93fdce1df48e0a325503c02bab44e04e8b914b0bf04cf1ce5bcbf72215d325292edc4459d65d6ebd38978d735fb2f77eb95

data/Gemfile

@@ -4,7 +4,6 @@ gem 'ansi', '~> 1.4', '>= 1.4.3'
 gem 'semantic', '~> 1.3', '>=1.3'
 gem 'logging', '~> 1.8', '>=1.8.2'
 gem 'git', '~> 1.2', '>=1.2.8'
-gem 'thin', '~> 1.6.3', '>= 1.6.3'
 gem 'sinatra', '~>1.4.5', '>=1.4.5'
 gem 'nokogiri', '~>1.6.3', '>=1.6.3'
 

data/README.md

@@ -5,43 +5,39 @@
 [![Code Climate](https://codeclimate.com/github/nutella-framework/nutella_framework/badges/gpa.svg)](https://codeclimate.com/github/nutella-framework/nutella_framework)
 
 # Nutella 
-Nutella is a framework to build and run "Internet of Things"-like learning applications. It's still _very_ under development so keep an eye on new versions and help fix the bugs you find by [submitting issues](https://waffle.io/nutella-framework/nutella_framework). Nutella's goal is to be for the "Internet of Things" what Ruby on Rails has been for web applications. Ambitious? You bet, but where is the fun if the challenge is trivial?
+Nutella is a framework to build and run classroom narratives. It's still _very_ under development so any help [finding and fixing bugs](https://github.com/nutella-framework/nutella_framework/issues) will be greatly appreciated!
 
 # Installing
-Nutella is a ruby gem so to install it we do:
+Nutella is written in ruby but it leverages lots of technologies that already exists. Therefore, before you can successfully install nutella, you need to install (if you don't have them already):
+
+1. _ruby_ (version >= 2.1.0). Do yourself a favor and use [RVM](https://rvm.io/rvm/install).
+1. _git_ (version >= 1.8.0). Do yourself a favor and use [Homebrew](http://brew.sh/) if you are on OSX.
+1. _tmux_ (version >= 1.8.0). Do yourself a favor and use [Homebrew](http://brew.sh/) if you are on OSX.
+1. _node.js_ (version >= 0.10.0). Yes, really, you need to install node becaue we use it to run the broker that handles all communications between all the pieces of the framework. Do yourself a favor and use [nvm](https://github.com/creationix/nvm).
+
+Once you have all the pieces that you need, to install nutella simply do:
 ```
 gem install nutella_framework
 ```
-If all goes as expected you should be able to type `nutella` in your shell and get a welcome message (yay!) together with a warnining (booooo!). Let's see why...
+Once the installation is complete you should be able to type `nutella` in your shell and get a welcome message. 
+
+## nutella checkup
+If you are reading this you probably already saw the warning: "Looks like this is a fresh installation of nutella. Please run 'nutella checkup' to check all dependencies are installed".
 
 Nutella is written in ruby but is designed to run bots and interfaces written in virtually any programming language. All communications among these components are routed through an _MQTT broker_ which needs to be installed (together with its dependencies) before nutella can actually work correctly. Therefore **right after your install nutella** you should run: 
 ```
 nutella checkup
 ```
-in order to make sure all the dependencies have been correctly installed.
+This will install the [Mosca](http://www.mosca.io/) MQTT broker and make sure all the dependencies required by nutella are installed as well.
 
+Congratulations! Nutella is ready to use!
 
-# Hello world
-So what does nutella do for me? Suppose we want to create a new application called "crepe" (because I like nutella crêpes). Let's do that:
-```
-nutella new crepe
-```
-Nutella will create the basic project structure in a directory called `crepe`. Now that we have created a basic project, we can 
-```
-cd crepe
-``` 
-and start our new project by doing
-```
-nutella start
-```
-Pretty boring isn't it? Nothing is happeninig! Why? Well, because the project we just created is simply an empty shell. Let's spice things up a bit and throw some cinnamon into this crêpe!
 
-## Templates
-What are templates? Templates are simply [boilerplate code](http://en.wikipedia.org/wiki/Boilerplate_code) that you don't have to write.  Templates are there to simplify your life. Let's see how. Our new application is a ...
-**This tutorial is a work in progress**
+# Where next?
+If you already have a projects you want to tinker with (like [RoomQuake](https://github.com/ltg-uic/roomquake)) simply checkout the project to a local folder, `cd /to/my/local/folder` and start tinkering away. Not sure what to do? Check out our [nutella Command Line Tool man page](https://github.com/nutella-framework/nutella_framework/wiki/Nutella-Command-Line-Interface).
 
+If you want to create your own project, check out the [new project tutorial](https://github.com/nutella-framework/nutella_framework/wiki/New-project-tutorial).
 
-For a complete guide on how to use Nutella, please refer to [this wiki](https://github.com/nutella-framework/nutella_framework/wiki).
 
-# Building & contributing
-Clone the repo, `bundle install` to take care of the dependencies and then `rake` to run all the tests. If you want to perform some fancier task simply type `rake -T` for a list of awesomeness.
+# Contributing
+Check out our [contributing wiki page](https://github.com/nutella-framework/nutella_framework/wiki/Contributing)! Thanks!

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/actors/main_interface/main_interface_bot.rb

@@ -15,6 +15,9 @@ rescue
   abort 'Impossible to parse configuration and/or runlist files!'
 end
 
+# Set Sinatra to run in production mode
+set :environment, :production
+
 # Set Sinatra's port to nutella's main_interface_port
 set :port, config_h['main_interface_port']
 
@@ -26,7 +29,7 @@ end
 
 
 # Renders the run template
-get '/:run_id' do
+get '/:run_id/?' do
 
   # Parse the run_id from URL and extract the run path from runlist.json
   @run_id = params[:run_id]

data/actors/main_interface/startup

@@ -1,5 +1,5 @@
 #!/bin/sh
 
 BASEDIR=$(dirname $0)
-ruby $BASEDIR/main_interface_bot.rb $1 $2 &>/dev/null &
+ruby $BASEDIR/main_interface_bot.rb $1 $2 > /dev/null 2>&1 &
 echo $! > $BASEDIR/.pid

data/lib/core/commands/start.rb

@@ -43,9 +43,12 @@ module Nutella
 
     def add_to_run_list(run_id, prj_dir)
       unless Nutella.runlist.add?( run_id, prj_dir )
-        console.error 'Impossible to start project: an instance of this project with the same run_id is already running!'
-        console.error "You might want to kill it with 'nutella stop #{run_id}'"
-        return false
+        # If the run_id is already in the list, check that it's actually live
+        if Tmux.session_exists? run_id
+          console.error 'Impossible to start project: an instance of this project with the same run_id is already running!'
+          console.error "You might want to kill it with 'nutella stop #{run_id}'"
+          return false
+        end
       end
       true
     end
@@ -54,13 +57,18 @@ module Nutella
     def start_internal_broker
       pid_file_path = "#{Nutella.config['broker_dir']}bin/.pid"
       return true if sanitize_pid_file pid_file_path
+      # Check that broker is not running unsupervised (check port)
+      unless broker_port_free?
+        console.error 'Impossible to start project: looks like a broker is already running on port 1883. Stop it before trying to start the project again'
+        return false
+      end
       # Broker is not running and there is no file so we try to start
       # and create a new pid file. Note that the pid file is created by
       # the startup script!
       pid = fork
       exec("#{Nutella.config['broker_dir']}/startup") if pid.nil?
       # Sleep a bit to give the chance to the broker to actually start up
-      sleep(0.8)
+      sleep(1)
       # All went well so we return true
       true
     end
@@ -93,6 +101,19 @@ module Nutella
     end
 
 
+    # Checks if port 1883 (MQTT broker port) is free
+    # or some other service is already listening on it
+    def broker_port_free?
+      begin
+        s = TCPServer.new('0.0.0.0', 1883)
+        s.close
+      rescue
+        return false
+      end
+      true
+    end
+
+
     def start_nutella_actors
       nutella_actors_dir = "#{Nutella.config['nutella_home']}actors"
       for_each_actor_in_dir nutella_actors_dir do |actor|

data/lib/core/tmux.rb

@@ -25,24 +25,13 @@ module Nutella
       `tmux send-keys "cd bots/#{bot};./startup #{@run_id} #{Nutella.config['broker']}" C-m`
     end
 
-    def new_interface_window( iface )
-      # Create new window for `iface`
-      # note: -k option destroys it if it can't be created
-      # hide window creation info
-      `tmux new-window -kP -n #{iface} &> /dev/null`
-      @sessions.push(iface)
-      # Select window
-      `tmux select-window -t #{@run_id}:#{@sessions.length-1} &> /dev/null`
-      port = Nutella.config['main_interface_port'] + @sessions.length
-      url = "http://localhost:#{port}/index.html"
-      # Start serving interface
-      `tmux send-keys "cd interfaces/#{iface};thin -R #{Nutella.config['nutella_home']}/lib/extra/config.ru -p #{port.to_s} start" C-m`
-      url
-    end
-
     def self.kill_session( run_id )
       `tmux kill-session -t #{run_id} &> /dev/null`
     end
+
+    def self.session_exists?( run_id )
+      system( "tmux has-session -t #{run_id} &> /dev/null" )
+    end
       
   end
   

data/nutella_framework.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: nutella_framework 0.2.0 ruby lib
+# stub: nutella_framework 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "nutella_framework"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Alessandro Gnoli"]
-  s.date = "2014-11-26"
+  s.date = "2015-01-20"
   s.description = "Nutella is a framework to build and run \"Internet of Things\"-like learning applications"
   s.email = "tebemis@gmail.com"
   s.executables = ["nutella"]
@@ -74,7 +74,6 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<semantic>, [">= 1.3", "~> 1.3"])
       s.add_runtime_dependency(%q<logging>, [">= 1.8.2", "~> 1.8"])
       s.add_runtime_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
-      s.add_runtime_dependency(%q<thin>, [">= 1.6.3", "~> 1.6.3"])
       s.add_runtime_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
       s.add_development_dependency(%q<shoulda>, [">= 3", "~> 3"])
@@ -88,7 +87,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<semantic>, [">= 1.3", "~> 1.3"])
       s.add_dependency(%q<logging>, [">= 1.8.2", "~> 1.8"])
       s.add_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
-      s.add_dependency(%q<thin>, [">= 1.6.3", "~> 1.6.3"])
       s.add_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
       s.add_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
       s.add_dependency(%q<shoulda>, [">= 3", "~> 3"])
@@ -103,7 +101,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<semantic>, [">= 1.3", "~> 1.3"])
     s.add_dependency(%q<logging>, [">= 1.8.2", "~> 1.8"])
     s.add_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
-    s.add_dependency(%q<thin>, [">= 1.6.3", "~> 1.6.3"])
     s.add_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
     s.add_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
     s.add_dependency(%q<shoulda>, [">= 3", "~> 3"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutella_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alessandro Gnoli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -90,26 +90,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement