rmbox 0.4

data/README.md

@@ -0,0 +1,56 @@
+#Ruby MailBox file management (rmbox)
+
+Another library for manage a mailbox as object...
+
+##reading a mailbox
+
+The new method create a new instance, classic:
+
+      require 'rmbox'
+      mbox=Mailbox.new '/var/mail/fulano'
+
+If the mailbox do now exit, will be created. I suggest to write some email or you'll have an empty file :D
+
+##reading emails
+
+Each mailbox has a mail number. Lets get the mail number 3 from the mailbox.
+
+      # return the amount of mails in the mailbox
+      mbox.mails
+      => 18
+      
+      # get the mail number 3 as is in the mailbox
+      @myemail=mbox.get 3
+
+If you mailbox change and you wanna reflect thats changes in you mailbox object, use the reread method:
+
+      # read the mailbox file again
+      mbox.reread
+
+Ask a mail number bigger than existent mails will raise an exception. If your mailbox is not to big, you could use ".to_a" method for get an array with all the emails:
+
+      # get all the emails as an array
+      mbox.to_a
+
+Then you can use, last and/or [-1] etc... but, be careful with big mailboxes and remember that you having a common array.
+
+##writing a mail to your mailbox
+
+Write in the mailbox is append a mail to the mailbox.
+
+      # add a email to the Mailbox
+      mbox.append @myemail
+      
+      # duplicate the first email
+      mbox.append(mbox.get 1)
+
+Where @myemail is a rfc822 mail formated string. Mailbox will be "rereaded" after and before append any new mail. Remember use <b>.append</b> instead of write. Changes are updated (write) automatically.
+
+##deleting mails
+
+Is very easy, just like any email client do it. Which mail number shall deleted?
+
+      # delete mail number 2
+      mbox.delete 2
+
+

data/lib/rmbox.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+
+class Mailbox # handle mailbox files as object
+
+# read or create a mailbox file
+def initialize fichero=false
+
+if fichero==false # if not mailbox was especified, not argument gived
+   raise ArgumentError, 'argument must be a valid absolute path file'
+end
+
+# we'll store ALL the mails here
+# TERRIBLE ram usage if the mbox is a big file
+@@correos={}
+
+# take file's path
+@@fichero=fichero
+
+# file must exist an be readable or creations enabled
+if File.exist?(fichero)
+
+   # can I read it?
+   if File.readable? fichero
+
+      # open and read the file
+      @@mbox=File.read fichero
+
+      unless @@mbox.length==0 # file must not empty
+
+            # must be a valid mailbox file
+            unless @@mbox.lines.to_a[0].downcase.start_with? 'from '
+               raise ArgumentError, 'argument must be a valid mailbox file'
+            end # unless
+
+            # split the file by the 'From ', first object is a "" skip it
+            @@mbox.lines.each do |li|
+
+            # take the 'From ' where split each mail at the mailbox file
+            @key=li if li.downcase.start_with? 'from ' and /from .* \d\d:\d\d:\d\d \d\d\d\d\n/===li.downcase
+
+               # fill the value with the email
+               unless @@correos.keys.include? @key
+                  @@correos[@key]=''
+               else
+                  @@correos[@key]+=li
+               end # unless 
+
+            end # .each do
+
+      end # unless empty
+
+   else # some mailbox can be listed but not readed
+      raise ArgumentError, "Can't read the file #{fichero}. Permission?"
+
+   end # if File.readable?
+
+else # try to write it
+
+   begin # create the file
+   File.write @@fichero,''
+
+   rescue # warn it if something get wrong
+      raise Exception, "can't write the file #{@@fichero}"
+
+   end # begin
+
+end # if File.exist?
+
+end # initialize
+
+# return the number of email in the mbox
+def mails
+   @@correos.values.length
+end # mails
+
+# read again the email
+def reread
+   # reaload everything
+   # this is a very dirty operation
+   initialize @@fichero
+end # reread
+
+
+# return mail number num
+def get num
+
+  if mails==0 # if has not mails, tell it
+     raise ArgumentError, 'Mailbox is empty'
+  elsif num.to_i==0 or num.to_i>mails
+     raise ArgumentError, "Give me a valid mail number from 1 to #{mails}"
+  end # if
+
+  # took the mail number "num" from mailbox
+  @@correos.values[num-1]
+
+end # get
+
+# return an array with all the mails
+def to_a
+   return @@correos.values
+end # to_a
+
+# not move if file is not writable
+def writable?
+return true if File.writable?(@@fichero)
+return false
+end # writable?
+
+# append a mail to the mailbox file
+# argument must be RFC822 email as string 
+def append mail
+
+   raise Exception, "Fichero #{@@fichero} is not writable" unless writable?
+
+   # read again the email
+   reread
+
+   # generate a from based in the local user
+   @from=Time.now.strftime "From #{ENV['USER']}  %a %b  %d %T %Y\n"
+
+
+   # we'll append the email in the file
+   @fichero=File.open(@@fichero,'a')
+   @fichero.write @from+mail
+   @fichero.close
+
+   # read again the email
+   reread
+
+end # append
+
+# remove the mail number num from the mailbox
+def delete num
+
+# can't delete emails in a not writable mailbox file
+raise Exception, "Fichero #{@@fichero} is not writable" unless writable?
+
+reread # sync!
+
+# can't parse a email out of range, and out or range is NOT the last email
+if num.to_i==0 or num>mails
+   raise ArgumentError, "argument must be a valid mail's number from 1 to #{mails}"
+end
+
+
+# remove the email from the block
+@@correos.delete(@@correos.keys[num-1])
+
+# each From plus their mail
+@mailbox=String.new
+@@correos.each do|from,mail|
+   @mailbox<<from+mail
+end # do
+
+   # write in to the disk
+   File.write @@fichero,@mailbox
+   
+   # and again
+   reread
+
+end # delete
+
+end # class Mailbox

data/rmbox.gemspec

@@ -0,0 +1,29 @@
+# autogeneramos la version a patitir de los commit de git
+commit=File.read('.git/logs/HEAD').lines.to_a.length.to_s
+if commit.length == 1
+   version="0.#{commit}"
+else
+   version=commit[0..-2]+'.'+commit[-1]
+end
+
+# los ficheros que le pondremos al s.files
+ficheros=[]
+Dir.glob('*').each {|fi| ficheros << fi} unless Dir.glob('*')==[]
+Dir.glob('*/*').each {|fi| ficheros << fi} unless Dir.glob('*/*')==[]
+
+
+
+# podemos hacer un iterador que busca la ceadena 'description' en comentarios
+# y la tome como descripcion, de esa misma form con el sumario
+
+Gem::Specification.new do |s|
+s.name        = 'rmbox'
+s.version     = version
+s.date        = Time.now.to_s.split(' ')[0]
+s.description = 'Manage Mailbox files using ruby'
+s.summary     = 'Manage Mailbox files using ruby'
+s.authors     = 'Lázaro Armando'
+s.email       = 'uranio-235@myopera.com'
+s.files       = ficheros.uniq
+s.homepage    = 'http://github.com/uranio-235/dev/rmbox'
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: rmbox
+version: !ruby/object:Gem::Version
+  version: '0.4'
+  prerelease: 
+platform: ruby
+authors:
+- Lázaro Armando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies: []
+description: Manage Mailbox files using ruby
+email: uranio-235@myopera.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- rmbox.gemspec
+- README.md
+- lib/rmbox.rb
+homepage: http://github.com/uranio-235/dev/rmbox
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Manage Mailbox files using ruby
+test_files: []