dmarc_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f971fb0c37417274aff8a1890e225a33d103954
+  data.tar.gz: cd7687feb50dc597f427f7fef701da4bf74fa54b
+SHA512:
+  metadata.gz: e00369d4740a7822f461eac5405c78fa66abccfd606465e76bc59421fd33622f1732e9ff0dcb693d8237ead86b7f30bde9644cf1173def1a3c17f76805a2e82b
+  data.tar.gz: 4094cee4b99de7d54a72e7c36a02c6cb95c351648cf97276b78053d0d3ca91d008d211429f3def8cd488d1301c49ba79871ab5f1a6b7970b51c5ba60e9991d39

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    dmarc_parser (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dmarc_parser!
+  pry
+  rake (~> 10.0)
+  rb-readline
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 D Salko
+
+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,57 @@
+# DMARC Parser
+
+Parses DMARC XML reports for future processing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmarc_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmarc_parser
+
+## Usage
+
+```
+  report = DmarcParser::Report.new(xml_string)
+```
+
+Getting metadata:
+
+```
+  report.metadata
+```
+
+Getting DMARC policy information:
+
+```
+  report.policy
+```
+
+Getting collection of report records:
+
+```
+  report.records
+```
+
+## 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/DSalko/dmarc_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "dmarc_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/dmarc_parser.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dmarc_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dmarc_parser"
+  spec.version       = DmarcParser::VERSION
+  spec.authors       = ["Dmytro Salko"]
+  spec.email         = ["dm.salko@gmail.com"]
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.summary       = %q{Reads and parses DMARC XML reports.}
+#  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/DSalko/dmarc_parser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+#    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/DSalko/dmarc_parser"
+    spec.metadata["changelog_uri"] = "https://github.com/DSalko/dmarc_parser/README.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rb-readline"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+end

data/lib/dmarc_parser.rb

@@ -0,0 +1,7 @@
+require "dmarc_parser/version"
+
+module DmarcParser
+  class Error < StandardError; end
+
+  require "dmarc_parser/report"
+end

data/lib/dmarc_parser/auth_result.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'nokogiri'
+require_relative 'xml_helper'
+
+module DmarcParser
+  class AuthResult
+    include XmlHelper
+    ATTRIBUTES = [:type, :domain, :result, :selector]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def initialize(node)
+      @node = node
+      self.type = node.name
+      self.domain = get_text('domain')
+      self.result = get_text('result')
+      self.selector = get_text('selector')
+    end
+  end
+end

data/lib/dmarc_parser/metadata.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'nokogiri'
+require_relative 'xml_helper'
+
+module DmarcParser
+  class Metadata
+    include XmlHelper
+    ATTRIBUTES = [:org_name, :email, :extra_contact_info, :report_id, :begin_at, :end_at]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def initialize(node)
+      @node = node
+      self.org_name = get_text("feedback/report_metadata/org_name")
+      self.email = get_text("feedback/report_metadata/email")
+      self.extra_contact_info = get_text("feedback/report_metadata/extra_contact_info")
+      self.report_id = get_text("feedback/report_metadata/report_id")
+      self.begin_at = get_timestamp("feedback/report_metadata/date_range/begin")
+      self.end_at = get_timestamp("feedback/report_metadata/date_range/end")
+    end
+  end
+end

data/lib/dmarc_parser/policy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'nokogiri'
+require_relative 'xml_helper'
+
+module DmarcParser
+  class Policy
+    include XmlHelper
+    ATTRIBUTES = [:domain, :adkim, :aspf, :p, :sp, :pct]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def initialize(node)
+      @node = node
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", get_text("feedback/policy_published/#{attr}"))
+      end
+      self.pct = self.pct ? self.pct.to_i : nil
+    end
+  end
+end

data/lib/dmarc_parser/record.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'nokogiri'
+require_relative 'xml_helper'
+require_relative 'auth_result'
+
+module DmarcParser
+  class Record
+    include XmlHelper
+    ATTRIBUTES = [:source_ip, :count, :disposition, :dkim, :spf, :header_from, :auth_results]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def initialize(node)
+      @node = node
+      self.source_ip = get_text('row/source_ip')
+      self.count = get_int('row/count')
+      self.disposition = get_text('row/policy_evaluated/disposition')
+      self.dkim = get_text('row/policy_evaluated/dkim')
+      self.spf = get_text('row/policy_evaluated/spf')
+      self.header_from = get_text('identifiers/header_from')
+      self.auth_results = node.xpath('auth_results/*').map do |auth_results_node|
+        DmarcParser::AuthResult.new(auth_results_node)
+      end
+    end
+  end
+end

data/lib/dmarc_parser/report.rb

@@ -0,0 +1,27 @@
+require 'nokogiri'
+require_relative 'metadata'
+require_relative 'policy'
+require_relative 'record'
+
+module DmarcParser
+  class Report
+    def initialize(xml)
+      @xml = xml
+      @node = Nokogiri::XML(xml)
+    end
+
+    def metadata
+      @metadata ||= DmarcParser::Metadata.new(@node)
+    end
+
+    def policy
+      @policy ||=DmarcParser::Policy.new(@node)
+    end
+
+    def records
+      @records ||= @node.xpath('feedback/record').map do |node|
+        DmarcParser::Record.new(node)
+      end
+    end
+  end
+end

data/lib/dmarc_parser/version.rb

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

data/lib/dmarc_parser/xml_helper.rb

@@ -0,0 +1,19 @@
+require 'nokogiri'
+
+module DmarcParser
+  module XmlHelper
+    def get_text(xpath)
+      @node.xpath(xpath).first.text rescue nil
+    end
+
+    def get_timestamp(xpath)
+      value = get_text(xpath)
+      value ? Time.at(value.to_i) : nil
+    end
+
+    def get_int(xpath)
+      value = get_text(xpath)
+      value ? value.to_i : nil
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: dmarc_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmytro Salko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rb-readline
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+description: 
+email:
+- dm.salko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dmarc_parser.gemspec
+- lib/dmarc_parser.rb
+- lib/dmarc_parser/auth_result.rb
+- lib/dmarc_parser/metadata.rb
+- lib/dmarc_parser/policy.rb
+- lib/dmarc_parser/record.rb
+- lib/dmarc_parser/report.rb
+- lib/dmarc_parser/version.rb
+- lib/dmarc_parser/xml_helper.rb
+homepage: https://github.com/DSalko/dmarc_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DSalko/dmarc_parser
+  source_code_uri: https://github.com/DSalko/dmarc_parser
+  changelog_uri: https://github.com/DSalko/dmarc_parser/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Reads and parses DMARC XML reports.
+test_files: []