talktome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 868359e1f73e9fcf52180d2217179b7ea15ad990
+  data.tar.gz: 49a82192411f5ca01f129e3ece14712ce1eee0be
+SHA512:
+  metadata.gz: b485f9ec89169ba868237e9007cf9d2f46cb42fbffb5ed28e1565a5193b3e4d2047b48284343a1ca395b370cd046156479fea710784614a404268d31382ad0f6
+  data.tar.gz: ccb84f63e28059def408fa31365913f993cde2335b8ec62874e8de180bfa493a37fec596cddaca1765456c6ce8cf0d44eb0da39ea49daa6cb4439232226cd05e

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2017 - Enspirit SPRL (Bernard Lambeau)
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Talktome - Talk to users easily
+
+...

data/Rakefile

@@ -0,0 +1,12 @@
+require 'path'
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end
+
+task :default => :test

data/lib/talktome.rb

@@ -0,0 +1,17 @@
+require 'yaml'
+require 'path'
+require 'mustache'
+require 'redcarpet'
+module Talktome
+
+  def redcarpet
+    @redcarpet ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML, extensions = {})
+  end
+  module_function :redcarpet
+
+end
+require 'talktome/version'
+require 'talktome/error'
+require 'talktome/strategy'
+require 'talktome/message'
+require 'talktome/client'

data/lib/talktome/client.rb

@@ -0,0 +1,21 @@
+module Talktome
+  class Client
+
+    def initialize
+      @strategies = {}
+      yield self if block_given?
+    end
+
+    def strategy(name, stragegy)
+      @strategies[name] = stragegy
+    end
+
+  protected
+
+    def get_handler(strategy)
+      @strategies[strategy]
+    end
+
+  end # class Client
+end # module Talktome
+require 'talktome/client/local'

data/lib/talktome/client/local.rb

@@ -0,0 +1,54 @@
+module Talktome
+  class Client
+    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)
+        message, handler = load_message!(message, strategies)
+        message = message.instantiate(tpldata)
+        options[:debugger].call(message, user, handler) if options[:debugger]
+        handler.send_message message, user
+      end
+
+    protected
+
+      def load_message!(identifier, strategies)
+        folder = self.folder/identifier
+        raise InvalidMessageError, "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?
+            handler = get_handler(s)
+            options = {}
+            options[:templater] = templater(s)
+            message = Message.new(file, options)
+            return [ message, handler ]
+          end
+        end
+        files = folder.glob("*").map{|f| f.basename.to_s }
+        raise InvalidMessageError, "No available strategy for `#{identifier}`\n#{files.inspect} vs. #{strategies.inspect}"
+      end
+
+      def templater(strategy)
+        return nil unless tpl_folder = options[:templates]
+        ->(message, src, ctype) {
+          if (file = tpl_folder/"#{strategy}.#{ctype}").file?
+            data = { metadata: message.metadata, yield: src }
+            Mustache.render(file.read, data)
+          else
+            src
+          end
+        }
+      end
+
+    end # class Client
+  end # class Client
+end # module Talktome

data/lib/talktome/error.rb

@@ -0,0 +1,4 @@
+module Talktome
+  class Error < StandardError; end
+  class InvalidMessageError < Error; end
+end

data/lib/talktome/message.rb

@@ -0,0 +1,89 @@
+module Talktome
+  class Message
+
+    def initialize(path, options = {})
+      @path = path
+      @options = options
+      compile
+    end
+    attr_accessor :path
+    attr_accessor :metadata
+    attr_accessor :data
+    attr_accessor :template_content
+    protected :path=, :metadata=, :data=, :template_content=
+
+    def instantiate(tpldata)
+      self.dup do |m|
+        m.metadata = {}
+        self.metadata.each_pair do |k, v|
+          m.metadata[k] = i(v, tpldata)
+        end
+        m.template_content = i(m.template_content, tpldata.merge(metadata: m.metadata))
+        m.data = tpldata
+      end
+    end
+
+    def dup
+      d = super
+      yield(d) if block_given?
+      d
+    end
+
+    def extension
+      path.ext.to_s
+    end
+
+    def to_text
+      template_it(self.template_content, :text)
+    end
+
+    def to_html
+      case extension
+      when 'md'
+        template_it(Talktome.redcarpet.render(self.template_content), :html)
+      else
+        template_it(self.template_content, :html)
+      end
+    end
+
+  private
+
+    class Template < Mustache
+
+      def partial(name)
+        path = "#{@options[:template_path]}/#{name}.#{template_extension}"
+        File.read(path).force_encoding(Encoding::UTF_8)
+      end
+
+      def raise_on_context_miss?
+        true
+      end
+
+    end
+
+    def template_it(src, ctype)
+      if @options[:templater]
+        @options[:templater].call(self, src, ctype)
+      else
+        src
+      end
+    end
+
+    def i(tpl, tpldata)
+      Template.new({
+        template_file: self.path,
+        template_path: self.path.parent
+      }).render(tpl, tpldata)
+    end
+
+    def compile
+      raw = path.read.force_encoding(Encoding::UTF_8)
+      if raw =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        @metadata, @template_content = YAML::load($1), $'
+      else
+        @metadata, @template_content = {}, raw
+      end
+    end
+
+  end # module Message
+end # module Talktome

data/lib/talktome/strategy.rb

@@ -0,0 +1,7 @@
+module Talktome
+  class Strategy
+
+  end # class Strategy
+end # module Talktome
+require 'talktome/strategy/debug'
+require 'talktome/strategy/email'

data/lib/talktome/strategy/debug.rb

@@ -0,0 +1,21 @@
+module Talktome
+  class Strategy
+    class Debug
+
+      attr_accessor :last
+
+      def clear!
+        @last = nil
+      end
+
+      def send_message(message, user)
+        require 'ostruct'
+        @last = OpenStruct.new({
+          message: message,
+          user: user
+        })
+      end
+
+    end # class Debug
+  end # class Strategy
+end # module Talktome

data/lib/talktome/strategy/email.rb

@@ -0,0 +1,46 @@
+require 'mail'
+module Talktome
+  class Strategy
+    class Email < Strategy
+
+      def initialize(options = {}, &defaulter)
+        @options = options
+        @defaulter = defaulter
+      end
+
+      def send_message(message, user)
+        mail = base_email
+        mail.to = user[:email]
+        mail.reply_to = message.metadata["reply_to"] if message.metadata.has_key?("reply_to")
+        mail.subject  = message.metadata["subject"]
+
+        case message.extension
+        when 'md', 'html', 'htm'
+          mail.text_part do
+            content_type 'text/plain; charset=UTF-8'
+            body message.to_text
+          end
+          mail.html_part do
+            content_type 'text/html; charset=UTF-8'
+            body message.to_html
+          end
+        when 'text'
+          mail.body message.to_text
+        else
+          raise "Unsupported extension `#{message.extension}`"
+        end
+
+        mail.deliver!
+      end
+
+    private
+
+      def base_email
+        default_email = Mail.new
+        @defaulter.call(default_email) if @defaulter
+        default_email
+      end
+
+    end # class Email
+  end # class Strategy
+end # module Talktome

data/lib/talktome/version.rb

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

data/spec/client/test_local.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+module Talktome
+  class Client
+    describe Local do
+
+      let(:strategy) {
+        Strategy::Debug.new
+      }
+
+      let(:client){
+        Local.new(folder, options) do |c|
+          c.strategy :email, strategy
+        end
+      }
+
+      let(:folder) {
+        Path.dir/"../fixtures"
+      }
+
+      let(:user) {
+        { email: "user@test.com" }
+      }
+
+      let(:tpldata) {
+        { who: "Test user" }
+      }
+
+      before(:each) {
+        strategy.clear!
+      }
+
+      context "without templates" do
+        let(:options) {
+          {}
+        }
+
+        it 'sends email when requested' do
+          client.talktome("welcome", user, tpldata, [:email])
+          expect(strategy.last.message).not_to be_nil
+          expect(strategy.last.message.to_html).to eql("<h1>Hello Test user</h1>\n\n<p>Welcome to this email example!</p>\n\n<h3>Test user</h3>\n")
+        end
+      end
+
+      context "with templates" do
+        let(:options) {
+          {
+            templates: Path.dir/"../fixtures/templates"
+          }
+        }
+
+        it 'sends email when requested' do
+          client.talktome("welcome", user, tpldata, [:email])
+          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
+      end
+
+    end
+  end
+end

data/spec/fixtures/templates/email.html

@@ -0,0 +1 @@
+<html><title>{{metadata.subject}}</title><body>{{{yield}}}</body></html>

data/spec/fixtures/welcome/email.md

@@ -0,0 +1,8 @@
+---
+subject: Hello {{who}}
+---
+# {{metadata.subject}}
+
+Welcome to this email example!
+
+{{> footer}}

data/spec/fixtures/welcome/footer.mustache

@@ -0,0 +1 @@
+### {{who}}

data/spec/message/test_initialize.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+module Talktome
+  describe Message, 'initialize' do
+
+    subject{
+      Message.new path
+    }
+
+    context 'on a file with yaml frontmatter' do
+      let(:path) { Path.dir/'with-frontmatter.md' }
+
+      it 'works as expected' do
+        expect(subject.template_content).to eql("Subject: {{metadata.subject}}\n\nHello {{who}} [test]({{url}})\n")
+        expect(subject.metadata).to eql("hello" => "World", "subject" => "Hello {{who}}")
+      end
+    end
+
+    context 'on a file without yaml frontmatter' do
+      let(:path) { Path.dir/'without-frontmatter.md' }
+
+      it 'works as expected' do
+        expect(subject.template_content).to eql("Hello {{who}}\n")
+        expect(subject.metadata).to eql({})
+      end
+    end
+
+  end
+end

data/spec/message/test_instantiate.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+module Talktome
+  describe Message, 'instantiate' do
+
+    subject{
+      Message.new(path).instantiate(data)
+    }
+
+    let(:path) { Path.dir/'with-frontmatter.md' }
+    let(:data) { { url: "http://foo", who: "bar"} }
+
+    it 'works as expected' do
+      expect(subject.template_content).to eql("Subject: Hello bar\n\nHello bar [test](http://foo)\n")
+      expect(subject.metadata).to eql("hello" => "World", "subject" => "Hello bar")
+    end
+
+  end
+end

data/spec/message/with-frontmatter.md

@@ -0,0 +1,7 @@
+---
+hello: World
+subject: Hello {{who}}
+---
+Subject: {{metadata.subject}}
+
+Hello {{who}} [test]({{url}})

data/spec/message/without-frontmatter.md

@@ -0,0 +1 @@
+Hello {{who}}

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'talktome'
+
+module SpecHelpers
+end
+
+RSpec.configure do |c|
+  c.include SpecHelpers
+end

data/tasks/gem.rake

@@ -0,0 +1,39 @@
+require 'rubygems/package_task'
+
+# Dynamically load the gem spec
+gemspec_file = File.expand_path('../../talktome.gemspec', __FILE__)
+gemspec      = Kernel.eval(File.read(gemspec_file))
+
+Gem::PackageTask.new(gemspec) do |t|
+
+  # Name of the package
+  t.name = gemspec.name
+
+  # Version of the package
+  t.version = gemspec.version
+
+  # Directory used to store the package files
+  t.package_dir = "pkg"
+
+  # True if a gzipped tar file (tgz) should be produced
+  t.need_tar = false
+
+  # True if a gzipped tar file (tar.gz) should be produced
+  t.need_tar_gz = false
+
+  # True if a bzip2'd tar file (tar.bz2) should be produced
+  t.need_tar_bz2 = false
+
+  # True if a zip file should be produced (default is false)
+  t.need_zip = false
+
+  # List of files to be included in the package.
+  t.package_files = gemspec.files
+
+  # Tar command for gzipped or bzip2ed archives.
+  t.tar_command = "tar"
+
+  # Zip command for zipped archives.
+  t.zip_command = "zip"
+
+end

data/tasks/test.rake

@@ -0,0 +1,11 @@
+namespace :test do
+  require "rspec/core/rake_task"
+
+  desc "Run RSpec code examples"
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = "spec/**/test_*.rb"
+    t.rspec_opts = ["--color", "--backtrace"]
+  end
+
+end
+task :test => [:'test:unit']

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: talktome
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernard Lambeau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/talktome.rb
+- lib/talktome/client.rb
+- lib/talktome/client/local.rb
+- lib/talktome/error.rb
+- lib/talktome/message.rb
+- lib/talktome/strategy.rb
+- lib/talktome/strategy/debug.rb
+- lib/talktome/strategy/email.rb
+- lib/talktome/version.rb
+- spec/client/test_local.rb
+- spec/fixtures/templates/email.html
+- spec/fixtures/welcome/email.md
+- spec/fixtures/welcome/footer.mustache
+- spec/message/test_initialize.rb
+- spec/message/test_instantiate.rb
+- spec/message/with-frontmatter.md
+- spec/message/without-frontmatter.md
+- spec/spec_helper.rb
+- tasks/gem.rake
+- tasks/test.rake
+homepage: http://github.com/enspirit/talktome
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Talktome helps you talk to users by email, messaging, sms, etc.
+test_files: []