icwot 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb968b7f9058426b8b88f3529efbd842b28d8a83
-  data.tar.gz: 66c697961bab6edd2bda01f32b0c538104ed244b
+  metadata.gz: 773473aad14e5ed4062fad79be4441964f29f8e7
+  data.tar.gz: 0f2cbd799437e45e5eb8bebfe0c1165ccb9cf11b
 SHA512:
-  metadata.gz: 905289642d5740d4d6ab84c87674429720cd90801e647220b4b81b1a33ae231f9e789386a66e51d21232a43325281526e134481a0c8f5775c7e96daf0c81e70a
-  data.tar.gz: e37f838c5be217e31daf4c1c4509adb32d8edd17cbc99c329dc07da37a5d8b596558dde0d6db96da47e20f3ce553e6f90d7618e0a5d40227f50b4a115976c373
+  metadata.gz: a8db4381533ea0272faf11e4ba0f1edf11a89bcc89cb9c7ad85e807bef44e75b3ba59c01d2ce22e7ba64f5f8314d1189b3458fb4dfd85bbdccbfcc09eeffa31e
+  data.tar.gz: 0187bf5afd0f92ef09daa6b25326b6ff15d2b21e6103489f96645e23a72bd1ce0f07828210f5ae5c5033631149af54d3cf11a75c50bf787e6c5edb0b0179ac39

data/README.md

@@ -1,64 +1,93 @@
-# Icwot
+# Icwot [![GemVersion](https://badge.fury.io/rb/icwot.svg)](http://badge.fury.io/rb/icwot)
 
-RESTfull [sinatra](http://www.sinatrarb.com) server providing inversion of control for logging messages from another RESTfull application web-server
+> Application [Sinatra](http://www.sinatrarb.com)  permettant de logger les notifications envoyées par une application du Web de Objets utilisant l'inversion de contrôle.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'icwot'
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install icwot
-
-## Usage
-
-In a terminal run:
+## Description
+Icwot pour Inversion of Control for Web Of Things est une application Web basée sur le framework [Sinatra](http://www.sinatrarb.com) qui démontre l’inversion de contrôle telle que définie dans le xWoT méta-modèle. C’est à dire qu’un serveur Web est mis en place côté client et est prêt à recevoir des requêtes HTTP POST du service Web auprès duquel il s’est enregistré (Webhook). Icwot a été développé grâce au langage Ruby et est distribué grâce au gestionnaire de bibliothèques Ruby, RubyGems.
 
-    $ icwot <HOST>
+## Motivation
+La motivation de réaliser un tel module était de démontrer avec quelle facilité il est possible d’implémenter l’inversion de contrôle et de le distribuer. Nous voulons également démontrer qu’il est possible d’implémenter avec facilité une application Web répondant à nos besoins. Si notre implémentation est extrêment basique, c’est par volonté de permettre à n’importe qui de comprendre le code et de là de développer une implémentation plus complète.
 
-It will:
-
-1.  Register to the specified host by ` POST ` method and sending in the body information(s).
- Currently, the body information is the uri needed for the host to send informations to the client.
-2.  Start a [sinatra](http://www.sinatrarb.com) server on default port 4567. Logging messages will be saved by default to :
-your-home-directory/log/icwot-msg.log
-
-By default, the header of the ` POST ` method will have these values:
-
-     content-type=application/json
-     accept=application/json
-
-You can change it by specifying the ` -c your-content-type ` and ` -a your-accept ` in the command line call. Actaually, it can encode the body in two different maners:
-
-*   json, the body will typically be like this : ` {"uri": "your-ip-address:port-where-sinatra-is running"} `
-*   xml, the body will typically be like this:
-    ` <client xmlns=\"http://jaxb.xwot.first.ch.unifr.diuf\">
-        <uri>your-ip-address:port-where-sinatra-is running</uri>
-    </client> `
-The xml is not as the best for the moment. We recommand to use json.
-
-### There are several options for the commande line:
-
-    icwot <host>
-                -h print help
-                -l the host is localhost
-                -c the content-type value for the header application/json by default
-                -a the accept value for the header  text/plain by default
-                -p the port where to run the server
-                -t the protocol to use http:// by default
-                -l where to save the log. By default your-home-directory/log/icwot-{port}-msg.log
-                host is where to register for the service.
-
-## Contributing
+## Installation
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Dans le terminal exécuter la ligne suivante (nécessite Ruby et RubyGems d'installés):
+
+    gem install icwot
+
+## Installation depuis les sources
+
+Faire un checkout des sources depuis le repo GIT. Puis lancer les commandes
+
+    gem build icwot.gemspec
+    gem install icwot-0.3.4.gem
+
+## Publier le GEM
+
+
+## Utilisation
+Depuis un terminal lancer la commande
+
+```
+icwot HOST
+```
+
+où `HOST` est l’URL de la ressource d’un service Web de laquelle nous souhaitons recevoir des notifications. Cette commande va :
+
+1. Enregistrer le client par une requête HTTP POST sur l’URL fournie. Dans la requête POST une URL est transmise afin d’indiquer où recevoir des notifications. Par défaut ip-du-client:4567/
+2. Lancer le serveur Sinatra avec le port 4567 par défaut. Les notification reçues vont être enregistrées dans le dossier log/icwot/ du répertoire de l’utilisateur.
+
+Par défaut, le header de la requête POST pour s’enregistrer est `accept:application/json ;content_type:application/json`. Il est possible de le changer en ajoutant les arguments ``-c le-content-type et -a le-accept`. Où `le-content-type` et `le-accept` peuvent chacun être soit json soit xml. Donc suivant la valeur de l’argument `le-accept`, le corps de la requête sera encodé de deux manières :
+1. En JSON :
+```json
+{"url":"xx.xxx.x.x:4567/"}
+```
+2. En XML:
+```xml
+<client xmlns="http://jaxb.xwot.first.ch.unifr.diuf">
+    <uri>xx.xxx.x.x:4567/</uri>
+</client>
+```
+
+De même que le serveur encode les données en XML si `le-content-type` est égale à `xml`, sinon en JSON.
+
+Il y a également différentes options pour la ligne de commande pouvant être obtenue avec `icwot -h`:
+
+```
+Usage : icwot <host>
+             -h print help
+             -l the host is localhost
+             -c the content-type value for the header application/json by default
+             -a the accept value for the header text/plain by default
+             -p the port where to run the server
+             -t the protocol to use http:// by default
+             -o where to save the log. By default   your-home-directory/log/icwot-{port}-msg.log
+             <host> is the URL of the resource to register for the service.
+```
+
+## Structure
+Icwot est structuré comme suit : le dossier` bin/` contient le fichier Ruby exécutable `icwot` qui permet de lancer `icwot` depuis le terminal. Le dossier `lib/` contient quatre fichiers nécessaires à l’implémentation :
+1. Le fichier `server_client.rb` contenant la classe `ServerClient` responsable de l’implémentation de l'application Web.
+2. Le fichier `console.rb` pour l’intéraction avec l’utilisateur.
+3. Le fichier `client.rb` pour enregistrer les information du client et les encoder en XML ou JSON.
+4. Le fichier `version.rb` pour maintenir un numéro de version de la gem.
+
+## Implémentation
+Pour s’enregistrer vers le serveur afin de recevoir des notifications, la gem RestClient est utilisée. Si le code HTTP de la réponse renvoyée par le serveur est 200, nous estimons que l’enregistrement est réussi et nous démarrons le serveur Sinatra.
+
+L’implémentation du serveur Sinatra est extrêmement simple, le code ci-dessous montre le code nécessaire pour que le serveur puisse recevoir une requête HTTP POST à l’URI / et l’enregistre dans un fichier de log.
+
+```ruby
+  post '/' do
+    # response is returned in text/plain
+    content_type 'text/plain'
+    # save in a special log the body of the received request
+    msg.info request.body.read
+    # write in main log (the console) that we have received a new   notification
+    logger.info "message saved to #{self.class.logger_log_file.path}"
+    # return the HTTP code 200 with the text ok
+    'ok'
+  end
+```
+
+Nous avons défini que toutes les notifications envoyées à l'application sont enresitrées dans un fichier de log. Le format du logger pour enregistrer les notifications est de la forme : `date heure:break message`, où `date` et `heure` sont la date et l’heure à laquelle la notification est reçue, `break` indique un saut à la ligne et `message` est la notification reçue.
+Quand l’application reçoit le signal `EXIT`, elle envoie une requête au serveur pour se désenregistrer de l’envoi de notifications et arrête le serveur Sinatra.

data/bin/icwot

@@ -5,6 +5,7 @@ require 'icwot'
 require 'icwot/client'
 require 'icwot/console'
 require 'rest-client'
+require 'json'
 
 console = Console.new
 
@@ -19,25 +20,31 @@ if Icwot.is_port_open?('localhost', console.port)
 end
 
 client = Client.new(port: console.port, content_type: console.produces)
-console.host_url = client.uri
+#console.host_url = client.uri
+console.host_url = ''
+
 
 begin
-  response = RestClient.put console.url, client.to_s, console.header
+  #response = RestClient.put console.url, client.to_s, console.header
+  response = RestClient.post console.url, {"uri" => "#{client.uri}", "method" => "POST", "accept" => "application/json"}.to_json, console.header
 rescue RestClient::Exception => e
   puts "Error #{e.response.code} while contacting the host. The url is: '#{console.url}'"
-    exit 0
+  exit 0
 rescue Errno::ECONNREFUSED => e
   puts "Connection refused. The url is: '#{console.url}'"
+  puts e
   exit 0
 end
 
 #TODO handle the case when the response of the host is not correct
 puts "The response server: '#{response}' with code #{response.code}"
-   thr = Thread.new { app = Icwot.run(console.port, console.log_path) }
-  thr.join
+returnedclient = JSON.parse(response)
+
+thr = Thread.new { app = Icwot.run(console.port, console.log_path) }
+thr.join
 Signal.trap 'EXIT' do
   puts 'unregister from the server'
-  RestClient.delete console.url
+  RestClient.delete "#{console.url}/#{returnedclient['id']}"
   app.quit!
   puts 'quitting sinatra...'
 end

data/icwot.gemspec

@@ -5,7 +5,7 @@ require 'icwot/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "icwot"
-  spec.version       = '0.3.3'
+  spec.version       = '0.3.4'
   spec.authors       = ["leo"]
   spec.email         = ["facenord.sud@gmail.com"]
   spec.description   = %q{icwot : RESTfull sinatra server providing inversion of control for logging messages from another web-server}

data/lib/icwot/console.rb

@@ -55,7 +55,7 @@ class Console
 
   def url
     base_uri = protocol+host
-    base_uri += '/' unless base_uri[-1] == '/'
+    #base_uri += '/' unless base_uri[-1] == '/'
     base_uri + host_url
   end
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: icwot
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - leo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
 description: 'icwot : RESTfull sinatra server providing inversion of control for logging
@@ -103,7 +103,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,19 +125,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: 'icwot: inversion of control in RESTful applications'
 test_files: []
-has_rdoc: