middleman-protect-emails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9092336bc246a62deb1d6a3a3c3ce38fc99fed7
+  data.tar.gz: 5e925a8bd83b277720d3ab16f680665613dab495
+SHA512:
+  metadata.gz: 1c365af2cb55d34a1c4939991302f05276f809e46169e0f586f849dbd641a0fcdf196fc23c73f9f8a2ae4a8caf033bf020cf4e08083b5ba550cd4d772d3ceb64
+  data.tar.gz: 59fb71b6185287e946ca4aa020bed464169909ccd89c77ee78b55b259a68e674714ce44fe95affc050727d2cfb77638c17ddd1826d39860b88ffddcd9bf99ff7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.1.5
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+script: "bundle exec rake test"

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'cucumber'
+  gem 'fivemat'
+  gem 'aruba'
+  gem 'codeclimate-test-reporter'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ankit Sardesai
+
+MIT License
+
+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,47 @@
+# middleman-protect-emails
+
+[![Build Status](https://travis-ci.org/amsardesai/middleman-protect-emails.svg)](https://travis-ci.org/amsardesai/middleman-protect-emails)
+[![Code Climate](https://codeclimate.com/github/amsardesai/middleman-protect-emails/badges/gpa.svg)](https://codeclimate.com/github/amsardesai/middleman-protect-emails)
+[![Test Coverage](https://codeclimate.com/github/amsardesai/middleman-protect-emails/badges/coverage.svg)](https://codeclimate.com/github/amsardesai/middleman-protect-emails)
+
+**middleman-protect-emails** is a [Middleman](http://middlemanapp.com) extension that encrypts email links on your page on the server-side and decodes them on the client-side, avoiding spam bots with no visible impacts to your users.
+
+This gem makes use of the [ROT13](http://en.wikipedia.org/wiki/ROT13) encryption algorithm to encrypt email links. Users must have Javascript enabled on their computers for the decoding stage to work.
+
+## Installation
+
+Add this line to your Middleman application's Gemfile:
+
+```ruby
+gem 'middleman-protect-emails'
+```
+
+And then run:
+
+    $ bundle
+
+## Configuration
+
+Implementing this gem is as simple as adding the following line to your project's `config.rb` file:
+
+```ruby
+# config.rb
+activate :protect_emails
+```
+
+You can also add it to your build-specific configuration:
+
+```ruby
+# config.rb
+configure :build do
+  activate :protect_emails
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a [new pull request](../../pull/new/master)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rake/clean'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+task test: ['cucumber']
+task default: :test

data/features/extension.feature

@@ -0,0 +1,31 @@
+Feature: Email Protection
+
+  Scenario: Inserts script into the page
+    Given the Server is running at "test-app"
+    When I go to "/"
+    Then I should see "</script>"
+
+  Scenario: Shows obfuscated email on page
+    Given the Server is running at "test-app"
+    When I go to "/"
+    Then I should see "<a href='#email-protection-rznvy@rknzcyr.pbz'></a>"
+
+  Scenario: Inserts script into end of body if a body tag exists
+    Given the Server is running at "test-app"
+    When I go to "/with_body.html"
+    Then I should see:
+    """
+    </script>
+    </body>
+    """
+
+  Scenario: Does not insert script if there is no email on the page
+    Given the Server is running at "test-app"
+    When I go to "/with_no_email.html"
+    Then I should not see "</script>"
+
+  Scenario: Obfuscates multiple emails
+    Given the Server is running at "test-app"
+    When I go to "/with_multiple_emails.html"
+    Then I should see "<a href='#email-protection-rznvy1@rknzcyr.pbz'></a>"
+    Then I should see "<a href='#email-protection-rznvy2@rknzcyr.pbz'></a>"

data/features/support/env.rb

@@ -0,0 +1,8 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-protect-emails')

data/fixtures/test-app/config.rb

@@ -0,0 +1 @@
+activate :protect_emails

data/fixtures/test-app/source/index.html

@@ -0,0 +1 @@
+<a href='mailto:email@example.com'></a>

data/fixtures/test-app/source/with_body.html

@@ -0,0 +1 @@
+<html><head></head><body><a href='mailto:email@example.com'></a></body></html>

data/fixtures/test-app/source/with_multiple_emails.html

@@ -0,0 +1 @@
+<html><head></head><body><a href='mailto:email1@example.com'></a><a href='mailto:email2@example.com'></a></body></html>

data/fixtures/test-app/source/with_no_email.html

@@ -0,0 +1 @@
+<html><head></head><body>Hello!</body></html>

data/lib/middleman-protect-emails/extension.rb

@@ -0,0 +1,67 @@
+require 'middleman-core/util'
+
+class Middleman::ProtectEmailsExtension < ::Middleman::Extension
+
+  def initialize(app, options_hash={}, &block)
+    super
+  end
+
+  def after_configuration
+    app.use Middleware, middleman_app: app
+  end
+
+  class Middleware
+    def initialize(app, options = {})
+      @rack_app = app
+      @middleman_app = options[:middleman_app]
+    end
+
+    def call(env)
+      status, headers, response = @rack_app.call(env)
+
+      # Get path
+      path = ::Middleman::Util.full_path(env['PATH_INFO'], @middleman_app)
+
+      # Match only HTML documents
+      if path =~ /(^\/$)|(\.(htm|html)$)/
+        body = ::Middleman::Util.extract_response_text(response)
+        if body
+          status, headers, response = Rack::Response.new(rewrite_response(body), status, headers).finish
+        end
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    def rewrite_response(body)
+      # Keeps track of email replaces
+      replaced_email = false
+
+      # Replaces mailto links with ROT13 equivalent
+      # TODO: Don't replace plaintext mailto links
+      new_content = body.gsub /mailto:([A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4})/i do
+        replaced_email = true
+        email = $1.tr 'A-Za-z','N-ZA-Mn-za-m'
+        "#email-protection-#{email}"
+      end
+
+      # Don't do anything else if there are no emails on the page
+      return body unless replaced_email
+
+      # Reads decoding script
+      file = File.join(File.dirname(__FILE__), 'rot13_script.html')
+      script_content = File.read file
+
+      # Appends decoding script at end of body or end of page
+      if new_content =~ /<\/body>/i
+        new_content.gsub(/(<\/body>)/i) do
+          script_content + $1
+        end
+      else
+        new_content + script_content
+      end
+    end
+  end
+end

data/lib/middleman-protect-emails/rot13_script.html

@@ -0,0 +1 @@
+<script type="text/javascript">!function(){try{var a,b,c,d,g=document.getElementsByTagName("a");for(c=0;g.length-c;c++)try{b=g[c].getAttribute("href"),b&&b.indexOf("#email-protection-")>-1&&b.length>19&&(a="",d=19+b.indexOf("#email-protection-"),b.length>d&&(a=b.substr(18).replace(/[a-zA-Z]/g,function(a){return String.fromCharCode(("Z">=a?90:122)>=(a=a.charCodeAt(0)+13)?a:a-26)})),g[c].setAttribute("href","mailto:"+a))}catch(h){}}catch(h){}}();</script>

data/lib/middleman-protect-emails/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module ProtectEmails
+    VERSION = '0.1.0'
+  end
+end

data/lib/middleman-protect-emails.rb

@@ -0,0 +1,7 @@
+require 'middleman-core'
+require 'middleman-protect-emails/version'
+
+::Middleman::Extensions.register(:protect_emails) do
+  require 'middleman-protect-emails/extension'
+  ::Middleman::ProtectEmailsExtension
+end

data/middleman-protect-emails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-protect-emails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-protect-emails'
+  spec.version       = Middleman::ProtectEmails::VERSION
+  spec.authors       = ['Ankit Sardesai']
+  spec.email         = ['amsardesai@gmail.com']
+  spec.summary       = %q{Middleman extension for email link protection and obfuscation}
+  spec.description   = %q{Middleman extension for email link protection and obfuscation.}
+  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'middleman-core', '~> 3.2'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: middleman-protect-emails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ankit Sardesai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Middleman extension for email link protection and obfuscation.
+email:
+- amsardesai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/extension.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/source/index.html
+- fixtures/test-app/source/with_body.html
+- fixtures/test-app/source/with_multiple_emails.html
+- fixtures/test-app/source/with_no_email.html
+- lib/middleman-protect-emails.rb
+- lib/middleman-protect-emails/extension.rb
+- lib/middleman-protect-emails/rot13_script.html
+- lib/middleman-protect-emails/version.rb
+- middleman-protect-emails.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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Middleman extension for email link protection and obfuscation
+test_files:
+- features/extension.feature
+- features/support/env.rb