pretty_proxy 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 718ffdcdc9a88b9103bfe1aa2e32cc32039a8b20
-  data.tar.gz: 4a5614d06ed052826da3f9eaac0e443b2ef82946
+  metadata.gz: 53c916eb8a133fba2863121b82f713be339870d9
+  data.tar.gz: 20203a8923d5fdf6a74a28f88fb9cd48ed29ec0a
 SHA512:
-  metadata.gz: 633d5ca4cb8cd20c745a17eefa402eb9328da09c06b13aeccecdf74dbfd6a16c3511f0e1d3dfae190687787f36508d4e089c69a061a46c69cf3e264c097b12b0
-  data.tar.gz: c00c15756541fdd878f1db00728752e48546acdf3107d21d5c0fc11fb3214856acc115788db9bff16d50ce5eaebcda77c90cf774d2eb2cfb5c4bd92062478c55
+  metadata.gz: 3df53ebf6c8ddcff87a78488ca2d21f862017d5916c6daa7aad70cf242bfe17238b431c538baca7586c51ed55d04d8edb8e491f153ec5042c38d2b380741ca7a
+  data.tar.gz: 9a5eb9afaa314dd26f3efa3e491431413aea0d1df5f08640f5e8a8e904992ba3560ccb312a7e5a2e8a6f791ab7e0f88d1179fa72e3c431cf01b84b444431fc6a

data/example/example_conf.json

@@ -23,7 +23,8 @@
     "  </div>",
     "  <div>",
     "    <a href=\"ORIGINAL_DOMAIN/PROXY_PATH/p1\" >and yet another link</a>",
-    "    <p><a href=\"../PROXY_PATH/p1\" >the last link</a></p>",
+    "    <p><a href=\"../PROXY_PATH/p1\" >almost there</a></p>",
+    "    <p><a href=\"/p1\" >the last link</a></p>",
     "  </div>",
     "</body>",
     "</html>"

data/lib/pretty_proxy.rb

@@ -84,10 +84,11 @@ class PrettyProxy < Rack::Proxy
 
     @proxy_path = proxy_path.clone
     @original_domain = URI(original_domain.clone)
+    @original_paths = Set.new 
     if original_paths.respond_to? :each
-      @original_paths = original_paths.clone
+      original_paths.each { | value | @original_paths << value.clone }
     else
-      @original_paths = [original_paths.clone]
+      @original_paths << original_paths.clone
     end
   end
 
@@ -96,7 +97,8 @@ class PrettyProxy < Rack::Proxy
   # @!attribute original_domain
   #   return the clone of the internal value
   # @!attribute original_paths
-  #   return the clone of the internal value
+  #   return the clone of the internal value (always a Set, no matter what is
+  #   passed to initialize).
   [:proxy_path, :original_domain, :original_paths].each do | reader |
     define_method(reader) { instance_variable_get("@#{reader.to_s}").clone }
   end
@@ -158,32 +160,33 @@ class PrettyProxy < Rack::Proxy
   def proxify_hyperlink(hyperlink, proxy_page_url)
     hyperlink = URI(hyperlink.clone)
     proxy_page_url = URI(proxy_page_url)
-    if Utils.relative_path? hyperlink
-      # recreate the original site url from the relative path
+    if hyperlink.scheme
+      if inside_proxy_control? hyperlink
+        unless point_to_a_proxy_page?(hyperlink, proxy_page_url)
+          hyperlink = proxify_uri(hyperlink, proxy_page_url)
+        end
+      end
+    else
+      # recreate the original site url from the relative/absolute path
       absolute_link = unproxify_url proxy_page_url
       absolute_link.path = Pathname.new(absolute_link.path).join(hyperlink.path).to_s
       if inside_proxy_control? absolute_link
-        if same_domain_as_original?(proxy_page_url) &&
-             valid_path_for_proxy?(absolute_link.path)
-          # in the case of a relative path in the original page who points
-          # to a proxy page, and the proxy page is inside the proxy control
-          # we have to use the absolute_link or the page will be double proxified
-          # example: ../proxy/content in http://example.com/proxy/content, with
-          # original_path as '/' is http://example.com/proxy/proxy/content
-          hyperlink = absolute_link
+        if Pathname.new(hyperlink.path).relative?
+          if same_domain_as_original?(proxy_page_url) &&
+               valid_path_for_proxy?(absolute_link.path)
+            # in the case of a relative path in the original page who points
+            # to a proxy page, and the proxy page is inside the proxy control
+            # we have to use the absolute_link or the page will be double proxified
+            # example: ../proxy/content in http://example.com/proxy/content, with
+            # original_path as '/' is http://example.com/proxy/proxy/content
+            hyperlink = absolute_link
+          end
+        else # is absolute
+          hyperlink.path = @proxy_path + hyperlink.path[1..-1]
         end
       else
         hyperlink = absolute_link
       end
-    else
-      if inside_proxy_control? hyperlink
-        unless point_to_a_proxy_page?(hyperlink, proxy_page_url)
-          hyperlink.scheme = proxy_page_url.scheme
-          hyperlink.host = proxy_page_url.host
-          hyperlink.port = proxy_page_url.port
-          hyperlink.path = @proxy_path + hyperlink.path[1..-1]
-        end
-      end
     end
 
     hyperlink.to_s
@@ -375,17 +378,19 @@ class PrettyProxy < Rack::Proxy
   # Check if the absolute path begin with a proxy_path and is followed by a
   # original_paths element.
   def valid_path_for_proxy?(absolute_path)
+    return false unless absolute_path.start_with?(@proxy_path)
+
     path_without_proxy_prefix = absolute_path[(@proxy_path.size-1)..-1]
-    # if we don't add the trailing slash '/about' and '/about_us' match
-    original_paths_with_trailing_slash = []
-    @original_paths.each do | path |
-      original_paths_with_trailing_slash << (path.end_with?('/') ? path : "#{path}/")
-    end
 
-    absolute_path.start_with?(@proxy_path) &&
-      original_paths_with_trailing_slash.any? do | original_path |
+    @original_paths.any? do | original_path |
+      # if we don't test this '/about' and '/about_us' will match
+      if original_path.end_with? '/'
         path_without_proxy_prefix.start_with? original_path
+      else
+        path_without_proxy_prefix == original_path ||
+          path_without_proxy_prefix.start_with?("#{original_path}/")
       end
+    end
   end
 
   # Take a url and the proxy domain (scheme, host and port) and return if
@@ -395,12 +400,21 @@ class PrettyProxy < Rack::Proxy
       valid_path_for_proxy?(hyperlink.path)
   end
 
+  # api private Don't use this method.
+  def proxify_uri(uri, proxy_domain)
+    uri = uri.clone
+
+    uri.scheme = proxy_domain.scheme
+    uri.host = proxy_domain.host
+    uri.port = proxy_domain.port
+    uri.path = @proxy_path + uri.path[1..-1]
+
+    uri
+  end
+  private :proxify_uri
+
   # api private Don't use the methods of this class. They are for internal use only.
   module Utils
-    def self.relative_path?(hyperlink)
-      ! hyperlink.scheme
-    end
-
     def self.same_domain?(u1, u2)
       u1.scheme == u2.scheme &&
         u1.host == u2.host &&

data/spec/pretty_proxy_spec.rb

@@ -39,7 +39,8 @@ describe PrettyProxy do
     </div>
 		<div>
       <a href="ARG_4" >and yet another link</a>
-      <p><a href="ARG_5" >the last link</a></p>
+      <p><a href="ARG_5" >almost there</a></p>
+      <p><a href="ARG_6" >the last link</a></p>
     </div>
 	</body>
 </html>
@@ -53,13 +54,14 @@ describe PrettyProxy do
                                                 'http://othersite.net',
                                                 '../p3', '../p2/p2_2/',
                                                 'http://site.net/proxy/p1',
-                                                '../proxy/p1']) }
+                                                '../proxy/p1', '/p1']) }
 
   let(:proxified_html) { generate_html_for_test(['http://site.net/proxy/p2/p2_2/',
                                                   'http://othersite.net',
                                                   'http://site.net/p3', '../p2/p2_2/',
                                                   'http://site.net/proxy/p1',
-                                                  'http://site.net/proxy/p1']) }
+                                                  'http://site.net/proxy/p1',
+                                                  '/proxy/p1']) }
 
   let (:correct_new_args_example) { ['/proxy/', 'http://myoriginalsite.com', '/content'] }
   let (:pp) { described_class.new(*correct_new_args_example) }
@@ -113,7 +115,7 @@ describe PrettyProxy do
     describe "##{reader_method.to_s}" do
       return_changers = { proxy_path: :chop!,
                           original_domain: ->(uri){ uri.host = 'otherdomain.com'},
-                          original_paths: :shift }
+                          original_paths: :clear }
 
       it_behaves_like 'an reader method who encapsulate a mutable variable' do
         let(:reader_method_name) { reader_method }
@@ -185,13 +187,16 @@ describe PrettyProxy do
   describe '#proxify_hyperlink' do
     let (:pp) { described_class.new('/proxy/', 'http://site.net', ['/p1', '/p2/p2_2/']) }
 
-    it "proxify absolute hyperlinks to inside the proxy control" do
+    it "proxify absolute paths to inside the proxy control" do
+      expect(pp.proxify_hyperlink('/p2/p2_2/', 'http://theproxy.net/proxy/p1')).to eq '/proxy/p2/p2_2/'
+    end
+    it "proxify hyperlinks with scheme to inside the proxy control" do
       expect(pp.proxify_hyperlink('http://site.net/p2/p2_2/', 'http://theproxy.net/proxy/p1')).to eq 'http://theproxy.net/proxy/p2/p2_2/'
     end
-    it "don't change absolute hyperlinks to ouside the proxy control" do
+    it "don't change hyperlinks with scheme to ouside the proxy control" do
       expect(pp.proxify_hyperlink('http://othersite.net', 'http://theproxy.net/proxy/p1')).to eq 'http://othersite.net'
     end
-    it 'change to absolute hyperlinks the relative paths to outside the proxy control' do
+    it 'change to urls the relative paths to outside the proxy control' do
       expect(pp.proxify_hyperlink('../p3', 'http://theproxy.net/proxy/p1')).to eq 'http://site.net/p3'
       expect(pp.proxify_hyperlink('../p2/p2_2', 'http://theproxy.net/proxy/p1')).to eq 'http://site.net/p2/p2_2' # without the trailing '/'
     end
@@ -202,11 +207,11 @@ describe PrettyProxy do
     context 'when the proxy itself is inside the proxy control' do
       let (:pp) { described_class.new('/proxy/', 'http://site.net', '/') }
       
-      it "dont't change absolute hyperlinks to the proxy itself" do
+      it "dont't change urls to the proxy itself" do
         expect(pp.proxify_hyperlink('http://site.net/proxy/p1', 'http://site.net/proxy/p1')).to eq 'http://site.net/proxy/p1'
         expect(pp.proxify_hyperlink('http://site.net/proxy/p1', 'http://site.net/proxy/p2/p2_2/')).to eq 'http://site.net/proxy/p1'
       end
-      it 'change to absolute hyperlinks the relative paths to the proxy itself' do
+      it 'change to urls the relative paths to the proxy itself' do
         expect(pp.proxify_hyperlink('../proxy/p1', 'http://site.net/proxy/p1')).to eq 'http://site.net/proxy/p1'
         expect(pp.proxify_hyperlink('../../proxy/p1', 'http://site.net/proxy/p2/p2_2/')).to eq 'http://site.net/proxy/p1'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pretty_proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Henrique Becker