syslog-stream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 298186ea7270b64c496829f2ef4e28b49d40c9d1
+  data.tar.gz: c14d98d672f753afdef07dafa7258e863ee15666
+SHA512:
+  metadata.gz: d9166c06f4b08ac73c277bc18d42ed72dc9e7d5f928a2d880dbb2b98f3ce58d80168d4232cb6f247ad3941b3e0dde41f67eab692993ccb20398f16bbaec64dce
+  data.tar.gz: 8a3cdf252b19a799b49405567ae00e40f098d72088e4e638ee89f4142b77f419bd08032c993a355dea8fb857c2214c3e10cd3702f7db632ee1897ea2e2c60358

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Calle Erlandsson
+
+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,93 @@
+# Syslog::Stream
+
+Parse streams of RFC5424 Syslog messages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syslog-stream"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it using gem(1):
+
+```sh
+gem install syslog-stream
+```
+
+## Usage
+
+`Syslog::Stream::OctetCountingFraming.new` should be able to accept any IO
+object.
+
+```ruby
+require "stringio"
+require "syslog/stream"
+
+io = StringIO.new(
+  '176 <165>1 2003-10-11T22:14:15.003Z mymachine.example.com evntslog - ID47 '\
+  '[exampleSDID@32473 iut="3" eventSource="Application" eventID="1011"] An '\
+  'application event log entry...181 <165>1 2003-10-11T22:14:16.003Z '\
+  'mymachine.example.com evntslog - ID48 [exampleSDID@32473 iut="3" '\
+  'eventSource="Application" eventID="1012"] Another application event log '\
+  'entry...',
+)
+
+stream = Syslog::Stream.new(Syslog::Stream::OctetCountingFraming.new(io))
+
+stream.messages do |message|
+  # The values below are for the first yield to this block. This block will be
+  # yielded to, two times in total: Once for each messsage.
+  message.prival          #=> 165
+  message.facility        #=> 20
+  message.severity        #=> 5
+  message.version         #=> 1
+  message.timestamp       #=> 2003-10-11 22:14:15 UTC
+  message.timestamp.class #=> Time
+  message.hostname        #=> "mymachine.example.com"
+  message.app_name        #=> "evntslog"
+  message.procid          #=> nil
+  message.structured_data #=> [#<struct StructuredDataElement
+  # id="exampleSDID@32473"@71, params={"iut"=>"3", "eventSource"=>"Application",
+  # "eventID"=>"1011"}>]
+  message.msg             #=> "An application event log entry..."
+end
+```
+
+### Parsing streams received via Heroku HTTPS log drains
+
+The cloud application platform [Heroku][heroku] allows it's users to register
+log drains that receive Syslog formatted application log messages over HTTPS. As
+outlined in [Heroku's documentation on HTTPS Log Drains][drains], these messages
+do not fully conform to RFC5424:
+
+> “application/logplex-1” does not conform to RFC5424. It leaves out
+> STRUCTURED-DATA but does not replace it with a NILVALUE.
+
+RFC5424 requires STRUCTURED-DATA to consist of either one NILVALUE or one or
+more SD-ELEMENTs.
+
+[heroku]: https://heroku.com
+[drains]: https://devcenter.heroku.com/articles/log-drains#https-drains
+
+In order to parse Syslog streams received via Heroku HTTPS log drains,
+`Syslog::Stream` needs to be instantiated with a parser that allows missing
+STRUCTURE-DATA:
+
+```ruby
+parser = Syslog::Parser.new(allow_missing_structured_data: true)
+
+io = StringIO.new
+
+stream = Syslog::Stream.new(
+  Syslog::Stream::OctetCountingFraming.new(io),
+  parser: parser,
+)
+```

data/Rakefile

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

data/lib/syslog/stream.rb

@@ -0,0 +1,19 @@
+require "syslog/parser"
+require "syslog/stream/octet_counting_framing"
+
+module Syslog
+  class Stream
+    def initialize(framing, options={})
+      @framing = framing
+      @parser = options.fetch(:parser) { Syslog::Parser.new }
+    end
+
+    def messages
+      return to_enum(__callee__) unless block_given?
+
+      @framing.messages do |message|
+        yield @parser.parse(message)
+      end
+    end
+  end
+end

data/lib/syslog/stream/octet_counting_framing.rb

@@ -0,0 +1,26 @@
+module Syslog
+  class Stream
+    class OctetCountingFraming
+      def initialize(io)
+        @io = io
+      end
+
+      def messages
+        loop do
+          length = ""
+          octet = ""
+
+          until octet == " " do
+            if @io.read(1, octet) == nil
+              return
+            end
+
+            length << octet
+          end
+
+          yield @io.read(Integer(length)).force_encoding("UTF-8")
+        end
+      end
+    end
+  end
+end

data/lib/syslog/stream/version.rb

@@ -0,0 +1,5 @@
+module Syslog
+  class Stream
+    VERSION = "0.1.0"
+  end
+end

data/syslog-stream.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "syslog/stream/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "syslog-stream"
+  spec.version = Syslog::Stream::VERSION
+  spec.authors = ["Calle Erlandsson"]
+  spec.email = ["calle@calleerlandsson.com"]
+
+  spec.summary = "Parse streams of RFC5424 Syslog messages"
+  spec.homepage = "https://github.com/calleerlandsson/syslog-stream/"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "syslog-parser"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: syslog-stream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calle Erlandsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syslog-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- calle@calleerlandsson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/syslog/stream.rb
+- lib/syslog/stream/octet_counting_framing.rb
+- lib/syslog/stream/version.rb
+- syslog-stream.gemspec
+homepage: https://github.com/calleerlandsson/syslog-stream/
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Parse streams of RFC5424 Syslog messages
+test_files: []