forwarded_email_parser 0.2.1

data/lib/forwarded_email_parser/parsed_email.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ForwardedEmailParser
+  class ParsedEmail
+    attr_accessor :forwarded, :message, :email, :subject, :date, :from, :to, :cc, :body
+
+    def initialize(forwarded, message, email)
+      @forwarded = forwarded
+      @message = message
+      @email = email
+
+      @subject = email[:subject]
+      @date = email[:date]
+      @from = email[:from]
+      @to = email[:to]
+      @cc = email[:cc]
+      @body = email[:body]
+    end
+  end
+end

data/lib/forwarded_email_parser/parser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ForwardedEmailParser
+  class Parser
+    # Constructor
+    def initialize
+      @parser = EmailParser.new
+    end
+
+    # Attempts to parse a forwarded email
+    # @param [String] body
+    # @param [String, nil] subject
+    # @return [Hash] The parsed email
+    def parse(body, subject = nil)
+      email = {}
+      result = {}
+
+      # Check if email was forwarded or not (via the subject)
+
+      parsed_subject = @parser.parse_subject(subject) if subject
+      forwarded = !subject.nil? && !parsed_subject.nil?
+
+      # Check if email was forwarded or not (via the body)
+      if !subject || forwarded
+        result = @parser.parse_body(body, forwarded)
+        if result[:email]
+          forwarded = true
+          email = @parser.parse_original_email(result[:email], result[:body])
+        end
+      end
+
+      email[:subject] = parsed_subject if (email[:subject].nil? || email[:subject].empty?) && parsed_subject
+      ParsedEmail.new(forwarded, result[:message], email)
+    end
+  end
+end

data/lib/forwarded_email_parser/utils.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module ForwardedEmailParser
+  class Utils
+    class << self
+      # Executes multiple regular expressions until one succeeds
+      # @param regexes [Array<Regexp, String>] Array of regexes or regex strings
+      # @param str [String] The string to match against
+      # @param mode [String] The mode of operation ('match', 'split', or 'replace')
+      # @param highest_position [Boolean] Whether to find the highest position match
+      # @return [Array, String] The result of the first successful regular expression
+      def loop_regexes(regexes, str, mode = "match", highest_position = true)
+        match = nil
+        min_length = mode == "split" ? 1 : 0
+        max_length = str.length
+
+        regexes.each do |regex|
+          regex = Regexp.new(regex) if regex.is_a?(String)
+
+          current_match = case mode
+                          when "match"
+                            str.match(regex)
+                          when "split"
+                            str.split(regex)
+                          when "replace"
+                            str.gsub(regex, "")
+                          end || ""
+
+          if mode == "replace"
+            match = current_match
+            break if match.length < max_length
+          elsif %w[split match].include?(mode)
+            if (current_match || []).length > min_length
+              if highest_position
+                if !match
+                  match = current_match
+                else
+                  higher = if mode == "match"
+                             match.begin(0) > current_match.begin(0)
+                           else
+                             match[0].length > current_match[0].length
+                           end
+                  match = current_match if higher
+                end
+              else
+                match = current_match
+                break
+              end
+            end
+          end
+        end
+
+        mode == "replace" ? (match || "") : (match || [])
+      end
+
+      # Reconciliates match substrings after a "split" operation
+      # @param match [Array] The match result
+      # @param min_substrings [Integer] Minimum number of substrings
+      # @param default_substrings [Array<Integer>] Indices of default substrings
+      # @param exclude_proc [Proc] Optional proc to determine substring exclusion
+      # @return [String] The reconciliated string
+      def reconciliate_split_match(match, min_substrings, default_substrings, exclude_proc = nil)
+        str = ""
+
+        default_substrings.each do |index|
+          str += match[index]
+        end
+
+        if match.length > min_substrings
+          (min_substrings...match.length).each do |i|
+            exclude = exclude_proc&.call(i)
+            str += match[i] unless exclude
+          end
+        end
+
+        str
+      end
+
+      # Trims a string
+      # @param str [String] The string to trim
+      # @return [String] The trimmed string
+      def trim_string(str)
+        (str || "").strip
+      end
+    end
+  end
+end

data/lib/forwarded_email_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ForwardedEmailParser
+  VERSION = "0.2.1"
+end

data/lib/forwarded_email_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "forwarded_email_parser/parsed_email"
+require_relative "forwarded_email_parser/version"
+require_relative "forwarded_email_parser/utils"
+require_relative "forwarded_email_parser/email_parser"
+require_relative "forwarded_email_parser/parser"
+
+module ForwardedEmailParser
+  class Error < StandardError; end
+end

data/sig/email_forward_parser.rbs

@@ -0,0 +1,4 @@
+module ForwardedEmailParser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: forwarded_email_parser
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Clayton Lengel-Zigich
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-05 00:00:00.000000000 Z
+dependencies: []
+description: Extract information from forwarded emails. Cloned from https://github.com/crisp-oss/email-forward-parser.
+email:
+- 6334+clayton@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/forwarded_email_parser.rb
+- lib/forwarded_email_parser/email_parser.rb
+- lib/forwarded_email_parser/parsed_email.rb
+- lib/forwarded_email_parser/parser.rb
+- lib/forwarded_email_parser/utils.rb
+- lib/forwarded_email_parser/version.rb
+- sig/email_forward_parser.rbs
+homepage: https://github.com/clayton/forwarded_email_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/clayton/forwarded_email_parser
+  source_code_uri: https://github.com/clayton/forwarded_email_parser
+  changelog_uri: https://github.com/clayton/forwarded_email_parser/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Parses forwarded emails.
+test_files: []