chatterbox-email 0.2.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rob Sanheim
+
+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,18 @@
+= chatterbox-email
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Rob Sanheim. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "chatterbox-email"
+    gem.summary = %Q{Send emails via chatterbox}
+    gem.description = %Q{Send emails via chatterbox - see chatterbox main project for details}
+    gem.email = "rsanheim@gmail.com"
+    gem.homepage = "http://github.com/rsanheim/chatterbox-email"
+    gem.authors = ["Rob Sanheim"]
+    gem.add_development_dependency "spicycode-micronaut"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'micronaut/rake_task'
+Micronaut::RakeTask.new(:examples) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.ruby_opts << '-Ilib -Iexamples'
+end
+
+Micronaut::RakeTask.new(:rcov) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.rcov_opts = '-Ilib -Iexamples'
+  examples.rcov = true
+end
+
+task :examples => :check_dependencies
+
+task :default => :examples
+
+task :release => [:default, "gemcutter:release"]
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chatterbox-email #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/examples/chatterbox/email_example.rb

@@ -0,0 +1,44 @@
+require 'example_helper'
+
+describe Chatterbox::Email do
+  include Chatterbox
+  
+  describe "creation" do
+    it "is wired with valid options" do
+      lambda {
+        Chatterbox::Email.deliver(valid_options)
+      }.should_not raise_error
+    end
+    
+    it "returns TMail::Mail instance" do
+      result = Chatterbox::Email.deliver(valid_options)
+      result.should be_instance_of(TMail::Mail)
+    end
+  end
+  
+  describe "validations" do
+    it "should require :message" do
+      lambda {
+        Email.deliver(:config => { :from => "foo", :to => "foo"})
+      }.should raise_error(ArgumentError, /Must configure with a :message/)
+    end
+    
+    it "should require :message => :summary" do
+      lambda {
+        Email.deliver(:message => {}, :config => { :from => "foo", :to => "foo"})
+      }.should raise_error(ArgumentError, /Must provide :summary in the :message/)
+    end
+    
+    it "should require :to" do
+      lambda {
+        Email.deliver(:message => {:summary => ""}, :config => { :from => "anyone" })
+      }.should raise_error(ArgumentError, /Must provide :to in the :config/)
+    end
+  
+    it "should require from address" do
+      lambda {
+        Email.deliver(:message => {:summary => ""}, :config => { :to => "anyone"})
+      }.should raise_error(ArgumentError, /Must provide :from in the :config/)
+    end
+  end
+end

data/examples/chatterbox/mailer_example.rb

@@ -0,0 +1,56 @@
+require 'example_helper'
+
+describe Chatterbox::Mailer do
+  before { ActionMailer::Base.delivery_method = :test }
+  include Chatterbox
+
+  describe "wiring the email" do
+    it "should set subject to the summary" do
+      email = Mailer.create_message(valid_options.merge(:message => { :summary => "check this out"}))
+      email.subject.should == "check this out"
+    end
+    
+    it "should not require a body (for emails that are subject only)" do
+      email = Mailer.create_message(valid_options.merge(:message => { :body => nil}))
+      email.body.should be_blank # not nil for some reason -- ActionMailer provides an empty string somewhere
+    end
+    
+    it "should set body to the body" do
+      email = Mailer.create_message(valid_options.merge(:message => { :body => "here is my body"}))
+      email.body.should == "here is my body"
+    end
+    
+    it "should set from" do
+      email = Mailer.create_message(valid_options.merge(:config => { :from => ["from@example.com"] }))
+      email.from.should == ["from@example.com"]
+    end
+  end
+  
+  describe "content type" do
+    it "can be set" do
+      Mailer.create_message(valid_options.merge(:config => { :content_type => "text/html"})).content_type.should == "text/html"
+    end
+    
+    it "should default to text/plain" do
+      Mailer.create_message(valid_options).content_type.should == "text/plain"
+    end
+  end
+  
+  [:to, :cc, :bcc, :reply_to].each do |field| 
+    describe "when configuring the #{field} field that takes one or many email addresses" do
+      it "should allow setting a single address" do
+        email = Mailer.create_message(valid_options.merge(:config => { field => "joe@exmaple.com"}))
+        email.send(field).should == ["joe@exmaple.com"]
+      end
+      
+      it "should allow setting multiple addresses" do
+        email = Mailer.create_message(valid_options.merge(:config => { field => ["joe@example.com", "frank@example.com"]}))
+        email.send(field).should == ["joe@example.com", "frank@example.com"]
+      end
+    end
+  end
+
+end
+
+# content_type - Specify the content type of the message. Defaults to text/plain.
+# headers - Specify additional hea

data/examples/example_helper.rb

@@ -0,0 +1,30 @@
+gem 'spicycode-micronaut'
+require 'micronaut'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'chatterbox'
+require 'chatterbox/email'
+
+ActionMailer::Base.delivery_method = :test
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+def valid_options(overrides = {})
+  options = { 
+    :message => { :summary => "here is a message" },
+    :config => { 
+      :to => "joe@example.com", 
+      :from => "someone@here.com" 
+    }
+  }.merge(overrides)
+end
+
+Micronaut.configure do |c|
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+end

data/lib/chatterbox/email.rb

@@ -0,0 +1,52 @@
+require 'chatterbox'
+require 'chatterbox/mailer'
+
+module Chatterbox
+  class Email
+    
+    def self.deliver(options = {})
+      new(options).deliver
+    end
+    
+    attr_reader :options
+    
+    def initialize(options = {})
+      @options = options
+      validate_options
+    end
+    
+    def deliver
+      Mailer.deliver_message(options)
+    end
+    
+    private
+    
+    def validate_options
+      require_message
+      require_message_keys(:summary)
+      
+      require_config
+      require_config_keys(:to, :from)
+    end
+    
+    def require_message
+      raise(ArgumentError, "Must configure with a :message") unless options.key?(:message)
+    end
+    
+    def require_config
+      raise(ArgumentError, "Must configure with a :config") unless options.key?(:config)
+    end
+    
+    def require_config_keys(*keys)
+      Array(keys).each do |key|
+        raise(ArgumentError, "Must provide #{key.inspect} in the :config") unless options[:config].key?(key)
+      end
+    end
+    
+    def require_message_keys(*keys)
+      Array(keys).each do |key|
+        raise(ArgumentError, "Must provide #{key.inspect} in the :message") unless options[:message].key?(key)
+      end
+    end
+  end
+end

data/lib/chatterbox/mailer.rb

@@ -0,0 +1,26 @@
+require 'actionmailer'
+
+module Chatterbox
+  class Mailer < ActionMailer::Base
+    self.template_root = File.join(File.dirname(__FILE__), *%w[views])
+
+    def self.reloadable?() false end
+
+    def message(data={})
+      data = data.dup.symbolize_keys
+    
+      content_type data[:config][:content_type] || "text/plain" 
+
+      recipients data[:config][:to]
+      from       data[:config][:from]
+
+      reply_to   data[:config][:reply_to] if data[:config][:reply_to]
+      bcc        data[:config][:bcc] if data[:config][:bcc]
+      cc         data[:config][:cc] if data[:config][:cc]
+      
+      subject    data[:message][:summary]
+      body       data[:message][:body] if data[:message][:body]
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: chatterbox-email
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Rob Sanheim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spicycode-micronaut
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Send emails via chatterbox - see chatterbox main project for details
+email: rsanheim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/chatterbox/email_example.rb
+- examples/chatterbox/mailer_example.rb
+- examples/example_helper.rb
+- lib/chatterbox/email.rb
+- lib/chatterbox/mailer.rb
+- lib/chatterbox/views/chatterbox/mailer/message.erb
+has_rdoc: true
+homepage: http://github.com/rsanheim/chatterbox-email
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Send emails via chatterbox
+test_files: 
+- examples/chatterbox/email_example.rb
+- examples/chatterbox/mailer_example.rb
+- examples/example_helper.rb