dsn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 534f17912ad61e0312b2237ab2b2f85e1b2297e7188470d0fbc978dcb7f41d5b
+  data.tar.gz: d29e79a5bfcc273805efb859d7f7b2cb8f36fc485c899ac5def0f197d7cf108d
+SHA512:
+  metadata.gz: c236e9d93f3222c92994772aea68b7931b3bc005a61d92c3a95d4ef59d4e59da267d4db51ce58c9cf81b04739621ca3ea145371b93245423d4e105b78ab032d0
+  data.tar.gz: 436e8e0289765292e634a9581a9ca815e337b098cf6d23aeb41afe649e5dfc262638698c954df6d232589c21490d15ad901ce3d10cb90d3d3858b91758f031d6

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2020-07-18
+
+* Initial version of DSN.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dsn.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    dsn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dsn!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,64 @@
+# DSN
+
+Ruby parser for [RFC 3463](https://tools.ietf.org/html/rfc3463) Delivery Status Notification codes.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'dsn'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dsn
+
+## Usage
+
+```ruby
+dsn = DSN.new('5.7.5')
+dsn.valid?
+# => true
+dsn.success?
+# => false
+dsn.transient_failure?
+# => false
+dsn.failed?
+# => true
+dsn.to_s
+# => "5.7.5"
+dsn.subcode.to_s
+# => "X.7.5"
+
+dsn = DSN.new('5.7.999')
+dsn.valid?
+# => false
+dsn.class_subcode.valid?
+# => true
+dsn.subject_subcode.valid?
+# => true
+dsn.detail_subcode.valid?
+# => false
+dsn.to_s
+# => "5.7.999"
+dsn.subcode.to_s
+# => "X.7.XXX"
+
+msg = DSN::Message.new(dsn.subcode)
+msg.summary
+# => "Security or Policy Status"
+msg.body
+# => "The security or policy status codes report failures involving policies such as per-recipient or per-host filtering and cryptographic operations.  Security and policy status issues are assumed to be under the control of either or both the sender and recipient.  Both the sender and recipient must permit the exchange of messages and arrange the exchange of necessary keys and certificates for cryptographic operations."
+
+DSN.message('5.7.5').summary
+# => "Cryptographic failure"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/garethrees/dsn.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dsn/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'dsn'
+  spec.version = DSN::VERSION
+  spec.authors = ['Gareth Rees']
+  spec.email = ['gareth@garethrees.co.uk']
+  spec.license = 'MIT'
+
+  spec.summary = %(Ruby parser for RFC 3463 Delivery Status Notification codes)
+  spec.homepage = 'https://github.com/garethrees/dsn'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/dsn.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'dsn/status_code'
+require 'dsn/message'
+require 'dsn/version'
+
+require 'dsn/parser/string'
+
+require 'dsn/subcode/base'
+require 'dsn/subcode/class_subcode'
+require 'dsn/subcode/subject_subcode'
+require 'dsn/subcode/detail_subcode'
+
+# Ruby parser for RFC 3463 Delivery Status Notification codes
+module DSN
+  # Raised when the status code is unparsable.
+  class InvalidStatusCode < StandardError; end
+
+  # Raised when attempting to operate on an invalid subcode.
+  class InvalidSubcode < StandardError; end
+
+  # Parse a StatsCode from a String
+  def self.new(*args)
+    StatusCode.new(Parser::String.new(*args))
+  end
+
+  # Return the most detailed Message possible from a String code
+  def self.message(*args)
+    Message.new(new(*args).subcode)
+  end
+end

data/lib/dsn/data/2.XXX.XXX

@@ -0,0 +1,5 @@
+Success
+
+Success specifies that the DSN is reporting a positive delivery
+action.  Detail sub-codes may provide notification of
+transformations required for delivery.

data/lib/dsn/data/4.XXX.XXX

@@ -0,0 +1,7 @@
+Persistent Transient Failure
+
+A persistent transient failure is one in which the message as
+sent is valid, but persistence of some temporary condition has
+caused abandonment or delay of attempts to send the message.
+If this code accompanies a delivery failure report, sending in
+the future may be successful.

data/lib/dsn/data/5.XXX.XXX

@@ -0,0 +1,6 @@
+Permanent Failure
+
+A permanent failure is one which is not likely to be resolved
+by resending the message in the current form.  Some change to
+the message or the destination must be made for successful
+delivery.

data/lib/dsn/data/X.0.0

@@ -0,0 +1,5 @@
+Other undefined Status
+
+Other undefined status is the only undefined error code.  It
+should be used for all errors for which only the class of the
+error is known.

data/lib/dsn/data/X.0.XXX

@@ -0,0 +1,3 @@
+Other or Undefined Status
+
+There is no additional subject information available.

data/lib/dsn/data/X.1.0

@@ -0,0 +1,4 @@
+Other address status
+
+Something about the address specified in the message caused
+this DSN.

data/lib/dsn/data/X.1.1

@@ -0,0 +1,6 @@
+Bad destination mailbox address
+
+The mailbox specified in the address does not exist.  For
+Internet mail names, this means the address portion to the left
+of the "@" sign is invalid.  This code is only useful for
+permanent failures.

data/lib/dsn/data/X.1.2

@@ -0,0 +1,7 @@
+Bad destination system address
+
+The destination system specified in the address does not exist
+or is incapable of accepting mail.  For Internet mail names,
+this means the address portion to the right of the "@" is
+invalid for mail.  This code is only useful for permanent
+failures.

data/lib/dsn/data/X.1.3

@@ -0,0 +1,5 @@
+Bad destination mailbox address syntax
+
+The destination address was syntactically invalid.  This can
+apply to any field in the address.  This code is only useful
+for permanent failures.

data/lib/dsn/data/X.1.4

@@ -0,0 +1,6 @@
+Destination mailbox address ambiguous
+
+The mailbox address as specified matches one or more recipients
+on the destination system.  This may result if a heuristic
+address mapping algorithm is used to map the specified address
+to a local mailbox name.

data/lib/dsn/data/X.1.5

@@ -0,0 +1,4 @@
+Destination address valid
+
+This mailbox address as specified was valid.  This status code
+should be used for positive delivery reports.

data/lib/dsn/data/X.1.6

@@ -0,0 +1,5 @@
+Destination mailbox has moved, No forwarding address
+
+The mailbox address provided was at one time valid, but mail is
+no longer being accepted for that address.  This code is only
+useful for permanent failures.

data/lib/dsn/data/X.1.7

@@ -0,0 +1,4 @@
+Bad sender's mailbox address syntax
+
+The sender's address was syntactically invalid.  This can apply
+to any field in the address.

data/lib/dsn/data/X.1.8

@@ -0,0 +1,6 @@
+Bad sender's system address
+
+The sender's system specified in the address does not exist or
+is incapable of accepting return mail.  For domain names, this
+means the address portion to the right of the "@" is invalid
+for mail.

data/lib/dsn/data/X.1.XXX

@@ -0,0 +1,5 @@
+Addressing Status
+
+The address status reports on the originator or destination
+address.  It may include address syntax or validity.  These
+errors can generally be corrected by the sender and retried.

data/lib/dsn/data/X.2.0

@@ -0,0 +1,4 @@
+Other or undefined mailbox status
+
+The mailbox exists, but something about the destination mailbox
+has caused the sending of this DSN.

data/lib/dsn/data/X.2.1

@@ -0,0 +1,5 @@
+Mailbox disabled, not accepting messages
+
+The mailbox exists, but is not accepting messages.  This may be
+a permanent error if the mailbox will never be re-enabled or a
+transient error if the mailbox is only temporarily disabled.

data/lib/dsn/data/X.2.2

@@ -0,0 +1,7 @@
+Mailbox full
+
+The mailbox is full because the user has exceeded a per-mailbox
+administrative quota or physical capacity.  The general
+semantics implies that the recipient can delete messages to
+make more space available.  This code should be used as a
+persistent transient failure.

data/lib/dsn/data/X.2.3

@@ -0,0 +1,6 @@
+Message length exceeds administrative limit
+
+A per-mailbox administrative message length limit has been
+exceeded.  This status code should be used when the per-mailbox
+message length limit is less than the general system limit.
+This code should be used as a permanent failure.

data/lib/dsn/data/X.2.4

@@ -0,0 +1,5 @@
+Mailing list expansion problem
+
+The mailbox is a mailing list address and the mailing list was
+unable to be expanded.  This code may represent a permanent
+failure or a persistent transient failure.

data/lib/dsn/data/X.2.XXX

@@ -0,0 +1,5 @@
+Mailbox Status
+
+Mailbox status indicates that something having to do with the
+mailbox has caused this DSN.  Mailbox issues are assumed to be
+under the general control of the recipient.

data/lib/dsn/data/X.3.0

@@ -0,0 +1,5 @@
+Other or undefined mail system status
+
+The destination system exists and normally accepts mail, but
+something about the system has caused the generation of this
+DSN.

data/lib/dsn/data/X.3.1

@@ -0,0 +1,6 @@
+Mail system full
+
+Mail system storage has been exceeded.  The general semantics
+imply that the individual recipient may not be able to delete
+material to make room for additional messages.  This is useful
+only as a persistent transient error.

data/lib/dsn/data/X.3.2

@@ -0,0 +1,6 @@
+System not accepting network messages
+
+The host on which the mailbox is resident is not accepting
+messages.  Examples of such conditions include an immanent
+shutdown, excessive load, or system maintenance.  This is
+useful for both permanent and persistent transient errors.

data/lib/dsn/data/X.3.3

@@ -0,0 +1,6 @@
+System not capable of selected features
+
+Selected features specified for the message are not supported
+by the destination system.  This can occur in gateways when
+features from one domain cannot be mapped onto the supported
+feature in another.

data/lib/dsn/data/X.3.4

@@ -0,0 +1,5 @@
+Message too big for system
+
+The message is larger than per-message size limit.  This limit
+may either be for physical or administrative reasons.  This is
+useful only as a permanent error.

data/lib/dsn/data/X.3.5

@@ -0,0 +1,4 @@
+System incorrectly configured
+
+The system is not configured in a manner that will permit it to
+accept this message.

data/lib/dsn/data/X.3.XXX

@@ -0,0 +1,6 @@
+Mail System Status
+
+Mail system status indicates that something having to do with
+the destination system has caused this DSN.  System issues are
+assumed to be under the general control of the destination
+system administrator.

data/lib/dsn/data/X.4.0

@@ -0,0 +1,5 @@
+Other or undefined network or routing status
+
+Something went wrong with the networking, but it is not clear
+what the problem is, or the problem cannot be well expressed
+with any of the other provided detail codes.

data/lib/dsn/data/X.4.1

@@ -0,0 +1,5 @@
+No answer from host
+
+The outbound connection attempt was not answered, because
+either the remote system was busy, or was unable to take a
+call.  This is useful only as a persistent transient error.

data/lib/dsn/data/X.4.2

@@ -0,0 +1,6 @@
+Bad connection
+
+The outbound connection was established, but was unable to
+complete the message transaction, either because of time-out,
+or inadequate connection quality.  This is useful only as a
+persistent transient error.

data/lib/dsn/data/X.4.3

@@ -0,0 +1,8 @@
+Directory server failure
+
+The network system was unable to forward the message, because a
+directory server was unavailable.  This is useful only as a
+persistent transient error.
+
+The inability to connect to an Internet DNS server is one
+example of the directory server failure error.

data/lib/dsn/data/X.4.4

@@ -0,0 +1,10 @@
+Unable to route
+
+The mail system was unable to determine the next hop for the
+message because the necessary routing information was
+unavailable from the directory server.  This is useful for both
+permanent and persistent transient errors.
+
+A DNS lookup returning only an SOA (Start of Administration)
+record for a domain name is one example of the unable to route
+error.

data/lib/dsn/data/X.4.5

@@ -0,0 +1,5 @@
+Mail system congestion
+
+The mail system was unable to deliver the message because the
+mail system was congested.  This is useful only as a persistent
+transient error.

data/lib/dsn/data/X.4.6

@@ -0,0 +1,6 @@
+Routing loop detected
+
+A routing loop caused the message to be forwarded too many
+times, either because of incorrect routing tables or a user-
+forwarding loop.  This is useful only as a persistent transient
+error.

data/lib/dsn/data/X.4.7

@@ -0,0 +1,8 @@
+Delivery time expired
+
+The message was considered too old by the rejecting system,
+either because it remained on that host too long or because the
+time-to-live value specified by the sender of the message was
+exceeded.  If possible, the code for the actual problem found
+when delivery was attempted should be returned rather than this
+code.

data/lib/dsn/data/X.4.XXX

@@ -0,0 +1,7 @@
+Network and Routing Status
+
+The networking or routing codes report status about the
+delivery system itself.  These system components include any
+necessary infrastructure such as directory and routing
+services.  Network issues are assumed to be under the control
+of the destination or intermediate system administrator.

data/lib/dsn/data/X.5.0

@@ -0,0 +1,5 @@
+Other or undefined protocol status
+
+Something was wrong with the protocol necessary to deliver the
+message to the next hop and the problem cannot be well
+expressed with any of the other provided detail codes.

data/lib/dsn/data/X.5.1

@@ -0,0 +1,5 @@
+Invalid command
+
+A mail transaction protocol command was issued which was either
+out of sequence or unsupported.  This is useful only as a
+permanent error.

data/lib/dsn/data/X.5.2

@@ -0,0 +1,6 @@
+Syntax error
+
+A mail transaction protocol command was issued which could not
+be interpreted, either because the syntax was wrong or the
+command is unrecognized.  This is useful only as a permanent
+error.

data/lib/dsn/data/X.5.3

@@ -0,0 +1,8 @@
+Too many recipients
+
+More recipients were specified for the message than could have
+been delivered by the protocol.  This error should normally
+result in the segmentation of the message into two, the
+remainder of the recipients to be delivered on a subsequent
+delivery attempt.  It is included in this list in the event
+that such segmentation is not possible.

data/lib/dsn/data/X.5.4

@@ -0,0 +1,6 @@
+Invalid command arguments
+
+A valid mail transaction protocol command was issued with
+invalid arguments, either because the arguments were out of
+range or represented unrecognized features.  This is useful
+only as a permanent error.

data/lib/dsn/data/X.5.5

@@ -0,0 +1,4 @@
+Wrong protocol version
+
+A protocol version mis-match existed which could not be
+automatically resolved by the communicating parties.

data/lib/dsn/data/X.5.XXX

@@ -0,0 +1,6 @@
+Mail Delivery Protocol Status
+
+The mail delivery protocol status codes report failures
+involving the message delivery protocol.  These failures
+include the full range of problems resulting from
+implementation errors or an unreliable connection.

data/lib/dsn/data/X.6.0

@@ -0,0 +1,5 @@
+Other or undefined media error
+
+Something about the content of a message caused it to be
+considered undeliverable and the problem cannot be well
+expressed with any of the other provided detail codes.

data/lib/dsn/data/X.6.1

@@ -0,0 +1,5 @@
+Media not supported
+
+The media of the message is not supported by either the
+delivery protocol or the next system in the forwarding path.
+This is useful only as a permanent error.

data/lib/dsn/data/X.6.2

@@ -0,0 +1,6 @@
+Conversion required and prohibited
+
+The content of the message must be converted before it can be
+delivered and such conversion is not permitted.  Such
+prohibitions may be the expression of the sender in the message
+itself or the policy of the sending host.

data/lib/dsn/data/X.6.3

@@ -0,0 +1,7 @@
+Conversion required but not supported
+
+The message content must be converted in order to be forwarded
+but such conversion is not possible or is not practical by a
+host in the forwarding path.  This condition may result when an
+ESMTP gateway supports 8bit transport but is not able to
+downgrade the message to 7 bit as required for the next hop.

data/lib/dsn/data/X.6.4

@@ -0,0 +1,7 @@
+Conversion with loss performed
+
+This is a warning sent to the sender when message delivery was
+successfully but when the delivery required a conversion in
+which some data was lost.  This may also be a permanent error
+if the sender has indicated that conversion with loss is
+prohibited for the message.

data/lib/dsn/data/X.6.5

@@ -0,0 +1,4 @@
+Conversion Failed
+
+A conversion was required but was unsuccessful.  This may be
+useful as a permanent or persistent temporary notification.

data/lib/dsn/data/X.6.XXX

@@ -0,0 +1,8 @@
+Message Content or Media Status
+
+The message content or media status codes report failures
+involving the content of the message.  These codes report
+failures due to translation, transcoding, or otherwise
+unsupported message media.  Message content or media issues are
+under the control of both the sender and the receiver, both of
+which must support a common set of supported content-types.

data/lib/dsn/data/X.7.0

@@ -0,0 +1,7 @@
+Other or undefined security status
+
+Something related to security caused the message to be
+returned, and the problem cannot be well expressed with any of
+the other provided detail codes.  This status code may also be
+used when the condition cannot be further described because of
+security policies in force.

data/lib/dsn/data/X.7.1

@@ -0,0 +1,7 @@
+Delivery not authorized, message refused
+
+The sender is not authorized to send to the destination.  This
+can be the result of per-host or per-recipient filtering.  This
+memo does not discuss the merits of any such filtering, but
+provides a mechanism to report such.  This is useful only as a
+permanent error.

data/lib/dsn/data/X.7.2

@@ -0,0 +1,4 @@
+Mailing list expansion prohibited
+
+The sender is not authorized to send a message to the intended
+mailing list.  This is useful only as a permanent error.

data/lib/dsn/data/X.7.3

@@ -0,0 +1,5 @@
+Security conversion required but not possible
+
+A conversion from one secure messaging protocol to another was
+required for delivery and such conversion was not possible.
+This is useful only as a permanent error.

data/lib/dsn/data/X.7.4

@@ -0,0 +1,5 @@
+Security features not supported
+
+A message contained security features such as secure
+authentication that could not be supported on the delivery
+protocol.  This is useful only as a permanent error.

data/lib/dsn/data/X.7.5

@@ -0,0 +1,6 @@
+Cryptographic failure
+
+A transport system otherwise authorized to validate or decrypt
+a message in transport was unable to do so because necessary
+information such as key was not available or such information
+was invalid.

data/lib/dsn/data/X.7.6

@@ -0,0 +1,5 @@
+Cryptographic algorithm not supported
+
+A transport system otherwise authorized to validate or decrypt
+a message was unable to do so because the necessary algorithm
+was not supported.

data/lib/dsn/data/X.7.7

@@ -0,0 +1,6 @@
+Message integrity failure
+
+A transport system otherwise authorized to validate a message
+was unable to do so because the message was corrupted or
+altered.  This may be useful as a permanent, transient
+persistent, or successful delivery code.

data/lib/dsn/data/X.7.XXX

@@ -0,0 +1,9 @@
+Security or Policy Status
+
+The security or policy status codes report failures involving
+policies such as per-recipient or per-host filtering and
+cryptographic operations.  Security and policy status issues
+are assumed to be under the control of either or both the
+sender and recipient.  Both the sender and recipient must
+permit the exchange of messages and arrange the exchange of
+necessary keys and certificates for cryptographic operations.

data/lib/dsn/message.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DSN
+  # Descriptions of each Subcode as per RFC3463
+  class Message
+    def initialize(subcode)
+      @subcode = subcode
+    end
+
+    def summary
+      data.first
+    end
+
+    def body
+      data.last.gsub("\n", ' ').strip
+    end
+
+    def to_s
+      [summary, body].join("\n\n")
+    end
+
+    protected
+
+    attr_reader :subcode
+
+    private
+
+    def data
+      @data ||= data!
+    end
+
+    def data!
+      File.read(filepath).split("\n\n")
+    rescue Errno::ENOENT
+      raise InvalidSubcode, %("#{subcode}")
+    end
+
+    # TODO: Cleanup
+    def filepath
+      "#{__dir__}/data/#{subcode}"
+    end
+  end
+end

data/lib/dsn/parser/string.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DSN
+  module Parser
+    # Parse DSN subcode componentds from a String
+    class String
+      def initialize(code)
+        @code = code
+      end
+
+      def class_subcode
+        parts[0]
+      end
+
+      def subject_subcode
+        parts[1]
+      end
+
+      def detail_subcode
+        parts[2]
+      end
+
+      def to_s
+        code
+      end
+
+      protected
+
+      attr_reader :code
+
+      private
+
+      def parts
+        @parts ||= parts!
+      end
+
+      def parts!
+        split_parts = code.split('.')
+        raise InvalidStatusCode unless split_parts.compact.size == 3
+
+        split_parts
+      end
+    end
+  end
+end

data/lib/dsn/status_code.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module DSN
+  # The full status code
+  class StatusCode
+    extend Forwardable
+
+    def self.from_string(code)
+      new(Parser::String.new(code))
+    end
+
+    def_delegators :class_subcode, :success?, :transient_failure?, :failed?
+
+    def initialize(code)
+      @code = code
+      @class_subcode = Subcode::ClassSubcode.new(code)
+      @subject_subcode = Subcode::SubjectSubcode.new(code)
+      @detail_subcode = Subcode::DetailSubcode.new(code)
+    end
+
+    def valid?
+      subcodes.all?(&:valid?)
+    end
+
+    # Returns the most detailed subcode that is valid
+    def subcode
+      raise InvalidStatusCode unless class_subcode.valid?
+
+      subcodes.select(&:valid?).last
+    end
+
+    def to_s
+      code.to_s
+    end
+
+    attr_reader :class_subcode
+    attr_reader :subject_subcode
+    attr_reader :detail_subcode
+
+    protected
+
+    attr_reader :code
+
+    private
+
+    def subcodes
+      [class_subcode, subject_subcode, detail_subcode]
+    end
+  end
+end

data/lib/dsn/subcode/base.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module DSN
+  module Subcode
+    # Shared behaviour for subcodes.
+    class Base
+      def initialize(status_code)
+        @status_code = status_code
+      end
+
+      def valid?
+        File.exist?(filepath)
+      rescue InvalidSubcode
+        false
+      end
+
+      def to_s
+        filename
+      end
+
+      def to_i
+        Integer(significant_parts.last)
+      rescue ArgumentError
+        raise InvalidSubcode
+      end
+
+      protected
+
+      attr_reader :status_code
+
+      private
+
+      def filename
+        format_string % significant_parts
+      rescue ArgumentError
+        raise InvalidSubcode
+      end
+
+      def format_string
+        raise NotImplementedError
+      end
+
+      def significant_parts
+        raise NotImplementedError
+      end
+
+      # TODO: Cleanup
+      def filepath
+        "#{__dir__}/../data/#{self}"
+      end
+    end
+  end
+end

data/lib/dsn/subcode/class_subcode.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DSN
+  module Subcode
+    # The class sub-code provides a broad classification of the status.
+    class ClassSubcode < Subcode::Base
+      SUCCESS_CODE = 2
+      TRANSIENT_FAILURE_CODE = 4
+      FAILURE_CODE = 5
+
+      def success?
+        to_i == SUCCESS_CODE
+      end
+
+      def transient_failure?
+        to_i == TRANSIENT_FAILURE_CODE
+      end
+
+      def failed?
+        to_i == FAILURE_CODE
+      end
+
+      private
+
+      def format_string
+        '%d.XXX.XXX'
+      end
+
+      def significant_parts
+        [status_code.class_subcode]
+      end
+    end
+  end
+end

data/lib/dsn/subcode/detail_subcode.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DSN
+  module Subcode
+    # The detail value provides more information about the status and is defined
+    # relative to the subject of the status.
+    class DetailSubcode < Subcode::Base
+      private
+
+      def format_string
+        'X.%d.%d'
+      end
+
+      def significant_parts
+        [status_code.subject_subcode, status_code.detail_subcode]
+      end
+    end
+  end
+end

data/lib/dsn/subcode/subject_subcode.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DSN
+  module Subcode
+    # The subject sub-code classifies the status. This value applies to each of
+    # the three classifications.
+    class SubjectSubcode < Subcode::Base
+      private
+
+      def format_string
+        'X.%d.XXX'
+      end
+
+      def significant_parts
+        [status_code.subject_subcode]
+      end
+    end
+  end
+end

data/lib/dsn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DSN
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: dsn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gareth Rees
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- gareth@garethrees.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dsn.gemspec
+- lib/dsn.rb
+- lib/dsn/data/2.XXX.XXX
+- lib/dsn/data/4.XXX.XXX
+- lib/dsn/data/5.XXX.XXX
+- lib/dsn/data/X.0.0
+- lib/dsn/data/X.0.XXX
+- lib/dsn/data/X.1.0
+- lib/dsn/data/X.1.1
+- lib/dsn/data/X.1.2
+- lib/dsn/data/X.1.3
+- lib/dsn/data/X.1.4
+- lib/dsn/data/X.1.5
+- lib/dsn/data/X.1.6
+- lib/dsn/data/X.1.7
+- lib/dsn/data/X.1.8
+- lib/dsn/data/X.1.XXX
+- lib/dsn/data/X.2.0
+- lib/dsn/data/X.2.1
+- lib/dsn/data/X.2.2
+- lib/dsn/data/X.2.3
+- lib/dsn/data/X.2.4
+- lib/dsn/data/X.2.XXX
+- lib/dsn/data/X.3.0
+- lib/dsn/data/X.3.1
+- lib/dsn/data/X.3.2
+- lib/dsn/data/X.3.3
+- lib/dsn/data/X.3.4
+- lib/dsn/data/X.3.5
+- lib/dsn/data/X.3.XXX
+- lib/dsn/data/X.4.0
+- lib/dsn/data/X.4.1
+- lib/dsn/data/X.4.2
+- lib/dsn/data/X.4.3
+- lib/dsn/data/X.4.4
+- lib/dsn/data/X.4.5
+- lib/dsn/data/X.4.6
+- lib/dsn/data/X.4.7
+- lib/dsn/data/X.4.XXX
+- lib/dsn/data/X.5.0
+- lib/dsn/data/X.5.1
+- lib/dsn/data/X.5.2
+- lib/dsn/data/X.5.3
+- lib/dsn/data/X.5.4
+- lib/dsn/data/X.5.5
+- lib/dsn/data/X.5.XXX
+- lib/dsn/data/X.6.0
+- lib/dsn/data/X.6.1
+- lib/dsn/data/X.6.2
+- lib/dsn/data/X.6.3
+- lib/dsn/data/X.6.4
+- lib/dsn/data/X.6.5
+- lib/dsn/data/X.6.XXX
+- lib/dsn/data/X.7.0
+- lib/dsn/data/X.7.1
+- lib/dsn/data/X.7.2
+- lib/dsn/data/X.7.3
+- lib/dsn/data/X.7.4
+- lib/dsn/data/X.7.5
+- lib/dsn/data/X.7.6
+- lib/dsn/data/X.7.7
+- lib/dsn/data/X.7.XXX
+- lib/dsn/message.rb
+- lib/dsn/parser/string.rb
+- lib/dsn/status_code.rb
+- lib/dsn/subcode/base.rb
+- lib/dsn/subcode/class_subcode.rb
+- lib/dsn/subcode/detail_subcode.rb
+- lib/dsn/subcode/subject_subcode.rb
+- lib/dsn/version.rb
+homepage: https://github.com/garethrees/dsn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garethrees/dsn
+  source_code_uri: https://github.com/garethrees/dsn
+  changelog_uri: https://github.com/garethrees/dsn/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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Ruby parser for RFC 3463 Delivery Status Notification codes
+test_files: []