volt-mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2416a1f3327d0efb536075d06882a43d9cbb3a4a
+  data.tar.gz: b5c410054e1151743f94a3f57e1a56c48c1c9e8b
+SHA512:
+  metadata.gz: c1e264470d919cc5ead6741e393740b2d1e804e7a1eb21138f498d5f49309f87fa9d9bdd81bcc44df4722261c150653034624c17bcc77ac004a2addb18ce7048
+  data.tar.gz: 1320fd84e0ad2cc0e470e694bed7c1c1f7669c3848dc93ebd48d700f3944578482046b221222c55bca084e1ea50917a2f4d0da0d89bd1700201a3292e7ca24de

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in volt-mailer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,66 @@
+# Volt::Mailer
+
+An easy way to send e-mail from your Volt app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'volt-mailer'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+## Templates
+
+When using volt-mailer, you create .email templates and deliver them based on their path.  (Typically at app/main/views/mailers/*.email)
+
+Email templates have three sections in a single file:
+
+```html
+<:Subject>
+  Welcome
+
+<:Html>
+  <h1>Welcome {{ name }}</h1>
+
+  <p>...</p>
+
+<:Text>
+Welcome
+
+...
+
+```
+
+## Delivery
+
+On the client or the server you can send an e-mail with:
+
+```ruby
+Mailer.deliver('path/to/views', {to: 'someone@address.com'}).then do
+  # email sent
+end.fail do |errors|
+  # failed to send, handle errors
+end
+```
+
+Mailer.deliver takes two arguments, the path to your mailer and a hash of options.  In a new volt project, there will be an "app/main/views/mailer" folder.  Any view with .email (or .html) can be used.  Normally you would use a .email view.  Views with the .email extension will not be loaded on the client.
+
+If you skip the :Html section, the :Text section will be used for the html e-mail.
+
+The ```Mailer``` class is a Volt::Task, so the deliver method returns a promise.  Be sure to handle the fail.
+
+The second argument is a hash of options.  volt-mailer uses the [pony gem](https://github.com/benprew/pony) under the hood to deliver the mail.  Any supported pony options will be passed to pony during the sending.  All options passed in will be exposed as methods inside of the email template.  If a matching controller is provided, the options will be set as the controllers model.
+
+## Attachments
+
+Because Volt uses the [pony gem](https://github.com/benprew/pony), you can pass any pony options as the second argument to deliver to add attachments, reply_to, message_id's, etc..
+
+
+## Mailer Config
+
+Commonly when sending e-mails, you'll need to globally configure things like the :via and :via_options, and the :from address.  This can be configured in Volt.configure block in your app.  Volt provides default setup options out of the box.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/mailer/config/dependencies.rb

@@ -0,0 +1 @@
+# Component dependencies

data/app/mailer/tasks/mailer_task.rb

@@ -0,0 +1,44 @@
+unless RUBY_PLATFORM == 'opal'
+  require 'pony'
+  require 'volt/page/path_string_renderer'
+end
+
+class Mailer < Volt::Task
+  def deliver(view_path, attrs)
+    raise ":to must be supplied when delivering e-mail" unless attrs[:to]
+
+    subject = Volt::PathStringRenderer.new("#{view_path}/subject", attrs).html
+
+    text = begin
+      Volt::PathStringRenderer.new("#{view_path}/text", attrs).html
+    rescue ViewLookupException => e
+      nil
+    end
+
+    html = begin
+      Volt::PathStringRenderer.new("#{view_path}/html", attrs).html
+    rescue ViewLookupException => e
+      nil
+    end
+
+    if !text && !body
+      raise "No text or html version of the e-mail supplied in #{view_path}"
+    end
+
+    # If no html version is supplied, use the text version.
+    html ||= "<pre>#{text}</pre>"
+
+    attrs[:subject] = subject
+    attrs[:html_body] = html
+    attrs[:body] = text
+
+    # Merge attrs into a copy of the mailer options
+    attrs = Volt.config.mailer.dup.merge(attrs) if Volt.config.mailer
+
+    allowed_opts = Pony.permissable_options
+
+    pony_options = attrs.select {|k,v| allowed_opts.include?(k.to_sym) }
+    # Send the e-mail
+    Pony.mail(pony_options)
+  end
+end

data/lib/volt/mailer/version.rb

@@ -0,0 +1,5 @@
+module Volt
+  module Mailer
+    VERSION = "0.0.1"
+  end
+end

data/lib/volt/mailer.rb

@@ -0,0 +1,7 @@
+# Add mailer to the list of default loaded components
+Volt.config.default_components << 'mailer'
+
+module Volt
+  module Mailer
+  end
+end

data/volt-mailer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'volt/mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "volt-mailer"
+  spec.version       = Volt::Mailer::VERSION
+  spec.authors       = ["Ryan Stout"]
+  spec.email         = ['ryan@agileproductions.com']
+  spec.summary       = %q{A simple way to send e-mail from within a Volt app.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pony", "~> 1.11"
+
+  spec.add_development_dependency "volt", "~> 0.9.0"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: volt-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Stout
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: volt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !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'
+description: 
+email:
+- ryan@agileproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- app/mailer/config/dependencies.rb
+- app/mailer/tasks/mailer_task.rb
+- lib/volt/mailer.rb
+- lib/volt/mailer/version.rb
+- volt-mailer.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple way to send e-mail from within a Volt app.
+test_files: []