secret_mail 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rune Myrland
+
+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,24 @@
+= secret_mail
+
+**Still under heavy developmnet**
+
+Maintains a table of secret mail addresses, with a crypted version of the address
+which may send to it, and an action which is to performed on the mails. The actions
+are handled in an controller class which is meant to be overridden and extended
+by applications.
+
+Typical usage will be posting to blogs via an email interface.
+
+== 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) 2010 Rune Myrland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "secret_mail"
+    gem.summary = %Q{Maintan a database of secret mail adresses.}
+    gem.description = %Q{The secret mail address is mapped to a sender address and a forwarding address or action}
+    gem.email = "rune@epubify.com"
+    gem.homepage = "http://github.com/wrimle/secret_mail"
+    gem.authors = ["Rune Myrland"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "secret_mail #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/db/create_tables.rb

@@ -0,0 +1,19 @@
+class CreateTables < ActiveRecord::Migration
+  def self.up
+    create_table :mail_actions do |t|
+      t.string :secret_mail
+      t.string :crypted_from
+      t.string :salt
+      t.string :packed_action
+      t.string :packed_params
+
+      t.timestamps
+    end
+
+    add_index :mail_actions, :secret_mail
+  end
+
+  def self.down
+    drop_table :mail_actions
+  end
+end

data/lib/secret_mail/controller.rb

@@ -0,0 +1,53 @@
+require 'mail'
+
+
+class UnkownAction < StandardError
+end
+
+
+module SecretMail
+  class Controller
+    def self.process message, &block
+      record = MailAction.find_valid(message.to, message.from)
+      if record
+        Controller.new record, message, &block
+      end
+    end
+
+
+    def create
+      s = MailAction.create(@message.from[0], @record.params, @message.subject)
+      s.save
+      @created = s
+    end
+
+
+    def destroy
+      s = MailAction.find_valid(@message.subject.strip, @message.from[0])
+      s.destroy
+      s.save
+    end
+
+
+    private
+    def initialize record, message, &block
+      @record = record
+      @message = message
+
+      action = record.action
+      if respond_to?(action)
+        send(action.to_s)
+        if(@created && block_given?)
+          yield :created, @created, message
+        end
+      else
+        if block_given?
+          yield action.to_sym, record, message
+        else
+          raise UnkownAction, "Action: #{action} not implemented in the controller"
+        end
+      end
+    end
+  end
+
+end

data/lib/secret_mail/record.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'base32_pure'
+require 'json'
+require 'uuidtools'
+require 'active_record'
+
+
+module SecretMail
+  class MailAction < ActiveRecord::Base
+    def self.create from, action, params = {}
+      # Create a secret mail address
+      r = SecureRandom.random_bytes(5)
+      secret = Base32::Crockford.encode(r).downcase
+
+      # Create object with sender
+      record = MailAction.new({
+        :secret_mail => "#{secret}@#{self.mail_domain}",
+        :from => from,
+        :action => action,
+        :params => params,
+      })
+    end
+
+
+    def self.find_valid secret_mail, from
+      s = find_by_secret_mail(secret_mail)
+      if s && s.crypted_from
+        s.valid_sender?(from) ? s : nil
+      else
+        s
+      end
+    end
+
+    def from= v
+      self.salt = UUIDTools::UUID::random_create.to_s
+      self.crypted_from = MailAction.sign(salt, v)
+    end
+
+
+    def valid_sender? v
+      crypted_from == MailAction.sign(salt, v)
+    end
+
+
+    def action= v
+      self.packed_action = [v].to_json
+    end
+
+
+    def action
+      (self.packed_action && JSON.parse(self.packed_action)[0]) || nil
+    end
+
+
+    def params= v
+      self.packed_params = [v].to_json
+    end
+
+
+    def params
+      (self.packed_params && JSON.parse(self.packed_params)[0]) || nil
+    end
+
+
+    protected
+    def self.mail_domain v = nil
+      if v
+        @mail_domain = v
+      else
+        @mail_domain
+      end
+    end
+
+
+    def self.sign salt, v
+      namespace = UUIDTools::UUID.parse(salt)
+      UUIDTools::UUID.sha1_create(namespace, v).hexdigest
+    end
+
+  end
+end

data/lib/secret_mail.rb

@@ -0,0 +1,3 @@
+
+require 'secret_mail/record'
+require 'secret_mail/controller'

data/script/db_create.rb

@@ -0,0 +1,27 @@
+#!/bin/env ruby
+
+require 'rubygems'
+require 'active_record'
+require 'yaml'
+require 'db/create_tables'
+
+db_yaml = case
+          when File.exists?(f = "config/database.yml") then
+            f
+          when File.exists?(f = "#{ENV['HOME']}/.secret_mail/config/database.yml") then
+            f
+          when File.exists?(f = "/etc/secret_mail/database.yml") then
+            f
+          else
+            nil
+          end
+
+dbconfig = YAML::load(File.open(db_yaml))
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Base.connection
+
+begin
+  CreateTables.up
+rescue ActiveRecord::StatementInvalid
+  puts "Creation failed. Tables already up?"
+end

data/script/db_drop.rb

@@ -0,0 +1,27 @@
+#!/bin/env ruby
+
+require 'rubygems'
+require 'active_record'
+require 'yaml'
+require 'db/create_tables'
+
+db_yaml = case
+          when File.exists?(f = "config/database.yml") then
+            f
+          when File.exists?(f = "#{ENV['HOME']}/.secret_mail/config/database.yml") then
+            f
+          when File.exists?(f = "/etc/secret_mail/database.yml") then
+            f
+          else
+            nil
+          end
+
+dbconfig = YAML::load(File.open(db_yaml))
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Base.connection
+
+begin
+  CreateTables.down
+rescue ActiveRecord::StatementInvalid
+  puts "Dropping failed. Tables already down?"
+end

data/spec/controller_spec.rb

@@ -0,0 +1,65 @@
+
+describe SecretMail::Controller do
+  begin
+  end
+
+  it "takes a mail message and translates it to a controller action" do
+    @mail = Mail.new do
+      to "blog@example.com"
+      from "from@example.com"
+      subject "user@example.com"
+      body "A body"
+    end
+
+    controller = SecretMail::Controller::process(@mail)
+  end
+
+
+  it "creates a new secret mail address if email address has action create" do
+    @mail = Mail.new do
+      to "blog@example.com"
+      from "from@example.com"
+      subject "user@example.com"
+      body "A body"
+    end
+
+    controller = SecretMail::Controller::process(@mail)
+    controller.instance_eval do
+      secret_mail = @created.secret_mail
+      r = SecretMail::MailAction.find_valid(secret_mail, "from@example.com")
+      r.should_not == nil
+
+      r.action.should_not == nil
+      r.params.should_not == nil
+      r.salt.should_not == nil
+      r.crypted_from.should_not == nil
+    end
+  end
+
+
+  it "destroys a secret mail address if email address has action destroy" do
+    create_mail = Mail.new do
+      to "blog@example.com"
+      from "from@example.com"
+      subject "user@example.com"
+      body "A body"
+    end
+
+    controller = SecretMail::Controller::process(create_mail)
+
+    destroy_mail = Mail.new do
+      to "destroy@example.com"
+      from "from@example.com"
+      body "A body"
+    end
+    controller.instance_eval do
+      destroy_mail.subject @created.secret_mail
+    end
+    secret_mail = destroy_mail.subject
+    controller = SecretMail::Controller::process(destroy_mail)
+
+    record = SecretMail::MailAction.find_valid(secret_mail, "from@example.com")
+    record.should == nil
+  end
+
+end

data/spec/record_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+include SecretMail
+
+describe "MailAction" do
+  begin
+    salt = UUIDTools::UUID::random_create.to_s
+    attributes = {
+      :secret_mail => "secret@example.com",
+      :from => "from@example.com",
+      :action => "mail_to",
+      :params => {}
+    }
+    MailAction.new(attributes).save
+  end
+
+
+  it "creates a secret mail address for a sender email and an action" do
+    mail_from = "from@example.com"
+    action = "mail_to"
+    params = { :to => "secret@example.com" }
+    record = MailAction::create(mail_from, action, params)
+    
+    record.secret_mail.should be_a(String)
+    record.secret_mail.length.should be > 0
+    record.secret_mail.should include("@#{MailAction.mail_domain}")
+
+    record.action.should_not == nil
+    record.params.should_not == nil
+
+    record.should be_valid_sender(mail_from)
+    record.save
+  end
+
+
+  it "checks that the sender is valid" do
+    secret_mail = "secret@example.com"
+    from = "wrong@example.com"
+    record = MailAction::find_valid(secret_mail, from)
+    record.should be(nil)
+  end
+
+
+  it "finds an action based on secret_mail and sender" do
+    from = "from@example.com"
+    # The secret is in the mails to field
+    secret_mail = "secret@example.com"
+    record = MailAction::find_valid(secret_mail, from)
+    record.should_not be(nil)
+    record.action.should_not == nil
+  end
+
+
+  it "destroys a secret_mail when asked to" do
+    from = "from@example.com"
+    secret_mail = "secret@example.com"
+    record = MailAction::find_valid(secret_mail, from)
+    record.should_not be(nil)
+    record.destroy
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'secret_mail'
+require 'spec'
+require 'spec/autorun'
+require 'fileutils'
+require 'db/create_tables'
+
+Spec::Runner.configure do |config|
+  SecretMail::MailAction.mail_domain "example.com"
+
+  ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database => "db/test.sqlite3"
+  ) 
+  ActiveRecord::Base.connection
+  ActiveRecord::Migrator.migrate("db/migrate")
+  begin
+    CreateTables.down
+  rescue
+  end
+  CreateTables.up
+ 
+  attributes = {
+    :secret_mail => "blog@example.com",
+    :action => "create",
+    :params => "mail_to"
+  }
+  record = SecretMail::MailAction.new(attributes)
+  record.save
+
+  attributes = {
+    :secret_mail => "destroy@example.com",
+    :action => "destroy",
+    :params => {}
+  }
+  record = SecretMail::MailAction.new(attributes)
+  record.save
+
+
+  Mail.defaults do
+    delivery_method :test
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: secret_mail
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Rune Myrland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: The secret mail address is mapped to a sender address and a forwarding address or action
+email: rune@epubify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- db/create_tables.rb
+- lib/secret_mail.rb
+- lib/secret_mail/controller.rb
+- lib/secret_mail/record.rb
+- script/db_create.rb
+- script/db_drop.rb
+- spec/controller_spec.rb
+- spec/record_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/wrimle/secret_mail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Maintan a database of secret mail adresses.
+test_files: 
+- spec/record_spec.rb
+- spec/spec_helper.rb
+- spec/controller_spec.rb