email_nugget_rb 0.0.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end
+
+gem "uuid"
+gem "json"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.6)
+    macaddr (1.5.0)
+      systemu (>= 2.4.0)
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    systemu (2.5.0)
+    uuid (2.3.5)
+      macaddr (~> 1.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  json
+  rspec (~> 2.3.0)
+  uuid
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jon Durbin
+
+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.rdoc

@@ -0,0 +1,19 @@
+= email_nugget_rb
+
+Description goes here.
+
+== Contributing to email_nugget_rb
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jon Durbin. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "email_nugget_rb"
+  gem.homepage = "http://github.com/gdi/email_nugget_rb"
+  gem.license = "MIT"
+  gem.summary = %Q{Save email envelope and message in single data format.}
+  gem.description = %Q{Save email envelope and message in a single data format.}
+  gem.email = "development@greenviewdata.com"
+  gem.authors = ["Jon Durbin"]
+  gem.version = "0.0.3"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/email_nugget.rb

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'uuid'
+require 'json'
+
+class EmailNugget
+  autoload "Envelope", "email_nugget/envelope"
+  autoload "Message", "email_nugget/message"
+
+  attr_accessor :id, :envelope, :message
+
+  # Initialize a new email nugget.
+  def initialize(args = {})
+    self.envelope = EmailNugget::Envelope.new(args[:envelope] || args['envelope'])
+    self.message = EmailNugget::Message.new(args[:message] || args['message'])
+    self.id = args[:id] || args['id'] || generate_id
+  end
+  
+  # Generate a new UUID
+  def generate_id
+    UUID.new.generate
+  end
+  
+  def to_hash
+    {
+      :ip => self.envelope.ip,
+      :helo => self.envelope.helo,
+      :mail_from => self.envelope.mail_from,
+      :rcpt_to => self.envelope.rcpt_to,
+      :date => self.envelope.date,
+      :context => self.envelope.context,
+      :misc => self.envelope.misc,
+    }
+  end
+  
+  # Save the current nugget to the specified file.
+  def write_to(file_path)
+    # Catch any errors opening or writing to the file.
+    begin
+      nugget_file = File.open(file_path, "w")
+      # Get a lock on the file.
+      nugget_file.flock(File::LOCK_EX | File::LOCK_NB)
+      # Save the envelope as JSON in the first line.
+      nugget_file.syswrite(to_hash.to_json + "\n")
+      # Save the checksum in the second line.
+      nugget_file.syswrite(self.message.checksum + "\n")
+      # Save the message contents after the second line.
+      nugget_file.syswrite(self.message.data + "\n")
+    rescue => e
+      # Unable to save email nugget to file_path
+      #puts "Error saving email nugget to #{file_path}: #{e.to_s}"
+      return false
+    end
+    # Success
+    return true
+  end
+  
+  class << self
+    # Create a new email nugget from the specified file path.
+    def new_from(file_path)
+      # Catch any errors opening or reading from the file.
+      begin
+        nugget_file = File.open(file_path, 'rb')
+        # Envelope is the first line.
+        envelope = JSON.parse(nugget_file.readline.chomp)
+        # Checksum is the second line.
+        checksum = nugget_file.readline.chomp
+        return EmailNugget.new({'envelope' => envelope, 'message' => {'data_stream' => nugget_file}})
+      rescue => e
+        # Unable to open or read nugget file.
+        #puts "Error creating email nugget from #{file_path}: #{e.to_s}"
+        return nil
+      end
+    end
+  end
+end

data/lib/email_nugget/envelope.rb

@@ -0,0 +1,37 @@
+class EmailNugget
+  class Envelope
+    attr_accessor :ip, :helo, :mail_from, :rcpt_to, :date, :context, :misc
+    
+    def initialize(args = {})
+      self.ip = args[:ip] || args['ip'] || ""
+      self.helo = args[:helo] || args['helo'] || ""
+      self.mail_from = args[:mail_from] || args['mail_from'] || ""
+      self.rcpt_to = args[:rcpt_to] || args['rcpt_to'] || []
+      self.date = args[:date] || args['date'] || ""
+      self.context = args[:context] || args['context'] || ""
+      self.misc = args[:misc] || args['misc'] || {}
+      self.ensure_fields
+    end
+    
+    def ensure_fields
+      if !self.rcpt_to.is_a?(Array)
+        self.rcpt_to = [self.rcpt_to]
+      end
+
+      if !self.misc.is_a?(Hash)
+        if self.misc.is_a?(Array)
+          temp = {}
+          self.misc.each do |m|
+            temp[m] = 1 
+          end
+          self.misc = temp
+        elsif self.misc.is_a?(String) || self.misc.is_a?(Integer)
+          temp = {self.misc => 1}
+          self.misc = temp
+        else
+          self.misc = {}
+        end
+      end
+    end
+  end
+end

data/lib/email_nugget/message.rb

@@ -0,0 +1,36 @@
+require 'digest/md5'
+
+class EmailNugget
+  class Message
+    attr_accessor :arg_checksum, :arg_data, :arg_data_stream
+    
+    def initialize(args = {})
+      self.arg_checksum = args[:checksum] || args['checksum']
+      self.arg_data = args[:data] || args['data']
+      self.arg_data_stream =  args[:data_stream] || args['data_stream']
+    end
+    
+    def data_stream
+      if self.arg_data_stream
+        self.arg_data_stream
+      else 
+        StringIO.new(self.data)
+      end
+    end
+
+    def data
+      if self.arg_data.nil?
+        self.arg_data = self.arg_data_stream.read
+      end
+      self.arg_data
+    end
+
+    def checksum  
+      if self.arg_checksum.nil?
+        Digest::MD5.hexdigest(self.data)
+      else
+        self.arg_checksum
+      end
+    end
+  end
+end

data/lib/email_nugget_rb.rb

@@ -0,0 +1 @@
+require 'email_nugget'

data/spec/fixtures/test1.nugget

@@ -0,0 +1,7 @@
+{"ip":"127.0.0.1","helo":"test.com","mail_from":"test@test.com","rcpt_to":"test@test.com","date":"2012-01-16 14:55:52 -0500","context":"inbound","misc":{"message_id" : "123456789"}}
+a68a72d5abdb040c7b279c707ed5477e
+From: "test" <test@test.com>
+To: "test" <test@test.com>
+Subject: Test nugget.
+
+Test nugget 1.

data/spec/fixtures/test2.nugget

@@ -0,0 +1,3 @@
+{"ip":"127.0.0.1","helo":"test.com","mail_from":"test@test.com","rcpt_to":["test@test.com"],"date":"2012-03-26 16:29:26 -0400","context":"inbound","misc":{}}
+7df477726f7d2673a018d1789af53e24
+Test write nugget.

data/spec/lib/email_nugget/envelope_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe EmailNugget::Envelope do
+  before do
+    @current_time = Time.now
+    @test_envelope_hash = {
+      'ip' => '127.0.0.1',
+      'helo' => 'localhost.localdomain',
+      'mail_from' => 'root@localhost',
+      'rcpt_to' => 'root@localhost',
+      'date' => @current_time.to_s,
+      'context' => 'inbound'
+    }
+    @envelope = EmailNugget::Envelope.new(@test_envelope_hash)
+  end
+
+  describe '.new' do
+    it "should create an email nugget envelope from a hash" do
+      @envelope.should be_a_kind_of(EmailNugget::Envelope)
+    end
+    it "should return empty string for fields not set in initialize" do
+      with_nil_params = {
+        'ip' => '127.0.0.1',
+        'rcpt_to' => 'root@localhost'
+      }
+      test_envelope = EmailNugget::Envelope.new(with_nil_params)
+      test_envelope.mail_from.should == ""
+    end
+  end
+
+  describe '#ip' do
+    it "should return the sender IP address" do
+      @envelope.ip.should == @test_envelope_hash['ip']
+    end
+  end
+
+  describe '#helo' do
+    it "should return the helo host" do
+      @envelope.helo.should == @test_envelope_hash['helo']
+    end
+  end
+
+  describe '#mail_from' do
+    it "should return the mail_from" do
+      @envelope.mail_from.should == @test_envelope_hash['mail_from']
+    end
+  end
+  
+  describe '#rcpt_to' do
+    it "should return the rcpt_to array" do
+      @envelope.rcpt_to.should be_a_kind_of(Array)
+    end
+    it "should contain the first rcpt_to in the first array item" do
+      @envelope.rcpt_to[0].should == @test_envelope_hash['rcpt_to']
+    end
+    it "should be the same size as the input hash recipient array" do
+      multiple_rcpt = @test_envelope_hash
+      multiple_rcpt['rcpt_to'] = ["rcpt1@test.com", "rcpt2@test.com"]
+      test_envelope = EmailNugget::Envelope.new(multiple_rcpt)
+      test_envelope.rcpt_to.length.should == multiple_rcpt['rcpt_to'].length
+    end
+  end
+  
+  describe '#date' do
+    it "should return the date" do
+      @envelope.date.should == @test_envelope_hash['date']
+    end
+  end
+end

data/spec/lib/email_nugget/message_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe EmailNugget::Message do
+  before do
+    @test_message_hash = {
+      'data' => 'This is a test message',
+      'checksum' => Digest::MD5.hexdigest('This is a test message')
+    }
+    @message = EmailNugget::Message.new(@test_message_hash)
+  end
+  
+  describe '.new' do
+    it "should create an email nugget message from a hash" do
+      @message.should be_a_kind_of(EmailNugget::Message)
+    end
+  end
+  
+  describe '#checksum' do
+    it "should return the checksum of the data" do
+      @message.checksum.should == Digest::MD5.hexdigest(@test_message_hash['data'])
+    end
+    it "should return the checksum of the data if not provided" do
+      test_message = EmailNugget::Message.new({'data' => 'test'})
+      test_message.checksum.should == Digest::MD5.hexdigest('test')
+    end
+  end
+  
+  describe '#data' do
+    it "should return the data provided in the message hash" do
+      @message.data.should == @test_message_hash['data']
+    end
+  end
+
+  describe '#data_stream' do
+    before do
+      @f = File.open(File.dirname(__FILE__) + '/../../fixtures/test1.nugget', 'r')
+      @f.readline
+      @checksum = @f.readline
+      @test_message = EmailNugget::Message.new({'data_stream' => @f, 'checksum' => @checksum})
+    end 
+    it "should return a StringIO to the data string" do
+      @message.data_stream.should be_a_kind_of(StringIO)
+    end
+    it "should return a FileIO if data stream is provided" do
+      @test_message.should be_a_kind_of(EmailNugget::Message)
+    end
+    it "should return a string calling the data method when provide a data stream" do
+      @test_message.data.should be_a_kind_of(String)
+    end
+    it "should return the argument checksum" do
+      @test_message.checksum.should == @checksum
+    end
+  end
+end

data/spec/lib/email_nugget_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe EmailNugget do
+  before do
+    @current_time = Time.now
+    @test_email_hash = {
+      'envelope' => {
+        'mail_from' => 'test@test.com',
+        'helo' => 'test.com',
+        'rcpt_to' => 'test@test.com',
+        'ip' => '127.0.0.1',
+        'date' => @current_time.to_s,
+        'context' => 'inbound',
+        'misc' => {'message_id' => '123456'},
+      },
+      'message' => {
+        'data' => 'Test write nugget.',
+        'checksum' => Digest::MD5.hexdigest('Test write nugget.')
+      }
+    }
+    @nugget = EmailNugget.new(@test_email_hash) 
+  end
+  # 
+  describe '.new' do
+    it "should create a nugget from a hash" do
+      @nugget.should be_a_kind_of(EmailNugget)
+    end
+  end
+  
+  describe '#envelope' do
+    it "should initialize the envelope from the hash" do
+      @nugget.envelope.should be_a_kind_of(EmailNugget::Envelope)
+    end
+  end
+  
+  describe '#message' do
+    it "should initialize the message from the hash" do
+      @nugget.message.should be_a_kind_of(EmailNugget::Message)
+    end
+  end
+  
+  describe '#id' do
+    it "should generate an ID if none is given" do
+      @nugget.id.should_not be_nil
+    end
+    it "should use the ID given in the hash" do
+      @test_email_hash['id'] = "asdf"
+      test_nugget = EmailNugget.new(@test_email_hash)
+      test_nugget.id.should == "asdf"
+    end
+  end
+  
+  describe '.write_to()' do
+    it "should write the current nugget to the specified file" do
+      @nugget.write_to(File.dirname(__FILE__) + '/../fixtures/test2.nugget').should == true
+    end
+    it "should return false if write failed" do
+      @nugget.write_to("/a/a/a/a/bad_path_to.nugget").should == false
+    end
+  end
+  
+  describe '.new_from()' do
+    it "should create a new nugget from the file path" do
+      nugget = EmailNugget.new_from(File.dirname(__FILE__) + '/../fixtures/test1.nugget')
+      nugget.should be_a_kind_of(EmailNugget)
+    end
+    it "should return nil if the nugget file path doesn't exist" do
+      nugget = EmailNugget.new_from("/a/a/a/a/bad_path_to.nugget")
+      nugget.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'email_nugget_rb'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: email_nugget_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jon Durbin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: &70342398812280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342398812280
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70342398811640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342398811640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70342398810880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70342398810880
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70342398810160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70342398810160
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70342398809420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70342398809420
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70342398829440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70342398829440
+description: Save email envelope and message in a single data format.
+email: development@greenviewdata.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/email_nugget.rb
+- lib/email_nugget/envelope.rb
+- lib/email_nugget/message.rb
+- lib/email_nugget_rb.rb
+- spec/fixtures/test1.nugget
+- spec/fixtures/test2.nugget
+- spec/lib/email_nugget/envelope_spec.rb
+- spec/lib/email_nugget/message_spec.rb
+- spec/lib/email_nugget_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gdi/email_nugget_rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3983421339398493086
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Save email envelope and message in single data format.
+test_files: []