astrotrain 0.5.4 → 0.6.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gemspec
+gem 'rake', '~> 0.9.2'
+
+group :development do
+  gem 'resque'
+end

data/LICENSE

@@ -1,20 +1,21 @@
-Copyright (c) 2008-* ENTP
+The MIT License
 
-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:
+Copyright (c) rick
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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

@@ -1,124 +1,139 @@
+require 'rubygems'
 require 'rake'
+require 'date'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "astrotrain"
-    gem.summary = %Q{email => http post}
-    gem.email = "technoweenie@gmail.com"
-    gem.homepage = "http://github.com/entp/astrotrain"
-    gem.authors = ["technoweenie"]
-
-    dm_ver = "0.9.11"
-    gem.add_runtime_dependency 'addressable',   '2.0.2'
-    gem.add_runtime_dependency "tmail",         "1.2.3.1"
-    gem.add_runtime_dependency "data_objects",   dm_ver
-    gem.add_runtime_dependency "dm-core",        dm_ver # The datamapper ORM
-    gem.add_runtime_dependency "dm-aggregates",  dm_ver # Provides your DM models with count, sum, avg, min, max, etc.
-    gem.add_runtime_dependency "dm-timestamps",  dm_ver # Automatically populate created_at, created_on, etc. when those properties are present.
-    gem.add_runtime_dependency "dm-types",       dm_ver # Provides additional types, including csv, json, yaml.
-    gem.add_runtime_dependency "dm-validations", dm_ver # Validation framework
-    gem.add_development_dependency "context"
-    gem.add_development_dependency "rr"
-    gem.add_development_dependency "sinatra", "~> 1.0.0"
-    gem.add_development_dependency "rack-test"
-    gem.add_development_dependency "xmppr4-simple"
-  end
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
 
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
 end
 
-namespace :at do
-  task :init do
-    $LOAD_PATH.unshift File.expand_path(ENV['LIB']) if ENV['LIB']
-    require ENV['CONFIG'] if ENV['CONFIG']
-
-    if !Object.const_defined?(:Astrotrain)
-      require 'astrotrain'
-      Astrotrain.load
-    end
-
-    Astrotrain::Message.queue_path = ENV['QUEUE'] if ENV['QUEUE']
-    if !File.exist?(Astrotrain::Message.queue_path)
-      puts "No Queue: #{Astrotrain.queue_path.inspect}"
-      exit
-    end
-  end
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
 
-  desc "List Mappings"
-  task :mappings => :init do
-    Astrotrain::Mapping.all.each do |map|
-      puts "##{map.id}: #{map.full_email} => #{map.destination}"
-      puts "Separated by: #{map.separator.inspect}" if !map.separator.blank?
-      puts
-    end
-  end
+def date
+  Date.today.to_s
+end
 
-  desc "Add mapping EMAIL=ticket*@foo.com DEST=http://foo.com/email [TRANS=(http_post|jabber)] [SEP=REPLYABOVEHERE] [HEADERS=delivered_to,to,original_to]"
-  task :map => :init do
-    map = Astrotrain::Mapping.new
-    map.email_user, map.email_domain = ENV['EMAIL'].to_s.split('@')
-    map.destination = ENV['DEST']
-    map.transport   = ENV['TRANS'] if ENV['TRANS']
-    map.separator   = ENV['SEP']   if ENV['SEP']
-    if map.save
-      puts "Mapping created for #{map.full_email} => #{map.destination}"
-      Rake::Task['at:mappings'].invoke
-    else
-      puts map.inspect
-      puts map.errors.inspect
-    end
-  end
+def rubyforge_project
+  name
+end
 
-  desc "Remove mapping MAP=123"
-  task :unmap => :init do
-    map = Astrotrain::Mapping.get(ENV["MAP"])
-    map.destroy if map
-    Rake::Task['at:mappings'].invoke
-  end
+def gemspec_file
+  "#{name}.gemspec"
+end
 
-  desc "Start astrotrain DRb server."
-  task :process => :init do
-    require 'astrotrain/worker'
-    Astrotrain::Worker.start
-  end
+def gem_file
+  "#{name}-#{version}.gem"
 end
 
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
 require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/*_test.rb"
+  sh "open coverage/index.html"
 end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -Ilib -r #{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
   end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "astrotrain #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
 end
 
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
 
-desc 'Default: run test examples'
-task :default => 'test'
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/astrotrain.gemspec

@@ -1,141 +1,92 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
-  s.name = %q{astrotrain}
-  s.version = "0.5.4"
-
+  s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["technoweenie"]
-  s.date = %q{2010-04-01}
-  s.email = %q{technoweenie@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "astrotrain.gemspec",
-     "config/sample.rb",
-     "lib/astrotrain.rb",
-     "lib/astrotrain/api.rb",
-     "lib/astrotrain/logged_mail.rb",
-     "lib/astrotrain/mapping.rb",
-     "lib/astrotrain/mapping/http_post.rb",
-     "lib/astrotrain/mapping/jabber.rb",
-     "lib/astrotrain/mapping/transport.rb",
-     "lib/astrotrain/message.rb",
-     "lib/astrotrain/tmail.rb",
-     "lib/astrotrain/worker.rb",
-     "lib/vendor/rest-client/README.rdoc",
-     "lib/vendor/rest-client/Rakefile",
-     "lib/vendor/rest-client/bin/restclient",
-     "lib/vendor/rest-client/foo.diff",
-     "lib/vendor/rest-client/lib/rest_client.rb",
-     "lib/vendor/rest-client/lib/rest_client/net_http_ext.rb",
-     "lib/vendor/rest-client/lib/rest_client/payload.rb",
-     "lib/vendor/rest-client/lib/rest_client/request_errors.rb",
-     "lib/vendor/rest-client/lib/rest_client/resource.rb",
-     "lib/vendor/rest-client/rest-client.gemspec",
-     "lib/vendor/rest-client/spec/base.rb",
-     "lib/vendor/rest-client/spec/master_shake.jpg",
-     "lib/vendor/rest-client/spec/payload_spec.rb",
-     "lib/vendor/rest-client/spec/request_errors_spec.rb",
-     "lib/vendor/rest-client/spec/resource_spec.rb",
-     "lib/vendor/rest-client/spec/rest_client_spec.rb",
-     "test/api_test.rb",
-     "test/fixtures/apple_multipart.txt",
-     "test/fixtures/bad_content_type.txt",
-     "test/fixtures/basic.txt",
-     "test/fixtures/custom.txt",
-     "test/fixtures/fwd.txt",
-     "test/fixtures/gb2312_encoding.txt",
-     "test/fixtures/gb2312_encoding_invalid.txt",
-     "test/fixtures/html.txt",
-     "test/fixtures/html_multipart.txt",
-     "test/fixtures/iso-8859-1.txt",
-     "test/fixtures/mapped.txt",
-     "test/fixtures/multipart.txt",
-     "test/fixtures/multipart2.txt",
-     "test/fixtures/multiple.txt",
-     "test/fixtures/multiple_delivered_to.txt",
-     "test/fixtures/multiple_with_body_recipients.txt",
-     "test/fixtures/reply.txt",
-     "test/fixtures/undisclosed.txt",
-     "test/fixtures/utf-8.txt",
-     "test/logged_mail_test.rb",
-     "test/mapping_test.rb",
-     "test/message_test.rb",
-     "test/test_helper.rb",
-     "test/transport_test.rb"
-  ]
-  s.homepage = %q{http://github.com/entp/astrotrain}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{email => http post}
-  s.test_files = [
-    "test/api_test.rb",
-     "test/logged_mail_test.rb",
-     "test/mapping_test.rb",
-     "test/message_test.rb",
-     "test/test_helper.rb",
-     "test/transport_test.rb"
-  ]
+  s.rubygems_version = '1.3.5'
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'astrotrain'
+  s.version           = '0.6.0'
+  s.date              = '2012-04-13'
+  s.rubyforge_project = 'astrotrain'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<addressable>, ["= 2.0.2"])
-      s.add_runtime_dependency(%q<tmail>, ["= 1.2.3.1"])
-      s.add_runtime_dependency(%q<data_objects>, ["= 0.9.11"])
-      s.add_runtime_dependency(%q<dm-core>, ["= 0.9.11"])
-      s.add_runtime_dependency(%q<dm-aggregates>, ["= 0.9.11"])
-      s.add_runtime_dependency(%q<dm-timestamps>, ["= 0.9.11"])
-      s.add_runtime_dependency(%q<dm-types>, ["= 0.9.11"])
-      s.add_runtime_dependency(%q<dm-validations>, ["= 0.9.11"])
-      s.add_development_dependency(%q<context>, [">= 0"])
-      s.add_development_dependency(%q<rr>, [">= 0"])
-      s.add_development_dependency(%q<sinatra>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<rack-test>, [">= 0"])
-      s.add_development_dependency(%q<xmppr4-simple>, [">= 0"])
-    else
-      s.add_dependency(%q<addressable>, ["= 2.0.2"])
-      s.add_dependency(%q<tmail>, ["= 1.2.3.1"])
-      s.add_dependency(%q<data_objects>, ["= 0.9.11"])
-      s.add_dependency(%q<dm-core>, ["= 0.9.11"])
-      s.add_dependency(%q<dm-aggregates>, ["= 0.9.11"])
-      s.add_dependency(%q<dm-timestamps>, ["= 0.9.11"])
-      s.add_dependency(%q<dm-types>, ["= 0.9.11"])
-      s.add_dependency(%q<dm-validations>, ["= 0.9.11"])
-      s.add_dependency(%q<context>, [">= 0"])
-      s.add_dependency(%q<rr>, [">= 0"])
-      s.add_dependency(%q<sinatra>, ["~> 1.0.0"])
-      s.add_dependency(%q<rack-test>, [">= 0"])
-      s.add_dependency(%q<xmppr4-simple>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<addressable>, ["= 2.0.2"])
-    s.add_dependency(%q<tmail>, ["= 1.2.3.1"])
-    s.add_dependency(%q<data_objects>, ["= 0.9.11"])
-    s.add_dependency(%q<dm-core>, ["= 0.9.11"])
-    s.add_dependency(%q<dm-aggregates>, ["= 0.9.11"])
-    s.add_dependency(%q<dm-timestamps>, ["= 0.9.11"])
-    s.add_dependency(%q<dm-types>, ["= 0.9.11"])
-    s.add_dependency(%q<dm-validations>, ["= 0.9.11"])
-    s.add_dependency(%q<context>, [">= 0"])
-    s.add_dependency(%q<rr>, [">= 0"])
-    s.add_dependency(%q<sinatra>, ["~> 1.0.0"])
-    s.add_dependency(%q<rack-test>, [">= 0"])
-    s.add_dependency(%q<xmppr4-simple>, [">= 0"])
-  end
-end
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "email => http post"
+  s.description = s.summary
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@gmail.com'
+  s.homepage = 'http://github.com/technoweenie/astrotrain'
 
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('utf8',            ["~> 0.1.8"])
+  s.add_dependency('mail',            ["~> 2.4.0"])
+  s.add_dependency('i18n',            ["~> 0.4.1"])
+  s.add_dependency('faraday',         ["~> 0.5.0"])
+  s.add_dependency('addressable',     ["~> 2.2.4"])
+  s.add_dependency('charlock_holmes', ["~> 0.6.8"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('resque')
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    Rakefile
+    astrotrain.gemspec
+    lib/astrotrain.rb
+    lib/astrotrain/attachment.rb
+    lib/astrotrain/message.rb
+    lib/astrotrain/transports/http_post.rb
+    lib/astrotrain/transports/resque.rb
+    test/fixtures/apple_multipart.txt
+    test/fixtures/bad_content_type.txt
+    test/fixtures/bad_email_format.txt
+    test/fixtures/basic.txt
+    test/fixtures/custom.txt
+    test/fixtures/fwd.txt
+    test/fixtures/gb2312_encoding.txt
+    test/fixtures/gb2312_encoding_invalid.txt
+    test/fixtures/html.txt
+    test/fixtures/html_multipart.txt
+    test/fixtures/iso-8859-1.txt
+    test/fixtures/mapped.txt
+    test/fixtures/multipart.txt
+    test/fixtures/multipart2.txt
+    test/fixtures/multiple.txt
+    test/fixtures/multiple_delivered_to.txt
+    test/fixtures/multiple_with_body_recipients.txt
+    test/fixtures/reply.txt
+    test/fixtures/undisclosed.txt
+    test/fixtures/utf-8.txt
+    test/message_test.rb
+    test/test_helper.rb
+    test/transport_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/*._test\.rb/ }
+end