talktome 1.2.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c02c611e3628b2f56012103e2c8ae0a5bb600ee9e11a24a7c7acf748475c9380
-  data.tar.gz: f1dadedcddd3f434298359293ef656be2f14396c7d9dd8c597ea5db2bb7a138b
+  metadata.gz: 61b3186927b959dff89432173c8144e50805115dfb2ce270cb82c6612797fd21
+  data.tar.gz: 0e2f96a0d4fcbd97e958281d0ee474afdf0dc57483181bc5427eb794c21f47e4
 SHA512:
-  metadata.gz: 76e3843b6ec151090b9c88f26180a620d82bb737360fbb43b8f70f6f10d559401bf822f626cfde81c3edd43df253388ded9ca8761ce849c2af55262eb6e66503
-  data.tar.gz: 5f6558c21f2eeebd114a876232be0eb2c6dfdde84d7862d105c6da2400ee55d367f1428289e572a02c64fb5e8056e4e8999a9bb28de0b2af1199c1dd5613bc73
+  metadata.gz: 223de995f0f58b54c09039c63228c1a4ffa581b7dbe82cf3dc2b410b03a599c06c3e88bed88ce6e89a5fbf2e78882eb40a8b55e85a88312639c5279d43a4da04
+  data.tar.gz: 83e62ce22e6714376bcef8adaf027ce34e2f490aa88aa80d94e19fe3cd97c47a319ca558679ffc53bf0694825103d84d7a96dc85ec8be4bb3ebeb9451632d49c

data/lib/talktome/app.rb

@@ -13,36 +13,49 @@ 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
+      Attachment = {
+        mime_type : String
+        content   : .Object
+      }
       Email = String(s | s =~ /^[^@]+@[^@]+$/ )
       {
-        to       :? Email
-        reply_to :? Email
-        ...      :  .Object
+        to          :? Email
+        reply_to    :? Email
+        in_reply_to :? String
+        attachments :? {
+          ...       : Attachment
+        }
+        ...         :  .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
         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!
-        TALKTOME.talktome(action, user, info.merge(allvars: as_array, subject: subject, footer: footer), [:email]){|email|
+        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)
+          email.in_reply_to = info[:in_reply_to] if info.has_key?(:in_reply_to)
+          (info[:attachments] || {}).each do |name, att|
+            email.attachments[name.to_s] = att
+          end
         }
         [ 200, { "Content-Type" => "text/plain"}, ["Ok"] ]
       rescue JSON::ParserError
         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
 
@@ -55,7 +68,8 @@ module Talktome
     end
 
     def load_user_from_info!
-      if to = info[:to]
+      protected_fields = [:to, :in_reply_to, :attachments]
+      if (info.keys & protected_fields).any?
         secret = Talktome.env('TALKTOME_BEARER_SECRET')
         fail!("Missing secret", 400) unless secret
         fail!("Invalid secret", 401) unless "Bearer #{secret}" == env["HTTP_AUTHORIZATION"]

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?

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/strategy/email.rb

@@ -16,6 +16,8 @@ module Talktome
         [
           :to,
           :reply_to,
+          :in_reply_to,
+          :attachments,
           :subject
         ].each do |which|
           if arg = message.metadata[which.to_s]

data/lib/talktome/version.rb

@@ -1,8 +1,8 @@
 module Talktome
   module Version
     MAJOR = 1
-    MINOR = 2
-    TINY  = 0
+    MINOR = 3
+    TINY  = 3
   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
@@ -162,5 +163,136 @@ module Talktome
       end
     end
 
+    context 'POST /support/, regarding the In-Reply-To' do
+      class ::Talktome::Message::Template
+        def raise_on_context_miss?
+          false
+        end
+      end
+
+      it 'forbids the usage of :in_reply_to unless a secret is provided' do
+        post "/support/", {
+          in_reply_to: '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@company.com>',
+      }.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 :in_reply_to without a valid AUTH token' do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Invalid secret") do
+          post "/support/", {
+            in_reply_to: '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@company.com>',
+          }.to_json, { "CONTENT_TYPE" => "application/json" }
+          expect(last_response.status).to eql(401)
+          expect(Mail::TestMailer.deliveries.length).to eql(0)
+        end
+      end
+
+      it "lets override it by passing a inReplyTo field" do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Some secret") do
+          header 'Authorization', 'Bearer Some secret'
+          post "/support/", {
+            to: 'client@company.com',
+            in_reply_to: '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@company.com>',
+          }.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.in_reply_to).to eql('F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@company.com')
+        end
+      end
+    end
+
+    context 'POST /support/, regarding the attachments' do
+      class ::Talktome::Message::Template
+        def raise_on_context_miss?
+          false
+        end
+      end
+
+      it 'forbids the usage of :attachments unless a secret is provided' do
+        post "/support/", {
+          :to => 'client@company.com',
+          :attachments => {
+            "plain.txt" => {
+              "mime_type" => "plain/text",
+              "content" => Base64.encode64('Some plain/text attachment')
+            }
+          }
+        }.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 :attachments without a valid AUTH token' do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Invalid secret") do
+          post "/support/", {
+            :to => 'client@company.com',
+            :attachments => {
+              "plain.txt" => {
+                "mime_type" => "plain/text",
+                "content" => Base64.encode64('Some plain/text attachment')
+              }
+            }
+          }.to_json, { "CONTENT_TYPE" => "application/json" }
+          expect(last_response.status).to eql(401)
+          expect(Mail::TestMailer.deliveries.length).to eql(0)
+        end
+      end
+
+      it "lets customize attachments by passing an array" do
+        Talktome.set_env('TALKTOME_BEARER_SECRET', "Some secret") do
+          header 'Authorization', 'Bearer Some secret'
+          post "/support/", {
+            :to => 'client@company.com',
+            :attachments => {
+              "plain.txt" => {
+                "mime_type" => "plain/text",
+                "content" => Base64.encode64('Some plain/text attachment')
+              }
+            }
+          }.to_json, { "CONTENT_TYPE" => "application/json" }
+          expect(last_response).to be_ok
+          expect(Mail::TestMailer.deliveries.length).to eql(1)
+          mail = Mail::TestMailer.deliveries.first
+          expect(mail.attachments['plain.txt']).to be_a_kind_of(Mail::Part)
+          file = mail.attachments['plain.txt']
+          expect(file).to be_a_kind_of(Mail::Part)
+        end
+      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

@@ -74,6 +74,7 @@ module Talktome
           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

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/fixtures/support/email.md

@@ -0,0 +1,6 @@
+---
+subject: Regarding your support request
+---
+Our support team will get back to you ASAP regarding your request.
+
+Best regards

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talktome
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.3
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -191,7 +191,10 @@ files:
 - lib/talktome/version.rb
 - spec/app/test_app.rb
 - spec/client/test_local.rb
+- spec/fixtures/contact-us/email.md
 - spec/fixtures/layouts/email.html
+- spec/fixtures/multi-lingual/en/email.md
+- spec/fixtures/support/email.md
 - spec/fixtures/welcome/email.md
 - spec/fixtures/welcome/footer.mustache
 - spec/message/test_initialize.rb
@@ -220,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Talktome helps you talk to users by email, messaging, sms, etc.