isomorfeus-mailer 1.0.0.zeta17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52d9bd4e04bd1cdc98d6f4e554c60157d8e957696c893b3ad7c1d1ae270e04c4
+  data.tar.gz: '093267ef78db9fbe97e3e615d9504cd6c1d88ff005da48c8177539e300d4db20'
+SHA512:
+  metadata.gz: a6c97e10fa49fd702df741a53dd47e2056af9b989e141c6f2d76367626e57fc042d64abd0b6c252498b70dcf675cb49fc4625ef3714104a505402be7f4c30ffa
+  data.tar.gz: 0f3161bce4725cb4473f0cc7c4c8e3ecac7e281d3dd9b71102a5f2b211bbd2cdb52215f3644481751eafdd521ca3630fffac721698f9ddd8e30601ac7d438b1d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2019 Jan Biedermann
+
+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,93 @@
+# isomorfeus-mailer
+
+Build mails with components and send them with [Mailhandler](https://github.com/wildbit/mailhandler#email-sending).
+
+### Community and Support
+At the [Isomorfeus Framework Project](http://isomorfeus.com) 
+
+### Configuration
+
+Configuration options can be set as hash passed to:
+```ruby
+Isomorfeus.email_sender_config = { type: :smtp }
+```
+All configuration options of Mailhandler can be passed in the hash. For Mailhandler option see
+[Email sending](https://github.com/wildbit/mailhandler#email-sending) section of the Mailhandler docs.
+
+### Usage
+
+#### Mail Components
+Within a isomorfeus project components for building emails are the app/mail_components directory.
+When using LucidComponent or LucidMaterial::Component the main component passed to the mail must be either a LucidApp or LucidMaterial::App component.
+Each mail template build of components can be considered a tiny App.
+
+Mail components are rendered using the React static renderer, so the React rules for static rendering apply.
+
+Inline styles work in Mail Components too.
+
+Example component:
+```ruby
+class EmailComponent < LucidApp::Base
+  # the toplevel component must be a App component
+  # then oder LucidComponent's can be used in the render block 
+
+  prop :name
+
+  render do
+    DIV "Welcome #{props.name}!"
+  end
+end
+```
+
+#### Sending Mail
+
+One class is provided to actually build and send the mail: LucidMail. This class is only available on the server.
+
+Sending mail with the rendered component:
+```ruby
+mail = LucidMail.new(component: 'EmailComponent', 
+                     props: { name: 'Siegfried' }, # are passed to the component
+                     from: 'me@test.com',
+                     to: 'you@test.com',
+                     subject: 'Welcome')
+mail.send
+```
+#### Inspecting the rendered component
+
+The generated HTML is accessible after building the mail using:
+```ruby
+mail.build
+html = mail.rendered_component
+```
+
+#### Accessing the mail before sending
+
+It is possible to access the actual mail object after building it for further inspection or modification:  
+```ruby
+mail.build
+mail_object = mail.mail
+```
+For documentation about the Mail Object see the [Mail Documentation](https://github.com/mikel/mail).
+
+#### Triggering mail from a client
+LucidMail is available only on the server. It can be wrapped in a operation to allow triggering the sending of mail from a client. Example:
+```ruby
+class MailOp < LucidQuickOp::Base
+  op do
+    LucidMail.new(component: 'EmailComponent', 
+                  from: 'me@test.com',
+                  to: current_user.email,
+                  subject: 'Welcome')
+  end
+end
+```
+Make sure policy allows running the operation:
+```ruby
+class MyUserPolicy
+  allow MailOp, :promise_run
+end
+```
+Then on a client mail can be triggered:
+```ruby
+MailOp.promise_run
+```

data/lib/isomorfeus-mailer.rb

@@ -0,0 +1,5 @@
+require 'html2text'
+require 'mailhandler'
+require 'isomorfeus-react'
+require 'isomorfeus/mailer/config'
+require 'lucid_mail'

data/lib/isomorfeus/mailer/config.rb

@@ -0,0 +1,23 @@
+module Isomorfeus
+  # available settings
+  class << self
+    if RUBY_ENGINE != 'opal'
+      def email_sender_config
+        @email_sender_config ||= { type: :smtp }
+      end
+
+      def email_sender_config=(new_config)
+        Isomorfeus.raise_error "email_sender_config must at least include a :type!" unless new_config.key?(:type)
+        @email_sender_config = new_config
+      end
+
+      def email_sender
+        @email_sender ||= MailHandler.sender(Isomorfeus.email_sender_config[:type]) do |dispatcher|
+          Isomorfeus.email_sender_config.each do |key, value|
+            dispatcher.__send__("#{key}=".to_sym, value) unless key == :type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/isomorfeus/mailer/version.rb

@@ -0,0 +1,5 @@
+module Isomorfeus
+  module Mailer
+    VERSION = '1.0.0.zeta17'
+  end
+end

data/lib/lucid_mail.rb

@@ -0,0 +1,56 @@
+class LucidMail
+  include Isomorfeus::ReactViewHelper
+  extend LucidPropDeclaration::Mixin
+
+  prop :from, class: String, required: true
+  prop :reply_to, class: String, required: false
+  prop :to, class: String, required: true
+  prop :subject, class: String, required: true
+  prop :component, class: String, required: true
+  prop :props
+
+  attr_reader :mail
+  attr_reader :props
+  attr_reader :rendered_component
+
+  def initialize(**props)
+    self.class.validate_props(props)
+    @props = LucidProps.new(props)
+    @mail = nil
+    @rendered_component = nil
+  end
+
+  def render_component
+    rendered_tree = mount_static_component(props.component, props.props, 'mail_components.js')
+    @rendered_component = <<~HTML
+    <!DOCTYPE html>
+    <html><head><style type="text/css">#{ssr_styles}</style></head><body>#{rendered_tree}</body></html>
+    HTML
+    self
+  end
+
+  def build
+    render_component unless rendered_component
+    html_body = rendered_component
+    text_body = Html2Text.convert(rendered_component)
+    @mail = Mail.new
+    @mail.to(props.to)
+    @mail.from(props.from)
+    @mail.subject(props.subject)
+    @mail.reply_to(props.reply_to) if props.key?(:reply_to)
+    @mail.text_part do
+      content_type 'text/plain; charset=UTF-8'
+      body text_body
+    end
+    @mail.html_part do
+      content_type 'text/html; charset=UTF-8'
+      body html_body
+    end
+    self
+  end
+
+  def send
+    build unless mail
+    Isomorfeus.email_sender.send_email(mail)
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: isomorfeus-mailer
+version: !ruby/object:Gem::Version
+  version: 1.0.0.zeta17
+platform: ruby
+authors:
+- Jan Biedermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: html2text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mailhandler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: opal-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: isomorfeus-react
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.12.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.12.18
+- !ruby/object:Gem::Dependency
+  name: isomorfeus-redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.17
+- !ruby/object:Gem::Dependency
+  name: isomorfeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.zeta17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.zeta17
+- !ruby/object:Gem::Dependency
+  name: opal-webpack-loader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: Write mail template components and send mail.
+email: jan@kursator.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/isomorfeus-mailer.rb
+- lib/isomorfeus/mailer/config.rb
+- lib/isomorfeus/mailer/version.rb
+- lib/lucid_mail.rb
+homepage: http://isomorfeus.com
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/isomorfeus/gems
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Write mail template components and send mail.
+test_files: []