talktome 0.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12474ba945a8c289bc358c4e654667ac7684618b3c19f3babd74dcd6c4dd2dd
-  data.tar.gz: e3a4ebaaa0796bae48cc52e978c3aee64aade68cd80c654616171f9bf49da783
+  metadata.gz: 8ca8cf300ad4144fd6336f1ff56e4fc97140742869f10397ce62c9d0fecd3c03
+  data.tar.gz: 9d439309e79ebb3da0ea177af0606e882a643adc55e045cca5a56bb154ac6888
 SHA512:
-  metadata.gz: a64d48bc5544b99ae7868a10d2435b390526ccf9a95fc0ca323952264cb933749d20aea08365b3d9f995143df7514f7624e40dc69b2398791750149db2abc21e
-  data.tar.gz: 9253bdbe2c08c1b75a6eeb9bb4a5e0dbfb6402365d9e925fe64282e872e034bd71da900eb235fe8e674ecd6e586b3a73a81a832775267c21b10f4f5ad1365a95
+  metadata.gz: d4bd93a6e3bde5390185ebd55844a0db7b48fd81ca0c0982289d67ca15c5866f402b645191f6ba1826a7c4b5147b67937e0d7c07cd9f08788a616b2f019751c4
+  data.tar.gz: 9b255ab12108b8e37c024aff7bbe49b8ce85c543cc14fe62b797d64aadcbd59c2a9fe33530bdfa3e35872a7a3a553673ff064472e4fbf4cf4563377c2de4ad14

data/LICENSE.md

@@ -1,22 +1,20 @@
-# The MIT Licence
+Copyright (c) 2017-2021 - Enspirit SPRL (Bernard Lambeau)
 
-    Copyright (c) 2017 - Enspirit SPRL (Bernard Lambeau)
+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:
 
-    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 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.
+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.md

@@ -1,3 +1,141 @@
 # Talktome - Talk to users easily
 
-...
+[![Build Status](https://travis-ci.com/enspirit/talktome.svg?branch=master)](https://travis-ci.com/enspirit/talktome)
+
+Talktome helps talking to users (by email for now, but later we aim to add support
+for various notification systems) easily. As a ruby gem to be used programmatically,
+or as a docker container exposing web services (different use cases, see below).
+
+## Using Talktome programmatically
+
+Using Talktome programmatically is useful to send transactional emails to users.
+
+```
+require 'talktome'
+CLIENT = Talktome::Client::Local.new(path_to_templates)
+
+# later on
+CLIENT.talktome(template_name, user, template_info, strategies)
+
+# typically, the will send an email to foo@bar.com instantiating
+# the email found in path_to_templates/hello/email.md and
+# instantiated using mustache and markdown
+CLIENT.talktome("hello", {email: 'foo@bar.com'}, {}, [:email])
+```
+
+## Using Talktome using the docker image
+
+The docker image aims at supporting another category of use cases, such as providing
+a reusable backend for contact forms.
+
+```
+docker run \
+    -p4567:4567 \
+    -e TALKTOME_EMAIL_DEFAULT_FROM=info@mydomain.com
+    -e TALKTOME_EMAIL_DEFAULT_TO=support@mydomain.com
+    enspirit/talktome
+```
+
+Send an contact-us email through the web api using curl, as follows:
+
+```
+curl -XPOST \
+     -H'Content-Type: application/json' \
+     -d'{"reply_to": "someone@foo.bar", "message": "Hello"}' \
+     http://127.0.0.1:4567/contact-us/
+```
+
+This web API does not allow specifying `from` and `to` as input data to avoid
+exposing a way to send SPAM easily.
+
+### Overriding templates (and having more than one endpoint)
+
+The default image comes with a single contact-us email template used by Enspirit.
+Feel free to override it by providing one or more email templates.
+
+You can mount a volume with email templates into `/app/templates/`, which will
+be used for the available endpoints. For instance, the following `templates/`
+folder will expose two endpoints with possibly different behaviors (according
+to the templates themselves):
+
+```
+templates/
+  contact-us/
+    email.md
+  report-issue/
+    email.md
+```
+
+Two usual ways to do so in docker: commandline or Dockerfile. On commandline,
+use the following option:
+
+```
+-v ${PWD}/my-templates:/app/templates
+```
+
+In a Dockerfile, add your templates:
+
+```
+FROM enspirit/talktome
+
+COPY ./templates /app/templates
+```
+
+## Configuring Talktome
+
+The easiest way to configure Talktome is through environment variables. The following
+ones are supported:
+
+```
+TALKTOME_DEBUG                   when set enables the dumping of sent messages to ./tmp folder
+
+TALKTOME_EMAIL_DELIVERY          smtp, file or test (see ruby Mail library)
+TALKTOME_EMAIL_DEFAULT_FROM      default From: to use for email sending
+TALKTOME_EMAIL_DEFAULT_REPLYTO   default Reply-To: to use for email sending
+TALKTOME_EMAIL_DEFAULT_TO        default To: to use for email sending
+
+TALKTOME_EMAIL_SUBJECT           Set the subject of the default "contact us" email
+TALKTOME_EMAIL_FOOTER            Set the footer of the default "contact us" email
+
+TALKTOME_LAYOUTS_FOLDER          Set the folder to use for messaging layouts
+
+TALKTOME_SMTP_ADDRESS            host address for smtp sending
+TALKTOME_SMTP_PORT               port of smtp server to use
+TALKTOME_SMTP_DOMAIN             sending domain
+TALKTOME_SMTP_USER               user for smtp authentication
+TALKTOME_SMTP_PASSWORD           password for smtp authentication
+TALKTOME_SMTP_STARTTLS_AUTO      true or false (see ruby Mail library)
+
+TALKTOME_BEARER_SECRET           secret for the webapi, to let send emails to anyone
+```
+
+## Hacking Talktome
+
+In pure Ruby:
+
+```
+bundle install
+bundle exec rake test
+```
+
+Or using docker, please then use the `make` targets initially cooked for Jenkins:
+
+```
+make image
+make test
+```
+
+## Contributing
+
+Please use github issues for questions and bugs, and pull requests for
+submitting improvement proposals and new features.
+
+## Contributors
+
+Enspirit (https://enspirit.be) and Klaro App (https://klaro.cards) are
+both actively using, contributing and funding work on this library.
+Please contact Bernard Lambeau for any question.
+
+## Licence
+
+Webspicy is distributed under a MIT Licence, by Enspirit SRL.

data/lib/talktome.rb

@@ -4,25 +4,39 @@ require 'mustache'
 require 'redcarpet'
 module Talktome
 
+  # Root folder of the project structure
+  ROOT_FOLDER = Path.backfind('.[Gemfile]') or raise("Missing Gemfile")
+
+  def env(which, default = nil)
+    if ENV.has_key?(which)
+      got = ENV[which].to_s.strip
+      return got unless got.empty?
+    end
+    default
+  end
+  module_function :env
+
+  def with_env(which, &bl)
+    env(which).tap{|x|
+      bl.call(x) unless x.nil?
+    }
+  end
+  module_function :with_env
+
+  def set_env(which, value, &bl)
+    old, ENV[which] = ENV[which], value
+    bl.call.tap{
+      ENV[which] = old
+    }
+  end
+  module_function :set_env
+
   def redcarpet
     @redcarpet ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML, extensions = {})
   end
   module_function :redcarpet
 
-  #
   # Infer all client and strategy options from environment variables.
-  # The following ones are recognized:
-  #
-  # - TALKTOME_DEBUG: when set (to anything) enables the dumping of sent
-  #   messages to the debug folder
-  # - TALKTOME_EMAIL_DELIVERY: "smtp", "file" or "test"
-  # - TALKTOME_EMAIL_DEFAULT_FROM: default from address to use for email sending
-  # - TALKTOME_SMTP_ADDRESS: host address for smtp sending
-  # - TALKTOME_SMTP_PORT: port of smtp server to use
-  # - TALKTOME_SMTP_DOMAIN: sending domain
-  # - TALKTOME_SMTP_USER: user for smtp authentication
-  # - TALKTOME_SMTP_PASSWORD: user for smtp authentication
-  #
   def auto_options(folder)
     options = {}
     debug_folder = folder/"tmp"
@@ -40,10 +54,11 @@ module Talktome
 
     email_config.merge!({
       address:   ENV['TALKTOME_SMTP_ADDRESS'],
-      port:      ENV['TALKTOME_SMTP_PORT'],
+      port:      ENV['TALKTOME_SMTP_PORT'].to_i,
       domain:    ENV['TALKTOME_SMTP_DOMAIN'],
       user_name: ENV['TALKTOME_SMTP_USER'],
-      password:  ENV['TALKTOME_SMTP_PASSWORD']
+      password:  ENV['TALKTOME_SMTP_PASSWORD'],
+      enable_starttls_auto: (ENV['TALKTOME_SMTP_STARTTLS_AUTO'] != 'false')
     }) if email_delivery == :smtp
 
     email_config.merge!({
@@ -52,9 +67,21 @@ module Talktome
 
     options[:strategies][:email] = ::Talktome::Strategy::Email.new{|email|
       email.delivery_method(email_delivery, email_config)
-      email.from(ENV['TALKTOME_EMAIL_DEFAULT_FROM']) if ENV['TALKTOME_EMAIL_DEFAULT_FROM']
+      with_env('TALKTOME_EMAIL_DEFAULT_FROM'){|default|
+        email.from(default)
+      }
+      with_env('TALKTOME_EMAIL_DEFAULT_TO'){|default|
+        email.to(default)
+      }
+      with_env('TALKTOME_EMAIL_DEFAULT_REPLYTO'){|default|
+        email.reply_to(default)
+      }
     }
 
+    if layouts_folder = ENV['TALKTOME_LAYOUTS_FOLDER']
+      options[:layouts] = Path(layouts_folder)
+    end
+
     options
   end
   module_function :auto_options

data/lib/talktome/app.rb

@@ -0,0 +1,77 @@
+require 'sinatra'
+require 'finitio'
+require 'rack/robustness'
+module Talktome
+  class App < Sinatra::Application
+
+    use Rack::Robustness do |g|
+      g.catch_all
+      g.status 500
+      g.content_type 'text/plain'
+      g.body{ "An error occured." }
+    end
+
+    set :raise_errors, true
+    set :show_exceptions, false
+    set :talktome, Talktome::Client::Local.new(ROOT_FOLDER/'templates')
+
+    VALIDATION_SCHEMA = ::Finitio.system(<<~FIO)
+      @import finitio/data
+      Email = String(s | s =~ /^[^@]+@[^@]+$/ )
+      {
+        to       :? Email
+        reply_to :? Email
+        ...      :  .Object
+      }
+    FIO
+
+    post %r{/([a-z-]+([\/][a-z-]+)*)/} do |action, _|
+      begin
+        as_array = info.map{|k,v| {'key' => k.capitalize, 'value' => v}}
+        subject  = Talktome.env('TALKTOME_EMAIL_SUBJECT', 'Someone wants to reach you!')
+        footer   = Talktome.env('TALKTOME_EMAIL_FOOTER', "Truly yours,\n
+          Sent by [Enspirit.be](https://enspirit.be/), contact us if you need help with any IT task.")
+        user     = load_user_from_info!
+        settings.talktome.talktome(action, user, info.merge(allvars: as_array, subject: subject, footer: footer), [:email]){|email|
+          email.reply_to = info[:reply_to] if info.has_key?(:reply_to)
+        }
+        [ 200, { "Content-Type" => "text/plain"}, ["Ok"] ]
+      rescue JSON::ParserError
+        fail!("Invalid data")
+      rescue Finitio::Error => ex
+        fail!(ex.message)
+      rescue ::Talktome::InvalidEmailError => ex
+        fail!("Invalid email address")
+      end
+    end
+
+  private
+
+    def info
+      @info ||= VALIDATION_SCHEMA.dress(JSON.parse(request.body.read)).tap{|info|
+        not_a_robot!(info)
+      }
+    end
+
+    def load_user_from_info!
+      if to = info[:to]
+        secret = Talktome.env('TALKTOME_BEARER_SECRET')
+        fail!("Missing secret", 400) unless secret
+        fail!("Invalid secret", 401) unless "Bearer #{secret}" == env["HTTP_AUTHORIZATION"]
+        { email: info[:to] }
+      else
+        {}
+      end
+    end
+
+    def fail!(message, status = 400)
+      halt([ status, { "Content-Type" => "text/plain"}, [message] ])
+    end
+
+    def not_a_robot!(info)
+      # `reply_to_confirm` is a honeypot field, if it's filled it means it's a bot and an error is thrown
+      raise ::Talktome::InvalidEmailError if info[:reply_to_confirm] && info[:reply_to_confirm] =~ /^[^@]+@[^@]+$/
+    end
+
+  end # class App
+end # module Talktome

data/lib/talktome/client/local.rb

@@ -33,7 +33,7 @@ module Talktome
       end
 
       def templater(strategy)
-        return nil unless tpl_folder = options[:templates]
+        return nil unless tpl_folder = options[:layouts] || options[:templates]
         ->(message, src, ctype) {
           if (file = tpl_folder/"#{strategy}.#{ctype}").file?
             data = { metadata: message.metadata, yield: src }

data/lib/talktome/error.rb

@@ -1,4 +1,5 @@
 module Talktome
   class Error < StandardError; end
   class InvalidMessageError < Error; end
+  class InvalidEmailError < Error; end
 end

data/lib/talktome/strategy/email.rb

@@ -9,10 +9,23 @@ module Talktome
       end
 
       def send_message(message, user)
+        # Take a base email, with all info coming from the environment (if set)
         mail = base_email
-        mail.to = users(user).map{|u| u[:email] }
-        mail.reply_to = message.metadata["reply_to"] if message.metadata.has_key?("reply_to")
-        mail.subject  = message.metadata["subject"]
+
+        # Override environment defaults with template behavior, for flexibility
+        [
+          :to,
+          :reply_to,
+          :subject
+        ].each do |which|
+          if arg = message.metadata[which.to_s]
+            mail.send(:"#{which}=", arg)
+          end
+        end
+
+        # If the user is actually known from source code behavior, override the
+        # `mail.to` to send the email to that particular person.
+        mail.to = user[:email] if user.has_key?(:email)
 
         case message.extension
         when 'md', 'html', 'htm'
@@ -37,10 +50,6 @@ module Talktome
 
     private
 
-      def users(user)
-        user.is_a?(Array) ? user : [user]
-      end
-
       def base_email
         default_email = Mail.new
         @defaulter.call(default_email) if @defaulter

data/lib/talktome/version.rb

@@ -1,8 +1,8 @@
 module Talktome
   module Version
-    MAJOR = 0
-    MINOR = 2
-    TINY  = 1
+    MAJOR = 1
+    MINOR = 3
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/app/test_app.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+module Talktome
+  describe App do
+    include Rack::Test::Methods
+
+    let(:app) {
+      Talktome::App.new
+    }
+
+    before(:each) do
+      Talktome::App.set :talktome, Talktome::Client::Local.new(Path.dir.parent/'fixtures')
+      ENV['TALKTOME_EMAIL_DEFAULT_TO'] = "to@talktome.com"
+      ENV['TALKTOME_EMAIL_DEFAULT_FROM'] = "from@talktome.com"
+      Mail::TestMailer.deliveries.clear
+    end
+
+    context 'POST /contact-us/, the basic contract' do
+
+      it 'works' do
+        post "/contact-us/", {
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response).to be_ok
+        expect(Mail::TestMailer.deliveries.length).to eql(1)
+        expect(Mail::TestMailer.deliveries.first.to).to eql(["to@talktome.com"])
+        expect(Mail::TestMailer.deliveries.first.from).to eql(["from@talktome.com"])
+        expect(Mail::TestMailer.deliveries.first.subject).to eql("Someone wants to reach you!")
+        expect(Mail::TestMailer.deliveries.first.html_part.body).to include("<li>Key: value</li>")
+        expect(Mail::TestMailer.deliveries.first.html_part.body).to include("Truly yours")
+      end
+
+      it 'allows to use environment variable to tune the subject and the footer' do
+        Talktome.set_env('TALKTOME_EMAIL_SUBJECT', "Subject from environment") do
+          Talktome.set_env('TALKTOME_EMAIL_FOOTER', "Footer from environment") do
+            post "/contact-us/", {
+              reply_to: 'info@domain.com',
+              message: 'This is the message.'
+            }.to_json, { "CONTENT_TYPE" => "application/json" }
+            expect(last_response).to be_ok
+            expect(Mail::TestMailer.deliveries.length).to eql(1)
+            expect(Mail::TestMailer.deliveries.first.subject).to eql("Subject from environment")
+            expect(Mail::TestMailer.deliveries.first.html_part.body).to include("Footer from environment")
+          end
+        end
+      end
+
+      it 'allows to use a token authentification to bypass default security measures, for e.g. passing the :to' do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Some secret") do
+          header 'Authorization', 'Bearer Some secret'
+          post "/contact-us/", {
+            to: 'hello@visitor.com',
+            reply_to: 'hello@visitor.com',
+            message: 'Hello from visitor',
+            key: 'value',
+          }.to_json, { "CONTENT_TYPE" => "application/json" }
+          expect(last_response).to be_ok
+          expect(Mail::TestMailer.deliveries.length).to eql(1)
+          expect(Mail::TestMailer.deliveries.first.to).to eql(["hello@visitor.com"])
+          expect(Mail::TestMailer.deliveries.first.from).to eql(["from@talktome.com"])
+        end
+      end
+
+      it 'detects invalid emails' do
+        post "/contact-us/", {
+          reply_to: 'helloatvisitor.com',
+          message: 'Hello from visitor'
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(400)
+        expect(Mail::TestMailer.deliveries.length).to eql(0)
+      end
+
+      it "detects invalid bodies" do
+        post "/contact-us/", body: "foobar"
+        expect(last_response.status).to eql(400)
+        expect(Mail::TestMailer.deliveries.length).to eql(0)
+      end
+
+      it "detects stupid bots at least" do
+        post "/contact-us/", {
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          reply_to_confirm: 'hello@visitor.com'
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(400)
+        expect(Mail::TestMailer.deliveries.length).to eql(0)
+      end
+
+      it 'forbids usage of :to unless a secret is provided' do
+        post "/contact-us/", {
+          to: 'hello@visitor.com',
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(400)
+        expect(Mail::TestMailer.deliveries.length).to eql(0)
+      end
+
+      it 'does not allow setting the :to without a valid AUTH token' do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Invalid secret") do
+          post "/contact-us/", {
+            to: 'hello@visitor.com',
+            reply_to: 'hello@visitor.com',
+            message: 'Hello from visitor',
+            key: 'value',
+          }.to_json, { "CONTENT_TYPE" => "application/json" }
+          expect(last_response.status).to eql(401)
+          expect(Mail::TestMailer.deliveries.length).to eql(0)
+        end
+      end
+
+      it 'requires a valid Email for :to' do
+        post "/contact-us/", {
+          to: nil,
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(400)
+
+        post "/contact-us/", {
+          to: "notavalidemail",
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(400)
+      end
+
+    end
+
+    context 'POST /contact-us/, regarding the Reply-To' do
+      class ::Talktome::Message::Template
+        def raise_on_context_miss?
+          false
+        end
+      end
+
+      around(:each) do |bl|
+        Talktome.set_env('TALKTOME_EMAIL_DEFAULT_REPLYTO', "replyto@talktome.com", &bl)
+      end
+
+      it 'takes the default value from environment if set' do
+        post "/contact-us/", {
+          message: 'Hello from visitor'
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response).to be_ok
+        expect(Mail::TestMailer.deliveries.length).to eql(1)
+        expect(Mail::TestMailer.deliveries.first.reply_to).to eql(["replyto@talktome.com"])
+      end
+
+      it "lets override it by passing a replyTo field" do
+        post "/contact-us/", {
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor'
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response).to be_ok
+        expect(Mail::TestMailer.deliveries.length).to eql(1)
+        expect(Mail::TestMailer.deliveries.first.reply_to).to eql(["hello@visitor.com"])
+      end
+    end
+
+    context 'POST /multi-lingual/en/' do
+
+      it 'works' do
+        post "/multi-lingual/en/", {
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+        expect(last_response.status).to eql(200)
+        expect(last_response).to be_ok
+        expect(Mail::TestMailer.deliveries.length).to eql(1)
+        expect(Mail::TestMailer.deliveries.first.to).to eql(["to@talktome.com"])
+        expect(Mail::TestMailer.deliveries.first.from).to eql(["from@talktome.com"])
+        expect(Mail::TestMailer.deliveries.first.subject).to eql("Someone wants to reach you!")
+        expect(Mail::TestMailer.deliveries.first.html_part.body).to include("<li>Key: value</li>")
+        expect(Mail::TestMailer.deliveries.first.html_part.body).to include("Truly yours")
+      end
+    end
+
+  end
+end

data/spec/client/test_local.rb

@@ -3,110 +3,76 @@ module Talktome
   class Client
     describe Local do
 
-      let(:user) {
-        { email: "user@test.com" }
+      let(:strategy) {
+        Strategy::Debug.new
       }
 
-      let(:tpldata) {
-        { who: "Test user" }
+      let(:client){
+        Local.new(folder, options) do |c|
+          c.strategy :email, strategy
+        end
       }
 
       let(:folder) {
         Path.dir/"../fixtures"
       }
 
-      let(:client){
-        Local.new(folder, options) do |c|
-          c.strategy :email, strategy
-        end
+      let(:user) {
+        { email: "user@test.com" }
       }
 
-      context 'with a debug strategy' do
-        let(:strategy) {
-          Strategy::Debug.new
-        }
-
-        before(:each) {
-          strategy.clear!
-        }
+      let(:tpldata) {
+        { who: "Test user" }
+      }
 
-        context "without templates" do
-          let(:options) {
-            {}
-          }
+      before(:each) {
+        strategy.clear!
+      }
 
-          it 'sends email when requested' do
-            client.talktome("welcome", user, tpldata, [:email])
-            expect(strategy.last.message).not_to be_nil
-            expect(strategy.last.message.to_html).to eql("<h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n")
-          end
+      context "without layouts" do
+        let(:options) {
+          {}
+        }
 
-          it 'lets send the same email to multiple users' do
-            client.talktome("welcome", [user], tpldata, [:email])
-            expect(strategy.last.message).not_to be_nil
-            expect(strategy.last.message.to_html).to eql("<h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n")
-          end
+        it 'sends email when requested' do
+          client.talktome("welcome", user, tpldata, [:email])
+          expect(strategy.last.message).not_to be_nil
+          expect(strategy.last.message.to_html).to eql("<h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n")
         end
+      end
 
-        context "with templates" do
-          let(:options) {
-            {
-              templates: Path.dir/"../fixtures/templates"
-            }
+      context "with layouts under the :layouts option key" do
+        let(:options) {
+          {
+            layouts: Path.dir/"../fixtures/layouts"
           }
+        }
 
-          it 'sends email when requested' do
-            client.talktome("welcome", user, tpldata, [:email])
-            expect(strategy.last.message).not_to be_nil
-            expect(strategy.last.message.to_html).to eql("<html><title>Hello Test user</title><body><h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n</body></html>\n")
-          end
-
-          it 'yields the callback with the email' do
-            seen = nil
-            client.talktome("welcome", user, tpldata, [:email]){|m|
-              seen = m
-            }
-            expect(seen).not_to be_nil
-          end
+        it 'sends email when requested' do
+          client.talktome("welcome", user, tpldata, [:email])
+          expect(strategy.last.message).not_to be_nil
+          expect(strategy.last.message.to_html).to eql("<html><title>Hello Test user</title><body><h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n</body></html>\n")
         end
-      end
 
-      context 'with an email strategy' do
-        before do
-          Mail.defaults do
-            delivery_method :test
-          end
-          Mail::TestMailer.deliveries = []
+        it 'yields the callback with the email' do
+          seen = nil
+          client.talktome("welcome", user, tpldata, [:email]){|m|
+            seen = m
+          }
+          expect(seen).not_to be_nil
         end
+      end
 
+      context "with layouts under the :templates option key (backward compatibility)" do
         let(:options) {
-          {}
-        }
-
-        let(:strategy) {
-          Strategy::Email.new({}){|m|
-            m.from "hello@test.com"
+          {
+            templates: Path.dir/"../fixtures/layouts"
           }
         }
 
         it 'sends email when requested' do
           client.talktome("welcome", user, tpldata, [:email])
-          mail = Mail::TestMailer.deliveries.first
-          expect(mail).not_to be_nil
-          expect(mail.from).to eql(["hello@test.com"])
-          expect(mail.to).to eql(["user@test.com"])
-        end
-
-        it 'allows sending email to multiple users' do
-          client.talktome("welcome", [
-            { email: "user1@test.com" },
-            { email: "user2@test.com" }
-          ], tpldata, [:email])
-          expect(Mail::TestMailer.deliveries.length).to eql(1)
-          mail = Mail::TestMailer.deliveries.first
-          expect(mail).not_to be_nil
-          expect(mail.from).to eql(["hello@test.com"])
-          expect(mail.to).to eql(["user1@test.com", "user2@test.com"])
+          expect(strategy.last.message.to_html).to eql("<html><title>Hello Test user</title><body><h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n</body></html>\n")
         end
       end
 

data/spec/fixtures/contact-us/email.md

@@ -0,0 +1,13 @@
+---
+subject: |-
+  {{subject}}
+---
+Hello,
+
+This person is trying to reach you:
+
+{{#allvars}}
+  * {{key}}: {{value}}
+{{/allvars}}
+
+{{footer}}

data/spec/fixtures/multi-lingual/en/email.md

@@ -0,0 +1,13 @@
+---
+subject: |-
+  {{subject}}
+---
+Hello,
+
+This person is trying to reach you:
+
+{{#allvars}}
+  * {{key}}: {{value}}
+{{/allvars}}
+
+{{footer}}

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'talktome'
+require 'talktome/app'
+require 'rack/test'
 
 module SpecHelpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talktome
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,42 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: path
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +114,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: finitio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: rack-robustness
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Talktome helps you talk to users by email, messaging, sms, etc. It abstracts
   the messaging mechanisms and lets you manage message templates easily.
 email: blambeau@gmail.com
@@ -112,6 +180,7 @@ files:
 - README.md
 - Rakefile
 - lib/talktome.rb
+- lib/talktome/app.rb
 - lib/talktome/client.rb
 - lib/talktome/client/local.rb
 - lib/talktome/error.rb
@@ -120,8 +189,11 @@ files:
 - lib/talktome/strategy/debug.rb
 - lib/talktome/strategy/email.rb
 - lib/talktome/version.rb
+- spec/app/test_app.rb
 - spec/client/test_local.rb
-- spec/fixtures/templates/email.html
+- spec/fixtures/contact-us/email.md
+- spec/fixtures/layouts/email.html
+- spec/fixtures/multi-lingual/en/email.md
 - spec/fixtures/welcome/email.md
 - spec/fixtures/welcome/footer.mustache
 - spec/message/test_initialize.rb
@@ -150,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Talktome helps you talk to users by email, messaging, sms, etc.