roadie 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4f6223eab7dab406f618cdc4de6561112c38883
-  data.tar.gz: 2ecab891c4958a775437dae141628055982591ff
+  metadata.gz: 5824c94736e27c2a19d255fe99c7083ad42772b7
+  data.tar.gz: 0c8a41f35860a127e707f6fa115bb15399dbed8d
 SHA512:
-  metadata.gz: 7c04785fd8b911957558447ca928e7001e6602ee2e98a659124b8173b7238f5e4f9ff7ee9dea71b1dade51720e007a44d142310989d5996db63845ec4316dbad
-  data.tar.gz: 2e4e7ac1b09251ec08f1af1024b6614ea6c3663752066241063d8827faebc8782752abc6e51f140b047edcea62b9877e49520193e809b020563a20a96101aeb6
+  metadata.gz: 031ee1cede388f42a4bfbb05ecddcfaf7d42867e28f9e1f08e5645a6fc24efe5dc0a113553ceb6c987eb844ff1fc53e2814eb656ad9ea03709f68662d4f8dc2a
+  data.tar.gz: 290f00e6c0be0773af92d676ec8e7fa4524ecdad17c688ed5fbddc5afd88a7425779cf589f51822270ebc9f6936cf20f417fc2ff79b0aa0b625db63297959488

data/Changelog.md

@@ -1,9 +1,16 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v3.0.3...master)
+[full changelog](https://github.com/Mange/roadie/compare/v3.0.4...master)
 
 * Nothing yet.
 
+### 3.0.4
+
+[full changelog](https://github.com/Mange/roadie/compare/v3.0.3...v3.0.4)
+
+* Bug fixes:
+  * Schemeless URLs was accepted as-is, which isn't supported in a lot of email clients. (#104)
+
 ### 3.0.3
 
 [full changelog](https://github.com/Mange/roadie/compare/v3.0.2...v3.0.3)

data/README.md

@@ -253,6 +253,14 @@ This project follows [Semantic Versioning](http://semver.org/) and has been sinc
 FAQ
 ---
 
+### Why is my markup changed in subtle ways?
+
+Roadie uses Nokogiri to parse and regenerate the HTML of your email, which means that some unintentional changes might show up.
+
+One example would be that Nokogiri might remove your ` `s in some cases.
+
+Another example is Nokogiri's lack of HTML5 support, so certain new element might have spaces removed. I recommend you don't use HTML5 in emails anyway because of bad email client support (that includes web mail!).
+
 ### I'm getting segmentation faults (or other C-like problems)! What should I do? ###
 
 Roadie uses Nokogiri to parse the HTML of your email, so any C-like problems like segfaults are likely in that end. The best way to fix this is to first upgrade libxml2 on your system and then reinstall Nokogiri.

data/lib/roadie/url_generator.rb

@@ -26,6 +26,7 @@ module Roadie
       validate_options url_options
 
       @url_options = url_options
+      @scheme = normalize_scheme(url_options[:scheme] || url_options[:protocol])
       @root_uri = build_root_uri
     end
 
@@ -55,21 +56,25 @@ module Roadie
     # @return [String] an absolute URL
     def generate_url(path, base = "/")
       return root_uri.to_s if path.nil? or path.empty?
+      return add_scheme(path) if path_is_schemeless?(path)
       return path if path_is_absolute?(path)
 
       combine_segments(root_uri, base, path).to_s
     end
 
     private
-    attr_reader :root_uri
+    attr_reader :root_uri, :scheme
 
     def build_root_uri
       path = make_absolute url_options[:path]
       port = parse_port url_options[:port]
-      scheme = normalize_scheme(url_options[:scheme] || url_options[:protocol])
       URI::Generic.build(scheme: scheme, host: url_options[:host], port: port, path: path)
     end
 
+    def add_scheme(path)
+      [scheme, path].join(":")
+    end
+
     def combine_segments(root, base, path)
       new_path = apply_base(base, path)
       if root.path
@@ -104,12 +109,18 @@ module Roadie
       end
     end
 
+    def path_is_schemeless?(path)
+      path =~ %r{^//\w}
+    end
+
     def path_is_absolute?(path)
       # Ruby's URI is pretty unforgiving, but roadie aims to be. Don't involve
       # URI for URLs that's easy to determine to be absolute.
-      # URLs starting with a scheme (http:, data:) are absolute, as is URLs
-      # start start with double slashes (//css/app.css).
-      path =~ %r{^(\w+:|//)} || !parse_path(path).relative?
+      # URLs starting with a scheme (http:, data:) are absolute.
+      #
+      # URLs that start with double slashes (//css/app.css) are also absolute
+      # in modern browsers, but most email clients do not understand them it.
+      path =~ %r{^\w+:} || !parse_path(path).relative?
     end
 
     def parse_path(path)

data/lib/roadie/version.rb

@@ -1,3 +1,3 @@
 module Roadie
-  VERSION = '3.0.3'
+  VERSION = '3.0.4'
 end

data/spec/lib/roadie/url_generator_spec.rb

@@ -92,10 +92,6 @@ module Roadie
         expect(url(data_uri, host: "example.com")).to eq(data_uri)
       end
 
-      it "does not touch absolute URLs without schemes" do
-        expect(url("//assets.myapp.com/foo.jpg", host: "example.com")).to eq("//assets.myapp.com/foo.jpg")
-      end
-
       it "does not touch custom schemes" do
         expect(url("myapp://", host: "example.com")).to eq("myapp://")
       end
@@ -106,6 +102,30 @@ module Roadie
         # markers.
         expect(url("https://foo.com/%|MARKETING_TOKEN|%", host: "example.com")).to eq("https://foo.com/%|MARKETING_TOKEN|%")
       end
+
+      # A lot of email clients do not support schemeless URLs (it's a HTML5
+      # feature) so we should add a scheme to them.
+      context "on schemeless urls" do
+        # Checking for host matches would be too complex, and it's not too hard
+        # to assume that schemeless URLs to assets comes from a shared
+        # configuration with a web page which uses HTTP and HTTPS in different
+        # cases. That also means that we'd like to match the assets URLs with
+        # whatever we want to link to, most likely.
+        it "adds given scheme, even when host does not match" do
+          result = url("//assets.myapp.com/foo.jpg", host: "example.com", scheme: "https")
+          expect(result).to eq("https://assets.myapp.com/foo.jpg")
+        end
+
+        it "adds standard http: scheme when no scheme given" do
+          result = url("//assets.myapp.com/foo.jpg", host: "example.com")
+          expect(result).to eq("http://assets.myapp.com/foo.jpg")
+        end
+
+        it "adds scheme to invalid URLs" do
+          result = url("//foo.com/%|TOKEN|%", scheme: "ftp", host: "example.com")
+          expect(result).to eq("ftp://foo.com/%|TOKEN|%")
+        end
+      end
     end
 
     # URLs in resources that are not based inside the root requires that we may

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roadie
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Magnus Bergmark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri