talktome 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 868359e1f73e9fcf52180d2217179b7ea15ad990
-  data.tar.gz: 49a82192411f5ca01f129e3ece14712ce1eee0be
+  metadata.gz: 2817b7e3a3e6d077e889d0d53ac368195785af09
+  data.tar.gz: e5d9c60306e644301a1029739f16041f3b740be2
 SHA512:
-  metadata.gz: b485f9ec89169ba868237e9007cf9d2f46cb42fbffb5ed28e1565a5193b3e4d2047b48284343a1ca395b370cd046156479fea710784614a404268d31382ad0f6
-  data.tar.gz: ccb84f63e28059def408fa31365913f993cde2335b8ec62874e8de180bfa493a37fec596cddaca1765456c6ce8cf0d44eb0da39ea49daa6cb4439232226cd05e
+  metadata.gz: 8cf1e843cfd0ce3187bc693889ed5baf7e0deeddff436cf483ec0af6f20f6698e5d91eea60717f990b270f274bddd1ff959e75a1dca8fc7e5ad7325873c31f56
+  data.tar.gz: f312d5300c8eeacee34bd90097d61bd996246081b0400e013f59a63147a374719a59c904b3bd191481fc9d08e1417c5eebf266374931273a448e05b047ff0c8f

data/lib/talktome.rb

@@ -9,6 +9,56 @@ module Talktome
   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"
+
+    options[:debugger] = ->(message, user, handler) {
+      debug_folder.mkdir_p unless debug_folder.exists?
+      (debug_folder/"#{user[:email]}.html").write(message.to_html)
+      (debug_folder/"#{user[:email]}.txt").write(message.to_text)
+    } if ENV['TALKTOME_DEBUG']
+
+    options[:strategies] = {}
+
+    email_delivery = (ENV['TALKTOME_EMAIL_DELIVERY'] || "test").to_sym
+    email_config   = {}
+
+    email_config.merge!({
+      address:   ENV['TALKTOME_SMTP_ADDRESS'],
+      port:      ENV['TALKTOME_SMTP_PORT'],
+      domain:    ENV['TALKTOME_SMTP_DOMAIN'],
+      user_name: ENV['TALKTOME_SMTP_USER'],
+      password:  ENV['TALKTOME_SMTP_PASSWORD']
+    }) if email_delivery == :smtp
+
+    email_config.merge!({
+      location: debug_folder.mkdir_p
+    }) if email_delivery == :file
+
+    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']
+    }
+
+    options
+  end
+  module_function :auto_options
+
 end
 require 'talktome/version'
 require 'talktome/error'

data/lib/talktome/client.rb

@@ -1,19 +1,27 @@
 module Talktome
   class Client
 
-    def initialize
-      @strategies = {}
+    def initialize(folder, options = {})
+      raise ArgumentError, "Missing root folder" unless folder
+      raise ArgumentError, "Invalid root folder" unless Path(folder).directory?
+      @folder = folder
+      @options = Talktome.auto_options(folder).merge(options)
       yield self if block_given?
     end
+    attr_reader :folder, :options
 
     def strategy(name, stragegy)
-      @strategies[name] = stragegy
+      strategies[name] = stragegy
     end
 
   protected
 
+    def strategies
+      options[:strategies]
+    end
+
     def get_handler(strategy)
-      @strategies[strategy]
+      strategies[strategy]
     end
 
   end # class Client

data/lib/talktome/client/local.rb

@@ -1,21 +1,16 @@
 module Talktome
   class Client
+    #
+    # Builds a local client, that applies strategies synchronously and runs
+    # locally
+    #
     class Local < Client
 
-      def initialize(folder, options = {})
-        raise ArgumentError, "Missing messages folder" unless folder
-        raise ArgumentError, "Invalid messages folder" unless Path(folder).directory?
-        @folder = folder
-        @options = options
-        super()
-      end
-      attr_reader :folder, :options
-
-      def talktome(message, user, tpldata, strategies)
+      def talktome(message, user, tpldata, strategies, &callback)
         message, handler = load_message!(message, strategies)
         message = message.instantiate(tpldata)
         options[:debugger].call(message, user, handler) if options[:debugger]
-        handler.send_message message, user
+        handler.send_message message, user, &callback
       end
 
     protected

data/lib/talktome/message.rb

@@ -30,7 +30,7 @@ module Talktome
     end
 
     def extension
-      path.ext.to_s
+      path.ext.to_s.gsub(/^\./,"")
     end
 
     def to_text

data/lib/talktome/strategy/debug.rb

@@ -14,6 +14,8 @@ module Talktome
           message: message,
           user: user
         })
+        yield(@last) if block_given?
+        @last
       end
 
     end # class Debug

data/lib/talktome/strategy/email.rb

@@ -30,6 +30,8 @@ module Talktome
           raise "Unsupported extension `#{message.extension}`"
         end
 
+        yield(mail) if block_given?
+
         mail.deliver!
       end
 

data/lib/talktome/version.rb

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

data/spec/client/test_local.rb

@@ -53,6 +53,14 @@ module Talktome
           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
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talktome
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,9 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,9 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -99,9 +93,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,9 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
 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
@@ -163,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Talktome helps you talk to users by email, messaging, sms, etc.