bind_log_analyzer 0.1.0 → 0.1.1

data/lib/bind_log_analyzer.rb

@@ -1,6 +1,8 @@
 require "bind_log_analyzer/version"
 require "bind_log_analyzer/base"
 
+# BindLogAnalyzer analyzes a Bind query log file, parses the logs and store them in
+# a database. The database choise is "limited" to the databases supported by ActiveRecord.
 module BindLogAnalyzer
 
 end

data/lib/bind_log_analyzer/base.rb

@@ -3,11 +3,22 @@ require 'bind_log_analyzer/connector'
 require 'models/log'
 
 module BindLogAnalyzer
+  # The main class of the BindLogAnalyzer module
   class Base
     include BindLogAnalyzer::Connector
 
-    attr_reader :log_filename, :database_confs
+    # @attribute [r]
+    # @return [String] The file containing the logs to be analyzed
+    attr_reader :log_filename
+    # @attribute [r]
+    # @return [Hash] The hash containing the database params and credentials
+    attr_reader :database_confs
     
+    # The constructor of BindLogAnalyzer::Base sets some vars and manages the setup of the database
+    # @param [Hash, String] database_confs The path to the database configurations file or a hash containing such informations
+    # @param [String] logfile The path to the file containing the Bind's logs to analyze
+    # @param [true, false] setup_database A flag which indicates whether to launch the database migration
+    # @param [Integer] log_level The level of the log requested by the user
     def initialize(database_confs = nil, logfile = nil, setup_database = false, log_level = 0)
       if database_confs
         if database_confs.instance_of?(Hash)
@@ -35,14 +46,21 @@ module BindLogAnalyzer
       setup_db(@database_confs, setup_database, log_level)
     end
 
+    # Sets the path to the log file checking if exists
+    # @param [String] logfile The path to the file containing the Bind's logs to analyze
     def logfile=(logfile)
       @log_filename = logfile if FileTest.exists?(logfile)
     end
 
+    # Returns the path to the Bind's log file
+    # @return [String] The path to the Bind's log file
     def logfile
       @log_filename
     end
 
+    # Parses a log line and creates a hash with the informations
+    # @param [String] line The query log line to parse
+    # @return [Hash, false] The hash containing the parsed line or false if the line couldn't be parsed
     def parse_line(line)
       query = {}
       regexp = %r{^(\d{2}-\w{3}-\d{4}\s+\d{2}:\d{2}:\d{2}\.\d{3})\s+client\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})#\d+:\s+query:\s+(.*)\s+IN\s+(\w+)\s+\+\s+\((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\)$}
@@ -65,11 +83,16 @@ module BindLogAnalyzer
       end
     end
 
+    # Stores the parsed log line into the database. Increments @stored_queries if successful
+    # @param [Hash] query The log line parsed by #parse_line
     def store_query(query)
       log = Log.new(query)
       @stored_queries += 1 if log.save
     end
 
+    # The main method used to manage the analysis operations.
+    # Opens the log file and passes wvery line to #parse_line and #store_query
+    # @return [true, false] False if there's a problem with the log file. True elsewhere.
     def analyze
       return false unless @log_filename
       
@@ -82,6 +105,7 @@ module BindLogAnalyzer
         end
       end
       puts "Analyzed #{lines} lines and correctly stored #{@stored_queries} logs"
+      return true
     end
   end
 end

data/lib/bind_log_analyzer/connector.rb

@@ -2,8 +2,14 @@ require 'active_record'
 require 'logger'
 
 module BindLogAnalyzer
+  # The module which provides connection facility
   module Connector
 
+    # Main connection method which connects to the database, launches migrations if requested,
+    # loads the Log ActiveRecord model and setups the logger.
+    # @param [Hash] database_params The database params and credentials
+    # @param [true, false] setup_database If true launches the migrations of the database
+    # @param [Integer] log_level The log level to setup the Logger
     def setup_db(database_params, setup_database = false, log_level = 0)
       @database_params = database_params
       
@@ -12,6 +18,7 @@ module BindLogAnalyzer
       migrate_tables if setup_database
 
       self.load_environment
+
       if log_level > 0
         
         log_level_class = {
@@ -26,20 +33,25 @@ module BindLogAnalyzer
       end
     end
 
+    # Launches ActiveRecord migrations
     def migrate_tables
       ActiveRecord::Migration.verbose = true
       migrations_dir = File.join(File.dirname(__FILE__), '..', '..', 'db/migrate')
       ActiveRecord::Migrator.migrate migrations_dir
     end
 
+    # Establishes the connection to the database
     def connect
       ActiveRecord::Base.establish_connection(@database_params)
     end
 
+    # Shows the status of the connection to the database
+    # @return [true, false] The status of the connection to the database
     def connected?
       ActiveRecord::Base.connected?
     end
 
+    # Loads the ActiveRecord models
     def load_environment
       Dir.glob('./lib/models/*').each { |r| require r }
     end

data/lib/bind_log_analyzer/exceptions.rb

@@ -1,4 +1,5 @@
 module BindLogAnalyzer
+  # A custom exception to be raise when database configurations are wrong
   class DatabaseConfsNotValid < Exception
   end
 end

data/lib/bind_log_analyzer/version.rb

@@ -1,3 +1,4 @@
 module BindLogAnalyzer
-  VERSION = "0.1.0"
+  # @return [String] The version of the gem
+  VERSION = "0.1.1"
 end

data/lib/models/log.rb

@@ -1,2 +1,3 @@
+# The Log object represents a log line of a Bind's query
 class Log < ActiveRecord::Base
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bind_log_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &8286660 !ruby/object:Gem::Requirement
+  requirement: &11066420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8286660
+  version_requirements: *11066420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8286020 !ruby/object:Gem::Requirement
+  requirement: &11065980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8286020
+  version_requirements: *11065980
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &8285380 !ruby/object:Gem::Requirement
+  requirement: &11065540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8285380
+  version_requirements: *11065540
 description: BindLogAnalyzer analyzes a Bind query log file and stores it's data into
   a SQL database (ActiveRecord is used for this feature)
 email:
@@ -60,7 +60,26 @@ files:
 - bin/bind_log_analyzer
 - bind_log_analyzer.gemspec
 - db/migrate/20120329151738_create_logs.rb
+- doc/BindLogAnalyzer.html
+- doc/BindLogAnalyzer/Base.html
+- doc/BindLogAnalyzer/Connector.html
+- doc/BindLogAnalyzer/DatabaseConfsNotValid.html
+- doc/Log.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
 - doc/database.yml
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - doc/update_bind_log_analyzer.sh
 - lib/bind_log_analyzer.rb
 - lib/bind_log_analyzer/base.rb
@@ -99,3 +118,4 @@ test_files:
 - spec/bind_log_analyzer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+has_rdoc: