mailee 0.2.1 → 0.3.0

data/app/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/app/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/app/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby1.8
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/app/test.rb

@@ -0,0 +1 @@
+Foo.bar.deliver

data/app/test/functional/foo_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class FooTest < ActionMailer::TestCase
+  test "bar" do
+    mail = Foo.bar
+    assert_equal "Bar", mail.subject
+    assert_equal ["to@example.org"], mail.to
+    assert_equal ["from@example.com"], mail.from
+    assert_match "Hi", mail.body.encoded
+  end
+
+  test "baz" do
+    mail = Foo.baz
+    assert_equal "Baz", mail.subject
+    assert_equal ["to@example.org"], mail.to
+    assert_equal ["from@example.com"], mail.from
+    assert_match "Hi", mail.body.encoded
+  end
+
+end

data/app/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/app/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/mailee.rb

@@ -1,8 +1,26 @@
 require 'active_resource'
 module Mailee
+
+  # The Config class is used to set your api url.
+  # You can do it in your applications.rb or in a initializar.
+  # It's simple:
+  #
+  #   Mailee::Config.site = "http://your.mailee.api.url"
   class Config < ActiveResource::Base
-    # O self.site tem q ser configurado no environment!
   end
+
+  # The Contact class gives you default access to your contacts (all,
+  # first, create, update, destroy) plus some facilities, like searching
+  # contacts by email, keyword (a smart search), signature (name & email)
+  # and internal id.
+  #
+  # Also, you can subscribe contacts to lists and unsubscribe. In Mailee
+  # unsubscribing a contact is radical: it will be unsubscribed from ALL
+  # lists FOREVER. House rules.
+  #
+  # If you use mailee gem to sync a model, it will always set the internal_id
+  # to your "local" model id and then search based on it to update de remote
+  # record.
   class Contact < Config
     def self.find_by_internal_id iid
       find(:first, :params => {:internal_id => iid})
@@ -21,32 +39,119 @@ module Mailee
       put(:subscribe, :list => {:name => list})
     end
   end
+
+  # The List class gives you default access to your lists (all, first, create, update, destroy)
   class List < Config
   end
+
+  # The Template class gives you default access to your templates (all, first, create, update, destroy)
   class Template < Config
   end
+
+  # The Quick class allows you to import contacts to mailee just like
+  # in the interface
+  #
+  # USAGE:
+  #
+  #   # Emails only
+  #   Mailee::Quick.import("witt@cambridge.uk dick@princeton.edu")
+  #
+  #   # Names and emails (needs line breaks)
+  #   Mailee::Quick.import("witt@cambridge.uk, Wittgenstein\ndick@princeton.edu, Rorty")
+  #   
+  #   # Signatures (gmail style)
+  #   Mailee::Quick.import('"Wittgenstein" <witt@cambridge.uk>,
+  #                         "Rorty" <dick@princeton.edu.us>')
   class Quick < Config
     self.collection_name = "quick"
     def self.import contacts
       create :contacts => contacts
     end
   end
+
+  # The Message class is where the fun happens.
+  #
+  # USAGE:
+  #
+  #   # Creating a message (still a draft):
+  #   message = Mailee::Message.create :title => "TITLE", :subject => "SUBJ", :from_name => "NAME", :from_email => "your@email.com", :html => "<h1>Hello</h1>", :list_id => 666
+  #   # Sending tests. 33, 44 and 55 are contact's ids.
+  #   message.test([33,44,55]).should_not be nil
+  #   # Sending the message now ...
+  #   message.ready
+  #   # ... or sending the message 10 days from now
+  #   message.ready(10.days.from_now)
   class Message < Config
     def test contacts
       put(:test, :contacts => contacts)
     end
     def ready date=nil, hour=0
-      if date && date.is_a?(Date)
-        put(:ready, :when => 'after', :date => date.strftime("%d/%m/%Y"), :hour => hour)
+      if date && date.is_a?(Date) && date > Time.now
+        put(:ready, :when => 'after', :after => {:date => date.strftime("%d/%m/%Y"), :hour => date.strftime('%H')})
       else
         put(:ready, :when => 'now')
       end
     end
   end
+  
+  # The Report class is still beta. It can return the results of a
+  # message - total deliveries, accesses and returns. There are also
+  # methods for getting accesses, unsubscribes and returns in "real time".
   class Report < Config
   end
 
+  # The Mailer class is responsible for making the mailee gem ActionMailer
+  # compatible.
+  #
+  # USAGE:
+  #
+  #  If you want to use Mailee to send all your systems emails, simply
+  #  configure the environment (dev or prod) like this:
+  #
+  #    config.action_mailer.delivery_method = Mailee::Mailer
+  #
+  #  But if you wanna send just a certain mailer with Mailee, add
+  #  "send_with_mailee" on a per mailer basis
+  #
+  #    class Notifications < ActionMailer::Base
+  #      send_with_mailee
+  #    end
+  #
+  #  One important thing, is to add the sender's name to the default "from" in
+  #  your mailer, this way:
+  #
+  #    default :from => "Your name <your@email.com.br>"
+  #
+  #  And don't forget to config your domain SPF!
+  class Mailer
+    
+    def initialize config
+    end
+    def deliver! mail
+      from_name = mail.header['from'].to_s.scan(/(.+?) <.+?>$/).to_s      
+      message = Mailee::Message.create :title => mail.subject, :subject => mail.subject, :from_name => from_name, :from_email => mail.from.first, :emails => mail.to.join(' '), :html => mail.body.to_s
+      message.ready(mail.date)
+      self 
+    end
+  end
+
+  module Send
+
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def send_with_mailee
+        puts "1"
+        self.delivery_method = Mailee::Mailer
+      end
+    end
+
+  end
+
   module Sync
+
     def self.included(base) # :nodoc:
       base.extend ClassMethods
     end
@@ -75,9 +180,11 @@ module Mailee
       def syncd?
         self.included_modules.include?(InstanceMethods)
       end
+
     end
 
     module InstanceMethods #:nodoc:
+
       def self.included(base) # :nodoc:
         base.extend ClassMethods
       end
@@ -169,4 +276,5 @@ module Mailee
     end
   end
 end
-ActiveRecord::Base.send(:include, Mailee::Sync) if defined?(ActiveRecord)
+ActiveRecord::Base.send(:include, Mailee::Sync) if defined?(ActiveRecord)
+ActionMailer::Base.send(:include, Mailee::Send) if defined?(ActionMailer)

data/mailee.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailee}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juan Maiz"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2010-10-07}
   s.description = %q{Permite sincronizar automaticamente seus modelos com o Mailee.me, inclusive com gerenciamento de optin.}
   s.email = %q{suporte@mailee.me}
   s.extra_rdoc_files = [
@@ -24,6 +24,56 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "app/.gitignore",
+     "app/Gemfile",
+     "app/Gemfile.lock",
+     "app/README",
+     "app/Rakefile",
+     "app/app/controllers/application_controller.rb",
+     "app/app/helpers/application_helper.rb",
+     "app/app/mailers/foo.rb",
+     "app/app/views/foo/bar.html.erb",
+     "app/app/views/foo/baz.text.erb",
+     "app/app/views/layouts/application.html.erb",
+     "app/config.ru",
+     "app/config/application.rb",
+     "app/config/boot.rb",
+     "app/config/database.yml",
+     "app/config/environment.rb",
+     "app/config/environments/development.rb",
+     "app/config/environments/production.rb",
+     "app/config/environments/test.rb",
+     "app/config/initializers/backtrace_silencers.rb",
+     "app/config/initializers/inflections.rb",
+     "app/config/initializers/mailee.rb",
+     "app/config/initializers/mime_types.rb",
+     "app/config/initializers/secret_token.rb",
+     "app/config/initializers/session_store.rb",
+     "app/config/locales/en.yml",
+     "app/config/routes.rb",
+     "app/db/seeds.rb",
+     "app/doc/README_FOR_APP",
+     "app/lib/tasks/.gitkeep",
+     "app/public/404.html",
+     "app/public/422.html",
+     "app/public/500.html",
+     "app/public/favicon.ico",
+     "app/public/images/rails.png",
+     "app/public/index.html",
+     "app/public/javascripts/application.js",
+     "app/public/javascripts/controls.js",
+     "app/public/javascripts/dragdrop.js",
+     "app/public/javascripts/effects.js",
+     "app/public/javascripts/prototype.js",
+     "app/public/javascripts/rails.js",
+     "app/public/robots.txt",
+     "app/public/stylesheets/.gitkeep",
+     "app/script/rails",
+     "app/test.rb",
+     "app/test/functional/foo_test.rb",
+     "app/test/performance/browsing_test.rb",
+     "app/test/test_helper.rb",
+     "app/vendor/plugins/.gitkeep",
      "init.rb",
      "install.rb",
      "lib/mailee.rb",