log_aggregator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a893c3bac14478e549eaad2cdf0f4d03d1e9423a61562d4fb97a875e8912d664
+  data.tar.gz: 155279de2519b3faa6326c142f9abb72e5ee1e834b0e06a722c133a5c407bb91
+SHA512:
+  metadata.gz: 0e4dce7af142dd402842a23866deae9c4b9a624204cfcb8f5231a42587c4d50fdfb37b156595effc821853ca317e9ba3d874e205b6077c8d0b019a863f9365cf
+  data.tar.gz: 1960454b2cab71075bbd4d63eb872252e2cfa9074b5290b439bf55d5f62f205dd81763835a650990a007c69fd278706d44700e534ff8c14999ef82ee20d9b09d

data/README.md

@@ -0,0 +1,56 @@
+# Parser
+
+Test app for SP: log files parser.
+Parses a log file and returns information regarding total visits and unique visits count.
+
+## Installation
+
+This Parser app uses ruby 2.6.
+Steps to install:
+  * git clone https://github.com/natonnelier/ruby_app.git
+  * cd ruby_app && bundle install
+
+## Usage
+
+### List pages with most views in descending order:
+```shell
+rake parse:visits webserver.log #or my-file-path.log
+```
+
+Prints:
+```
+/about/2 90 visits
+/contact 89 visits
+/index 82 visits
+/about 81 visits
+/help_page/1 80 visits
+/home 78 visits
+```
+
+### List pages with most unique page views in descending order:
+```shell
+rake parse:unique webserver.log #or my-file-path.log
+```
+
+Prints:
+```
+/help_page/1 23 unique views
+/contact 23 unique views
+/home 23 unique views
+/index 23 unique views
+/about/2 22 unique views
+/about 21 unique views
+```
+
+### To run tests:
+```shell
+rspec spec
+```
+or
+```shell
+bundle exec rspec spec
+```
+or
+```shell
+rake spec
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+begin
+  Dir["lib/**/*.rb"].each { |f| require_relative(f) }
+  Dir["lib/tasks/*.rake"].each { |f| load(f) }
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: %w[lint spec]
+rescue LoadError
+  # no rspec available
+end

data/lib/parser.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Main module
+module Parser
+end

data/lib/parser/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "exceptions"
+require_relative "reader"
+
+module Parser
+  class Client
+    attr_reader :file, :options, :data
+
+    def self.parse(file, options = {})
+      new(file, options).parse
+    end
+
+    def initialize(file, options = {})
+      @file = file
+      @options = options
+    end
+
+    def parse
+      read_file
+      print_data
+    end
+
+    private
+
+    def read_file
+      @data ||= ::Parser::Reader.new(file).call
+    rescue InvalidExtensionException, FileNotFoundException => e
+      abort e.message
+    end
+
+    def print_data
+      ::Parser::Presenter.new(data, options).call
+    end
+  end
+end

data/lib/parser/exceptions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Abstract exceptions raised from Error
+module Parser
+  class Error < StandardError; end
+  class FileNotFoundException < StandardError; end
+  class InvalidExtensionException < StandardError; end
+end

data/lib/parser/formats/average.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'base'
+
+module Formats
+  class Average < Base
+    def call
+      output_data
+    end
+
+    private
+
+    def output_data
+      sorted_data.each do |path, ips|
+        puts "#{path} average #{average(ips)}"
+      end
+    end
+
+    def average(ips)
+      ips.size.to_f / ips.uniq.size
+    end
+  end
+end

data/lib/parser/formats/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Formats
+  class Base
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    private
+
+    def sorted_data
+      data.sort_by { |_, ips| -ips.size }
+    end
+
+    def output_data
+      sorted_data.each do |path, ips|
+        puts "#{path} #{ips.size} #{description}"
+      end
+    end
+  end
+end

data/lib/parser/formats/unique_visit.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Formats
+  class UniqueVisit < Base
+    def call
+      ips_uniq!
+      output_data
+    end
+
+    private
+
+    def ips_uniq!
+      data.each { |_, ips| ips.uniq! }
+    end
+
+    def description
+      "unique views"
+    end
+  end
+end

data/lib/parser/formats/visit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Formats
+  class Visit < Base
+    def call
+      output_data
+    end
+
+    private
+
+    def description
+      "visits"
+    end
+  end
+end

data/lib/parser/presenter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Parser
+  class Presenter
+    attr_accessor :data, :options
+
+    def initialize(data, options = {})
+      @data = data
+      @options = options
+    end
+
+    def call
+      output_formatted_data
+    end
+
+    private
+
+    def format_class
+      return Formats::Average if options[:average]
+      return Formats::UniqueVisit if options[:unique]
+      Formats::Visit
+    end
+
+    def output_formatted_data
+      format_class.new(data).call
+    end
+  end
+end

data/lib/parser/reader.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Parser
+  class Reader
+    VALID_EXTENSIONS = %w[.log .txt].freeze
+
+    attr_accessor :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def call
+      validate_presence
+      validate_extension
+      aggregate
+    end
+
+    private
+
+    def validate_extension
+      unless VALID_EXTENSIONS.include? File.extname(file)
+        raise InvalidExtensionException, "File has to be .log or .txt"
+      end
+    end
+
+    def validate_presence
+      raise FileNotFoundException, "File not found" unless file && File.exist?(file)
+    end
+
+    def file_lines
+      @file_lines ||= File.readlines file
+    end
+
+    def aggregate
+      data = Hash.new { |h, key| h[key] = [] }
+      file_lines.each do |line|
+        path, ip = line.split
+        data[path] << ip
+      end
+      data
+    end
+  end
+end

data/lib/tasks/parser.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+namespace :parse do |args|
+  options = {}
+  file = ARGV[1]
+
+  task :visits do
+    Parser::Client.parse(file)
+  end
+
+  task :unique do
+    options[:unique] = true
+    Parser::Client.parse(file, options)
+  end
+
+  task :average do
+    options[:average] = true
+    Parser::Client.parse(file, options)
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: log_aggregator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Nicolas Tonnelier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-05 00:00:00.000000000 Z
+dependencies: []
+description: Parse and count requests by endpoints
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/parser.rb
+- lib/parser/client.rb
+- lib/parser/exceptions.rb
+- lib/parser/formats/average.rb
+- lib/parser/formats/base.rb
+- lib/parser/formats/unique_visit.rb
+- lib/parser/formats/visit.rb
+- lib/parser/presenter.rb
+- lib/parser/reader.rb
+- lib/tasks/parser.rake
+homepage: https://rubygems.org/gems/log_aggregator
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Log Parser and Aggregator
+test_files: []