talktome 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ff5a2d705d895d7b3e03e7b6d6a9df13e6a818df6198abb238b6b2b13f34a1
-  data.tar.gz: 8390299781fe6800b7e0e7b68fb5d0d504b4d90ee84c8c6452a1703b24ce2ad6
+  metadata.gz: a152ca28790d2d33a6e07329113e3b0c112fabb92e9713fad915e9ac80449e08
+  data.tar.gz: fdd0b125b604058bb01d3bc2ef883ccf4ed600e438a76a0077b064f61f6c45a4
 SHA512:
-  metadata.gz: 60ad688912efaefcdc60847da49b07aaadf07fdfaed1036b4905db407ff7d97c3d190ae41f8d7b70537ddfd2a7cd2dd711aa2cd1f346f48c92f6e5cac94a9686
-  data.tar.gz: a05b855ab7e15f29b39f8d42eee139d193788c876077e7ff0a3fd3819bb38314005a1eced8ba83c7c0d919319cb61a0adcf945e44e00847e142f1282031bebd3
+  metadata.gz: 295acd1285168e1beff58e15f43b3f10fc38b46c0dd02726a9b059bde9cf45cee2349492d67a90114b2860583bf57695457e53d79329f64619656f706fbb54c9
+  data.tar.gz: d74897e75e3e241aac8f4dcf554fe901264a6970efd4bee0a91f62bd087f8e09089763dc1ec6aabe553c7971e3f1c1a6dca8e4567fbd6ef260e1d946707184ec

data/README.md

@@ -30,7 +30,7 @@ a reusable backend for contact forms.
 
 ```
 docker run \
-    -p4567:4567 \
+    -p 3000:3000 \
     -e TALKTOME_EMAIL_DEFAULT_FROM=info@mydomain.com
     -e TALKTOME_EMAIL_DEFAULT_TO=support@mydomain.com
     enspirit/talktome
@@ -42,7 +42,7 @@ 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/
+     http://127.0.0.1:3000/contact-us/
 ```
 
 This web API does not allow specifying `from` and `to` as input data to avoid

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,6 +43,10 @@ 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
@@ -56,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/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 = 3
-    TINY  = 1
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 0
   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

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.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,7 +75,7 @@ dependencies:
         version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.6
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.6
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +120,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -168,6 +168,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.5'
 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
@@ -194,6 +208,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 +237,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.