talktome 1.3.0 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ca8cf300ad4144fd6336f1ff56e4fc97140742869f10397ce62c9d0fecd3c03
-  data.tar.gz: 9d439309e79ebb3da0ea177af0606e882a643adc55e045cca5a56bb154ac6888
+  metadata.gz: f3b0e85edd98ed5039c0fdfd16a446ad289e79a2875b7ff7a39c3b9a555a0f3b
+  data.tar.gz: 757644a3507d6699bc27e4aeb59bf7b2c5d7738212edf7ebada24438200e2449
 SHA512:
-  metadata.gz: d4bd93a6e3bde5390185ebd55844a0db7b48fd81ca0c0982289d67ca15c5866f402b645191f6ba1826a7c4b5147b67937e0d7c07cd9f08788a616b2f019751c4
-  data.tar.gz: 9b255ab12108b8e37c024aff7bbe49b8ce85c543cc14fe62b797d64aadcbd59c2a9fe33530bdfa3e35872a7a3a553673ff064472e4fbf4cf4563377c2de4ad14
+  metadata.gz: 78e81c6c932b3163c490ded97eb78adeb8ab9af3592a3448629159f016ab93275da6306958f6fe473759eb29fe03f8121ffcdd55f0ba9f4fc5645ec8f4fb8c25
+  data.tar.gz: a889469fb5e7bdb3d544e3c215ee685b01fa4795a3356b004a34757bec636632d66262a904b84af82de09fc99dda446d9668fd37daa55ce5cef54eecef0cf3a9

data/lib/talktome/app.rb

@@ -17,11 +17,20 @@ module Talktome
 
     VALIDATION_SCHEMA = ::Finitio.system(<<~FIO)
       @import finitio/data
+      Attachment = {
+        mime_type :  String
+        content   :  .Object
+        encoding  :? String
+      }
       Email = String(s | s =~ /^[^@]+@[^@]+$/ )
       {
-        to       :? Email
-        reply_to :? Email
-        ...      :  .Object
+        to          :? Email
+        reply_to    :? Email
+        in_reply_to :? String
+        attachments :? {
+          ...       : Attachment
+        }
+        ...         :  .Object
       }
     FIO
 
@@ -34,14 +43,20 @@ module Talktome
         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)
+          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
 
@@ -54,7 +69,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

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

data/spec/app/test_app.rb

@@ -163,6 +163,104 @@ 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
@@ -182,5 +280,19 @@ module Talktome
       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/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.3.0
+  version: 1.3.4
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -194,6 +194,7 @@ files:
 - 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
@@ -222,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.