internet_box_logger 0.1.1

data/lib/tasks/kibana.rb

@@ -0,0 +1,59 @@
+module InternetBoxLogger
+  module Tasks
+    module Kibana
+
+      def kibana_reports_source
+        reports_source = "#{ibl_gem_path}/config/kibana_reports"
+        Dir.entries(reports_source).keep_if {|e| e =~ /_report\.json$/i }.map {|e| "#{reports_source}/#{e}"}
+      end
+
+      def kibana_dashboards_path
+        "#{kibana_path}/app/dashboards"
+      end
+
+      def kibana_path
+        EasyAppHelper.config[:kibana_path]
+      end
+
+      def kibana_symlink_path
+        "#{EasyAppHelper.config.root}/public/kibana"
+      end
+
+      def valid_kibana_path? path
+        File.exists? "#{path}/index.html"
+      end
+
+      def deploy_reports
+        kibana_reports_source.each do |report_file|
+          EasyAppHelper.puts_and_logs " - Installing '#{report_file}' to '#{kibana_dashboards_path}'"
+          options = {}
+          FileUtils.cp report_file, kibana_dashboards_path, options
+        end
+      end
+
+      def serve_ui(port=EasyAppHelper.config[:server_port])
+        require 'webrick'
+        port ||= EasyAppHelper.config[:server_port]
+        WEBrick::HTTPServer.new(:Port => port, :DocumentRoot => kibana_path).start
+      end
+
+      def kibana_info
+        if valid_kibana_path?(kibana_path)
+          EasyAppHelper.puts_and_logs "A valid Kibana install has been found in #{kibana_path}"
+        else
+          raise <<EOM
+No Kibana installation found in '#{kibana_path}'.
+  You may want to update 'kibana_path' in your config to be able to use the 'deploy' target.
+
+  If Kibana is not on the machine this gem is installed you may have to manually copy files located in:
+    - #{ibl_gem_path}/config/kibana_reports
+  into your Kibana dashboards path:
+    - <place where your Kibana is installed>/app/dashboards
+
+EOM
+        end
+      end
+
+    end
+  end
+end

data/spec/elastic_search_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe InternetBoxLogger::ElasticSearch do
+
+
+end

data/spec/internet_box_logger_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+
+describe InternetBoxLogger do
+
+  subject {InternetBoxLogger}
+
+  it 'should not accept invalid parsers' do
+    expect{ subject.get_box(:stupid)}.to raise_error
+  end
+
+  it 'should accept any valid parser' do
+    InternetBoxLogger::Parsers[].each do |parser|
+      expect{ subject.get_box(parser)}.not_to raise_error
+    end
+  end
+
+  it 'should use the default box type if not provided' do
+    expect{ subject.get_box}.not_to raise_error
+  end
+
+  it 'should include a parser of the box_type specified in the constructor' do
+    parser = InternetBoxLogger::Parsers::FreeboxV5Parser
+    box = subject.get_box(parser)
+    expect( box.respond_to? :get_box_data).to be_truthy
+  end
+
+end

data/spec/parsers_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe InternetBoxLogger::Parsers do
+
+  it 'should have 1 parser' do
+    expect(subject[].length == 1).to be_truthy
+  end
+
+
+  InternetBoxLogger::Parsers[].each do |current_parser|
+
+    context "when testing '#{current_parser}' parser" do
+
+      subject {
+        s = Object.new
+        s.extend current_parser
+        s
+      }
+
+      it 'should parse an url' do
+        expect{ subject.get_box_data}.not_to raise_error
+      end
+
+      it 'should feed attributes' do
+        subject.get_box_data
+        expect(subject.attributes.nil?).to be_falsey
+        expect(subject.attributes.empty?).to be_falsey
+      end
+
+      it 'should use all regexp during parsing'  do
+        expect(subject.get_box_data).not_to be_nil
+      end
+
+      it 'should export data as an array' do
+        subject.get_box_data
+        expect(subject.as_es_documents is_a? Array).to be_truthy
+      end
+
+      it 'should have many up/down documents and one info' do
+        subject.get_box_data
+        docs = subject.as_es_documents
+        up, down, info, unknown = 0, 0, 0, 0
+        docs.each do |doc|
+          case doc[:type]
+            when 'up'
+              up += 1
+            when 'down'
+              down += 1
+            when :info
+              info += 1
+            else
+              unknown += 1
+          end
+        end
+        expect(up == down).to be_truthy
+        expect(info == 1).to be_truthy
+        expect(unknown == 0).to be_truthy
+      end
+
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+
+require 'internet_box_logger'
+EasyAppHelper.config.script_filename = File.expand_path '../../config/internet_box_logger.conf', __FILE__
+EasyAppHelper.config[:freebox_alternate_url] = File.expand_path '../../test/freebox_page_example.txt', __FILE__
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/test/freebox_page_example.txt

@@ -0,0 +1,103 @@
+______________________________________________________________________
+
+                      Etat de la Freebox                           
+______________________________________________________________________
+
+
+Informations générales :
+========================
+
+  Modèle                         Freebox ADSL            
+  Version du firmware            1.5.20                  
+  Mode de connection             Dégroupé                
+  Temps depuis la mise en route  12 jours, 16 heures, 27 minutes
+
+
+Téléphone :
+===========
+
+  Etat                           Ok                      
+  Etat du combiné                Raccroché               
+  Sonnerie                       Inactive                
+
+
+Adsl :
+======
+
+  Etat                           Showtime                
+  Protocole                      ADSL2+                  
+  Mode                           Interleaved             
+
+                         Descendant         Montant           
+                         --                 --                
+  Débit ATM              8949 kb/s          1025 kb/s         
+  Marge de bruit         5.20 dB            7.30 dB           
+  Atténuation            30.50 dB           15.30 dB          
+  FEC                    1190251            1771272           
+  CRC                    2338               0                 
+  HEC                    120                149402            
+
+ Journal de connexion adsl :
+ ---------------------------
+
+  Date                   Etat               Débit (kb/s)      
+  --                     --                 --                
+  Mise en route          Connexion          10292 / 1025      
+
+
+Wifi :
+======
+
+  Etat                           WiFi désactivé          
+  Modèle                         Ralink RT2880           
+  Canal                          3                       
+  État du réseau                 Désactivé               
+  FreeWifi                       Désactivé               
+  FreeWifi Secure                Désactivé               
+
+
+Réseau :
+========
+
+  Adresse MAC Freebox            12:34:56:78:9A:BC
+  Adresse IP                     88.111.111.111
+  IPv6                           Désactivé               
+  Mode routeur                   Activé                  
+  Adresse IP privée              192.168.0.254         
+  Adresse IP DMZ                 192.168.0.0           
+  Adresse IP Freeplayer          192.168.0.2           
+  Réponse au ping                Activé                  
+  Proxy Wake On Lan              Désactivé               
+  Serveur DHCP                   Activé                  
+  Plage d'adresses dynamique     192.168.0.10 - 192.168.0.50
+
+ Attributions dhcp :
+ -------------------
+
+  Adresse MAC            Adresse IP                  
+  --                     --                          
+  01:23:45:67:89:AB      192.168.0.10
+
+ Redirections de ports :
+ -----------------------
+
+  Protocole              Port source    Destination    Port destination
+  --                     --             --             --            
+  UDP                    12345          192.168.0.10 2222
+
+ Redirections de plage de ports :
+ --------------------------------
+
+  Protocole              Destination        Plage de redirection
+  --                     --                 --                
+  TCP                    192.168.0.10     6881 - 6889       
+
+ Interfaces réseau :
+ -------------------
+
+                         Lien           Débit entrant  Débit sortant 
+                         --             --             --            
+  WAN                    Ok             0 ko/s         0 ko/s        
+  Ethernet                              0 ko/s         0 ko/s        
+  USB                    Non connecté                                
+  Switch                 100baseTX-FD   0 ko/s         308 ko/s      

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: internet_box_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Laurent B
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  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: pry
+  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: activesupport
+  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: whenever
+  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: easy_app_helper
+  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: elasticsearch
+  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'
+description: Logs information gathered from your internet box and stores into ElasticSearch
+  for display into Kibana.
+email:
+- lbnetid+gh@gmail.com
+executables:
+- internet_box_logger
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/internet_box_logger
+- config/internet_box_logger.conf
+- config/kibana_reports/FreeboxV5_report.json
+- config/schedule.rb
+- internet_box_logger.gemspec
+- lib/internet_box_logger.rb
+- lib/internet_box_logger/elastic_search.rb
+- lib/internet_box_logger/generic_box.rb
+- lib/internet_box_logger/parsers.rb
+- lib/internet_box_logger/parsers/freebox_v5_parser.rb
+- lib/internet_box_logger/parsers/utils.rb
+- lib/internet_box_logger/version.rb
+- lib/tasks/cron.rb
+- lib/tasks/elastic_search.rb
+- lib/tasks/file.rb
+- lib/tasks/internet_box_logger_tasks.rake
+- lib/tasks/internet_box_logger_tasks.rb
+- lib/tasks/kibana.rb
+- spec/elastic_search_spec.rb
+- spec/internet_box_logger_spec.rb
+- spec/parsers_spec.rb
+- spec/spec_helper.rb
+- test/freebox_page_example.txt
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Monitor your internet box.
+test_files:
+- spec/elastic_search_spec.rb
+- spec/internet_box_logger_spec.rb
+- spec/parsers_spec.rb
+- spec/spec_helper.rb
+- test/freebox_page_example.txt