inkcite 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff1fb6ce80d821e6c797a6c691e904ed6dfb60d
-  data.tar.gz: dcea60b5e3efe7edabc97186822e09e8cf43c8d5
+  metadata.gz: 49c0ee10df003264c9c13457a64286f6f55284c4
+  data.tar.gz: 720db2e0316a425f31b390dc6e493e11af271f1f
 SHA512:
-  metadata.gz: 8b19819db8870689817a7947159c7d30ff14e7a237c485dd42d43443691da47f2af0573e34df9f1873cdb14c8a20b71516ff0a23e6b9abdf06eac3747fd7a315
-  data.tar.gz: 118adc599578c2d779d841ea78c8808a8a49334b084809e48eae9e6499e505d93218e5c5ab25026c7cf14b34ec930c39b4bc45401a928d3562eaed823f43aa80
+  metadata.gz: 6ecb5788b293ad9fcf75d344a3454cd57309b6f79c93b4ff8555e3c79b234087b75d304a4904afddb368a4fdb27861991ba915918f0c41de6a9610c027e26438
+  data.tar.gz: 67aa5173680fc76cea09588242493282b6a03cbe8b7ad39bdd93766a7f92119af08220dc6a2fef5a2b1b89feeb83334484ba96e96e3d412576ec3eb1ab3421bc

data/assets/example/helpers.tsv

@@ -0,0 +1,37 @@
+// This file helps you keep your email code DRY (don't repeat yourself) by
+// allowing you to easily define constants and custom tags.
+//
+// https://inkcite.readme.io/docs/helpers
+//
+// NOTE! The keys and values in this file are TAB-delimited.
+
+
+// This controls the subject line used for email prevents and text that is
+// written into the <title> of the HTML created by Inkcite.
+title	Welcome to Inkcite
+
+// This sets the color for all links generated with Inkcite's {a} helper.
+#link	#000099
+
+// This defines the default font family used throughout your email.
+font-family sans-serif
+
+// Default font styles
+font-family	sans-serif
+font-size	15
+line-height	19
+
+// This custom Helper wraps content in a specially formatted <span></span>
+// that changes its font family, size, color and applies custom padding.
+code	{span font-family=monospace font-size=16 padding=3 color=#999}	{/span}
+
+// Bullet-proof buttons
+button-border-radius	5
+button-float	center
+button-padding	8
+button-width	175
+
+// Dimensions
+width	500
+
+wrap	{table width=100% bgcolor=#fff}{td font-family="{font-family}" align=center}	{/td}{/table}

data/assets/example/source.html

@@ -0,0 +1,32 @@
+{wrap}
+
+  {preheader}This preheader will only be visible in supporting clients.{/preheader}
+
+  {table padding=10 width={width} mobile="fill"}
+    {td font=default align=left}
+
+      {img src=logo.jpg height=50 width=200 alt="Company Logo"}<br>
+
+      {img src=billboard.jpg height=180 width={width} mobile="fill"}<br>
+
+      The {code}&#123;img&#125;{/code} Helper automatically uses placehold.it when the specified image is missing from the {code}images/{/code} folder.  It also sets the {code}display{/code} attribute of its style to {code}block{/code} and will warn you when you've forgotten to set dimensions.  Inkcite's Image Helper is responsive-ready, too - you can set this image to {code}hide{/code}, {code}fill{/code} or show a different image using the {code}mobile-src{/code} property.<br><br>
+
+      {a id="image-docs" href="https://inkcite.readme.io/docs/image"}Learn More{/a}
+
+    {/td}
+  {/table}
+
+  {table padding=10 width={width} float=center mobile="fill"}
+    {td align=left font=small}
+
+      {img src=footer.jpg height=100 width={width} mobile="hide"}<br>
+
+      <% if email? %>
+        This email was sent to [email].  {a id="unsubscribe" href=#}Click here to unsubscribe{/a}.
+        Using ERB, this unsubscribe notice will only appear in the 'email' format of this project.
+      <% end %>
+
+    {/td}
+  {/table}
+
+{/wrap}

data/assets/init/config.yml

@@ -12,8 +12,9 @@ copy-alt-to-title: false
 # usually be disabled in development to make debugging easier.
 minify: true
 
-# When true (recommended), enables image optimization using ImageOptim.
-# http://imageoptim.com
+# When true (recommended), enables automatic image optimization of GIF,
+# JPG and PNG images used in your email.
+# https://inkcite.readme.io/v1.0/docs/image-optimization
 optimize-images: true
 
 # When empty links are found in content, this is the URL that will be
@@ -21,9 +22,26 @@ optimize-images: true
 # and needs to be provided.
 missing-link-url: 'https://github.com/404'
 
+# Add Google Fonts (https://www.google.com/fonts) to your emails.  Add
+# the URLs to the family and sizes needed in your email.  Then reference
+# the font family in either source.html:
+#
+#   {td font-family="'Open Sans Condensed', sans-serif"
+#
+# or inside of helpers.tsv:
+#
+#   default-font-family 'Open Sans Condensed', sans-serif
+#
+# https://inkcite.readme.io/docs/fonts#section-google-fonts
+#
+#fonts:
+# - 'https://fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700'
+
 # Inkcite can generate multiple versions of an email from a single source
 # file which is useful for targeted mailings and a/b testing.  Specify a
 # unique, single-word identifier for each version.
+# https://dash.readme.io/project/inkcite/v1.0/docs/ab-testing-and-versioning
+#
 #versions:
 #  - past_customer
 #  - prospect
@@ -31,6 +49,8 @@ missing-link-url: 'https://github.com/404'
 # SMTP settings for sending previews to the small list of internal and client
 # addresses specified below.  Most importantly, specify the address your test
 # emails will be sent 'from:'
+# https://dash.readme.io/project/inkcite/v1.0/docs/email-previews
+#
 smtp:
   host: 'smtp.gmail.com'
   port: 587
@@ -39,7 +59,18 @@ smtp:
   password: ''
   from: 'Your Name <email@domain.com>'
 
+# Mailgun settings for sending previews via their 3x faster API.  Sign up for
+# a free account and retrieve your API key and sending domain from your
+# Mailgun account dashboard.
+# https://inkcite.readme.io/v1.0/docs/email-previews#section-sending-via-mailgun
+#
+# mailgun:
+#  api-key: 'key-your-api-key'
+#  domain: 'mg.sending-domain.com'
+#  from: 'Your Name <email@domain.com>'
+
 # Specify the distribution lists for preview versions of your email.
+#
 recipients:
   client:
     - 'Awesome Client <awesome.client@domain.com>'
@@ -48,7 +79,8 @@ recipients:
     - 'Proofreader <proof.reader@domain.com>'
 
 # Easy Litmus integration for compatibility testing.
-# http://litmusapp.com
+# https://inkcite.readme.io/docs/compatibility-testing
+#
 litmus:
   subdomain: ''
   username: ''
@@ -56,6 +88,8 @@ litmus:
 
 # Easy deployment of static assets to a CDN or publicly-accessible
 # server - required when your email has images.
+# https://dash.readme.io/project/inkcite/v1.0/docs/cdn-upload
+#
 sftp:
   host: ''
   path: ''
@@ -67,16 +101,21 @@ sftp:
 # website analytics.  {id} will be replaced with the unique ID
 # from the link if you're concerned about which link the
 # recipient clicked to get to your website.
+# https://inkcite.readme.io/v1.0/docs/links
+#
 tag-links: "from_email=myemail|{id}"
 
 # Optionally, if your email newsletter links to multiple websites
 # and you only want to tag links to a specific domain, include
 # that domain in this setting.
+# https://inkcite.readme.io/v1.0/docs/links
+#
 #tag-links-domain: 'clientdomain.com'
 
 
 # Environment-specific overrides allow you to change any setting
 # for each environment (e.g local development vs. client preview).
+# https://dash.readme.io/project/inkcite/v1.0/docs/environments
 
 # These overrides apply to your local development environment when
 # you are viewing the email in your browser via Inkcite's server.
@@ -94,4 +133,3 @@ production:
   cache-bust: false
   image-host: "http://production.imagehost.com/emails/myemail"
   view-in-browser-url: 'http://production.contenthost.com/path/{filename}'
-

data/assets/init/helpers.tsv

@@ -1,31 +1,17 @@
-// This file helps you keep your email code DRY (don't repeat yourself)
-// by allowing you to easily define constants and custom tags.
+// This file helps you keep your email code DRY (don't repeat yourself) by
+// allowing you to easily define constants and custom tags.
 //
-// The keys and values in this file are tab-delimited.
-
-// Palette
-#background	#ffffff
-#text	#000000
-#link	#0099cc
-
-// Default font styles
-font-family	sans-serif
-font-size	15
-line-height	19
+// https://inkcite.readme.io/docs/helpers
+//
+// NOTE! The keys and values in this file are TAB-delimited.
 
-// This is an example of a custom tag.  Tabs delimit the tag name, its open and
-// close values.  Inkcite will replace instances of {big} and {/big} with these
-// values, respectively.  Notice that it allows its color, which defaults to
-// #444444, to be configured in your HTML as in {big color=#ff0000}.
-big	<div style="font-size: 18px; font-weight: bold; color: $color=#444444$">	</div>
 
-// Bullet-proof buttons
-button-border-radius	5
-button-float	center
-button-padding	8
-button-width	175
+// This controls the subject line used for email prevents and text that is
+// written into the <title> of the HTML created by Inkcite.
+title Welcome to Inkcite
 
-// Dimensions
-width	500
+// This sets the color for all links generated with Inkcite's {a} helper.
+#link #0099cc
 
-wrap	{table width=100% bgcolor={#background}}{td font-family="{font-family}" align=center}	{/td}{/table}
+// This defines the default font family used throughout your email.
+font-family sans-serif

data/assets/init/image_optim.yml

@@ -0,0 +1,37 @@
+# If you have enabled image optimization in config.yml you can control the
+# exact inner-workings of the process through these settings.  Additional
+# documentation available here:
+# https://github.com/toy/image_optim
+
+allow_lossy: true       # Small images through lossy compression
+verbose: false 			# Verbose output
+
+# Worker/optimizer-specific configurations follow
+
+advpng:
+  level: 4       		# Compression level: 0 - don't compress, 1 - fast, 2 - normal, 3 - extra, 4 - extreme
+
+gifsicle:
+  level: 3       		# Compression level: 1 - light and fast, 2 - normal, 3 - heavy (slower)
+  careful: false 		# Avoid bugs with some software (defaults to false)
+
+jpegoptim:
+  max_quality: 50		# Maximum image quality factor 0..100, ignored in default/lossless mode
+
+jpegrecompress:
+  quality: 1			# JPEG quality preset: 0 - low, 1 - medium, 2 - high, 3 - veryhigh
+
+optipng:
+  level: 5				# Optimization level preset: 0 - least, 7 - best
+
+pngquant:
+  quality: !ruby/range 0..50  # Quality min..max - don't save below min, use less colors below max
+  speed: 1				# Speed/quality trade-off: 1 - slow, 3 - default, 11 - fast & rough
+
+# Note: PNGOUT is free to use even in commercial soft, but you can not
+# redistribute, repackage or reuse it without consent and agreement of creator.
+# Enable PNGOUT optimization by downloading and installing the binaries available
+# from http://www.jonof.id.au/kenutils
+pngout: false
+
+svgo: false

data/assets/init/source.html

@@ -1,60 +0,0 @@
-{wrap}
-
-  {preheader}This preheader will only be visible in supporting clients.{/preheader}
-
-  {table padding=10 width={width} mobile="fill"}
-    {td font=default align=left}
-
-      {img src=logo.gif height=50 width=200 alt="Company Logo"}<br>
-
-      The &#123;img&#125; helper automatically uses placehold.it when the specified image is missing from the images/ folder.  It also sets the <code>display</code>-style to block and will warn you when you've forgotten to set dimensions.  &#123;img&#124; are responsive-ready - you can set this image to <code>hide</code>, <code>fill</code> or show a different image using the <code>mobile-src</code> property.
-
-      {img src=billboard.jpg height=180 width={width} mobile="fill"}<br>
-
-      {lorem sentences=10}<br><br>
-
-      {button id="call-to-action" href="http://inkceptional.com"}I'm a Responsive Button{/button}<br>
-
-    {/td}
-  {/table}
-
-  {table width={width} padding=10 float=center valign=top mobile="drop"}
-    {td width=50%}
-
-      {img src=kittens.jpg width=250 height=150 mobile="fill"}<br>
-
-      {big}{lorem type=headline}{/big}
-
-      {lorem sentences=8}<br><br>
-
-      {button id="call-to-action2" href="http://inkceptional.com"}Create &amp; Send{/button}
-
-    {/td}
-    {td width=50% bgcolor=#eeeeee font=default}
-
-      {big}{lorem type=headline}{/big}
-      {lorem sentences=3}<br><br>
-
-      {big}{lorem type=headline}{/big}
-      {lorem sentences=3}<br><br>
-
-      {big color=#990000}{lorem type=headline}{/big}
-      {lorem sentences=3}
-
-    {/td}
-  {/table}
-
-  {table padding=10 width={width} float=center mobile="fill"}
-    {td align=left font=small}
-
-      {img src=footer.jpg height=100 width={width} mobile="hide"}<br>
-
-      <% if email? %>
-        This email was sent to [email].  {a id="unsubscribe" href=#}Click here to unsubscribe{/a}.
-        Using ERB, this unsubscribe notice will only appear in the 'email' format of this project.
-      <% end %>
-
-    {/td}
-  {/table}
-
-{/wrap}

data/inkcite.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'builder'
   spec.add_dependency 'erubis'
   spec.add_dependency 'faker'
+  spec.add_dependency 'image_optim'
+  spec.add_dependency 'image_optim_pack'
   spec.add_dependency 'litmus'
   spec.add_dependency 'mail'
   spec.add_dependency 'mailgun-ruby'

data/lib/inkcite/cli/base.rb

@@ -23,9 +23,13 @@ module Inkcite
       end
 
       desc 'init NAME [options]', 'Initialize a new email project in the NAME directory'
+      option :'empty',
+          :aliases => '-e',
+          :desc => 'Prevents Inkcite from copying the example email files into the new project',
+          :type => :boolean
       option :from,
           :aliases => '-f',
-          :desc => 'Clones an existing Inkcite project into a new one'
+          :desc => 'Clones an existing Inkcite project (all images, helpers, partials, etc.) into the new one'
 
       def init name
         require_relative 'init'

data/lib/inkcite/cli/build.rb

@@ -99,7 +99,7 @@ module Inkcite
 
         # Check to see if images should be optimized and if so, perform said
         # optimization on new or updated images.
-        email.optimize_images if email.optimize_images?
+        email.optimize_images
 
         # For each of the production views, build the HTML and links files.
         email.views(:production) do |ev|

data/lib/inkcite/cli/init.rb

@@ -10,36 +10,51 @@ module Inkcite
         # Inkcite project.
         abort "It appears that an Inkcite already exists in #{path}" if File.exists?(File.join(full_init_path, 'config.yml'))
 
-        init_image_path = File.join(path, Inkcite::Email::IMAGES)
-        full_init_image_path = File.join(full_init_path, Inkcite::Email::IMAGES)
-
-        # Create the images directory first because it's the deepest level
-        # of the project structure.
-        FileUtils.mkpath(full_init_image_path)
-
-        puts "Created #{init_image_path}"
-
         # Check to see if the user specified a --from path that is used to
         # clone an existing project rather than init a new one.
         from_path = opts[:from]
 
+        # True if the designer wants the project empty/fresh rather than pre-populated
+        # with the example/demonstration email content.
+        is_empty = opts[:empty]
+
         # True if we're initializing a project from the built-in files.
         is_new = opts[:from].blank?
+        if is_new
+
+          # Use the default, bundled path if a from-path wasn't specified.
+          # Verify the path exists
+          from_path = File.join(Inkcite.asset_path, 'init')
 
-        # Use the default, bundled path if a from-path wasn't specified.
-        # Verify the path exists
-        from_path = File.join(File.expand_path('../../..', File.dirname(__FILE__)), 'assets', 'init') if is_new
+        elsif is_empty
+          abort "Can't initialize a project using --empty and --from at the same time"
+
+        end
+
+        init_image_path = File.join(path, Inkcite::Email::IMAGES)
+        full_init_image_path = File.join(full_init_path, Inkcite::Email::IMAGES)
+
+        # Create the images directory first because it's the deepest level
+        # of the project structure.
+        FileUtils.mkpath(full_init_image_path)
+        puts "Created #{init_image_path}"
 
         # Verify that the source directory contains the config.yml file
         # signifying an existing Inkcite project.
         abort "Can't find #{from_path} or it isn't an existing Inkcite project" unless File.exists?(File.join(from_path, 'config.yml'))
 
         # Copy the main Inkcite project files
-        FILES.each do |file|
-          from_file = File.join(from_path, file)
-          next unless File.exists?(from_file)
+        Dir.glob(File.join(from_path, '*.{html,tsv,txt,yml}')).each do |from_file|
           FileUtils.cp(from_file, full_init_path)
-          puts "Created #{File.join(path, file)}"
+          puts "Created #{File.join(path, from_file)}"
+        end
+
+        # If the example email is required, switch to the example root and
+        # copy the files within over the existing files.
+        unless is_empty
+          from_path = File.join(Inkcite.asset_path, 'example')
+          FileUtils.cp_r(File.join(from_path, '.'), full_init_path)
+          puts 'Copied example email files'
         end
 
         # Check to see if there are images and copy those as well.

data/lib/inkcite/cli/server.rb

@@ -92,6 +92,11 @@ module Inkcite
             puts ''
             puts "#{ts} Rendering your email [environment=#{environment}, format=#{format}, version=#{version || 'default'}]"
 
+            # Before the rendering takes place, trigger image optimization of any
+            # new or updated images.  The {image} tag takes care of injecting the
+            # right path (optimized or not) depending on which version is needed.
+            @email.optimize_images
+
             view = @email.view(environment, format, version)
 
             html = view.render!

data/lib/inkcite/cli/test.rb

@@ -7,46 +7,31 @@ module Inkcite
 
       def self.invoke email, opt
 
+        # Verify that a litmus: section is defined in the config.yml
+        config = email.config[:litmus]
+        if !config || config.blank?
+          puts "Unable to test with Litmus ('litmus:' section not found in config.yml)"
+          return false
+        end
+
+        # The new Litmus launched in October, 2015 no longer uses the API for creating
+        # tests and instead just accepts emails sent to the account's static email address.
+        # Check to see if a test-address has been defined.
+        send_to = config[:'test-address']
+        if send_to.nil? || send_to.blank?
+          puts "Unable to test with Litmus! ('test-address' entry missing from 'litmus:' section in the config.yml)"
+          return false
+        end
+
         # Push the browser preview up to the server to ensure that the
         # latest images are available.
         email.upload
 
-        config = email.config[:litmus]
-
-        # Initialize the Litmus base.
-        Litmus::Base.new(config[:subdomain], config[:username], config[:password], true)
-
         # Send each version to Litmus separately
         email.versions.each do |version|
 
           view = email.view(:preview, :email, version)
 
-          # This will hold the Litmus Test Version which provides the GUID (e.g. email)
-          # to which we will send.
-          test_version = nil
-
-          # Check to see if this email already has a test ID.
-          test_id = view.meta(:litmus_test_id)
-          if test_id.blank? || opt[:new]
-
-            email_test = Litmus::EmailTest.create
-
-            # Store the litmus test ID in the email's meta data.
-            view.set_meta :litmus_test_id, email_test['id']
-
-            # Extract the email address we need to send the test to.
-            test_version = email_test["test_set_versions"].first
-
-          else
-
-            # Create a new version of the test using the same ID as before.
-            test_version = Litmus::TestVersion.create(test_id)
-
-          end
-
-          # Extract the email address to send the test to.
-          send_to = test_version["url_or_guid"]
-
           puts "Sending '#{view.subject}' to #{send_to} ..."
 
           Inkcite::Mailer.litmus(email, version, send_to)

data/lib/inkcite/email.rb

@@ -52,12 +52,12 @@ module Inkcite
     # Optimizes this email's images if optimize-images is enabled
     # in the email configuration.
     def optimize_images
-      optimize_images! if optimize_images?
+      Minifier.images(self, false) if optimize_images?
     end
 
     # Optimizes all of the images in this email.
     def optimize_images!
-      Minifier.images(self)
+      Minifier.images(self, true)
     end
 
     def optimize_images?