bypass 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDBiMzE5MzA3NjVlMDg2MjE4NDdiMzM1MmIwNjg4N2RhNjcwODRiNQ==
+  data.tar.gz: !binary |-
+    OWJlMGQyMjliODRmOGM3YTExZjk5NmIwZThiMmI3ZTgyNDhiYTU2OQ==
+SHA512:
+  metadata.gz: !binary |-
+    OGY3NTZmMzc1ZGRhYzhlZWU2NWJlZDY2OWFmZWQ4YTJmZTkyNjZiZjY1ZWY3
+    OWE3NmFlOWJmYzJhMTg5ZWU4MjVhNTE4ZmE5YWM1OWMzMjU3M2FiNThmMzE2
+    Nzc1OGUzNDc4MWUxODI3YzA4NjVhOTE1NjFhYzM5ZjEwYjJhMWU=
+  data.tar.gz: !binary |-
+    M2Y0MTVkZTA1ZmI1YjFkNTNiOGI1NTg5YjM3YWQ2MmZmNDBkNDI1YTIyNjA2
+    MDlmNTFmNGJhOGM3ZjU4YzUyOWIwYTcxOGM1YzM2MWI1ZmI2NWY3MDUyOTky
+    M2M1ZWY4ZmI3OGMyOGY4OWMzN2Q4NzcxY2M1MDUwMjM2ZTA4MWU=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-2.1.1
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+  - ree

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+end
+
+# Specify your gem's dependencies in bypass.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derrick Reimer
+
+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,80 @@
+# Bypass
+
+[![Build Status](https://travis-ci.org/djreimer/bypass.png?branch=master)](https://travis-ci.org/djreimer/bypass)
+[![Code Climate](https://codeclimate.com/github/djreimer/bypass.png)](https://codeclimate.com/github/djreimer/bypass)
+
+Bypass is a Ruby gem that scans plain text or HTML documents for URLs and
+hyperlinks and allows you to mutate or replace them with ease. This library
+was originally designed for appending tracking data and shortening link
+URLs in HTML and plain text emails.
+
+Extracted from [Drip](http://www.getdrip.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bypass'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bypass
+
+## Usage
+
+There are URL filters available for both plain text and HTML documents. 
+
+### Plain Text
+
+To replace all URLs in a plain text document:
+
+```ruby
+text = "Visit our website: http://www.getdrip.com"
+filter = Bypass::TextFilter.new(text)
+
+filter.replace do |url|
+  url.append_to_query_values(:id => 123)
+end
+
+filter.content
+#=> "Visit our website: http://www.getdrip.com?id=123"
+```
+
+### HTML
+
+To replace all `href` attributes in `a` tags in an HTML document:
+
+```ruby
+text = "Visit our website: <a href='http://www.getdrip.com'>Drip</a>"
+filter = Bypass::HTMLFilter.new(text)
+
+filter.replace do |url|
+  url.append_to_query_values(:id => 123)
+end
+
+filter.content
+#=> "Visit our website: <a href='http://www.getdrip.com?id=123'>Drip</a>"
+```
+
+To convert all non-hyperlinked URLs to hyperlinks:
+
+```ruby
+text = "Lets auto link this: http://www.google.com"
+filter = Bypass::HTMLFilter.new(text)
+filter.auto_link
+
+filter.content
+#=> "Lets auto link this: <a href='http://www.google.com'>http://www.google.com</a>"
+```
+
+## 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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/bypass.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bypass/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bypass"
+  gem.version       = Bypass::VERSION
+  gem.authors       = ["Derrick Reimer"]
+  gem.email         = ["derrickreimer@gmail.com"]
+  gem.description   = %q{Mutate URLs and hyperlinks in HTML and plain text documents with ease}
+  gem.summary       = %q{Mutate URLs and hyperlinks in HTML and plain text documents with ease}
+  gem.homepage      = "https://github.com/djreimer/bypass"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency "nokogiri", "~> 1.5"
+  gem.add_dependency "addressable", "~> 2.0"
+  gem.add_development_dependency "shoulda-context", "~> 1.0"
+  gem.add_development_dependency "mocha"
+end

data/lib/bypass/filter.rb

@@ -0,0 +1,29 @@
+module Bypass
+  class Filter
+    attr_reader :content
+    
+    URL_PATTERN = /\bhttps?:\/\/
+      [a-zA-Z0-9\-\._~:\/\?#\[\]@!$&'\(\)\*\+,;=%]+
+      [a-zA-Z0-9\-_~:\/\?#\[\]@!$&\*\+;=%]/x
+    
+    def initialize(content)
+      @content = content.to_s
+    end
+
+    def replace
+      raise NotImplementedError
+    end
+    
+    def to_s
+      content
+    end
+  
+  private
+  
+    def gsub_urls(text, &block)
+      text.gsub(URL_PATTERN) do |match|
+        yield(match.to_s)
+      end
+    end
+  end
+end

data/lib/bypass/html_filter.rb

@@ -0,0 +1,54 @@
+require "nokogiri"
+
+module Bypass
+  class HTMLFilter < Filter
+
+    def replace(&block)
+      parsed_content.traverse do |node|
+        if node.name == "a" && href = node.get_attribute("href")
+          url = yield(Bypass::URI.parse(href))
+          node.set_attribute("href", url.to_s)
+        end
+      end
+    end
+
+    def auto_link(options = {})
+      each_text_node do |node|
+        text = gsub_urls(node.text.to_s) do |url| 
+          build_anchor_tag(url, url, options)
+        end
+        node.replace(parse_html_fragment(text))
+      end
+    end
+
+    def build_anchor_tag(text, href, options = {})
+      attributes = []
+      options.each { |k, v| attributes << " #{k}=\"#{v}\"" }
+      "<a href=\"#{href}\"#{attributes.join(' ')}>#{text}</a>"
+    end
+
+    def content
+      parsed_content.to_s
+    end
+
+  private
+
+    def each_text_node(&block)
+      parsed_content.traverse do |node|
+        if node.name == "text"
+          unless node.path.split("/").include?("a")
+            yield(node)
+          end
+        end
+      end
+    end
+
+    def parsed_content
+      @parsed_content ||= parse_html_fragment(@content)
+    end
+
+    def parse_html_fragment(html)
+      Nokogiri::HTML::DocumentFragment.parse(html)
+    end
+  end
+end

data/lib/bypass/text_filter.rb

@@ -0,0 +1,12 @@
+module Bypass
+  class TextFilter < Filter
+
+    def replace(&block)
+      @content = gsub_urls(content) do |url| 
+        yield(Bypass::URI.parse(url)).to_s
+      end
+    end
+
+    def auto_link(options = {}); end
+  end
+end

data/lib/bypass/uri.rb

@@ -0,0 +1,9 @@
+require "addressable/uri"
+
+module Bypass
+  class URI < Addressable::URI
+    def append_to_query_values(params = {})
+      self.query_values = (query_values || {}).merge(params)
+    end
+  end
+end

data/lib/bypass/version.rb

@@ -0,0 +1,3 @@
+module Bypass
+  VERSION = "0.0.2"
+end

data/lib/bypass.rb

@@ -0,0 +1,8 @@
+require "bypass/version"
+require "bypass/uri"
+require "bypass/filter"
+require "bypass/html_filter"
+require "bypass/text_filter"
+
+module Bypass
+end

data/test/detour/filter_test.rb

@@ -0,0 +1,11 @@
+require 'addressable/uri'
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Bypass::FilterTest < Test::Unit::TestCase
+  context "#to_s" do
+    should "return content" do
+      filter = Bypass::Filter.new("foo")
+      assert_equal "foo", filter.to_s
+    end
+  end
+end

data/test/detour/html_filter_test.rb

@@ -0,0 +1,58 @@
+require 'addressable/uri'
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Bypass::HTMLFilterTest < Test::Unit::TestCase
+  context "#replace" do
+    should "replace hrefs" do
+      text = "<a href=\"http://yahoo.com\">Yahoo</a>"
+      filter = Bypass::HTMLFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "<a href=\"foo\">Yahoo</a>", filter.content
+    end
+
+    should "handle cases when there is no href attribute" do
+      text = "<a>Yahoo</a>"
+      filter = Bypass::HTMLFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "<a>Yahoo</a>", filter.content
+    end
+  end
+
+  context "#auto_link" do
+    should "convert plain URLs into links" do
+      text = "Hello http://www.google.com."
+      filter = Bypass::HTMLFilter.new(text)
+      filter.auto_link
+      assert_equal "Hello <a href=\"http://www.google.com\">http://www.google.com</a>.", filter.content
+    end
+
+    should "not replace urls inside a-tags" do      
+      text = "<a href=\"http://yahoo.com\">http://yahoo.com</a>"
+      filter = Bypass::HTMLFilter.new(text)
+      filter.auto_link
+      assert_equal text, filter.content
+    end
+  end
+
+  context "#build_anchor_tag" do
+    should "use the right text and href" do
+      filter = Bypass::HTMLFilter.new("")
+      tag = "<a href=\"http://www.google.com\">Google</a>"
+      assert_equal tag, filter.build_anchor_tag("Google", "http://www.google.com")
+    end
+    
+    should "include additional attributes" do
+      filter = Bypass::HTMLFilter.new("")
+      tag = "<a href=\"http://www.google.com\" class=\"button\">Google</a>"
+      assert_equal tag, filter.build_anchor_tag("Google", "http://www.google.com", :class => "button")
+    end
+  end
+
+  context "#content" do
+    should "cast parsed content to string" do
+      filter = Bypass::HTMLFilter.new("")
+      filter.expects(:parsed_content).returns(stub(:to_s => "bar"))
+      assert_equal "bar", filter.content
+    end
+  end
+end

data/test/detour/text_filter_test.rb

@@ -0,0 +1,34 @@
+require 'addressable/uri'
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Bypass::TextFilterTest < Test::Unit::TestCase
+  context "#replace" do
+    should "replace URLs" do
+      text = "http://yahoo.com"
+      filter = Bypass::TextFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "foo", filter.content
+    end
+
+    should "not include trailing periods in urls" do
+      text = "http://yahoo.com."
+      filter = Bypass::TextFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "foo.", filter.content
+    end
+    
+    should "not include parenthesis in urls" do
+      text = "(http://yahoo.com)"
+      filter = Bypass::TextFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "(foo)", filter.content
+    end
+    
+    should "not include trailing commas in urls" do
+      text = "http://yahoo.com,"
+      filter = Bypass::TextFilter.new(text)
+      filter.replace { "foo" }
+      assert_equal "foo,", filter.content
+    end
+  end
+end

data/test/detour/uri_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Bypass::URITest < Test::Unit::TestCase
+  context "#append_to_query_values" do
+    should "add values to the query string if it starts empty" do
+      uri = Bypass::URI.parse("http://www.getdrip.com")
+      uri.append_to_query_values(:foo => "bar")
+      assert_equal "http://www.getdrip.com?foo=bar", uri.to_s
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require "bypass"
+require "minitest/autorun"
+require "shoulda-context"
+require "mocha/setup"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: bypass
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Derrick Reimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Mutate URLs and hyperlinks in HTML and plain text documents with ease
+email:
+- derrickreimer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bypass.gemspec
+- lib/bypass.rb
+- lib/bypass/filter.rb
+- lib/bypass/html_filter.rb
+- lib/bypass/text_filter.rb
+- lib/bypass/uri.rb
+- lib/bypass/version.rb
+- test/detour/filter_test.rb
+- test/detour/html_filter_test.rb
+- test/detour/text_filter_test.rb
+- test/detour/uri_test.rb
+- test/test_helper.rb
+homepage: https://github.com/djreimer/bypass
+licenses: []
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Mutate URLs and hyperlinks in HTML and plain text documents with ease
+test_files:
+- test/detour/filter_test.rb
+- test/detour/html_filter_test.rb
+- test/detour/text_filter_test.rb
+- test/detour/uri_test.rb
+- test/test_helper.rb