isomorfeus-mailer 1.0.0.zeta24 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5979f41dac7f4ce53ee77ea269685ddfacaa946cd652567200e148d12cd13acd
-  data.tar.gz: 429147109401f1c28140fb1fb66a8a265a600aef3c96d68b370198b57cbdac97
+  metadata.gz: 713145c865204dcc55ce9764805870e5c118ede00ff27390e897c0a0d56961db
+  data.tar.gz: 38c8de1a7466b8889526f9632a20f5c66a26656eac40589a3705c47a7b18f28a
 SHA512:
-  metadata.gz: 707d15bd37719398444a5e19d208cff78fb06274e0c212fc970484eab24f51e826e137139f1b2329a57357dc77c13a5e11d952404ca6f1eed17f8afa1a4d63d4
-  data.tar.gz: 8a7084557969f37e086d9f5f8d096587608b9f74ec436fd492266e35d708f487c5194d4c56a9600bd1588fc4a10f9899493f019746ea6a7835d7a4c93593875c
+  metadata.gz: 87c2628b07e3737e331de6ae500d2194664d7705ea53fd4087acd53c714bdbfccef75510d092d25885d4b2c44e45d5cb4837f65c519e5c51694db157eb2ccf10
+  data.tar.gz: ebfed713d47b12b18ced576777a54dd9d45348db95a90d114e02941da7479839df827717ec8612b5831cd72f452cb1cbb3e0ff89c42dd5b2c837bb010e878247

data/LICENSE

@@ -1,21 +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.
+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

@@ -1,93 +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
-```
+# 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 Preact static renderer, so the Preact rules for static rendering apply.
+
+Inline styles work in Mail Components too.
+
+Example component:
+```ruby
+class EmailComponent < LucidApp::Base
+  # the top level component must be a App component
+  # then other 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 to prevent abuse.
+
+Sending mail with the rendered component from the server:
+```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 to prevent abuse. 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/config.rb

@@ -1,23 +1,25 @@
-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(message: "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
+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(message: "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
+
+  self.assets['mail.js'] = Isomorfeus::AssetManager::Asset.new(:node)
+end

data/lib/isomorfeus/mailer/imports.rb

@@ -0,0 +1,18 @@
+module Isomorfeus
+  module Mailer
+    module Imports
+      def self.add
+        Isomorfeus.assets['mail.js'].add_js_import('redux', 'Redux', '*')
+        Isomorfeus.assets['mail.js'].add_js_import('preact', 'Preact', '*')
+        Isomorfeus.assets['mail.js'].add_js_import('preact/hooks', 'PreactHooks', '*')
+        Isomorfeus.assets['mail.js'].add_js_import('wouter-preact', nil, ['Router', 'Link', 'Redirect', 'Route', 'Switch'])
+        Isomorfeus.assets['mail.js'].add_js_import('preact-render-to-string', 'Preact', ['render'], nil, 'renderToString')
+        Isomorfeus.assets['mail.js'].add_js_import('wouter-preact/static-location', 'staticLocationHook')
+        Isomorfeus.assets['mail.js'].add_js_import('ws', 'WebSocket')
+        if Dir.exist?(Isomorfeus.app_root)
+          Isomorfeus.assets['mail.js'].add_ruby_import('mail_loader') if File.exist?(File.join(Isomorfeus.app_root, 'mail_loader.rb'))
+        end
+      end
+    end
+  end
+end

data/lib/isomorfeus/mailer/version.rb

@@ -1,5 +1,5 @@
-module Isomorfeus
-  module Mailer
-    VERSION = '1.0.0.zeta24'
-  end
-end
+module Isomorfeus
+  module Mailer
+    VERSION = '2.0.0.rc3'
+  end
+end

data/lib/isomorfeus-mailer.rb

@@ -1,5 +1,12 @@
-require 'html2text'
-require 'mailhandler'
-require 'isomorfeus-react'
-require 'isomorfeus/mailer/config'
-require 'lucid_mail'
+require 'html2text'
+require 'mailhandler'
+require 'isomorfeus-asset-manager'
+require 'isomorfeus-redux'
+require 'isomorfeus-preact'
+require 'isomorfeus-transport'
+require 'isomorfeus/mailer/config'
+require 'isomorfeus/mailer/imports'
+
+Isomorfeus::Mailer::Imports.add
+
+require 'lucid_mail'

data/lib/lucid_mail.rb

@@ -1,57 +1,65 @@
-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_transfer_encoding 'binary'
-      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
+class LucidMail
+  include Isomorfeus::PreactViewHelper
+  extend LucidPropDeclaration::Mixin
+
+  prop :from, class: String, required: true
+  prop :reply_to, class: String, required: false, allow_nil: true
+  prop :to, class: String, required: true
+  prop :subject, class: String, required: true
+  prop :component, class: String, required: true
+  prop :asset, class: String, default: 'mail.js'
+  prop :props
+
+  attr_reader :mail
+  attr_reader :props
+  attr_reader :rendered_component
+
+  def initialize(**props)
+    @props = LucidProps.new(self.class.validated_props(props))
+    @mail = nil
+    @rendered_component = nil
+    @loc_h = if self.class.const_defined?('::Isomorfeus::Puppetmaster')
+      "#{::Isomorfeus::Puppetmaster.served_app.host}:#{::Isomorfeus::Puppetmaster.served_app.port}"
+    elsif self.class.const_defined?('::Iodine')
+      "#{::Iodine::DEFAULT_SETTINGS[:address]}:#{::Iodine::DEFAULT_SETTINGS[:port]}"
+    else
+      'localhost:3000'
+    end
+  end
+
+  def render_component
+    component_props = { location_host: @loc_h }.merge(props.props)
+    rendered_tree = mount_component(props.component, component_props, props.asset, use_ssr: true)
+    @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_transfer_encoding 'binary'
+      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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-mailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.zeta24
+  version: 2.0.0.rc3
 platform: ruby
 authors:
 - Jan Biedermann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: html2text
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: mailhandler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.59
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.59
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.9
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: opal-activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -95,61 +95,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.3
 - !ruby/object:Gem::Dependency
-  name: isomorfeus-react
+  name: isomorfeus-asset-manager
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 16.13.0
+        version: 0.13.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 16.13.0
+        version: 0.13.8
+- !ruby/object:Gem::Dependency
+  name: isomorfeus-preact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.11
 - !ruby/object:Gem::Dependency
   name: isomorfeus-redux
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.22
+        version: 4.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.22
+        version: 4.1.9
 - !ruby/object:Gem::Dependency
-  name: isomorfeus
+  name: isomorfeus-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.zeta24
-  type: :development
+        version: 2.0.0.rc3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.zeta24
+        version: 2.0.0.rc3
 - !ruby/object:Gem::Dependency
-  name: opal-webpack-loader
+  name: isomorfeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: 2.0.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: 2.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +202,7 @@ files:
 - README.md
 - lib/isomorfeus-mailer.rb
 - lib/isomorfeus/mailer/config.rb
+- lib/isomorfeus/mailer/imports.rb
 - lib/isomorfeus/mailer/version.rb
 - lib/lucid_mail.rb
 homepage: http://isomorfeus.com
@@ -195,7 +210,7 @@ licenses:
 - MIT
 metadata:
   github_repo: ssh://github.com/isomorfeus/gems
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Write mail template components and send mail.
 test_files: []