remail 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.markdown

@@ -0,0 +1,59 @@
+Remail is RESTful email for Rails.
+
+Forget configuring SMTP servers and queues, just use Remail. 
+Remail uses Google App Engine to send and receive emails RESTfully.
+
+Remail only support Rails 3.
+
+Google App Engine gives you a free quota of 2000 emails per day or, with the
+paid version, 7,400,000 emails per day.
+
+## Features
+* POST emails to your Remail App Engine in order to send them
+* Remail POSTS received emails back to a configurable URL
+
+## Setup
+* Configure and deploy the [Remail App Engine](http://github.com/maccman/remail-engine)
+* Install the Remail gem (sudo gem install remail)
+
+## Sending email
+  Configure ActionMailer and Remail:
+  
+    config.action_mailer.delivery_method = :remail
+    config.action_mailer.remail_settings = {
+      :app_id  => "remail-appname",
+      :api_key => "changeme"
+    }
+  
+  The sender address of a message must be the email address of an administrator for the Remail App Engine.
+  If you want to send email on behalf of the application but do not want to use a single administrator's personal Google Account as the sender, you can create a new Google Account for the application using any valid email address, then add the new account as an administrator for the application.
+  
+## Receiving email
+* Configure the callback URL in your Remail App Engine.
+* Create a email controller, that looks a bit like this (remember to configure the routes):
+
+        class EmailsController < ApplicationController
+          skip_before_filter :verify_authenticity_token
+          
+          def create
+            if request.headers["Authorization"] != your_api_key
+              return head(:unauthorized)
+            end
+            UserMailer.receive(params[:email][:raw])
+            head :success
+          end
+        end
+  
+The API key is also passed through as an Authorization header,
+you should definitely validate that.
+
+You might want to add :email to the filter_parameters configuration, you 
+don't want your logs being clogged up with emails.
+
+Your app can receive email at addresses of the following form:
+  string@appid.appspotmail.com
+    
+## Misc
+
+To ensure your email doesn't get caught in spam filters, you should follow 
+the tips in this tutorial I [wrote](http://madebymany.co.uk/getting-email-around-spam-filters-00221) - the important points being setting SPF and MX records.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "remail"
+    gemspec.summary = "RESTful email"
+    gemspec.email = "info@eribium.org"
+    gemspec.homepage = "http://github.com/maccman/remail"
+    gemspec.authors = ["Alex MacCaw"]
+    gemspec.add_dependency("activeresource")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/remail.rb

@@ -0,0 +1,74 @@
+require "active_resource"
+
+module Remail
+  def site=(site)
+    Email.site = site
+  end
+  module_function :site=
+  
+  def app_id=(name)
+    self.site = "http://#{name}.appspot.com"
+  end
+  module_function :app_id=
+  
+  def api_key=(key)
+    Email.headers["Authorization"] = key
+  end
+  module_function :api_key=
+  
+  class Email < ActiveResource::Base
+    self.timeout = 5
+    self.format  = :json
+    
+    cattr_accessor :headers
+    @@headers = {}
+    
+    schema do
+      string :sender, :to, :cc, :bcc,
+             :reply_to, :subject,
+             :body, :html
+    end
+    
+    validates_presence_of :sender, :to, :subject
+    validates_presence_of :body, :unless => :html?
+
+    # The sender address must be the email address of a 
+    # registered administrator for the application    
+    def from=(address)
+      self.sender = address
+    end
+  end
+  
+  class ActionMailer
+    def initialize(settings)
+      settings.each {|key, value| 
+        Remail.send("#{key}=", value) 
+      }
+    end
+        
+    def deliver!(mail)
+      remail = Remail::Email.new
+      
+      %w{to from cc bcc reply_to}.each {|attr|
+        value = mail.send(attr)
+        next unless value
+        remail.send("#{attr}=", value.join(", "))
+      }      
+      
+      remail.subject  = mail.subject
+      
+      text_body   = mail.text_part ? mail.text_part.body : mail.body
+      html_body   = mail.html_part && mail.html_part.body
+      remail.body = text_body.encoded if text_body
+      remail.html = html_body.encoded if html_body
+      
+      remail.save!
+    end
+  end
+end
+
+begin
+  require "action_mailer"
+  ActionMailer::Base.add_delivery_method(:remail, Remail::ActionMailer)
+rescue LoadError
+end

data/remail.gemspec

@@ -0,0 +1,44 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{remail}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex MacCaw"]
+  s.date = %q{2010-03-22}
+  s.email = %q{info@eribium.org}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/remail.rb",
+     "remail.gemspec"
+  ]
+  s.homepage = %q{http://github.com/maccman/remail}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{RESTful email}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activeresource>, [">= 0"])
+    else
+      s.add_dependency(%q<activeresource>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activeresource>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: remail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: info@eribium.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- VERSION
+- lib/remail.rb
+- remail.gemspec
+has_rdoc: true
+homepage: http://github.com/maccman/remail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: RESTful email
+test_files: []
+