weblog-parser 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 213d9f51148d7c7c5201648b8409c9996c8fa6250bc7256766029e2973989c9a
-  data.tar.gz: fb7e70f03efcf6d711133731ee759702a3639dba7d6117eaff28afd8e7c06d20
+  metadata.gz: a39ee84c80475a33bf073af960a42f30517bb881d273367779d31fb124d16d9a
+  data.tar.gz: 2bcb4ff7114711eb946b6843a510a525545045111689ad00a77100f66fd8eaa6
 SHA512:
-  metadata.gz: dcd77fe9ae16abbea86aa980d93bc98a6ada1bd9999e84752a45057dfc0eb5da7e9355e224e7ff07c58d3cfb0bff1a0cea62b7aa7c210b851067b739ab7ac56c
-  data.tar.gz: 542e1293a56caeceff20eca7487998a973ac3f69b13dae306197479fb725c907f9bc5b1c85797b7467340dc1a910ab6dcd8702b72dbf4c5d6f66b78c8299f63b
+  metadata.gz: 342d756d1a9e37afdaedd26cdeda7dae52301e18989172500bb612cb1c9e1fe72add609ff4ccbe73713328fb2ca34e59f754ee49fb106aa0c4aaae7d7e97be3f
+  data.tar.gz: 210d60841f0fdf4957f06998f5a4ccb52ceda56d02c15e2477bf246f49f4baf534f7dfa16b59df4accb5aef51b8e407f34a0bfdba40434bc2cb40daa66fad6fd

data/README.md

@@ -1,4 +1,4 @@
-# Webserver Log Parser - Readme
+# WebLog Parser - Readme
 
 ## Installing
 
@@ -6,20 +6,34 @@
 
 ## Usage
 
-wlparser reads a webserver logfile and counts page visits and unique page views.
-It uses a command-line interface.
+WebLog Parser reads a webserver logfile and counts page visits and unique page
+views.  It uses a command-line interface.
+
+### Getting Started
+
+An example log file can be found at https://tinyurl.com/ve8x3qs
+You can download this file and name it 'weblog.log'.
+Then run the command:
+
+  `wlparser -i -f weblog.log`
+
+This will read the log file and validates either ip4 or ip6 addresses.  The file
+contains both, so if you don't use the -i option, it will show some errors as
+the default is ip4.
+
+### Options
 
   `wlparser -h`
   `wlparser --help`
 
 Shows a list of options
 
-  `wlparser -f logfile.log`
+  `wlparser -f logfile.log`  
   `wlparser --file logfile.log`
 
 Reads a log file and display results:
 
-  `wlparser -m 'logfile1.log logfile2.log'`
+  `wlparser -m 'logfile1.log logfile2.log'`  
   `wlparser --multiple_files 'logfile1.log logfile2.log'`
 
 Reads a list of log files in quotes and displays results.  All files give
@@ -83,7 +97,7 @@ Validates ip addresses using ip6 format.
  `wlparser -6`
  `wlparser --ip4ip6_validation`
 
-Validates ip addresses if it matches either ip4 or ip6 format.
+Validates ip addresses if they matches either ip4 or ip6 format.
 
  `wlparser -I`
  `wlparser --no_ip_validation`
@@ -103,7 +117,7 @@ Does not validate webpage path, assumes they are all valid.
  `wlparser -r`
  `wlparser --remove_invalid`
 
-Ignore logs in files if either ip address or path is invalid.
+Ignore logs if either ip address or path is invalid.
 
  `wlparser -R`
  `wlparser --warn_invalid`
@@ -129,7 +143,7 @@ Displays unique page views in results and in text file output (default).
   `wlparser -U`
   `wlparser --no_unique_page_views`
 
-Displays page visits in results and in text file output (default).
+Does not display unique page views in results or text file output (default).
 
 ##Log Format
 
@@ -141,8 +155,7 @@ Example log with ip4 address:
 
 Logs can use either using ip4 addresses or ip6 addresses.  
 
-ip4 addresses should be valid i.e. between 0.0.0.0 and 255.255.255.255, although
-you can skip this check.
+ip4 addresses should be valid i.e. between 0.0.0.0 and 255.255.255.255, although you can skip this check.
 
 Example log with ip6 address:
   `\webpage\index 1234:1234:1234:1234:1234:1234:1234:1234`
@@ -153,10 +166,12 @@ ip6 addresses can be compressed e.g.
 
 ## Testing
 
-Tests can be run using:
+Tests can be run from the cloned repository using:
 
   `rake test`
 
+The git repository is: https://github.com/davidmorton0/WebLogParser
+
 Tests have been separated into
 * unit tests - test methods in each class
 * integration tests - test the whole app
@@ -176,7 +191,8 @@ Note that the dependencies to Constants are not shown.
 ### Classes
 
 * Parser - Holds the log information and changes the format
-* LogReader - Loads files then reads logs.  Validates logs, ip addresses and paths
+* LogReader - Loads files then reads logs.  Validates logs, ip addresses and
+paths
 * ipValidator - Validates ip addresses
 * PathValidator - Validates the path for the webpage
 * OptionHandler - Sets the options from the command line arguments given

data/lib/log_parser/version.rb

@@ -2,5 +2,5 @@
 
 # Stores version number
 module LogParser
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/weblog_parser.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["davidmorton0@gmail.com"]
 
   spec.summary       = %q{A command line parser for web server logs}
-  spec.homepage      = "https://github.com/davidmorton0/LogParser"
+  spec.homepage      = "https://github.com/davidmorton0/WebLogParser"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
     #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
     #spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/davidmorton0/LogParser"
+    spec.metadata["source_code_uri"] = "https://github.com/davidmorton0/WebLogParser"
     #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
   else
     raise "RubyGems 2.0 or newer is required to protect against " \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weblog-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Morton
@@ -84,11 +84,11 @@ files:
 - lib/log_parser/version.rb
 - lib/log_parser/warning_handler.rb
 - weblog_parser.gemspec
-homepage: https://github.com/davidmorton0/LogParser
+homepage: https://github.com/davidmorton0/WebLogParser
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/davidmorton0/LogParser
+  source_code_uri: https://github.com/davidmorton0/WebLogParser
 post_install_message: 
 rdoc_options: []
 require_paths: