mailee 0.3.0 → 0.4.2

data/README.markdown

@@ -7,58 +7,152 @@
 
 == A solução
 
-  Este plugin tem como objetivo manter os contatos da sua aplicação sincronizados com os contatos do Mailee (www.mailee.me) sem muito esforço. De fato, basta executar o método "sync_with_mailee" no seu modelo (clientes, contatos, pessoas...) que este irá automaticamente realizar as tarefas de inserir, atualizar, excluir e descadastrar via REST. No Mailee, seu cliente poderá então montar as mensagens e enviar para os contatos.
+  Esta gem tem como objetivo manter os contatos da sua aplicação sincronizados com os contatos do Mailee (www.mailee.me) sem muito esforço. De fato, basta executar o método "sync_with_mailee" no seu modelo (clientes, contatos, pessoas...) que este irá automaticamente realizar as tarefas de inserir, atualizar, excluir e descadastrar via REST. No Mailee, seu cliente poderá então montar as mensagens e enviar para os contatos.
+
+== O que posso fazer com a gem?
+
+ * Simplesmente utilizar as classes do Mailee para:
+   * Criar, atualizar, buscar e excluir contatos.
+   * Importar contatos com nome e email.
+   * Criar, atualizar, buscar e excluir listas.
+   * Criar, atualizar, buscar e excluir templates.
+   * Criar rascunhos, enviar testes e enviar mensagens agora ou para uma data futura. O envio de mensagens permite enviar para uma lista, para um conjunto de emails, definindo o html na mão ou usando um template do Mailee.me e definindo áreas editáveis e de repetições.
+   * Buscar datos dos relatórios.
+ * Integrar com ActiveRecord (com ou sem Rails) e fazer um modelo sincronizar automaticamente com o Mailee.me.
+ * Integrar com ActionMailer (com ou sem Rails) e fazer os mailers enviarem as mensagens pelo Mailee.me.
 
 == Instalação
 
- * Execute o seguinte comando em sua aplicação Rails:
- > script/plugin install git@github.com:softa/mailee-api.git
- * Adicione a seguinte linha de configuração em sua aplicação:
- Mailee::Config.site = 'http://api.chave.subdominio.wizee.net'
- O site você descobre entrando no Mailee e indo em Configurações > Integração > REST
- 
- Pronto!
+ * Adicione a seguinte linha ao seu Gemfile:
+ > gem 'mailee'
+ * E execute o bundle:
+ > bundle install
+ * Uma vez instalado, para configurar, execute:
+ > rake mailee_rails:setup
+
+  Este comando irá solicitar sua URL da API e criar um initializer com toda a configuração necessária.
+  A URL da API você descobre entrando no Mailee e indo em Configurações > Integração > REST
  
+  Pronto!
+
+== Compatibilidade
+
+  Rails 3. 'Nuff said. Se você precisa de suporte aoRails 2, baixe a versão 0.1.0, mas ela possui muito menos funcionalidades do que a versão atual.
+
 == Uso
 
   * Na mão (console)
+
   Você pode usar a api do maile "na mão". Basta abrir o console e usar:
   > ruby script/console
+  >> include Mailee
   >> Contact.find(:all)
   >> Contact.find(:first)
+  >> Contact.search('russell')
+  >> Contact.find_by_internal_id(789)
+  >> Contact.find_by_email('russell@cambridge.edu.uk')
   >> Contact.create(:name => 'Bertrand Russell', :email => 'russell@cambridge.edu.uk')
-  Mais exemplos você encontra(rá) na (futura) documentação da API.
+  >> Contact.create(:email => 'ludwig@wittgenstein.edu.uk', :dynamic_attributes => {:influence => 'Frege'})
+  >> List.find(:all)
+  >> List.find(:first)
+  >> List.create(:name => 'My List')
+  >> Template.find(:all)
+  >> Template.find(:first)
+  >> Template.create(:title => 'My Template', :html => File.read('mytemplate.html'))
+  # Message with HTML and list
+  >> message = Message.create :title => "Title", :subject => "Subject", :from_name => "Rorty", :from_email => "rorty@princeton.us", :html => File.read('myhtml.html'), :list_id => 987
+  # Message with emails and template (with edits & repeats)
+  >> message = Message.create :title => "Title", :subject => "Subject", :from_name => "Rorty", :from_email => "rorty@princeton.us", :template_id => 765, :edits => {:greeting => 'Hi Davidson!'}, :repeats => {:news => ['A good news', 'A bad news'], :emails => 'davidson@some.com davidson@another.com'}
+  >> message.test([44,55,66])
+  >> message.ready # send it now
+  >> message.ready(10.days.from_now)
+
   * Com modelos (ActiveRecord)
-  Este plugin é feito para manter um modelo AciveRecord sincronizado com os contatos do Mailee. Para fazer isto, basta colocar o método "sync_with_mailee" em seu modelo. Se o seu modelo se chama "Contact", por exemplo, o código seria este:
+
+  Esta gem é feita para manter um modelo AciveRecord sincronizado com os contatos do Mailee. Para fazer isto, basta colocar o método "sync_with_mailee" em seu modelo. Se o seu modelo se chama "Contact", por exemplo, o código seria este:
   =code
     class Contact < ActiveRecord::Base
       sync_with_mailee
     end
-  A priori, o plugin espera que você tenha pelo menos um campo de email e pressupõe que o nome deste campo é "email". Se o campo da sua tabela não tem este nome, você pode fazer o seguinte:
+  A priori, a gem espera que você tenha pelo menos os campos de email e optins, e pressupõe que estes campos se chamem "email" e "news". Se os campos da sua tabela não tem estes nomes, você pode fazer o seguinte:
   =code
     class Contact < ActiveRecord::Base
-      sync_with_mailee :email => :my_email_column
+      sync_with_mailee :email => :my_email_column, :news => :my_optin_column
     end
-  Onde "my_email_column" é a coluna que guarda o e-mail na sua tabela.
-  O plugin também pode manter o nome do seu contato sincronizado, bastando para isto ter um campo "name" que será mapeado por padrão, mas que também pode ser sobrescrito:
+  Onde "my_email_column" é a coluna que guarda o e-mail na sua tabela e "my_optin_column" o booleano que guarda o optin.
+  A gem também pode manter o nome do seu contato sincronizado, bastando para isto ter um campo "name" que será mapeado por padrão, mas que também pode ser sobrescrito:
   =code
     class Contact < ActiveRecord::Base
-      sync_with_mailee :email => :my_email_column, :name => :my_name_column
-    end  
-  Por fim, o plugin permite que o cadastro no Mailee seja condicionado a um campo booleano (o padrão é "news"), que corresponde ao "opt-in" (a escolha de receber ou não mensagens) do seu contato. Ou seja, se o valor do campo for false, o plugin não cadastrará o contato no Mailee, e se o contato já estiver cadastrado e o valor deste campo mudar para falso, o contato será descadastrado e _não_ poderá ser mais cadastrado no Mailee (normas de privacidade). Para mudar o campo, basta:
-  =code
-    class Contact < ActiveRecord::Base
-      sync_with_mailee :email => :my_email_column, :name => :my_name_column, :news => :do_you_really_accept_to_receive_our_newsletter
+      sync_with_mailee :name => :my_name_column
     end  
+  Se o valor do campo "news" (ou o que você utilizar para optin) for false, a gem não cadastrará o contato no Mailee. Se o contato já estiver cadastrado e o valor deste campo mudar para falso, o contato será descadastrado e _não_ poderá ser mais cadastrado no Mailee (normas de privacidade). Se ele estiver falso e mudar para verdadeiro, ele irá cadastrá-lo.
+
+  * Com mailers (ActionMailer)
+  
+  Esta gem permite que você utilize o Mailee.me como meio de enviar suas mensagens sem precisar configurar um servidor smtp ou algo pareceido.
+  
+  Você pode optar por enviar todas as mensagens por ele, ou só as mensagens de determinados mailers. Para a configuração global, adicione a seguinte linha ao seu arquivo de ambiente (config/environments/production.rb ou development.rb):
+
+  = code
+    config.action_mailer.delivery_method = Mailee::Mailer
+
+  Agora, se você quer enviar apenas mensagens de um certo mailer pelo Mailee, basta adicionar o método "send_with_mailee" em cada um:
+
+  = code
+    class Notifications < ActionMailer::Base
+      send_with_mailee
+      ...
+    end
+  
+  É importante definir o from com o formato completo:
+
+  = code
+    class Notifications < ActionMailer::Base
+      default :from => "Plato <plato@liceum.gr>
+      ...
+    end
+
+  Ao enviar uma mensagem, você pode também optar por enviá-la agora ou no futuro:
+
+  = code
+    class Notifications < ActionMailer::Base
+      def signup(client, date=Time.now)
+        mail :date => date, :to => client.email
+      end
+      def feedback(client, date=Time.now)
+        mail :date => date, :to => client.email
+      end
+    end
+    ...
+    Notifications.signup(client).deliver
+    Notifications.feedback(client, 3.days.from_now).deliver
+
+  Por fim, ao enviar uma mensagem, a gem adiciona um método que representa a mensagem no Mailee.me, veja:
+  
+  = code
+    mail = Notifications.signup(client).deliver
+    mail.mailee_message.id # Retorna o id
+    mail.mailee_message.html # Retorna o html
+    # e assim por diante...
+  
+  Isto é útil, pois você já pode monitorar os resultados com este id:
+
+  = code
+    mail = Notifications.signup(client).deliver
+    Mailee::Report.find(mail.mailee_message.id)
+
   * Tarefas (rake)
+
   Caso você já tenha itens cadastrados, é necessário adicionar estes contatos ao Mailee antes de mais nada. Para isso execute a tarefa rake:
   > rake mailee:send CLASS=Contact
   Onde "Contact" é o nome do seu modelo. Se você quer apenas enviar os contatos a partir de uma determinada data, você pode fazê-lo desta forma:
   > rake mailee:send CLASS=Contact AFTER=5.days.ago
   Neste caso, ele vai apenas sincronizar os contatos que foram atualizados (baseado no campo "updated_at") nos últimos 5 dias.  
-  * Mas... como isso funciona, caso eu precise saber?
-  O plugin utiliza a API REST do Mailee para enviar dados, por isto cuide bem da sua URL - se alguém descobrir isso pode ser ruim. Para saber qual o contato na sua aplicação o plugin utiliza um campo disponível no Mailee chamado "internal_id" o qual recebe o "id" da sua tabela na criação. Este id é usado nas atualizações, descadastros e exclusões, então tome (ou avise seu cliente para tomar!) cuidado ao editar este campo na interface do Mailee.
+
+== Cuidado!
+
+  A gem utiliza a API REST do Mailee para enviar dados, por isto cuide bem da sua URL - se alguém descobrir isso pode ser ruim. Para saber qual o contato na sua aplicação a gem utiliza um campo disponível no Mailee chamado "internal_id" o qual recebe o "id" da sua tabela na criação. Este id é usado nas atualizações, descadastros e exclusões, então tome (ou avise seu cliente para tomar!) cuidado ao editar este campo na interface do Mailee.
 
 == Dúvidas?
 
-  Qualquer dúvida, não hesite em falar conosco pelo e-mail suporte@mailee.me. 
+  Qualquer dúvida, não hesite em falar conosco pelo e-mail suporte@mailee.me, pelo twitter @maileeme ou pelo IRC #maileeme. 

data/README.markdown.pt

@@ -0,0 +1,64 @@
+= Mailee - Email marketing para quem entende de tecnologia.
+==============
+
+== O problema
+
+  Você está desenvolvendo um sistema (e-commerce, cms, erp...) e o seu cliente solicita a possibilidade de enviar e-mails promocionais, ou notícias, para diversos contatos. Por experiência própria, você sabe que enviar e-mails não é coisa para _scriptkiddies_, e que, de fato, não vale a pena o esforço de desenvolver todo um sistema que faça o envio, garanta a entrega, analise os retornos e também apresente resultados de tudo isso. O problema é que os sistemas que você conhece não permitem uma integração fácil e rápida com seus sistemas em Rails...
+
+== A solução
+
+  Este plugin tem como objetivo manter os contatos da sua aplicação sincronizados com os contatos do Mailee (www.mailee.me) sem muito esforço. De fato, basta executar o método "sync_with_mailee" no seu modelo (clientes, contatos, pessoas...) que este irá automaticamente realizar as tarefas de inserir, atualizar, excluir e descadastrar via REST. No Mailee, seu cliente poderá então montar as mensagens e enviar para os contatos.
+
+== Instalação
+
+ * Execute o seguinte comando em sua aplicação Rails:
+ > script/plugin install git@github.com:softa/mailee-api.git
+ * Adicione a seguinte linha de configuração em sua aplicação:
+ Mailee::Config.site = 'http://api.chave.subdominio.wizee.net'
+ O site você descobre entrando no Mailee e indo em Configurações > Integração > REST
+ 
+ Pronto!
+ 
+== Uso
+
+  * Na mão (console)
+  Você pode usar a api do maile "na mão". Basta abrir o console e usar:
+  > ruby script/console
+  >> Contact.find(:all)
+  >> Contact.find(:first)
+  >> Contact.create(:name => 'Bertrand Russell', :email => 'russell@cambridge.edu.uk')
+  Mais exemplos você encontra(rá) na (futura) documentação da API.
+  * Com modelos (ActiveRecord)
+  Este plugin é feito para manter um modelo AciveRecord sincronizado com os contatos do Mailee. Para fazer isto, basta colocar o método "sync_with_mailee" em seu modelo. Se o seu modelo se chama "Contact", por exemplo, o código seria este:
+  =code
+    class Contact < ActiveRecord::Base
+      sync_with_mailee
+    end
+  A priori, o plugin espera que você tenha pelo menos um campo de email e pressupõe que o nome deste campo é "email". Se o campo da sua tabela não tem este nome, você pode fazer o seguinte:
+  =code
+    class Contact < ActiveRecord::Base
+      sync_with_mailee :email => :my_email_column
+    end
+  Onde "my_email_column" é a coluna que guarda o e-mail na sua tabela.
+  O plugin também pode manter o nome do seu contato sincronizado, bastando para isto ter um campo "name" que será mapeado por padrão, mas que também pode ser sobrescrito:
+  =code
+    class Contact < ActiveRecord::Base
+      sync_with_mailee :email => :my_email_column, :name => :my_name_column
+    end  
+  Por fim, o plugin permite que o cadastro no Mailee seja condicionado a um campo booleano (o padrão é "news"), que corresponde ao "opt-in" (a escolha de receber ou não mensagens) do seu contato. Ou seja, se o valor do campo for false, o plugin não cadastrará o contato no Mailee, e se o contato já estiver cadastrado e o valor deste campo mudar para falso, o contato será descadastrado e _não_ poderá ser mais cadastrado no Mailee (normas de privacidade). Para mudar o campo, basta:
+  =code
+    class Contact < ActiveRecord::Base
+      sync_with_mailee :email => :my_email_column, :name => :my_name_column, :news => :do_you_really_accept_to_receive_our_newsletter
+    end  
+  * Tarefas (rake)
+  Caso você já tenha itens cadastrados, é necessário adicionar estes contatos ao Mailee antes de mais nada. Para isso execute a tarefa rake:
+  > rake mailee:send CLASS=Contact
+  Onde "Contact" é o nome do seu modelo. Se você quer apenas enviar os contatos a partir de uma determinada data, você pode fazê-lo desta forma:
+  > rake mailee:send CLASS=Contact AFTER=5.days.ago
+  Neste caso, ele vai apenas sincronizar os contatos que foram atualizados (baseado no campo "updated_at") nos últimos 5 dias.  
+  * Mas... como isso funciona, caso eu precise saber?
+  O plugin utiliza a API REST do Mailee para enviar dados, por isto cuide bem da sua URL - se alguém descobrir isso pode ser ruim. Para saber qual o contato na sua aplicação o plugin utiliza um campo disponível no Mailee chamado "internal_id" o qual recebe o "id" da sua tabela na criação. Este id é usado nas atualizações, descadastros e exclusões, então tome (ou avise seu cliente para tomar!) cuidado ao editar este campo na interface do Mailee.
+
+== Dúvidas?
+
+  Qualquer dúvida, não hesite em falar conosco pelo e-mail suporte@mailee.me. 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.2

data/app/Gemfile

@@ -1,7 +1,7 @@
 source 'http://rubygems.org'
 
 gem 'rails', '3.0.0'
-gem 'mailee'
+gem 'mailee', '0.4.0'
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
 

data/app/Gemfile.lock

@@ -38,6 +38,7 @@ GEM
       activesupport (>= 2.3.6)
       mime-types
       treetop (>= 1.4.5)
+    mailee (0.4.0)
     mime-types (1.16)
     polyglot (0.3.1)
     rack (1.2.1)
@@ -69,5 +70,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  mailee (= 0.4.0)
   rails (= 3.0.0)
   sqlite3-ruby

data/app/config/initializers/mailee.rb

@@ -1 +1 @@
-Mailee::Config.site = 'your.api.path'
+Mailee::Config.site = 'http://api.bdb28c0a0a4a3.softa.mailee.me'

data/lib/mailee.rb

@@ -1,280 +1,8 @@
 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
-  end
+module Mailee; 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})
-    end
-    def self.find_by_email email
-      find(:first, :params => {:email => email})
-    end
-    def self.search keyword, page=1
-      find(:all, :params => {:page => page, :by_keyword => keyword })
-    end
-    def unsubscribe(data={})
-      #E.g. data --> {:reason => 'Trip to nowhere', :spam => false}
-      put(:unsubscribe, :unsubscribe => {:reason => 'Motivo não especificado'}.merge(data))
-    end
-    def subscribe(list)
-      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) && 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
-
-    module ClassMethods
-      def sync_with_mailee(options = {})
-        unless syncd? # don't let AR call this twice
-          cattr_accessor :sync_options
-          after_create :create_in_mailee
-          after_update :update_in_mailee
-          after_destroy :destroy_in_mailee
-          self.sync_options = {:email => :email, :name => :name, :news => :news}.merge(options) #options[:with] || :deleted_at
-          unless self.column_names.include?(self.sync_options[:email].to_s)
-            raise "Campo #{sync_options[:email]} não existe em #{new.class}."
-          end
-          unless self.column_names.include?(self.sync_options[:name].to_s)
-            self.sync_options[:name] = nil
-          end
-          unless self.column_names.include?(self.sync_options[:news].to_s)
-            self.sync_options[:news] = nil
-          end
-        end
-        include InstanceMethods
-      end
-
-      def syncd?
-        self.included_modules.include?(InstanceMethods)
-      end
-
-    end
-
-    module InstanceMethods #:nodoc:
-
-      def self.included(base) # :nodoc:
-        base.extend ClassMethods
-      end
-      
-      def create_in_mailee
-        return if( sync_options[:news] and ! send(sync_options[:news])) # Não cria se houver o campo booleano e ele for falso
-        self.class.benchmark "Criando contato no Mailee" do
-          contact = Mailee::Contact.new
-          contact.internal_id = id
-          contact.email = send(sync_options[:email])
-          contact.name = send(sync_options[:name]) if sync_options[:name]
-          contact.save
-        end
-      rescue
-        logger.warn "MAILEE-API: Falhou ao criar o contato #{id} no Mailee"
-      end
-
-      def update_in_mailee
-        self.class.benchmark "Atualizando contato no Mailee" do
-          contact = Mailee::Contact.find_by_internal_id id
-          if contact
-            #Se o contato existe e o booleano foi desmarcado, realiza um UNSUBSCRIBE
-            if sync_options[:news] and (! send(sync_options[:news]))
-              unsubscribe_in_mailee(contact)
-            else
-              contact.email = send(sync_options[:email])
-              contact.name = send(sync_options[:name]) if sync_options[:name]
-              contact.save
-            end
-          else
-            create_in_mailee # Se não achou o contato tem q inserir.
-          end
-        end
-      rescue
-        logger.warn "MAILEE-API: Falhou ao atualizar o contato #{id} no Mailee"
-      end
-
-      def destroy_in_mailee contact=nil
-        self.class.benchmark "Excluindo contato no Mailee" do
-          contact ||= Mailee::Contact.find_by_internal_id id
-          contact.destroy
-        end
-      rescue
-        logger.warn "MAILEE-API: Falhou ao excluir o contato #{id} no Mailee"
-      end
-
-      def unsubscribe_in_mailee contact=nil
-        self.class.benchmark "Descadastrando contato no Mailee" do
-          contact ||= Mailee::Contact.find_by_internal_id id
-          contact.unsubscribe
-        end
-      rescue
-        logger.warn "MAILEE-API: Falhou ao descadastrar o contato #{id} no Mailee"
-      end
-      
-      module ClassMethods
-        # Sincroniza todos os itens do modelo com Mailee.
-        # Permite que se passe um datetime para enviar apenas os contatos atualizados depois desta data
-        # Permite o uso de um bloco, que receberá o item do modelo e o item do Mailee associado a este.
-        # Ex: Contact.send_all_to_mailee{|i,im| im.address = i.endereco; im.save }
-        # Importante: este método apenas envia os contatos, mas não recebe.
-        # Para receber contatos, o ideal é fazer uma exportação no Mailee e realizar uma importação deste arquivo CSV no seu sistema.
-        
-        def send_all_to_mailee(after=nil)
-          items = after ? all(:conditions => ["updated_at >= ?", after]) : all
-          for item in items
-            begin
-              contact = Mailee::Contact.find_by_internal_id item.id
-              if contact and sync_options[:news] and ! item.send(sync_options[:news])
-                contact.unsubscribe
-                yield item, contact if block_given?
-                next
-              end
-              unless contact
-                next if sync_options[:news] and ! item.send(sync_options[:news])
-                contact = Mailee::Contact.new
-                contact.internal_id = item.id
-              end
-              contact.email = item.send(sync_options[:email])
-              contact.name = item.send(sync_options[:name]) if sync_options[:name]
-              contact.save
-              yield item, contact if block_given?
-            rescue
-              logger.warn "MAILEE-API: Falhou ao enviar o contato #{id} ao Mailee"
-            end
-          end
-        end
-      end
-    end
-  end
-end
-ActiveRecord::Base.send(:include, Mailee::Sync) if defined?(ActiveRecord)
-ActionMailer::Base.send(:include, Mailee::Send) if defined?(ActionMailer)
+require 'mailee/active_resource'
+require 'mailee/railties' if defined?(Rails)
+require 'mailee/active_record' if defined?(ActiveRecord)
+require 'mailee/action_mailer' if defined?(ActionMailer)

data/lib/mailee/action_mailer.rb

@@ -0,0 +1,52 @@
+module Mailee
+  # 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
+      result = message.ready(mail.date)
+      mail.instance_eval{ self.class.send('attr_accessor', :mailee_message); self.mailee_message = result }
+      self 
+    end
+  end
+
+  module Send
+
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def send_with_mailee
+        self.delivery_method = Mailee::Mailer
+      end
+    end
+
+  end
+end
+ActionMailer::Base.send(:include, Mailee::Send)

data/lib/mailee/active_record.rb

@@ -0,0 +1,153 @@
+# The Sync module is responsible for keeping a model syncd with Mailee.
+# It's behaviour is still too rails-twooish. But soon I'll make it more
+# treeish using Railties and stuff. But it works.
+#
+# All you need in your model are two fields, one for the email and one
+# for the optin, wich is by default called "news". The name field is
+# optional but encouraged.
+#
+# USAGE
+#
+#   # Simple example
+#   class Client < ActiveRecord::Base
+#     sync_with_mailee
+#   end
+#
+#   # Super hyper brainfuck complex example
+#   class Client < ActiveRecord::Base
+#     sync_with_mailee :email => :email_field, :name => :name_field, :news => :news_field
+#   end
+
+module Mailee
+  module Sync
+
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def sync_with_mailee(options = {})
+        unless syncd? # don't let AR call this twice
+          cattr_accessor :sync_options
+          after_create :create_in_mailee
+          after_update :update_in_mailee
+          after_destroy :destroy_in_mailee
+          self.sync_options = {:email => :email, :name => :name, :news => :news}.merge(options)
+          unless self.column_names.include?(self.sync_options[:email].to_s)
+            raise "Campo #{sync_options[:email]} não existe em #{new.class}."
+          end
+          unless self.column_names.include?(self.sync_options[:name].to_s)
+            self.sync_options[:name] = nil
+          end
+          unless self.column_names.include?(self.sync_options[:news].to_s)
+            self.sync_options[:news] = nil
+          end
+        end
+        include InstanceMethods
+      end
+
+      def syncd?
+        self.included_modules.include?(InstanceMethods)
+      end
+
+    end
+
+    module InstanceMethods #:nodoc:
+
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+    
+      def create_in_mailee
+        return if( sync_options[:news] and ! send(sync_options[:news])) # Não cria se houver o campo booleano e ele for falso
+        self.class.benchmark "Criando contato no Mailee" do
+          contact = Mailee::Contact.new
+          contact.internal_id = id
+          contact.email = send(sync_options[:email])
+          contact.name = send(sync_options[:name]) if sync_options[:name]
+          contact.save
+        end
+      rescue
+        logger.warn "MAILEE-API: Falhou ao criar o contato #{id} no Mailee"
+      end
+
+      def update_in_mailee
+        self.class.benchmark "Atualizando contato no Mailee" do
+          contact = Mailee::Contact.find_by_internal_id id
+          if contact
+            #Se o contato existe e o booleano foi desmarcado, realiza um UNSUBSCRIBE
+            if sync_options[:news] and (! send(sync_options[:news]))
+              unsubscribe_in_mailee(contact)
+            else
+              contact.email = send(sync_options[:email])
+              contact.name = send(sync_options[:name]) if sync_options[:name]
+              contact.save
+            end
+          else
+            create_in_mailee # Se não achou o contato tem q inserir.
+          end
+        end
+      rescue
+        logger.warn "MAILEE-API: Falhou ao atualizar o contato #{id} no Mailee"
+      end
+
+      def destroy_in_mailee contact=nil
+        self.class.benchmark "Excluindo contato no Mailee" do
+          contact ||= Mailee::Contact.find_by_internal_id id
+          contact.destroy
+        end
+      rescue
+        logger.warn "MAILEE-API: Falhou ao excluir o contato #{id} no Mailee"
+      end
+
+      def unsubscribe_in_mailee contact=nil
+        self.class.benchmark "Descadastrando contato no Mailee" do
+          contact ||= Mailee::Contact.find_by_internal_id id
+          contact.unsubscribe
+        end
+      rescue
+        logger.warn "MAILEE-API: Falhou ao descadastrar o contato #{id} no Mailee"
+      end
+    
+      module ClassMethods
+
+        # Sends all items from the model to Mailee.
+        # Allows passing a datetime to send only contacts updated after.
+        # Also allows the use of a block, wich will receive the record of
+        # the model and the record from Mailee:
+        #
+        #   Contact.send_all_to_mailee{|i,im| im.address = i.endereco; im.save }
+        #
+        # IMPORTANT:
+        # This method only _sends_ contacts. It does not receives 'em.
+        # If you need to receive contacts, for now the best way is to export in
+        # Mailee's web interface and import in your app.
+        def send_all_to_mailee(after=nil)
+          items = after ? all(:conditions => ["updated_at >= ?", after]) : all
+          for item in items
+            begin
+              contact = Mailee::Contact.find_by_internal_id item.id
+              if contact and sync_options[:news] and ! item.send(sync_options[:news])
+                contact.unsubscribe
+                yield item, contact if block_given?
+                next
+              end
+              unless contact
+                next if sync_options[:news] and ! item.send(sync_options[:news])
+                contact = Mailee::Contact.new
+                contact.internal_id = item.id
+              end
+              contact.email = item.send(sync_options[:email])
+              contact.name = item.send(sync_options[:name]) if sync_options[:name]
+              contact.save
+              yield item, contact if block_given?
+            rescue
+              logger.warn "MAILEE-API: Falhou ao enviar o contato #{id} ao Mailee"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, Mailee::Sync) if defined?(ActiveRecord)

data/lib/mailee/active_resource.rb

@@ -0,0 +1,102 @@
+module Mailee
+
+  # The Config class is used to set your api url.
+  # You can do it in your applications.rb or in a initializer.
+  # It's simple:
+  #
+  #   Mailee::Config.site = "http://your.mailee.api.url"
+  class Config < ActiveResource::Base
+  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})
+    end
+    def self.find_by_email email
+      find(:first, :params => {:email => email})
+    end
+    def self.search keyword, page=1
+      find(:all, :params => {:page => page, :by_keyword => keyword })
+    end
+    def unsubscribe(data={})
+      #E.g. data --> {:reason => 'Trip to nowhere', :spam => false}
+      put(:unsubscribe, :unsubscribe => {:reason => 'Motivo não especificado'}.merge(data))
+    end
+    def subscribe(list)
+      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) && 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
+
+end

data/lib/mailee/railties.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/actions'
+
+# = Mailee Railtie
+#
+# Creates a new railtie in order to add the mailee_rails:setup generator.
+class MaileeRails < Rails::Railtie
+
+  # Creates the mailee:rails:setup generator. This generator creates an initializer
+  # called "mailee.rb" by asking the user his api URL, and defining it to
+  # Mailee::Config.site attribute wich makes all that ActiveResource stuff works.
+  class Setup < Rails::Generators::Base
+    include Rails::Generators::Actions
+    def create
+      puts "Please enter your api URL:"
+      attempts = 0
+      url = readline.gsub(/\n/,'').gsub(/\s+/, '')
+      while url !~ /^http:\/\/api\.[a-f0-9]{13}\.[a-z\-]+?\.mailee\.me$/
+        attempts += 1
+        if attempts < 3
+          puts "Invalid URL. Please try again:"
+          url = readline.gsub(/\n/,'').gsub(/\s+/, '')
+        else
+          puts "I think need support. Please talk to us on IRC (#maileeme) or send an email to suporte@mailee.me"
+          exit
+        end
+      end
+      initializer("mailee.rb") do
+        "Mailee::Config.site = '#{url}'"
+      end
+      puts "*** Keep your key top secret, ok?"
+      puts "*** If anything goes wrong, reach us on IRC (#mailee) or by email on suporte@mailee.me"
+      puts "*** Thanks for using Mailee.me"
+    end
+  end
+end

data/mailee.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailee}
-  s.version = "0.3.0"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juan Maiz"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-10-08}
   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 = [
     "LICENSE",
      "README.markdown",
+     "README.markdown.pt",
      "README.rdoc"
   ]
   s.files = [
@@ -77,11 +78,17 @@ Gem::Specification.new do |s|
      "init.rb",
      "install.rb",
      "lib/mailee.rb",
+     "lib/mailee/action_mailer.rb",
+     "lib/mailee/active_record.rb",
+     "lib/mailee/active_resource.rb",
+     "lib/mailee/railties.rb",
      "mailee.gemspec",
      "pkg/mailee-0.1.0.gem",
      "pkg/mailee-0.1.1.gem",
      "pkg/mailee-0.1.2.gem",
+     "spec/am_spec_helper.rb",
      "spec/ar_spec_helper.rb",
+     "spec/mailee-api-am.rb",
      "spec/mailee-api-ar.rb",
      "spec/mailee-api.rb",
      "spec/spec.opts",
@@ -94,7 +101,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Gem de integração do Mailee.me}
   s.test_files = [
-    "spec/ar_spec_helper.rb",
+    "spec/am_spec_helper.rb",
+     "spec/ar_spec_helper.rb",
+     "spec/mailee-api-am.rb",
      "spec/mailee-api-ar.rb",
      "spec/mailee-api.rb",
      "spec/spec_helper.rb"

data/spec/am_spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'action_mailer'
+require 'mailee'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end
+
+class Foo < ActionMailer::Base
+
+  send_with_mailee
+
+  default :from => "Maiz <maiz@softa.com.br>"
+
+  def bar(date=Time.now)
+    @greeting = "Hi"
+    mail :date => date, :to => ["juanmaiz@gmail.com"]
+  end
+  
+end

data/spec/mailee-api-am.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/am_spec_helper')
+  
+describe "Mailee" do
+
+  before(:each) do
+    Mailee::Config.site = "http://api.bdb28c0a0a4a3.softa.server:3000"
+  end
+  
+  it "should respond to send_with_mailee" do
+    ActionMailer::Base.should respond_to(:send_with_mailee)
+  end
+
+  it "should use Mailee::Mailer as the delivery method" do
+    Foo.delivery_method.should be(Mailee::Mailer)
+  end
+
+  it "should deliver" do
+    result = Foo.bar.deliver
+    result.should_not be(false)
+    result.class.should be(Mail::Message)
+    result.delivery_method.class.should be(Mailee::Mailer)
+    result.mailee_message.class.should be(Mailee::Message)
+    result.mailee_message.id.should_not be(nil)
+    result.mailee_message.status.should_not be(4)
+    result.mailee_message.title.should_not be('Foo')
+    result.mailee_message.subject.should_not be('Foo')
+    result.mailee_message.from_name.should_not be('Maiz')
+    result.mailee_message.from_email.should_not be('maiz@softa.com.br')
+  end
+
+end

data/spec/mailee-api-ar.rb

@@ -6,7 +6,12 @@ describe "Mailee" do
     Mailee::Config.site = "http://api.bdb28c0a0a4a3.softa.server:3000"
     @moment = Time.now.strftime('%Y%m%d%H%M%S')
   end
-  
+
+  it "should respond to sync_with_mailee" do
+    ActiveRecord::Base.should respond_to(:sync_with_mailee)
+  end
+
+
   it "should create if news is checked" do
     foo = Foo.create :name => "rest_test_foo_#{@moment}", :email => "rest_test_foo_#{@moment}@test.com", :news => true
     found = Mailee::Contact.find_by_email("rest_test_foo_#{@moment}@test.com")

data/spec/mailee-api.rb

@@ -1,5 +1,3 @@
-#INSERT INTO "unsubscribes" ("created_at", "contact_id", "reason", "spam", "message_id") VALUES('2010-10-05 22:52:25.657597', 2082562, default, 'f', default) RETURNING "id"
-
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Mailee" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailee
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 0
-  version: 0.3.0
+  - 4
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Juan Maiz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-07 00:00:00 -04:00
+date: 2010-10-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.markdown
+- README.markdown.pt
 - README.rdoc
 files: 
 - LICENSE
@@ -89,16 +90,23 @@ files:
 - init.rb
 - install.rb
 - lib/mailee.rb
+- lib/mailee/action_mailer.rb
+- lib/mailee/active_record.rb
+- lib/mailee/active_resource.rb
+- lib/mailee/railties.rb
 - mailee.gemspec
 - pkg/mailee-0.1.0.gem
 - pkg/mailee-0.1.1.gem
 - pkg/mailee-0.1.2.gem
+- spec/am_spec_helper.rb
 - spec/ar_spec_helper.rb
+- spec/mailee-api-am.rb
 - spec/mailee-api-ar.rb
 - spec/mailee-api.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/mailee_tasks.rake
+- README.markdown.pt
 has_rdoc: true
 homepage: http://help.mailee.me/integration_rails.html
 licenses: []
@@ -134,7 +142,9 @@ signing_key:
 specification_version: 3
 summary: "Gem de integra\xC3\xA7\xC3\xA3o do Mailee.me"
 test_files: 
+- spec/am_spec_helper.rb
 - spec/ar_spec_helper.rb
+- spec/mailee-api-am.rb
 - spec/mailee-api-ar.rb
 - spec/mailee-api.rb
 - spec/spec_helper.rb