internet_box_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6eb612118c2d0893eaf96f60d371e1a4d96835f
+  data.tar.gz: a5c4c091d8364206a56c843edcd071f1b8a7c3eb
+SHA512:
+  metadata.gz: d3ddbbe8a55e786285ba37ce681c07fc91d55e0ce765b945b28a1d3c81d34b2a7c2134b4734c70061695cb13f31bba3fc3cfa3afd3b1b304e8387161c73da32f
+  data.tar.gz: 869d468ee6d9b08c9bd112f5e4acf4d859b292c37fb9835545d3ec997ac1a9447ee4be436ed19b7da175b327e5ed05b6c94df5f49f2ff6a6d4d04877def7cb98

data/.gitignore

@@ -0,0 +1,46 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# Standard
+*~
+
+# Ruby
+/.bundle/
+/.rvmrc
+/Gemfile.lock
+
+# Standard Rails project
+/tmp/
+/db/*.sqlite3
+/test/dummy/db/*.sqlite3
+/log/*.log
+
+# Rails engines
+/test/dummy/db/*.sqlite3
+/test/dummy/log/*.log
+/test/dummy/tmp/
+/test/dummy/.sass-cache
+
+# Should not be in the repo as setup by rake task
+/test/dummy/public/kibana
+
+# SASS CSS generation
+/public/stylesheets/.sass-cache/
+
+# Netbeans
+/nbproject/
+
+# Sublime Text 2 project
+*.sublime-project
+*.sublime-workspace
+*(copie)*
+
+# Rubymine
+/.idea/
+
+# Misc
+/projectFilesBackup/
+/pkg/
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in internet_box_logger.gemspec
+gemspec
+
+# gem 'easy_app_helper', path: '../easy_app_helper'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    internet_box_logger (0.1.1)
+      activesupport
+      easy_app_helper
+      elasticsearch
+      whenever
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    chronic (0.10.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    easy_app_helper (1.0.11)
+      slop
+    elasticsearch (1.0.6)
+      elasticsearch-api (= 1.0.6)
+      elasticsearch-transport (= 1.0.6)
+    elasticsearch-api (1.0.6)
+      multi_json
+    elasticsearch-transport (1.0.6)
+      faraday
+      multi_json
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    whenever (0.9.4)
+      chronic (>= 0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  internet_box_logger!
+  pry
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Laurent Briais
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,230 @@
+# [InternetBoxLogger][IBL]
+
+ [![Build Status](https://travis-ci.org/lbriais/internet_box_logger.png?branch=master)](https://travis-ci.org/lbriais/internet_box_logger)
+ [![Gem Version](https://badge.fury.io/rb/internet_box_logger.png)](http://badge.fury.io/rb/internet_box_logger)
+
+## Overview
+
+The goal of this [gem][IBL] is to provide an easy way to monitor your internet box status.
+It primarily targets the box I am using (the Freebox V5 from the '[Free]' french ISP).
+
+Currently supported box:
+
+* **Freebox V5**
+
+## Installation
+
+### Dependencies
+
+You need to have [ELK] installed, the fantastic software trilogy that brings you the power of analytics at your fingertips.
+In our case we just need ElasticSearch and Kibana, LogStash is not needed, but you should not prevent yourself from
+using it for log files of your own...
+
+Follow [ELK] installation procedure before installing this Gem.
+
+### Gem installation
+Add this line to your application's Gemfile:
+
+    gem 'internet_box_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install internet_box_logger
+
+### Configuration
+
+Configuration thanks to [EasyAppHelper][EAP] enables multiple places to store your configuration. But most useful one should be:
+
+* '`/etc/internet_box_logger.conf`' for a system-wide installation
+* '`~/.config/internet_box_logger.conf`' for a user-specific installation
+
+The default configuration is the following in YAML format:
+
+```yaml
+box_type: InternetBoxLogger::Parsers::FreeboxV5Parser
+
+cron_interval: 1
+
+kibana_path: /opt/kibana
+
+server_port: 5000
+
+default_elastic_search:
+  elastic_servers:
+    - 127.0.0.1:9200
+  elastic_binary: /opt/elasticsearch/bin/elasticsearch
+```
+
+`box_type` specifies the module in charge of gathering data from your box. it Should not be changed but you can define
+your own. **It is the way for you to add other types of boxes** if needed. If you do so, please do a pull-request
+afterwards.
+
+`cron_interval` defines the time in minutes between two measurements.
+
+`kibana_path` defines where your [Kibana][ELK] is installed. This one is only used by a rake task to setup default
+dashboards for your box. This is not really needed for the script to work.
+
+`server_port` defines the port to run a simple HTTP server to serve the Kibana UI.
+
+`elastic_servers` You can specify here, how to reach your ElasticSearch cluster. If you did the default install of
+ElasticSearch on the same machine as the gem is installed, then it should already be the correct host:port.
+
+`elastic_binary` defines where your [ElasticSearch][ELK] is installed. This one is only used by a rake task
+(to stop/start and get info) about the ElasticSearch cluster. This is not really needed for the log process to work.
+When you change it in your config, you do not need to set it in the `default_elastic_search` hash, but instead you can
+directly set it at the root.
+
+**These values are the default and you don't need to create a new config file if they already fit your needs.**
+And it should be the case if you installed [ELK] as a whole on the machine you are using this gem.
+
+You can deploy every component separately and in this case you nay have to tweak the configuration.
+
+Most probably if you installed [ELK] locally, your config file may look like:
+
+```yaml
+kibana_path: <the_place_where_I_installed_Kibana>
+elastic_binary: <the_path_to_the_elasticsearch_binary>
+```
+
+## Usage
+
+This Gem brings basically an executable '```internet_box_logger```' that will save the state of your box into an
+ElasticSearch instance.
+
+The script supports the following options that you can see with the ```--help``` options:
+
+```
+-- Generic options -------------------------------------------------------------
+        --auto                 Auto mode. Bypasses questions to user.
+        --simulate             Do not perform the actual underlying actions.
+    -v, --verbose              Enable verbose mode.
+    -h, --help                 Displays this help.
+-- Configuration options -------------------------------------------------------
+        --config-file          Specify a config file.
+        --config-override      If specified override all other config.
+-- Debug and logging options ---------------------------------------------------
+        --debug                Run in debug mode.
+        --debug-on-err         Run in debug mode with output to stderr.
+        --log-level            Log level from 0 to 5, default 2.
+        --log-file             File to log to.
+-- Script specific -------------------------------------------------------------
+        --cron_interval        Specify the interval at which the measurements will be done
+        --cron_remove          Remove the Cron task
+        --cron_setup           Setup the Cron task
+        --deploy_reports       Deploy boxes dashboards to Kibana default folder
+        --es_start             Starts the ElasticSearch server if installed locally and properly configured
+        --es_stop              Stops the ElasticSearch server if installed locally and properly configured
+        --serve                Runs a simple web server to serve Kibana UI
+        --server_port          Specify server port if you use the "--serve" option
+```
+
+On top of this the gem brings a set of rake tasks **in case you bundle this gem in your own project**.
+
+The rake tasks provided are:
+
+```
+rake internet_box_logger:cron:info           # Show your Cron config
+rake internet_box_logger:cron:remove         # Removes cron task
+rake internet_box_logger:cron:setup          # Setup cron to gather information every x minutes (configurable)
+rake internet_box_logger:es:info             # Show your local ElasticSearch config
+rake internet_box_logger:es:start            # Starts your local ElasticSearch server
+rake internet_box_logger:es:stop             # Stops your local ElasticSearch server
+rake internet_box_logger:kibana:deploy       # Deploys box specific reports into Kibana dashboards directory
+rake internet_box_logger:kibana:info         # Displays Kibana information
+rake internet_box_logger:kibana:serve[port]  # Launch a simple server to serve Kibana UI
+```
+
+### Script vs rake mode
+
+As stated, the [gem][IBL] supports two way to interact:
+
+* The ```internet_box_logger``` script provided with the gem
+* The rake tasks provided with the gem when you use it in your own projects
+
+Most commands are actually same, and the following commands have the same effect:
+
+<table>
+    <tr>
+        <td><pre>rake internet_box_logger:cron:setup</pre></td>
+        <td><pre>internet_box_logger -v --cron-setup</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:cron:remove</pre></td>
+        <td><pre>internet_box_logger -v --cron-remove</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:es:start</pre></td>
+        <td><pre>internet_box_logger -v --es-start</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:es:stop</pre></td>
+        <td><pre>internet_box_logger -v --es-stop</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:kibana:deploy</pre></td>
+        <td><pre>internet_box_logger -v --deploy-reports</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:kibana:serve</pre></td>
+        <td><pre>internet_box_logger -v --serve</pre></td>
+    </tr>
+    <tr>
+        <td><pre>rake internet_box_logger:kibana:serve[1234] (*)</pre></td>
+        <td><pre>internet_box_logger -v --serve --server-port 1234</pre></td>
+    </tr>
+</table>
+
+(\*) Warning, if you are using zsh, you may probably have to escape the brackets with backslashes.
+
+
+### Starting to monitor your box
+
+You have to have:
+
+ * A running instance of ElasticSearch. If it is installed locally and the path to your ElasticSearch binary
+ is correctly set in your config file, you can use the command line or the rake task (if you use this gem in your
+ project) to start/stop it.
+ * A place where kibana is installed
+ * Setup correctly the `kibana_path` in your config and run either the the command line or the rake task (if you use
+ this gem in your project) to deploy the reports to Kibana. Alternatively, you can manually copy the JSON files stored
+ in the config/kibana_reports directory to where your Kibana is install in the  app/dashboards sub-directory.
+ * An http server to serve the Kibana UI. You can use the mini embedded server and you can use the command line or the
+ rake task (if you use this gem in your project) to start/stop it (a correctly defined `kibana_path` in your config is
+ required). Alternatively you can serve it with a server of your own.
+ * Setup the CRON task that will schedule the log into elastic search. You can use the command line or the rake task
+ (if you use this gem in your project) to setup/remove the CRON task and you can verify it with `crontab -l`.
+ Alternatively, you can create the cron entry fully manually or call the `internet_box_logger` from your own
+ scheduler.
+
+Then provided you started the embedded server you just need to navigate to:
+
+   http://localhost:5000/#/dashboard/file/FreeboxV5_report.json
+
+   This url is for the Freebox V5 which is the currently only one supported.
+
+## Contributing
+
+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
+
+Basically, to contribute you may want to:
+
+* create the module to gather information from your box.
+* build the Kibana report to display information.
+* Update the tests accordingly
+
+
+That's all folks.
+
+
+[IBL]:  https://rubygems.org/gems/internet_box_logger        "internet_box_logger gem"
+[Free]: http://free.fr                                       "Free French ISP"
+[ELK]:  http://www.elasticsearch.org/overview/elkdownloads/  "ElasticSearch, LogStash, Kibana"
+[EAP]:  https://rubygems.org/gems/easy_app_helper            "EasyAppHelper gem"

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+load File.expand_path('../lib/tasks/internet_box_logger_tasks.rake', __FILE__)
+

data/bin/internet_box_logger

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'internet_box_logger'
+require 'tasks/internet_box_logger_tasks'
+
+module InternetBoxLogger
+  class Script
+    include EasyAppHelper
+
+    APP_NAME = 'The Internet Box Logger'
+    DESCRIPTION = 'This application will log your Internet box metrics into ElasticSearch.'
+
+    def initialize
+      # Providing this data is optional but brings better logging and online help
+      config.describes_application(app_name: APP_NAME, app_version: InternetBoxLogger::VERSION, app_description: DESCRIPTION)
+    end
+
+    def run
+      add_cmd_line_options
+      if config[:help]
+        puts config.help
+        exit 0
+      end
+      begin
+        if config[:cron_setup] && config[:cron_remove]
+          msg =  'Incompatible options cron_setup and cron_remove'
+          raise msg
+        end
+        if config[:deploy_reports]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::Kibana
+          kibana_info
+          deploy_reports
+          exit 0
+        end
+
+        if config[:cron_setup]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::Cron
+          cron_setup
+          exit 0
+        end
+        if config[:cron_remove]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::Cron
+          cron_remove
+          exit 0
+        end
+        if config[:es_start]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::ElasticSearch
+          start_es_server
+          exit 0
+        end
+        if config[:es_stop]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::ElasticSearch
+          stop_es_server
+          exit 0
+        end
+
+
+        if config[:serve]
+          self.extend InternetBoxLogger::Tasks
+          self.extend InternetBoxLogger::Tasks::Kibana
+          kibana_info
+          serve_ui
+        else
+          puts_and_logs 'Application is starting'
+          log_box_information
+        end
+      rescue => e
+        puts "Program aborted with message: #{e.message}"
+        logger.fatal "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}" if config[:debug]
+      end
+
+
+    end
+
+    def add_cmd_line_options
+      config.add_command_line_section do |slop|
+        slop.on :cron_interval, 'Specify the interval at which the measurements will be done', argument: true, as: Integer
+        slop.on :cron_remove, 'Remove the Cron task', argument: false
+        slop.on :cron_setup, 'Setup the Cron task', argument: false
+        slop.on :deploy_reports, 'Deploy boxes dashboards to Kibana default folder', argument: false
+        slop.on :es_start, 'Starts the ElasticSearch server if installed locally and properly configured', argument: false
+        slop.on :es_stop, 'Stops the ElasticSearch server if installed locally and properly configured', argument: false
+        slop.on :serve, 'Runs a simple web server to serve Kibana UI', argument: false
+        slop.on :server_port, 'Specify server port if you use the "--serve" option', argument: true, as: Integer
+      end
+    end
+
+    def log_box_information
+      InternetBoxLogger.get_box.log_box_info
+    end
+
+  end
+end
+
+InternetBoxLogger::Script.new.run

data/config/internet_box_logger.conf

@@ -0,0 +1,13 @@
+
+box_type: InternetBoxLogger::Parsers::FreeboxV5Parser
+
+cron_interval: 1
+
+kibana_path: /opt/kibana
+
+server_port: 5000
+
+default_elastic_search:
+  elastic_servers:
+    - 127.0.0.1:9200
+  elastic_binary: /opt/elasticsearch/bin/elasticsearch