jmcarbo-imapstore 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-07
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/imapstore
+lib/imapstore.rb
+lib/imapstore/imapstore.rb
+script/console
+script/destroy
+script/generate
+spec/imapstore_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on imapstore, see http://imapstore.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,74 @@
+= imapstore
+
+* http://wiki.github.com/jmcarbo/imapstore
+
+== DESCRIPTION:
+
+ruby gem to use an imap server as a file storage device
+
+== FEATURES/PROBLEMS:
+
+* many
+
+== SYNOPSIS:
+
+Usage: imapstore -c <ls, rm, put, get, rmdir, mkdir, quota, setup> -s <subject> -d <folder> -f <file list or glob> 
+       imapstore -h
+
+== REQUIREMENTS:
+
+* IMAP account
+* config file. Currently only supports this location: ~/.imapstore/config.yml
+* config file sample:
+
+email: account@gmail.com
+password: password
+store_tag: IMAPSTORE
+imap_server: imap.gmail.com
+imap_port: 993
+
+store_tag is the tag used in the message subject to distinguish imapstore created messages from any other messages in the
+store.
+
+== INSTALL:
+
+# add githum gem repository if you haven't done so
+
+gem sources -a http://gems.github.com
+
+#install gem
+
+sudo gem install imapstore
+
+# Create sample config at ~/.imapstore/config.yml
+
+imapstore -c setup 
+
+# Get help
+
+imapstore -h
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Joan Marc Carbo Arnau
+
+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/Rakefile

@@ -0,0 +1,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/imapstore'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('imapstore', IMAPSTORE::VERSION) do |p|
+  p.developer('Joan Marc Carbo Arnau', 'jmcarbo@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['tmail','>= 1.2.3'],
+    ['getoptions','>= 0.1']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/imapstore

@@ -0,0 +1,85 @@
+#! /usr/bin/ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'rubygems'
+require 'imapstore'
+require 'getoptions'
+
+COMMAND_LIST = ['ls', 'rm', 'put', 'get', 'rmdir', 'mkdir', 'quota', 'setup' ]
+opt = GetOptions.new(%w(help subject=s command=s dir=s files=@s recursive! versioned! ))
+
+if opt['help']
+	puts "Usage: imapstore -c <#{COMMAND_LIST.join(', ')}> -s <subject> -d <folder> -f <file list or glob> "
+	puts "       imapstore -h"
+	exit 0
+end
+
+
+command = opt['command'] || "ls"
+dir = opt['dir'] || "INBOX"
+files = opt['files'] || "*"
+subject = opt['subject'] || ""
+recursive = opt['recursive'] || false
+versioned = opt['versioned']
+
+begin
+if COMMAND_LIST.include? command 
+  if command == 'setup'
+	  IMAPSTORE::Imapstore.create_config_file
+    exit
+  end
+	i = IMAPSTORE::Imapstore.new
+	i.versioned=versioned if versioned!=nil
+
+	case command
+		when 'ls':
+			files.each do |f|
+				f = /.+/ if f == '*'
+				
+				i.ls(dir, Regexp.new(f)).each do |a|
+					puts a
+				end	
+			end
+		when 'put':
+			files.each do |f|
+				Dir.glob(f) do |f2|
+					if(!File.directory? f2)
+						puts "Storing file #{f2}"
+						i.store_file(f2,dir,subject)
+					end
+				end
+			end
+		when 'get':
+			files.each do |f|
+				f = /.+/ if f == '*'
+				puts "Getting files"
+				i.get_file(dir, Regexp.new(f)).each do |a|
+					puts a
+				end	
+			end
+		when 'rm':
+			files.each do |f|
+				f = /.+/ if f == '*'
+				puts "Deleting files"
+				i.rm_file(dir, Regexp.new(f)).each do |a|
+					puts a
+				end	
+			end			
+		when 'mkdir':
+			i.mkdir(dir)
+		when 'rmdir':
+			i.rmdir(dir)
+		when 'quota':
+			q = i.quota("INBOX")
+			puts "Used  #{q[1]['usage'].to_s} of #{q[1]['quota'].to_s}"
+		else
+			puts "unimplemented command #{command}"	
+	end
+			
+
+
+	i.disconnect
+end
+rescue
+	puts "An error has occured #{$!}"
+end

data/lib/imapstore.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'imapstore/imapstore.rb'
+
+module IMAPSTORE
+  VERSION = '0.0.1'
+
+end

data/lib/imapstore/imapstore.rb

@@ -0,0 +1,255 @@
+require 'net/imap'
+require 'rubygems'
+require 'tmail'
+require 'pp'
+require 'base64'
+require 'cgi'
+
+
+module IMAPSTORE
+	class Imapstore
+		MAX_FILE_SIZE=20000000
+		CHUNK_SIZE=10000000
+		
+		CONFIG_TEMPLATE = <<-END
+email: account@gmail.com
+password: password
+store_tag: IMAPSTORE
+imap_server: imap.gmail.com
+imap_port: 993
+END
+
+    def self.create_config_file(file = File.expand_path('~/.imapstore/config.yml'))
+			if !File.exists?(file)
+			  puts "creating #{File.dirname(file)}"
+			  FileUtils.mkdir_p(File.dirname(file))
+				File.open(file,"w").write(CONFIG_TEMPLATE)
+			end      
+    end
+    
+	  def initialize
+			@versioned = true
+	    get_config
+	    connect
+	  end
+	
+		def versioned
+			@versioned
+		end
+		
+		def versioned=(is_versioned)
+			@versioned = is_versioned
+		end
+		
+	  def email
+	    @email
+	  end
+
+	  def password
+	    @password
+	  end
+
+	  def store_tag
+	    @store_tag
+	  end
+
+		def imap_server
+			@imap_server
+		end
+		
+		def imap_port
+			@imap_port
+		end
+		
+	  def connect()
+	    if !@imap && @email && @password && @imap_server && @imap_port
+	      @imap = Net::IMAP.new(@imap_server, @imap_port, true)
+	      @imap.login(@email, @password)
+	    end
+	  end
+
+	  def disconnect()
+	    if @imap
+	      @imap.logout()
+	      begin
+	      	@imap.disconnect()
+	      rescue 
+	      end
+	    end
+	  end
+
+	  def get_config(file = File.expand_path('~/.imapstore/config.yml'))
+			if !File.exists?(file)
+				File.open(file,"w").write(CONFIG_TEMPLATE)
+			end
+	    aConfig = YAML::load_file(file)
+
+	    #COFIGURATION SECTION
+	    @email = aConfig['email']
+	    @password = aConfig['password']
+	    @store_tag = aConfig['store_tag'] || "IMAPSTORE"
+			@imap_server = aConfig['imap_server']
+			@imap_port = aConfig['imap_port']
+	    #END CONFIGURATION SECTION
+	  end
+
+		def store_file_chunk( file, folder = "INBOX", subject = "", chunk=nil, chunk_no=0, max_chunk_no=0 )
+			if(max_chunk_no>0)
+				puts "Storing part #{chunk_no} of #{max_chunk_no}"
+			end
+	    basename = File.basename(file)
+			version = 0
+
+			if max_chunk_no == 0
+				tag = "#{@store_tag}[#{basename}]"
+			else
+				tag = "#{@store_tag}[#{basename}](#{chunk_no}-#{max_chunk_no})"
+			end
+			@imap.select(folder)
+			@imap.search(["SUBJECT", tag, "NOT", "DELETED"]).each do |message_id|
+				if @versioned==true
+					version = version + 1
+				else
+					@imap.store(message_id, "+FLAGS", [:Deleted]) 
+				end
+			end
+			@imap.expunge
+			
+			mail = TMail::Mail.new
+	  	mail.to = @email
+	  	mail.from = @email
+			if max_chunk_no == 0
+	  		mail.subject = "#{@store_tag}[#{basename}]"
+			else
+	  		mail.subject = "#{@store_tag}[#{basename}](#{chunk_no}-#{max_chunk_no})"
+			end
+			
+			if version > 0
+				mail.subject = mail.subject + "(v. #{version})"
+			end
+			
+			if subject
+				mail.subject = mail.subject + ": #{subject}"
+			end
+			
+	  	mail.date = Time.now
+	  	mail.mime_version = '1.0'
+
+	  	mailpart1=TMail::Mail.new
+	  	mailpart1.set_content_type 'text', 'plain'
+	  	mailpart1.body = "This is a mail storage message of file #{file}"	
+	  	mail.parts << mailpart1
+	  	mail.set_content_type 'multipart', 'mixed'
+
+	  	if FileTest.exists?(file)
+	  		mailpart=TMail::Mail.new
+	  		mailpart.body = Base64.encode64(chunk.to_s)
+	  		mailpart.transfer_encoding="Base64"
+				if max_chunk_no == 0
+	  			mailpart['Content-Disposition'] = "attachment; filename=#{CGI::escape(basename)}"
+				else
+	  			mailpart['Content-Disposition'] = "attachment; filename=#{CGI::escape(basename)}_#{chunk_no}-#{max_chunk_no}"
+				end
+	  		mail.parts.push(mailpart)
+	  	end
+
+
+	  	@imap.append(folder, mail.to_s, [:Seen], File.new(file).atime)
+
+		end
+		
+	  def store_file( file, folder = "INBOX", subject = "")
+
+	  	@imap.create(folder) if !@imap.list("", folder)
+
+			size = File.size(file) 
+			if(size > MAX_FILE_SIZE)
+				remaining = size
+				max_chunk_no = (size/CHUNK_SIZE)+1
+				chunk_no = 1
+				File.open(file) do |f|
+					while(remaining>0)
+						content = f.read(CHUNK_SIZE)
+						store_file_chunk( file, folder, subject, content, chunk_no, max_chunk_no)
+						chunk_no = chunk_no +1
+						remaining = remaining - CHUNK_SIZE
+					end
+				end
+			else
+				content=File.open(file).read
+				store_file_chunk( file, folder, subject, content)
+			end
+	  end
+
+	  def ls(folder = "INBOX", glob = /.+/)
+			if folder == "/"
+				return @imap.list("","*").map { |d| d.name }.sort
+			end
+			
+	    file_list = []
+	    @imap.select(folder)
+	    @imap.search(["NOT", "DELETED"]).each do |message_id|
+	      a = @imap.fetch(message_id, "RFC822")
+	      mail = TMail::Mail.parse(a[0].attr["RFC822"])
+	      file_name = mail.subject.match(/^[^\[]+\[([^\]]+)\]/)[1]
+	      file_list << file_name if file_name.match(glob)
+	    end
+	    file_list
+	  end
+
+	  def get_file(folder = "INBOX", glob = /.+/)			
+	    file_list = []
+	    @imap.select(folder)
+	    @imap.search(["NOT", "DELETED"]).each do |message_id|
+	      a = @imap.fetch(message_id, "RFC822")
+	      mail = TMail::Mail.parse(a[0].attr["RFC822"])
+	      file_name = mail.subject.match(/^[^\[]+\[([^\]]+)\]/)[1]
+				if file_name.match(glob)
+					if mail.multipart? then
+					    mail.parts.each do |m|
+					      if !m.main_type
+									File.open(file_name,"w").write(m.body)
+								end
+					    end
+					end
+					
+	      	file_list << file_name
+				end
+	    end
+	    file_list
+	  end
+
+
+
+	  def rm_file(folder = "INBOX", glob = /.+/)
+	    file_list = []
+
+	    @imap.select(folder)
+	    @imap.search(["NOT", "DELETED"]).each do |message_id|
+	      a = @imap.fetch(message_id, "RFC822")
+	      mail = TMail::Mail.parse(a[0].attr["RFC822"])
+	      file_name = mail.subject.match(/^[^\[]+\[([^\]]+)\]/)[1]
+	      if glob && file_name.match(glob)
+	        @imap.store(message_id, "+FLAGS", [:Deleted]) 
+	        file_list << file_name
+	      end
+	    end
+	    @imap.expunge
+
+	    file_list
+	  end
+
+		def mkdir(folder)
+			@imap.create(folder)
+		end
+		
+		def rmdir(folder)
+			rm_file(folder)
+			@imap.delete(folder)
+		end
+		
+		def quota(folder)
+			@imap.getquotaroot(folder)
+		end
+	end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/imapstore.rb'}"
+puts "Loading imapstore gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/imapstore_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Configuration" do
+  it "Should read configuration" do
+    i = IMAPSTORE::Imapstore.new
+
+    i.email.should eql( 'account@gmail.com')
+    i.password.should eql('password')
+    i.store_tag.should eql('IMAPSTORE')
+		i.imap_server.should eql('imap.gmail.com')
+		i.imap_port.should eql(993)
+  end
+end
+
+describe "Connection" do
+
+  it "Should connect and disconnect properly" do
+    i = IMAPSTORE::Imapstore.new
+
+    i.disconnect
+  end
+
+  
+end
+
+describe "Store file" do
+  
+  it "Should store a file" do
+    i = IMAPSTORE::Imapstore.new
+    i.store_file(File.expand_path(File.dirname(__FILE__) + "/../lib/imapstore.rb"),"ttt","Test file")
+    i.rm_file("ttt")
+    i.disconnect    
+  end
+end
+
+describe "List folder" do
+  it "Sholuld list a folder" do
+    i = IMAPSTORE::Imapstore.new
+    i.store_file(File.expand_path(File.dirname(__FILE__) + "/../lib/imapstore.rb"),"ttt","Test file")
+    i.ls("ttt").should eql(["imapstore.rb"])
+    i.rm_file("ttt")
+    i.disconnect    
+  end
+end
+
+describe "rm_file" do
+  it "Sholuld remove a file" do
+    i = IMAPSTORE::Imapstore.new
+    i.store_file(File.expand_path(File.dirname(__FILE__) + "/../lib/imapstore.rb"),"ttt","Test file")
+    i.rm_file("ttt")
+    i.ls("ttt").should eql([])
+    i.disconnect    
+  end
+end
+
+describe "mkdir" do
+	it "should be able to create a valid folder" do
+    i = IMAPSTORE::Imapstore.new
+		i.mkdir('blablabla')
+		
+	end
+end
+
+describe "rmdir" do
+	it "should be able to delete an existing folder" do
+    i = IMAPSTORE::Imapstore.new
+		i.mkdir('blablabla2')
+		i.rmdir('blablabla2')
+	end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'imapstore'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: jmcarbo-imapstore
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Joan Marc Carbo Arnau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-08 00:00:00 -08:00
+default_executable: imapstore
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: getoptions
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ruby gem to use an imap server as a file storage device
+email: 
+- jmcarbo@gmail.com
+executables: 
+- imapstore
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/imapstore
+- lib/imapstore.rb
+- lib/imapstore/imapstore.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/imapstore_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://wiki.github.com/jmcarbo/imapstore
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: imapstore
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ruby gem to use an imap server as a file storage device
+test_files: []
+