talktome 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ec4ba471da7a770b79a04a0f30cd58514f0d43b72d66b15074f2fa984887bd
-  data.tar.gz: 8a58f1a1e7af3440a8066e11b2fa44e4aa606c595c5b9d9e6952dd0b22d6fb97
+  metadata.gz: 59ff5a2d705d895d7b3e03e7b6d6a9df13e6a818df6198abb238b6b2b13f34a1
+  data.tar.gz: 8390299781fe6800b7e0e7b68fb5d0d504b4d90ee84c8c6452a1703b24ce2ad6
 SHA512:
-  metadata.gz: 7340d04e04977b3d1a4a5def53d02b141a108e67514886f57d0d22dc87dfe340fe3a52d8f4552e7bd074229ba841256bb8006bfc900485b48cd8f0aa86522b39
-  data.tar.gz: 961f6e4931782c5b0f0e732c9ab3a5ea0578efe76e0346bbd8782f3b21a3a8ecd58731b51e3d3dd2e32ccb0c2d9ef48f3081f1e2f810722fbb6320348deef796
+  metadata.gz: 60ad688912efaefcdc60847da49b07aaadf07fdfaed1036b4905db407ff7d97c3d190ae41f8d7b70537ddfd2a7cd2dd711aa2cd1f346f48c92f6e5cac94a9686
+  data.tar.gz: a05b855ab7e15f29b39f8d42eee139d193788c876077e7ff0a3fd3819bb38314005a1eced8ba83c7c0d919319cb61a0adcf945e44e00847e142f1282031bebd3

data/README.md

@@ -94,12 +94,19 @@ 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

data/lib/talktome.rb

@@ -26,7 +26,7 @@ module Talktome
   def set_env(which, value, &bl)
     old, ENV[which] = ENV[which], value
     bl.call.tap{
-      ENV[which] = old unless old.nil?
+      ENV[which] = old
     }
   end
   module_function :set_env
@@ -78,6 +78,10 @@ module Talktome
       }
     }
 
+    if layouts_folder = ENV['TALKTOME_LAYOUTS_FOLDER']
+      options[:layouts] = Path(layouts_folder)
+    end
+
     options
   end
   module_function :auto_options

data/lib/talktome/app.rb

@@ -13,21 +13,26 @@ module Talktome
 
     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
 
-    TALKTOME = Talktome::Client::Local.new(ROOT_FOLDER/'templates')
-
-    post %r{/([a-z-]+)/} do |action|
+    post %r{/([a-z-]+([\/][a-z-]+)*)/} do |action, _|
       begin
-        TALKTOME.talktome(action, {}, info, [:email]){|email|
+        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"] ]
@@ -35,8 +40,10 @@ module Talktome
         fail!("Invalid data")
       rescue Finitio::Error => ex
         fail!(ex.message)
-      rescue ::Talktome::InvalidEmailError => ex
+      rescue ::Talktome::InvalidEmailError
         fail!("Invalid email address")
+      rescue ::Talktome::TemplateNotFoundError
+        fail!("No such template", 404)
       end
     end
 
@@ -48,8 +55,19 @@ module Talktome
       }
     end
 
-    def fail!(message)
-      [ 400, { "Content-Type" => "text/plain"}, [message] ]
+    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)

data/lib/talktome/client/local.rb

@@ -17,7 +17,7 @@ module Talktome
 
       def load_message!(identifier, strategies)
         folder = self.folder/identifier
-        raise InvalidMessageError, "No such message `#{identifier}`"            unless folder.exists?
+        raise TemplateNotFoundError, "No such message `#{identifier}`"            unless folder.exists?
         raise InvalidMessageError, "Message `#{identifier}` should be a folder" unless folder.directory?
         strategies.each do |s|
           if (file = folder.glob("#{s}.*").first) && file.file?
@@ -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

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

data/lib/talktome/version.rb

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

data/spec/app/test_app.rb

@@ -9,6 +9,7 @@ module Talktome
     }
 
     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
@@ -19,13 +20,47 @@ module Talktome
       it 'works' do
         post "/contact-us/", {
           reply_to: 'hello@visitor.com',
-          message: 'Hello from visitor'
+          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
@@ -53,6 +88,48 @@ module Talktome
         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
@@ -86,5 +163,38 @@ module Talktome
       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
+
+    context 'POST /xxx when the template does not exist' do
+
+      it 'return a 404 error when the template doesn\'t exist' do
+        post "/multi-lingual/fr/", {
+          reply_to: 'hello@visitor.com',
+          message: 'Hello from visitor',
+          key: 'value',
+        }.to_json, { "CONTENT_TYPE" => "application/json" }
+
+        expect(last_response.status).to eql(404)
+        expect(last_response.body).to match(/No such template/)
+      end
+    end
+
   end
 end

data/spec/client/test_local.rb

@@ -29,7 +29,7 @@ module Talktome
         strategy.clear!
       }
 
-      context "without templates" do
+      context "without layouts" do
         let(:options) {
           {}
         }
@@ -41,10 +41,10 @@ module Talktome
         end
       end
 
-      context "with templates" do
+      context "with layouts under the :layouts option key" do
         let(:options) {
           {
-            templates: Path.dir/"../fixtures/templates"
+            layouts: Path.dir/"../fixtures/layouts"
           }
         }
 
@@ -63,6 +63,20 @@ module Talktome
         end
       end
 
+      context "with layouts under the :templates option key (backward compatibility)" do
+        let(:options) {
+          {
+            templates: Path.dir/"../fixtures/layouts"
+          }
+        }
+
+        it 'sends email when requested' do
+          client.talktome("welcome", user, tpldata, [:email])
+          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
+
     end
   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}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talktome
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -138,16 +138,22 @@ dependencies:
   name: finitio
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        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.8.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: rack-robustness
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +191,9 @@ files:
 - 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
@@ -214,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Talktome helps you talk to users by email, messaging, sms, etc.