mailto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1489b60f5885ab72863231dd4e0c287fb5651945b96bcd11d63d9a2261ed664
+  data.tar.gz: 6f4d3e2a53dd2b7b2c9df3ef5c7147800b6b0a4d9941a82d944b08518fe0bdf3
+SHA512:
+  metadata.gz: ef31fb17f622a5446d0661f94fa82c60f25bcd71b4d2977e1c7a2d64fcc5fe1a722f45ebd58381ea8bf7d4487338edfc5b1d9ee46895d497df16fbbe9ade7679
+  data.tar.gz: 60ef731a84b88f3aefa1008bf93b658642188471a9c64739cbaa2142afb860b175cc873d6eace7131228a0dd9148946017c83dfd7a638ae259040ef82ea405e5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Brad Gessler
+
+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,82 @@
+# Mailto
+
+Mailto makes it easy to create mailto templates that customers can use to communicate quickly and efficiently with you. The result? You don't have to worry about the complexity of "contact us" forms, weird pop-up chat windows, and all that non-sense. It's just conversation between you and your customer over email.
+
+## Installation
+
+Run from the root of your Rails application:
+
+```sh
+$ bundle add "mailto"
+```
+
+Then install it by running:
+
+```sh
+$ ./bin/rails generate mailto:install
+```
+
+This creates the `./app/mailtos` directory and populates it with a few example templates, like `./app/mailtos/support.txt.erb`.
+
+## Usage
+
+Create a mailto template in the `app/mailtos` folder that looks like this:
+
+```txt
+---
+subject: Having trouble at <%= request.url %>
+to: support@example.com
+---
+
+Greetings,
+
+I was trying to request the page <%= request.url %> and it said there was an error. Could you please have a look?
+
+Here's my browser information: <%= request.user_agent %>
+
+Cheers!
+```
+
+Then load the `mail_to_template` view helper from any of your views:
+
+```
+<h1>Get help!</h1>
+
+<p>
+  If you're still having trouble after reading our <a href="/support">support docs</a>, you can
+  <% mail_to_template :support, "send us an email" %> and we'll check it out.
+</p>
+```
+
+When the user clicks on the link, they'll get an email that's populated with the contents of your template.
+
+### Production use case
+
+[Rocketship](https://rocketship.io/) uses mailto templates on its websites, like [Legible News](https://www.legiblenews.com/) to streamline communications with customers.
+
+Here's what it looks like for an error when a page isn't found:
+
+```txt
+---
+subject: Not found error at <%= request.url %>
+to: support@legiblenews.com
+---
+
+Greetings,
+
+I was trying to request the page <%= request.url %> and it said it couldn't be found, but I'm pretty sure this should work. Could you please have a look?
+
+Cheers!
+```
+
+When the customer clicks on the "email support" link, the templates is populated in their email:
+
+![Email message is populated with contents of template when a customer clicks on the mailto link](https://s3.amazonaws.com/bradgessler/OTvCp9Xd3X6LkRNfSSN1jcTRPW9ezlt3oCw5R9R19sjyCa1Ywv2nbtRc9LtwMSxWLJ75X4mYm6Al90q6dNYcLEivnONalotmlQKa.png)
+
+## Contributing
+
+Open an recreatable issue or a PR with a fix and tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/helpers/mailto_helper.rb

@@ -0,0 +1,10 @@
+# Make it a little easier to integrate email into support flows, etc.
+module MailtoHelper
+  def mail_to_template(template, text, **kwargs)
+    contents = File.read Rails.root.join("app/mailtos/#{template}.txt.erb")
+    parser = Mailto::Frontmatter.new render inline: contents
+    data = parser.data.merge("body": parser.body)
+    email = data.delete("to")
+    mail_to email, text, **data.merge(kwargs)
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/mailto/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/mailto/install/install_generator.rb

@@ -0,0 +1,7 @@
+class Mailto::InstallGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_templates
+    directory "mailtos", "app/mailtos"
+  end
+end

data/lib/generators/mailto/install/templates/mailtos/support.txt.erb

@@ -0,0 +1,12 @@
+---
+subject: Having trouble at <%= request.url %>
+to: support@example.com
+---
+
+Greetings,
+
+I was trying to request the page <%= request.url %> and it said there was an error. Could you please have a look?
+
+Here's my browser information: <%= request.user_agent %>
+
+Cheers!

data/lib/mailto/engine.rb

@@ -0,0 +1,4 @@
+module Mailto
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/mailto/version.rb

@@ -0,0 +1,3 @@
+module Mailto
+  VERSION = "0.1.0"
+end

data/lib/mailto.rb

@@ -0,0 +1,20 @@
+require "mailto/version"
+require "mailto/engine"
+
+module Mailto
+  class Frontmatter
+    DELIMITER = "---".freeze
+    NEWLINE = /\r\n?|\n/.freeze
+    PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m
+
+    attr_reader :body
+
+    def initialize(content)
+      _, @data, @body = content.match(PATTERN).captures
+    end
+
+    def data
+      @data ? YAML.load(@data) : {}
+    end
+  end
+end

data/lib/tasks/mailto_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mailto do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: mailto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+description: Use email for customer communications.
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mailto_manifest.js
+- app/helpers/mailto_helper.rb
+- config/routes.rb
+- lib/generators/mailto/install/USAGE
+- lib/generators/mailto/install/install_generator.rb
+- lib/generators/mailto/install/templates/mailtos/support.txt.erb
+- lib/mailto.rb
+- lib/mailto/engine.rb
+- lib/mailto/version.rb
+- lib/tasks/mailto_tasks.rake
+homepage: https://github.com/rocketshipio/mailto
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/rocketshipio/mailto
+  source_code_uri: https://github.com/rocketshipio/mailto
+  changelog_uri: https://github.com/rocketshipio/mailto
+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: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Use email for customer communications.
+test_files: []