syslog_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5345750d94a2130ead033c6c9a94c79d3b4729374a5a7c4562d85de25bdb0cfa
+  data.tar.gz: c683f9a8336fe5253562a076ac223e4cb9760d07f3e2a0119f02beaae28ab493
+SHA512:
+  metadata.gz: 6404d4503bab6a3ccb128bf3f22c3872cab79c342de564e5e7696278b9d96a1d8e33519af2504640f0e6458c356081f2ff465280ea5c9ada6673ade5aaae392f
+  data.tar.gz: 670e8077661e26de65cf63ac7718087be3d7ade15ddefa7a3652d0b4f90a8b818579618354c3ad497e0b8e0e722d5f1cdac31d71d9ca82e971be96138678fde3

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Linter
+      run: bundle exec standardrb
+    - name: Test
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "standardrb"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    syslog_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.1.7)
+      rubocop (= 1.18.4)
+      rubocop-performance (= 1.11.4)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standardrb
+  syslog_parser!
+
+BUNDLED WITH
+   2.2.15

data/README.md

@@ -0,0 +1,33 @@
+# SyslogParser
+
+Bare-bones syslog parser dependency-free.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syslog_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syslog_parser
+
+## Usage
+
+[See documentation](https://rubydoc.info/github/juanmanuelramallo/syslog_parser)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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 the created tag, 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/juanmanuelramallo/syslog_parser.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "syslog_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/lib/syslog_parser.rb

@@ -0,0 +1,2 @@
+require_relative "syslog_parser/version"
+require_relative "syslog_parser/parser"

data/lib/syslog_parser/parser.rb

@@ -0,0 +1,75 @@
+module SyslogParser
+  # Parses a group of syslog entries.
+  #
+  # @see https://datatracker.ietf.org/doc/html/rfc5424
+  #
+  # @example Parse a single syslog entry
+  #     SyslogParser::Parser.new(message_count: 1, body: syslog_entry).parse
+  #
+  # @example Parse a group of syslog entries
+  #     SyslogParser.new(message_count: 3, body: syslog_entries).parse
+  #
+  # Passing a message count value is particularly helpful when working with Heroku's LogPlex.
+  #
+  # @example The message count doesn't match the body
+  #     parser = SyslogParser::Parser.new(message_count: 2, body: syslog_entry)
+  #     parser.parse
+  #     parser.errors[:message_count] #=> "with 1 is inconsistent with body, missing frames to parse."
+  class Parser
+    attr_reader :message_count, :body, :errors
+
+    FRAME_REGEX = Regexp.new [
+      '<(?<priority>\d+)>',
+      '(?<syslog_version>\d) ',
+      '(?<timestamp>\S+) ',
+      '(?<host>\S+) ',
+      '(?<app_name>\S+) ',
+      '(?<process_name>\S+) ',
+      "- (?<message>.+)"
+    ].join.freeze
+
+    # @param message_count [Integer] Amount of syslog entries to parse from +body+
+    # @param body [String] A string that contains either one or several syslog entries.
+    def initialize(message_count:, body:)
+      @message_count = message_count
+      @body = body
+      @errors = {}
+    end
+
+    # Executes the parsing algorithm against the +body+.
+    #
+    # @return Array<Hash<String, String>>
+    def parse
+      body_index = 0
+      parsed_logs = message_count.times.map do |index|
+        # Overflow error
+        if body_index >= body.size
+          errors[:message_count] = "with #{message_count} is inconsistent with body, overflowed body."
+          return []
+        end
+
+        # Get frame size
+        frame = /\A(\d)+/.match(body[body_index..])[0].to_i
+
+        # Discard frame information and whitespace
+        body_index += frame.to_s.size + 1
+
+        # Get current frame
+        current_frame = body[body_index..(body_index + frame)]
+
+        # Advance pointer to the next frame
+        body_index += frame
+
+        FRAME_REGEX.match(current_frame).named_captures
+      end
+
+      # Missing frames to parse
+      if body_index != body.size
+        errors[:message_count] = "with #{message_count} is inconsistent with body, missing frames to parse."
+        return []
+      end
+
+      parsed_logs
+    end
+  end
+end

data/lib/syslog_parser/version.rb

@@ -0,0 +1,6 @@
+module SyslogParser
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].join(".")
+end

data/syslog_parser.gemspec

@@ -0,0 +1,22 @@
+require_relative "lib/syslog_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "syslog_parser"
+  spec.version = SyslogParser::VERSION
+  spec.authors = ["Juan Manuel Ramallo"]
+  spec.email = ["juanmanuelramallo@hey.com"]
+
+  spec.summary = "Syslog parser"
+  spec.description = "Syslog parser"
+  spec.homepage = "https://github.com/juanmanuelramallo/syslog_parser"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/juanmanuelramallo/syslog_parser"
+  spec.metadata["changelog_uri"] = "https://github.com/juanmanuelramallo/syslog_parser/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: syslog_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Manuel Ramallo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies: []
+description: Syslog parser
+email:
+- juanmanuelramallo@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/syslog_parser.rb
+- lib/syslog_parser/parser.rb
+- lib/syslog_parser/version.rb
+- syslog_parser.gemspec
+homepage: https://github.com/juanmanuelramallo/syslog_parser
+licenses: []
+metadata:
+  homepage_uri: https://github.com/juanmanuelramallo/syslog_parser
+  source_code_uri: https://github.com/juanmanuelramallo/syslog_parser
+  changelog_uri: https://github.com/juanmanuelramallo/syslog_parser/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Syslog parser
+test_files: []