ghost_in_the_post 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5264602db0f4c3dff7764e85b40b297046a9a55
+  data.tar.gz: 289c490672985941a51227c4a9133ec1ba9e175c
+SHA512:
+  metadata.gz: c7b6aca158ff83c738d9cb85d01d7011d9cae5d8e47a8f5ed6650dc394086a216217ab2e7c557796fbe02583b0c6489d959caa90c00e3ff1376bc3c38aa20f75
+  data.tar.gz: 40ae64bdf2f34875db66564f55de75b23563ed87595fe10102fc894e78ea091abf67e0d0c9572106c65fc1e358a74f0be406d1a19bf9d44737eb481f1ddc9fb2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tim Anema
+
+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/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+desc "Run specs"
+task :spec do
+  sh "bundle exec rspec -f progress"
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GhostInThePost'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec

data/lib/ghost_in_the_post.rb

@@ -0,0 +1,47 @@
+require 'rails'
+module GhostInThePost
+  ATTRIBUTE_NAMES = [
+    :phantomjs_path,
+    :includes,
+    :remove_js_tags,
+  ]
+  private_constant :ATTRIBUTE_NAMES
+  cattr_reader(*ATTRIBUTE_NAMES)
+
+  @@phantomjs_path = nil #setting this to nil helps testing
+  @@includes = []
+  @@remove_js_tags = true
+
+  def self.config=(new_config={})
+    self.complain_about_unknown_keys(new_config.keys)
+    @@phantomjs_path = new_config[:phantomjs_path]
+    @@includes = Array(new_config[:includes])
+    @@remove_js_tags = new_config[:remove_js_tags].nil? ? true : new_config[:remove_js_tags]
+    raise ArgumentError, "GhostInThePost.config.phantomjs_path is not set" if self.phantomjs_path.nil?
+  end
+
+  def self.phantomjs_path
+    @@phantomjs_path or raise ArgumentError, "GhostInThePost.config.phantomjs_path is not set"
+  end
+
+  private
+  
+  def self.complain_about_unknown_keys(keys)
+    invalid_keys = keys - ATTRIBUTE_NAMES
+    if invalid_keys.size > 0
+      raise ArgumentError, "Unknown configuration parameters: #{invalid_keys}", caller(1)
+    end
+  end
+
+end
+ 
+require "ghost_in_the_post/version"
+
+require "ghost_in_the_post/phantom_transform"
+require "ghost_in_the_post/mail_ghost"
+
+require "ghost_in_the_post/ghost_on_command"
+require "ghost_in_the_post/ghost_on_delivery"
+
+require "ghost_in_the_post/mailer"
+require "ghost_in_the_post/automatic"

data/lib/ghost_in_the_post/automatic.rb

@@ -0,0 +1,19 @@
+module GhostInThePost
+  module Automatic
+    attr_accessor :included_scripts
+
+    def include_script(*paths)
+      @included_scripts ||= []
+      @included_scripts += paths
+    end
+
+    def mail(*args, &block)
+      super.tap do |email|
+        email.extend GhostOnCommand
+        email.extend GhostOnDelivery
+        email.included_scripts = @included_scripts
+      end
+    end
+
+  end
+end

data/lib/ghost_in_the_post/ghost_on_command.rb

@@ -0,0 +1,10 @@
+module GhostInThePost
+  module GhostOnCommand
+    attr_accessor :included_scripts
+
+    def ghost
+      MailGhost.new(self, included_scripts).execute
+    end
+  end
+end
+

data/lib/ghost_in_the_post/ghost_on_delivery.rb

@@ -0,0 +1,12 @@
+module GhostInThePost
+  module GhostOnDelivery
+    def deliver
+      ghost
+      super
+    end
+    def deliver!
+      ghost
+      super
+    end
+  end
+end

data/lib/ghost_in_the_post/mail_ghost.rb

@@ -0,0 +1,30 @@
+module GhostInThePost
+  class MailGhost
+    attr_reader :email, :included_scripts
+
+    def initialize(email, included_scripts)
+      @email = email
+      @included_scripts = Array(included_scripts).compact
+    end
+
+    def execute
+      improve_body if email.content_type =~ /^text\/html/
+      improve_html_part(email.html_part) if email.html_part
+      email
+    end
+
+    private
+
+    def improve_body
+      email.body = ghost_html(email.body.decoded)
+    end
+
+    def improve_html_part(html_part)
+      html_part.body = ghost_html(html_part.body.decoded)
+    end
+
+    def ghost_html(old_html)
+      PhantomTransform.new(old_html, included_scripts).transform
+    end
+  end
+end

data/lib/ghost_in_the_post/mailer.rb

@@ -0,0 +1,18 @@
+module GhostInThePost
+  module Mailer
+    attr_accessor :included_scripts
+
+    def include_script(*paths)
+      @included_scripts ||= []
+      @included_scripts += paths
+    end
+
+    def mail(*args, &block)
+      super.tap do |email|
+        email.extend GhostOnCommand
+        email.included_scripts = included_scripts
+      end
+    end
+
+  end
+end

data/lib/ghost_in_the_post/phantom/staticize.js

@@ -0,0 +1,27 @@
+"use strict";
+var system  = require('system'),
+    page    = require('webpage').create(),
+    html    = system.args[1], //the email to be processed
+    no_script = system.args[2] == "true",
+    include = system.args[3]; //the injected js file
+
+page.onLoadFinished = function(status) {
+  //load included scripts to be loaded on the dom
+  if(!!include){
+    page.injectJs(include);
+  }
+  if(no_script) {
+    page.evaluate(function(){
+      var script_tags = document.getElementsByTagName("script");
+      for(var i = 0; i < script_tags.length; i++) {
+        script_tags[i].parentNode.removeChild(script_tags[i]);
+      }
+    })
+  }
+  //write out to console to export contents
+  console.log(page.content); 
+  phantom.exit(); //get out of here
+};
+//load html content
+page.setContent(html, 'http://www.whatever.com');
+

data/lib/ghost_in_the_post/phantom_transform.rb

@@ -0,0 +1,91 @@
+module GhostInThePost
+  class PhantomTransform
+    PHANTOMJS_SCRIPT = File.expand_path('../phantom/staticize.js', __FILE__)
+
+    def initialize(html, included_scripts=[])
+      @html = html
+      @included_scripts = Array(included_scripts).compact
+    end
+
+    def transform
+      injectable_scripts.any? ? transform_with_injections : simple_transform
+    end
+
+    private
+
+    def command
+      [
+        GhostInThePost.phantomjs_path, 
+        PHANTOMJS_SCRIPT, 
+        @html,
+        GhostInThePost.remove_js_tags
+      ]
+    end
+
+    #there is scripts to inject so create a tmp file to put them all in
+    def transform_with_injections
+      #set output to just html so that if there is an error that is caught it will
+      #at least return valid html
+      output = @html
+      begin
+        #generate a tempfile with all the js that we need so that phantom can inject
+        #easily and not have to max out a single command
+        file = Tempfile.new(['inject', '.js'])
+        injectable_scripts.map do |script|
+          asset = find_asset_in_pipeline(script)
+          file.write(asset.to_s) unless asset.nil?
+        end.compact
+        file.close #closing the file makes it accessible by phantom
+
+        #generate the html with the javascript
+        output = IO.popen(command + [file.path]){|io| io.read}
+
+        file.unlink
+      rescue => e
+        #clean up the temp file
+        file.unlink
+      end
+      output
+    end
+
+    #no scripts to inject so just run the command
+    def simple_transform
+      IO.popen(command){|io| io.read}
+    end
+
+    def injectable_scripts
+      @injectable_scripts ||= (GhostInThePost.includes + @included_scripts)
+    end
+ 
+    def find_asset_in_pipeline(name)
+      normalized_name = normalize_asset_name(name)
+      Rails.application.assets[normalized_name] || Rails.application.assets[remove_asset_digest(normalized_name)]
+    end
+
+    def normalize_asset_name(href)
+      remove_asset_prefix(href.split('?').first)
+    end
+
+    DIGEST_PATTERN = /
+      -                # Digest comes after a dash
+      (?:
+       [a-z0-9]{32} |  # Old style is 32 character hash
+       [a-z0-9]{64}    # New style is 64 characters
+      )
+      \.               # Dot for the file extension
+    /x.freeze
+
+    def remove_asset_digest(path)
+      path.gsub(DIGEST_PATTERN, '.')
+    end
+
+    def remove_asset_prefix(path)
+      path.sub(Regexp.new("^#{Regexp.quote(asset_prefix)}/?"), "")
+    end
+
+    def asset_prefix
+      ::Rails.application.try(:config).try(:assets).try(:prefix) || "/assets"
+    end
+
+  end
+end

data/lib/ghost_in_the_post/version.rb

@@ -0,0 +1,3 @@
+module GhostInThePost
+  VERSION = "0.0.1"
+end

data/spec/dummy/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'rails', '4.2.3'
+gem 'ghost_in_the_post', :path => '../..'

data/spec/dummy/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: ../..
+  specs:
+    ghost_in_the_post (0.0.1)
+      rails (~> 4.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    concurrent-ruby (1.0.0)
+    concurrent-ruby (1.0.0-java)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    json (1.8.3-java)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    nokogiri (1.6.7.2-java)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  ghost_in_the_post!
+  rails (= 4.2.3)
+
+BUNDLED WITH
+   1.10.6