mjml-remote-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54c05c64b5d9536df569f7040305cf75050d5a1d5651b3dadc325eec559c594a
+  data.tar.gz: a3f27b935d46494e65358b21bfd845f9bc8dad1173cc93475a394b77445f48ae
+SHA512:
+  metadata.gz: e37fc5cda6d5d4d130a2457047eba9ffed24b7c3de555fe14b24dc2fb8a8b1eca2d36a91dbdb3f4d09c0e43857527610cd57c61ac115278dc629d74dcb008240
+  data.tar.gz: 231f742abf8a9457985b6e990440fa550724d6c6c28ba252a3412157f74ee595ac7221edca5a18fbd3c9f00e4829112c8c208d798541b647584d78796bd012ff

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mjml-remote-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,146 @@
+PATH
+  remote: .
+  specs:
+    mjml-remote-rails (0.1.0)
+      faraday (~> 0.12)
+      rails (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.2)
+      actionpack (= 5.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.2)
+      activesupport (= 5.2.2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activestorage (5.2.2)
+      actionpack (= 5.2.2)
+      activerecord (= 5.2.2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nio4r (2.3.1)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.2)
+      actioncable (= 5.2.2)
+      actionmailer (= 5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      activemodel (= 5.2.2)
+      activerecord (= 5.2.2)
+      activestorage (= 5.2.2)
+      activesupport (= 5.2.2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  mjml-remote-rails!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 ecoPortal
+
+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,88 @@
+# mjml-remote-rails
+
+Based on [mjml-rails](https://github.com/sighmon/mjml-rails/), this gem offloads
+the actual MJML processing to a microservice (e.g a lambda function). If the
+microservice returns an error, `Mjml::Remote::Template::ParseError` will be
+raised.
+
+See [mjml-lambda](https://gitlab.com/ecoPortal/mjml-lambda) for an example
+lambda function that will do it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mjml-remote-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mjml-remote-rails
+
+## Configuring
+
+```ruby
+Mjml::Remote.setup do |setup|
+  # Override template language - default is erb
+  config.template_language = :haml
+  # config.endpoint is required!
+  config.endpoint = "https://<some-server/<some-endpoint>"
+  # headers for the requests can be set - default is no headers
+  config.headers = { "x-api-key" => "some header based authentication" }
+end
+```
+
+## ...why?!
+
+Calling MJML from ruby is pretty heavy memory-wise and threw a major spanner in
+the works of our heavily multi-threaded background job workers when lots of
+emails were being processed. Installing the mjml binary also added a decent
+amount of weight to our docker containers once you factored in the other
+dependencies you need.
+
+Moving the actual MJML processing to a lambda function means we don't need to
+worry about this any more, and as all our email processing is backgrounded
+anyway, it won't really make much of a difference to our users.
+
+## Falling back to regular MJML in development
+
+`Gemfile`
+
+```ruby
+group :production do
+  gem "mjml-remote-rails"
+end
+group :development do
+  gem "mjml-rails", require: false
+  gem "mjml-remote-rails", require: false
+end
+```
+
+`config/application.rb` at the top after requiring rails:
+
+```ruby
+if ENV["MJML_ENDPOINT"]
+  require "mjml-remote-rails"
+else
+  require "mjml-rails"
+end
+```
+
+`config/initializers/mjml.rb`
+
+```ruby
+if Rails.env.production? || ENV["MJML_ENDPOINT"]
+  Mjml::Remote.setup do |config|
+    ...
+  end
+else
+  Mjml.setup do |config|
+    ...
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mjml/remote/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mjml-remote-rails.rb

@@ -0,0 +1 @@
+require "mjml/remote"

data/lib/mjml/remote.rb

@@ -0,0 +1,21 @@
+require "action_view"
+require "action_view/template"
+require "rails/railtie"
+require "mjml/remote/version"
+require "mjml/remote/handler"
+require "mjml/remote/railtie"
+require "mjml/remote/template"
+
+module Mjml
+  module Remote
+    class Error < StandardError; end
+    mattr_accessor :endpoint, :headers, :template_language
+    @@endpoint          = nil
+    @@template_language = :erb
+    @@headers           = Hash.new
+
+    def self.setup
+      yield self if block_given?
+    end
+  end
+end

data/lib/mjml/remote/handler.rb

@@ -0,0 +1,24 @@
+module Mjml
+  module Remote
+    class Handler
+      def template_handler
+        @_template_handler ||= ActionView::Template.registered_template_handler(Mjml::Remote.template_language)
+      end
+      def call(template)
+        compiled_source = template_handler.call(template)
+        # Per MJML v4 syntax documentation[0] valid/render'able document MUST start with <mjml> root tag
+        # If we get here and template source doesn't start with one it means
+        # that we are rendering partial named according to legacy naming convention (partials ending with '.mjml')
+        # Therefore we skip MJML processing and return raw compiled source. It will be processed
+        # by MJML library when top-level layout/template is rendered
+        #
+        # [0] - https://github.com/mjmlio/mjml/blob/master/doc/guide.md#mjml
+        if compiled_source =~ /<mjml(.+)?>/i
+          "Mjml::Remote::Template.to_html(begin;#{compiled_source};end).html_safe"
+        else
+          compiled_source
+        end
+      end
+    end
+  end
+end

data/lib/mjml/remote/railtie.rb

@@ -0,0 +1,11 @@
+module Mjml
+  module Remote
+    class Railtie < Rails::Railtie
+      config.mjml_remote = Mjml::Remote
+      initializer "mjml-remote-rails.register_template_handler" do
+        ActionView::Template.register_template_handler :mjml, Mjml::Remote::Handler.new
+        Mime::Type.register_alias "text/html", :mjml
+      end
+    end
+  end
+end

data/lib/mjml/remote/template.rb

@@ -0,0 +1,31 @@
+module Mjml
+  module Remote
+    class Template
+      class ParseError < StandardError
+        attr_reader :response
+        def initialize(response)
+          @response = response
+        end
+      end
+      def self.to_html(compiled_source)
+        new(compiled_source).render.html_safe
+      end
+      def initialize(input)
+        @input = input
+      end
+      def render
+        response = Faraday.post(
+          Mjml::Remote.endpoint,
+          @input,
+          Mjml::Remote.headers
+        )
+        content = JSON.parse(response.body)
+        if response.success?
+          content["html".freeze]
+        else
+          raise ParseError.new(content)
+        end
+      end
+    end
+  end
+end

data/lib/mjml/remote/version.rb

@@ -0,0 +1,5 @@
+module Mjml
+  module Remote
+    VERSION = "0.1.0"
+  end
+end

data/mjml-remote-rails.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mjml/remote/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mjml-remote-rails"
+  spec.version       = Mjml::Remote::VERSION
+  spec.authors       = ["Tapio Saarinen"]
+  spec.email         = ["prime@factori.se"]
+
+  spec.summary       = %q{Use MJML with rails, rendered via a HTTP request}
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "faraday", "~> 0.12"
+  spec.add_dependency "rails", "~> 5.2"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mjml-remote-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tapio Saarinen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: 
+email:
+- prime@factori.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mjml-remote-rails.rb
+- lib/mjml/remote.rb
+- lib/mjml/remote/handler.rb
+- lib/mjml/remote/railtie.rb
+- lib/mjml/remote/template.rb
+- lib/mjml/remote/version.rb
+- mjml-remote-rails.gemspec
+homepage: 
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Use MJML with rails, rendered via a HTTP request
+test_files: []