sp_log_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b997ede7f1b2e48a507221cd26b4e40e2d97e795dcf88f506c50120cc54e7f01
+  data.tar.gz: 261287d351523587ffe68f07d5487322c8fa9e999412679a3ec9c464a68a6bcc
+SHA512:
+  metadata.gz: 0e6577baa1328d2ccb9a083c768d617ef2c0b40c8353b42b900c4254de1e0eb238ca8990dc848cf3c893a9b8931cf4f6b7b0025bd435b0b6fef21104182a983f
+  data.tar.gz: fe02182186e706b561a84208b3c0b6d98ec3984b1701dc65a3e5592413b5475d9316442d76529520dfbb888c14818f703ea362be7705da2fd444b6512fd2b3ac

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    sp_log_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sp_log_parser!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mario Zugaj
+
+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,60 @@
+# LogParser
+
+Simple log parser for you webserver logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sp_log_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sp_log_parser
+
+## Usage
+
+Execute the following to parse your log file and display visit statistics:
+
+```shell
+$ bundle exec exe/parser $PATH_TO_YOUR_LOG_FILE
+```
+
+You will get output similar to this:
+```
+--------Views--------------
+/help_page/1 => 5 views
+/home => 2 views
+/contact => 2 views
+/about => 1 view
+/index => 1 view
+/about/2 => 1 view
+-----Unique Views----------
+/help_page/1 => 5 unique views
+/home => 2 unique views
+/about => 1 unique view
+/index => 1 unique view
+/about/2 => 1 unique view
+/contact => 1 unique view
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/mariozugaj/sp-log-parser.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sp_log_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/parser

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'sp_log_parser'
+raw_logs = File.readlines(ARGV[0])
+visits = Parser.parse(raw_logs)
+stats = Stats.new(visits)
+puts "--------Views--------------"
+StatsDisplay.display(stats.views)
+puts "-----Unique Views----------"
+StatsDisplay.display(stats.unique_views, unique: true)

data/lib/sp_log_parser.rb

@@ -0,0 +1,10 @@
+require "sp_log_parser/version"
+require "sp_log_parser/visits"
+require "sp_log_parser/visit"
+require "sp_log_parser/stats"
+require "sp_log_parser/stats_display"
+require "sp_log_parser/parser"
+
+module SPLogParser
+
+end

data/lib/sp_log_parser/parser.rb

@@ -0,0 +1,11 @@
+class Parser
+  def self.parse(logs)
+    return if logs.empty?
+
+    visits = Visits.new
+    logs.inject(visits) do |visits_bucket, log_entry|
+      visits_bucket << Visit.new(log_entry.strip)
+    end
+    visits
+  end
+end

data/lib/sp_log_parser/stats.rb

@@ -0,0 +1,31 @@
+class Stats
+  Stat = Struct.new(:webpage, :views)
+
+  attr_reader :visits
+
+  def initialize(visits)
+    @visits = visits
+  end
+
+  def views
+    visits.unique_webpages.map do |webpage|
+      Stat.new(webpage, views_for(webpage).size)
+    end
+  end
+
+  def unique_views
+    visits.unique_webpages.map do |webpage|
+      Stat.new(webpage, unique_views_for(webpage).size)
+    end
+  end
+
+  private
+
+  def views_for(webpage)
+    visits.for(webpage)
+  end
+
+  def unique_views_for(webpage)
+    views_for(webpage).uniq { |visit| visit.ip_address }
+  end
+end

data/lib/sp_log_parser/stats_display.rb

@@ -0,0 +1,21 @@
+class StatsDisplay
+  class << self
+    def display(stats, unique: false)
+      sorted_stats(stats).each do |stat|
+        puts "#{stat.webpage} => #{pluralize(stat.views, unique)}"
+      end
+    end
+
+    private
+
+    def sorted_stats(stats)
+      stats.sort_by(&:views).reverse
+    end
+
+    def pluralize(count, unique)
+      word = count == 1 ? "view" : "views"
+
+      [(count || 0), ("unique" if unique), word].compact.join(" ")
+    end
+  end
+end

data/lib/sp_log_parser/version.rb

@@ -0,0 +1,3 @@
+module SPLogParser
+  VERSION = "0.1.0"
+end

data/lib/sp_log_parser/visit.rb

@@ -0,0 +1,25 @@
+class Visit
+  attr_reader :log_entry
+
+  def initialize(log_entry)
+    @log_entry = log_entry
+  end
+
+  def ==(other)
+    log_entry == other.log_entry
+  end
+
+  def webpage
+    parsed_log[0]
+  end
+
+  def ip_address
+    parsed_log[1]
+  end
+
+  private
+
+  def parsed_log
+    log_entry.split("\s")
+  end
+end

data/lib/sp_log_parser/visits.rb

@@ -0,0 +1,25 @@
+class Visits
+  attr_reader :bucket
+
+  def initialize
+    @bucket = []
+  end
+
+  def <<(visit)
+    @bucket << visit
+  end
+
+  def unique_webpages
+    @unique_webpages ||= webpages.uniq
+  end
+
+  def for(webpage)
+    @bucket.select { |visit| visit.webpage == webpage }
+  end
+
+  private
+
+  def webpages
+    @bucket.map(&:webpage)
+  end
+end

data/sp_log_parser.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/sp_log_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sp_log_parser"
+  spec.version       = SPLogParser::VERSION
+  spec.authors       = ["Mario Zugaj"]
+  spec.email         = ["mario@mariozugaj.com"]
+
+  spec.summary       = %q{Simple parser for webserver logs.}
+  spec.homepage      = "https://gitlab.com/mariozugaj/sp-log-parser"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/mariozugaj/sp-log-parser"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: sp_log_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Zugaj
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-16 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- mario@mariozugaj.com
+executables:
+- parser
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/parser
+- lib/sp_log_parser.rb
+- lib/sp_log_parser/parser.rb
+- lib/sp_log_parser/stats.rb
+- lib/sp_log_parser/stats_display.rb
+- lib/sp_log_parser/version.rb
+- lib/sp_log_parser/visit.rb
+- lib/sp_log_parser/visits.rb
+- sp_log_parser.gemspec
+homepage: https://gitlab.com/mariozugaj/sp-log-parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/mariozugaj/sp-log-parser
+  source_code_uri: https://gitlab.com/mariozugaj/sp-log-parser
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Simple parser for webserver logs.
+test_files: []