qmail_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2720d6871c24621b17cb21103bd5a3501aae99ea
+  data.tar.gz: 76775c3a414ce295017265dd0b35a7e98b5df09f
+SHA512:
+  metadata.gz: 5721a51620aec303530a4dc3573a959b6cfdfab7ccc3bf429721cf322fae50ccf38581167bd1d847a522500607dd83eac538e90a8422cd13fb7bb5a9eb10b5dc
+  data.tar.gz: ff31aaecaf9ac4823979491454bf4ba1381dc4e9b1869b57166b4b967435b98bdbd386ec848b7f277a1ff7b51522b190fc04d39bc0fbe4ea4d521516356e00f7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2
+notifications:
+  slack:
+    secure: Lk2lpPCixIRLvapR/8FvHAfLhAkjN9Gp7uKvrzZeKzW463/K/GNA+fOYzcMSaaJOvefoADVc6In7WOBZWhN+WW4S4P/EkBjHaQMIz9VX/5rNrm3kLor2fQEYjXHxli68XZKFPdH50eT49L8KUoDcOiYW5tSkPgoO8zGrCyOkTz6u6HWJo7IAmtxgdMVPrxyXr7QZQOGQLvQf3hhIP68gghGjtjZfyam78sA6HUpfebWQ9SqxzJh8W/d3j45D/iTqypP4o76ALyVuGGYKlOp7Q8LXAa++Ys9s0v8D5jV99sqHPTIq5cu5q2f5aV+KIKMb+H1nJbuHsf5r06tO4U2aphINDiNxfazNBfyWjw7x0vp/OTPvFRdN4SIqM5+9vvLHMOgttoRZN3bfL0SR2bdsJhUqvRW+5BUEFxl4KhpNDZT6DydKw1cbbcMsWJuPTOUnHiGcv11KygVnzJiiryBlTSdqrEGUcmwc718NDlOiOzN3vUm8ee4sgYjXsrPd0JTZ5AtovXdurL4KAhsIY6yDMROsymMd+BLFDU0GQ83+NXldSqGpa6QzJkePB6lb6HiiMv0TO8n+yjk/Qu6wS9d7qCSUr1xoUCPz/OYW3jlVGpx601K8qg0pUnpLMV2zvK+ylZEaErff62NYtbvJ8TLxvrXMxjteThTzoRlS22iGb2g=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at u.humika@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qmail_log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 alotofwe
+
+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,125 @@
+# QmailLog
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qmail_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qmail_log
+
+## Usage
+
+### Analyze your qmail log
+
+* localhost
+
+```
+QmailLog.analyze(PATH_TO_LOG) => array
+```
+
+* SSH
+
+```
+QmailLog.analyze(PATH_TO_LOG, SSH_HOST, {
+  port:     SSH_PORT
+  user:     SSH_USER
+  password: SSH_PASSWORD
+}) => array
+```
+
+`PATH_TO_LOG` should be valid path to file or directory.  
+If analyzer receive directory path, it analyze all files in this directory.
+
+Returned array has following format:
+
+```
+[{:time=>
+   {:new=>"2000-03-06T17:45:10Z",
+    :info=>"2000-03-06T17:45:10Z",
+    :starting=>"2000-03-06T17:45:10Z",
+    :delivery=>"2000-03-06T17:45:11Z",
+    :end=>"2000-03-06T17:45:11Z"},
+  :bytes=>"2343",
+  :from=>"alotofwe@email.com",
+  :qp=>"18695",
+  :uid=>"49491",
+  :delivery_id=>"2392",
+  :region=>"remote",
+  :to=>"suzupy@email.com",
+  :status=>
+   "success:209.85.127.177_accepted_message./Remote_host_said:_250_CAA01516_Message_accepted_for_delivery/",
+  :queue_id=>"93869"},
+
+  ... 
+]
+
+```
+
+### Parse returned array
+
+* JSON
+
+```
+QmailLog.parse(array, :json)
+  => [{"time":{"new":"2000-03-06T17:45:10Z","info":"2000-03-06T17:45:10Z","starting":"2000-03-06T17:45:10Z","delivery":"2000-03-06T17:45:11Z","end":"2000-03-06T17:45:11Z"},"bytes":"2343","from":"dave@sill.org","qp":"18695","uid":"49491","delivery_id":"2392","region":"remote","to":"lwq@w3.to","status":"success:209.85.127.177_accepted_message./Remote_host_said:_250_CAA01516_Message_accepted_for_delivery/","queue_id":"93869"},
+
+  ...
+```
+
+* YAML
+
+```
+QmailLog.parse(array, :yaml)
+=> ---
+   - :time:
+       :new: '2000-03-06T17:45:10Z'
+       :info: '2000-03-06T17:45:10Z'
+       :starting: '2000-03-06T17:45:10Z'
+       :delivery: '2000-03-06T17:45:11Z'
+       :end: '2000-03-06T17:45:11Z'
+     :bytes: '2343'
+     :from: dave@sill.org
+     :qp: '18695'
+     :uid: '49491'
+     :delivery_id: '2392'
+     :region: remote
+     :to: lwq@w3.to
+     :status: success:209.85.127.177_accepted_message./Remote_host_said:_250_CAA01516_Message_accepted_for_delivery/
+     :queue_id: '93869'
+
+     ...
+```
+
+* LTSV
+
+```
+QmailLog.parse(array, :ltsv)
+  => bytes:2343	from:dave@sill.org	qp:18695	uid:49491	delivery_id:2392	region:remote	to:lwq@w3.to	status:success:209.85.127.177_accepted_message./Remote_host_said:_250_CAA01516_Message_accepted_for_delivery/	queue_id:93869	new_time:2000-03-06T17:45:10Z	info_time:2000-03-06T17:45:10Z	starting_time:2000-03-06T17:45:10Z	delivery_time:2000-03-06T17:45:11Z	end_time:2000-03-06T17:45:11Z
+
+  ...
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 GitHub at https://github.com/[USERNAME]/qmail_log. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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/qmail_log.rb

@@ -0,0 +1,41 @@
+require "qmail_log/version"
+require 'specinfra'
+require 'specinfra/helper/set'
+require 'tai64'
+require 'json'
+require 'yaml'
+require 'ltsv'
+
+require 'qmail_log/ssh'
+require 'qmail_log/formatter'
+require 'qmail_log/analyzer'
+
+include Specinfra::Helper::Set
+
+module QmailLog
+  class << self
+    def analyze path, host = 'localhost', ssh_options = {}
+      QmailLog::SSH::Configure.backend(host, ssh_options)
+      @runner = Specinfra::Runner
+
+      raise Errno::ENOENT unless @runner.check_file_is_file(path) or @runner.check_file_is_directory(path)
+
+      data, qid_from_did, memory = [], {}, {}
+
+      files(path).each do |file|
+        @runner.get_file_content(file).stdout.split("\n").each do |log|
+          QmailLog::Analyzer.analyze(log, data, qid_from_did, memory)
+        end
+      end
+      data
+    end
+
+    def parse data, format = :json
+      QmailLog::Formatter.run(format, data)
+    end
+
+    def files path
+      @runner.run_command("find #{path} -type f -exec ls -rt '{}' +").stdout.split("\n")
+    end
+  end
+end

data/lib/qmail_log/analyze/helper.rb

@@ -0,0 +1,42 @@
+module QmailLog
+  module Analyze
+    module Helper
+      def queue_id content, qid_from_did
+        case content
+        when /new/      then content.split[2]
+        when /info/     then content.split[2].gsub(':', '')
+        when /starting/ then content.split[4]
+        when /delivery/ then qid_from_did[ content.split[1].gsub(':', '') ]
+        when /end/      then content.split[2]
+        end
+      end
+
+      def info content
+        _, _, _, _, bytes, _, from, _, qp, _, uid = content.split
+        {
+          bytes: bytes,
+          from:  from.gsub(/<(.*)>/, '\1'),
+          qp:    qp,
+          uid:   uid
+        }
+      end
+
+      def starting content
+        _, _, delivery_id, _, _, _, region, to = content.split
+        {
+          delivery_id: delivery_id.gsub(':', ''),
+          region:      region,
+          to:          to
+        }
+      end
+
+      def delivery content
+        _, delivery_id, *status = content.split
+        {
+          delivery_id: delivery_id.gsub(':', ''),
+          status:      status.join(' ')
+        }
+      end
+    end
+  end
+end

data/lib/qmail_log/analyzer.rb

@@ -0,0 +1,36 @@
+require 'qmail_log/analyze/helper'
+
+module QmailLog
+  class Analyzer
+    class << self
+      include QmailLog::Analyze::Helper
+
+      def analyze log, data, qid_from_did, memory
+        time     = Tai64.parse(log.split[0]).to_time.to_s
+        content  = log.partition(' ')[-1]
+        queue_id = queue_id(content, qid_from_did)
+
+        case content
+        when /(new)/
+          memory[queue_id] = { time: {} }
+
+        when /(info)/
+          memory[queue_id].merge!( info(content) )
+
+        when /(starting)/
+          memory[queue_id].merge!( starting(content) )
+          qid_from_did[ memory[queue_id][:delivery_id] ] = queue_id
+
+        when /(delivery)/
+          memory[queue_id].merge!( delivery(content) )
+
+        when /end/
+          memory[queue_id][:time][:end] = time
+          data << memory[queue_id].merge!({ queue_id: queue_id })
+        end
+
+        memory[queue_id][:time][$1.to_sym] = time if $1
+      end
+    end
+  end
+end

data/lib/qmail_log/format/json.rb

@@ -0,0 +1,11 @@
+module QmailLog
+  module Format
+    class JSON
+      class << self
+        def parse data
+          ::JSON.dump(data)
+        end
+      end
+    end
+  end
+end

data/lib/qmail_log/format/ltsv.rb

@@ -0,0 +1,18 @@
+module QmailLog
+  module Format
+    class LTSV
+      class << self
+        def parse data
+          ltsv = ''
+          data.each do |d|
+            time = d[:time].inject({}) { |res, (key, value)| res["#{key}_time".to_sym] = value; res }
+            ltsv << "#{::LTSV.dump(
+              d.select { |key, value| key.to_sym != :time }.merge(time)
+            )}\n"
+          end
+          ltsv
+        end
+      end
+    end
+  end
+end

data/lib/qmail_log/format/yaml.rb

@@ -0,0 +1,11 @@
+module QmailLog
+  module Format
+    class YAML
+      class << self
+        def parse data
+          data.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/qmail_log/formatter.rb

@@ -0,0 +1,13 @@
+require 'qmail_log/format/json'
+require 'qmail_log/format/yaml'
+require 'qmail_log/format/ltsv'
+
+module QmailLog
+  class Formatter
+    class << self
+      def run format, data
+        const_get("QmailLog::Format::#{format.upcase}").parse(data)
+      end
+    end
+  end
+end

data/lib/qmail_log/ssh.rb

@@ -0,0 +1 @@
+require 'qmail_log/ssh/configure'

data/lib/qmail_log/ssh/configure.rb

@@ -0,0 +1,32 @@
+module QmailLog
+  module SSH
+    class Configure
+      class << self
+        def backend host, ssh_options
+          ssh_options.symbolize_keys!
+
+          case host
+          when 'localhost', '127.0.0.1'
+            set :backend, :exec
+          else
+            set :backend,       :ssh
+            set :host,          host
+            set :ssh_options,   ssh_options
+            set :sudo_password, ssh_options[:password]
+          end
+        end
+      end
+    end
+  end
+end
+
+class Hash
+  def symbolize_keys!
+    self.replace(
+      self.inject({}) do |res, (key, value)|
+        res[key.to_sym] = value
+        res
+      end
+    )
+  end
+end

data/lib/qmail_log/version.rb

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

data/qmail_log.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qmail_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qmail_log"
+  spec.version       = QmailLog::VERSION
+  spec.authors       = ["alotofwe"]
+  spec.email         = ["u.humika@gmail.com"]
+
+  spec.summary       = %q{Analyze qmail log for save to hash, and parse it to DDL statements}
+  spec.description   = %q{Analyze qmail log for save to hash, and parse it to DDL statements}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler',   '~> 1.11'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.0'
+  spec.add_development_dependency 'specinfra', '~> 2.51'
+  spec.add_development_dependency 'tai64',     '~> 0.0'
+  spec.add_development_dependency 'json',      '~> 1.8'
+  spec.add_development_dependency 'ltsv',      '~> 0.1'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: qmail_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alotofwe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: specinfra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.51'
+- !ruby/object:Gem::Dependency
+  name: tai64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: ltsv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Analyze qmail log for save to hash, and parse it to DDL statements
+email:
+- u.humika@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qmail_log.rb
+- lib/qmail_log/analyze/helper.rb
+- lib/qmail_log/analyzer.rb
+- lib/qmail_log/format/json.rb
+- lib/qmail_log/format/ltsv.rb
+- lib/qmail_log/format/yaml.rb
+- lib/qmail_log/formatter.rb
+- lib/qmail_log/ssh.rb
+- lib/qmail_log/ssh/configure.rb
+- lib/qmail_log/version.rb
+- qmail_log.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Analyze qmail log for save to hash, and parse it to DDL statements
+test_files: []