log_analysis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7fb0868a486b07e30af1c5ce0d53a43bd92989c8c9aab417765363411f8de0b
+  data.tar.gz: 574d9810423c48fc9a51b5ee3b8fc574495578c9a4595582ff34f26b4ed4f9c0
+SHA512:
+  metadata.gz: 6185a37524183582de8a0fabebcb6d9ae32655f4c384c33621414877802d1efbab0bd26310e167428a1803bf81bc4cb7da573cae3047148c4d76a249b84d3708
+  data.tar.gz: 4cb647eaa11f23c0f853942acc2fe361d4ef5b2e27e4d7764228197e6e2174ecb9d599725a069e6bcbd69461b873046f98b3b649f71a3d7cd374f230d1a46f04

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mictran205@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in log_analysis.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    log_analysis (0.1.0)
+      activesupport (~> 6.0.3.1)
+      useragent (~> 0.16.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    rake (12.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    useragent (0.16.10)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  log_analysis!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Michael Tran
+
+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,44 @@
+# LogAnalysis
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/log_analysis`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_analysis'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install log_analysis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 GitHub at https://github.com/[USERNAME]/log_analysis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/log_analysis/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LogAnalysis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/log_analysis/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "log_analysis"
+
+# 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/lib/log_analysis.rb

@@ -0,0 +1,29 @@
+require 'log_analysis/version'
+require 'log_analysis/preprocess'
+require 'log_analysis/user_identification'
+require 'log_analysis/session_identification'
+
+class LogAnalysis
+  class Error < StandardError; end
+  # Your code goes here...
+
+  attr_reader :path, :origin_logs
+
+  def initialize(path, type = nil)
+    @path        = path
+    @type        = type
+    @origin_logs = PreProcess.input(path, type)
+  end
+
+  def cleaned_data
+    PreProcess.data_cleaning(@origin_logs)
+  end
+
+  def identified_user
+    UserIdentification.execute(cleaned_data)
+  end
+
+  def identified_session
+    SessionIdentification.execute(cleaned_data)
+  end
+end

data/lib/log_analysis/model/record.rb

@@ -0,0 +1,84 @@
+require 'ipaddr'
+require 'useragent'
+require 'log_analysis/model/user_identity'
+require 'active_support/core_ext/numeric/time'
+
+class Record
+  attr_accessor :time,
+                :host,
+                :status,
+                :size,
+                :request_length,
+                :req,
+                :method,
+                :uri,
+                :referer,
+                :ua,
+                :reqtime,
+                :runtime,
+                :apptime,
+                :cache,
+                :vhost,
+                :user,
+                :forwardedfor,
+                :forwardedproto
+
+  attr_reader   :params
+
+  DATA_TYPE = %w[.txt .json .js .css .jpg .jpeg .gif .woff2 .ico .png .bmp .mp3 .wav .avi .mpeg .vmw .mpg .map .pdf .doc .svg].freeze
+  REGEX_BOT = /facebookexternalhit|Mediapartners-Google|AWS|-|Crawler|spider|Detection/.freeze
+
+  def initialize(params)
+    @params = params
+    record_params.keys.each { |key| instance_variable_set("@#{key}", record_params[key]) }
+  end
+
+  def status_200?
+    status == 200
+  end
+
+  def method_get?
+    method == 'GET'
+  end
+
+  def uri_without_data
+    return false if uri.nil? || uri.end_with?(*DATA_TYPE)
+
+    true
+  end
+
+  def robot?
+    ua.bot? || ua.to_s.match?(REGEX_BOT)
+  end
+
+  private
+
+  def record_params
+    {}.tap do |p|
+      p['time']           = Time.parse(@params['time'].split.first.sub(/:/, ' ')) || nil
+      p['host']           = IPAddr.new(@params['host'])
+      p['status']         = @params['status'].to_i || 0
+      p['size']           = @params['size'].to_i || 0
+      p['request_length'] = @params['request_length'].to_i || 0
+      p['req']            = validate_string(@params['req'])
+      p['method']         = validate_string(@params['method'])
+      p['uri']            = validate_string(@params['uri'])
+      p['referer']        = validate_string(@params['referer'])
+      p['ua']             = UserAgent.parse(@params['ua'])
+      p['reqtime']        = @params['reqtime'].to_f
+      p['runtime']        = @params['runtime'].to_f
+      p['apptime']        = @params['apptime'].to_f
+      p['cache']          = validate_string(@params['cache'])
+      p['vhost']          = validate_string(@params['vhost'])
+      p['user']           = UserIdentity.new(host: IPAddr.new(@params['host']), user_agent: UserAgent.parse(@params['ua']))
+      p['forwardedfor']   = validate_string(@params['forwardedfor'])
+      p['forwardedproto'] = validate_string(@params['forwardedproto'])
+    end
+  rescue IPAddr::InvalidAddressError => e
+    puts e
+  end
+
+  def validate_string(value)
+    value == '-' ? nil : value
+  end
+end

data/lib/log_analysis/model/session_identity.rb

@@ -0,0 +1,8 @@
+class SessionIdentity
+  attr_accessor :user, :records
+
+  def initialize(params)
+    @user    = params[:user]
+    @records = params[:records]
+  end
+end

data/lib/log_analysis/model/user_identity.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/module/delegation'
+require 'useragent'
+
+class UserIdentity
+  attr_accessor :host, :user_agent
+
+  delegate :browser, :version, :os, :platform, :mobile?, :application, :localization, to: :user_agent
+
+  def initialize(params)
+    @host       = params[:host]
+    @user_agent = params[:user_agent]
+  end
+end

data/lib/log_analysis/preprocess.rb

@@ -0,0 +1,75 @@
+require 'log_analysis/model/record'
+require 'json'
+require 'pry'
+
+module PreProcess
+  class Error < StandardError; end
+  # Your code goes here...
+
+  REGEX_KEYS   = /(time:| host:| status:| size:| request_length:| req:| method:| uri:| referer:| ua:| reqtime:| runtime:| apptime:| cache:| vhost:| server:| user:| forwardedfor:| forwardedproto:)/.freeze
+  REGEX_NGINX  = /\A^(?<host>\S*) (?<identity>\S*) (?<user>\S*) \[(?<time>[^\]]*)\] "(?<method>\S+)(?: +(?<path>[^\"]*?)(?:\s+\S*)?)?" (?<code>\S*) (?<size>\S*)(?: "(?<referer>[^\"]*)" "(?<agent>[^\"]*)"(?:\s+(?<http_x_forwarded_for>\S+))?)?$/.freeze
+  REGEX_APACHE = %r{(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) - (.{0})- \[([^\]]+?)\] "(GET|POST|PUT|DELETE) ([^\s]+?) (HTTP\/1\.1)" (\d+) (\d+) "-" "(.*)"}.freeze
+
+  CONVERT_RECORD = { 'nginx' => 'convert_nginx_logs', 'apache' => 'convert_apache_logs', 'default' => 'to_records' }.freeze
+
+  def self.input(file_path, type)
+    arr_logs = File.readlines(file_path).each_with_object([]) do |line, arr|
+      preprocess_log = type.nil? ? line.gsub(/[\t]/i, ' ').chomp! : line
+      arr.push(preprocess_log)
+    end
+
+    send(CONVERT_RECORD[type.nil? ? 'nginx' : type], arr_logs)
+  end
+
+  def self.data_cleaning(logs)
+    logs.select { |record| record.status_200? && record.method_get? && record.uri_without_data && !record.robot? }
+  end
+
+  def self.to_records(logs)
+    logs.each_with_object([]).with_index do |(log, arrays), i|
+      next if log.nil?
+
+      o = log.split(REGEX_KEYS)
+      o = o.map(&:strip)
+      o.delete('')
+
+      log = o.each_slice(2).to_a.each_with_object({}) do |pair, log_obj|
+        log_obj.merge!(to_json(pair))
+      end
+
+      arrays << Record.new(log)
+
+      puts "#{i}/#{logs.size}"
+    end
+  end
+
+  def self.convert_nginx_logs(logs)
+    logs.each_with_object([]).with_index do |(log, arrays), i|
+      next if log.nil?
+
+      o = log.split(REGEX_NGINX)
+      o.delete('')
+
+      obj = {}.tap do |p|
+        p['host']      = o[0]
+        p['user']      = o[2]
+        p['time']      = o[3]
+        p['method']    = o[4]
+        p['uri']       = o[5]
+        p['status']    = o[6]
+        p['size']      = o[7]
+        p['referer']   = o[8]
+        p['ua']        = o[9]
+        p['forwarded'] = o[10]
+      end
+
+      arrays << Record.new(obj)
+
+      puts "#{i}/#{logs.size}"
+    end
+  end
+
+  def self.to_json(pair)
+    { pair.first.delete(':') => pair.last }
+  end
+end

data/lib/log_analysis/session_identification.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext/numeric/time'
+require 'log_analysis/model/session_identity'
+
+module SessionIdentification
+  MINUTE_THRESHOLD = 10
+
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.execute(cleaned_data)
+    session_identity = []
+    cleaned_data.each do |record|
+      isession = session_identity.rindex { |s| s.user.host == record.user.host && s.user.user_agent == record.user.user_agent }
+
+      if isession.present? && validate_time_session(session_identity[isession].records.last.time, record.time)
+        session_identity[isession].records << record
+      else
+        session_identity << SessionIdentity.new(session_identity_params(record))
+      end
+    end
+
+    session_identity.map { |i| i.records.map(&:uri) }
+  end
+
+  private
+
+  def self.session_identity_params(record)
+    {}.tap do |p|
+      p[:user]    = record.user
+      p[:records] = [record]
+    end
+  end
+
+  def self.validate_time_session(last_session_record_time, time)
+    (time - last_session_record_time) / 60 < MINUTE_THRESHOLD
+  end
+end

data/lib/log_analysis/user_identification.rb

@@ -0,0 +1,15 @@
+require 'ipaddr'
+require 'log_analysis/model/user_identity'
+
+module UserIdentification
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.execute(cleaned_data)
+    data = cleaned_data.map { |record| [record.host, record.ua.to_s] }.uniq
+    data.each_with_object([]) do |record, arrs|
+      o = UserIdentity.new(host: record.first, user_agent: record.last)
+      arrs << o
+    end
+  end
+end

data/lib/log_analysis/version.rb

@@ -0,0 +1,3 @@
+class LogAnalysis
+  VERSION = '0.1.0'.freeze
+end

data/log_analysis.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/log_analysis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_analysis"
+  spec.version       = LogAnalysis::VERSION
+  spec.authors       = ["Michael Tran"]
+  spec.email         = ["mictran205@gmail.com"]
+
+  spec.summary       = 'Log Analysis for thesis Huflit'
+  spec.description   = 'Preprocess step of web mining'
+  spec.homepage      = 'https://github.com/michaelt0520/log_analysis_thesis'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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/michaelt0520/log_analysis_thesis"
+
+  spec.add_dependency "useragent", "~> 0.16.10"
+  spec.add_dependency "activesupport", "~> 6.0.3.1"
+
+  # 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,92 @@
+--- !ruby/object:Gem::Specification
+name: log_analysis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Tran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.10
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+description: Preprocess step of web mining
+email:
+- mictran205@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log_analysis.rb
+- lib/log_analysis/model/record.rb
+- lib/log_analysis/model/session_identity.rb
+- lib/log_analysis/model/user_identity.rb
+- lib/log_analysis/preprocess.rb
+- lib/log_analysis/session_identification.rb
+- lib/log_analysis/user_identification.rb
+- lib/log_analysis/version.rb
+- log_analysis.gemspec
+homepage: https://github.com/michaelt0520/log_analysis_thesis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/michaelt0520/log_analysis_thesis
+  source_code_uri: https://github.com/michaelt0520/log_analysis_thesis
+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.3
+signing_key: 
+specification_version: 4
+summary: Log Analysis for thesis Huflit
+test_files: []