pretty_proxy 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5625b70ed64d26ac9a32bd89b38e28205625be
-  data.tar.gz: dc79eac8219b6ef787d25168f4f6e79fc0263ff6
+  metadata.gz: 718ffdcdc9a88b9103bfe1aa2e32cc32039a8b20
+  data.tar.gz: 4a5614d06ed052826da3f9eaac0e443b2ef82946
 SHA512:
-  metadata.gz: 3f24e47757aec9e3433c41568cf92d6855e9bee9886c7a5a382c8f4df5876cd2fe30f9cc399b0e4d831a380bb1ce90e7ce2a78e3a1a50a8619f21da37e59dc2d
-  data.tar.gz: 0717b822da160d1719051b2fca85d7981926a914acd0dd21e58696fe1dd879324bf470cb53f9c2bd96abf3bdc3b2703a0b07630434b563985ae110f50411bfbd
+  metadata.gz: 633d5ca4cb8cd20c745a17eefa402eb9328da09c06b13aeccecdf74dbfd6a16c3511f0e1d3dfae190687787f36508d4e089c69a061a46c69cf3e264c097b12b0
+  data.tar.gz: c00c15756541fdd878f1db00728752e48546acdf3107d21d5c0fc11fb3214856acc115788db9bff16d50ce5eaebcda77c90cf774d2eb2cfb5c4bd92062478c55

data/lib/pretty_proxy.rb

@@ -11,24 +11,23 @@ require 'rack-proxy'
 # the hyperlinks point to the proxy version of the page if it exist.
 #
 # @example A terrible example
-# require 'pretty_proxy'
+#   # You can run this example with 'rake heresy_example' in the gem folder
+#   # and see the result in localhost:9292/proxy/
+#   require 'pretty_proxy'
 #
-# class Heresy < PrettyProxy
-#   def sugared_rewrite_response(triplet, requested_to_proxy_env, rewritten_env)
-#     status, headers, page = triplet
-#     page = page.gsub(/(MTG )?Magic(: The Gathering)?/, 'Yu-Gi-Oh')
-#     [status, headers, page]
+#   class Heresy < PrettyProxy
+#     def sugared_rewrite_response(triplet, requested_to_proxy_env, rewritten_env)
+#       status, headers, page = triplet
+#       page = page.gsub(/(MTG )?Magic(: The Gathering)?/, 'Yu-Gi-Oh')
+#       [status, headers, page]
+#     end
 #   end
-# end
 #
-# run Heresy.new('/proxy/', 'http://magiccards.info', '/')
+#   run Heresy.new('/proxy/', 'http://magiccards.info', '/')
 #
-# You can see the result in http://localhost:9292/proxy/ (if you use the
-# command 'rake heresy_example' in the gem folder).
-#
-# @note: If you want to make a Rack app who use the proxy to point to
-#   another path of the same app you have to use a server in multithread
-#   mode, otherwise requests to the proxy will end in a deadlock.
+# If you want to make a Rack app who use the proxy to point to
+# another path of the same app you have to use a server in multithread
+# mode, otherwise requests to the proxy will end in a deadlock.
 # The proxy request the original page but the server don't respond because
 # is waiting the proxy request to be resolved. The proxy request don't end
 # because need the original page. A timeout error occur.
@@ -39,21 +38,19 @@ require 'rack-proxy'
 # support more than deflate and gzip; exception classes with more
 # than a message;
 #
-# Glossary:
-#   'a valid proxy url/path': The path (or the path of the url) start with
-#     the proxy_path and is followed by a original_path.
-#   'in(side)/out(side) the proxy control': The url have (or not) the path
-#     starting with a original_path and the scheme, port and host are the
-#     same of the original_domain.
-#
 # The exception classes (except Error) inherit Error, and Error inherit
 # ArgumentError. They are empty yet, only have a message.
 #
-#   @see PrettyProxy::Error
-#   @see PrettyProxy::ConfigError
-#   @see PrettyProxy::ProxyError
+# Glossary:
+#
+# 'a valid proxy url/path': The path (or the path of the url) start with
+# the proxy_path and is followed by a original_path.
+#
+# 'in(side)/out(side) the proxy control': The url have (or not) the path
+# starting with a original_path and the scheme, port and host are the
+# same of the original_domain.
 #
-# @author: Henrique Becker
+# @author Henrique Becker
 class PrettyProxy < Rack::Proxy
   # The supertype of any exceptions explicitly raised by the methods
   class Error < ArgumentError; end
@@ -94,15 +91,12 @@ class PrettyProxy < Rack::Proxy
     end
   end
 
-  # !@attribute proxy_path
-  #   @param a input who will be validated as in the initialize
-  #   @return the clone of the internal value
-  # !@attribute original_domain
-  #   @param a input who will be validated as in the initialize
-  #   @return the clone of the internal value
-  # !@attribute original_paths
-  #   @param a input who will be validated as in the initialize
-  #   @return the clone of the internal value
+  # @!attribute proxy_path
+  #   return the clone of the internal value
+  # @!attribute original_domain
+  #   return the clone of the internal value
+  # @!attribute original_paths
+  #   return the clone of the internal value
   [:proxy_path, :original_domain, :original_paths].each do | reader |
     define_method(reader) { instance_variable_get("@#{reader.to_s}").clone }
   end
@@ -123,8 +117,8 @@ class PrettyProxy < Rack::Proxy
   end
 
   # Take a proxy url and return the original URL behind the proxy. Preserve the
-  #   query and fragment, if any. For the rewrite of a request @see rewrite_env.
-  # @param [String, URI::HTTP, URI::HTTPS] A URL.
+  # query and fragment, if any. For the rewrite of a request @see rewrite_env.
+  # @param url [String, URI::HTTP, URI::HTTPS] A URL.
   # @return [URI::HTTP, URI::HTTPS] A URI object.
   # @raise PrettyProxy::ProxyError
   def unproxify_url(url)
@@ -151,10 +145,10 @@ class PrettyProxy < Rack::Proxy
   end
 
   # Take a hyperlink and the url of the proxy page (not the original page)
-  #   where it come from and return the rewritten hyperlink. If the page
-  #   pointed vy the hyperlink is in the proxy control the rewritten hyperlink
-  #   gonna point to the proxyfied version, otherwise gonna point to the original
-  #   version.
+  # where it come from and return the rewritten hyperlink. If the page
+  # pointed vy the hyperlink is in the proxy control the rewritten hyperlink
+  # gonna point to the proxyfied version, otherwise gonna point to the original
+  # version.
   # @param hyperlink [String, URI::HTTP, URI::HTTPS] A string with a relative
   #   path or an url (string or URI).
   # @param proxy_page_url [String, URI::HTTP, URI::HTTPS] The url from the
@@ -196,7 +190,7 @@ class PrettyProxy < Rack::Proxy
   end
 
   # Take a (X)HTML Document and apply proxify_hyperlink to the 'href'
-  #   attribute of each 'a' element.
+  # attribute of each 'a' element.
   # @param html [String] A (X)HTML document.
   # @param proxy_url [String, URI::HTTP, URI::HTTPS] The url where the
   #   the proxified version of the page will be displayed.
@@ -229,12 +223,12 @@ class PrettyProxy < Rack::Proxy
   end
 
   # Modify a Rack environment hash of a request to the proxy version of
-  #   a page to a request to the original page. As in Rack::proxy is used
-  #   by #call for require the original page before call rewrite_response in
-  #   the response. If you want to use your own rewrite rules maybe is more
-  #   wise to subclass Rack::Proxy instead subclass this class. The purpose
-  #   of this class is mainly implement and enforce these rules for you.
-  # @param html [Hash{String => String}] A Rack environment hash.
+  # a page to a request to the original page. As in Rack::proxy is used
+  # by #call for require the original page before call rewrite_response in
+  # the response. If you want to use your own rewrite rules maybe is more
+  # wise to subclass Rack::Proxy instead subclass this class. The purpose
+  # of this class is mainly implement and enforce these rules for you.
+  # @param env [Hash{String => String}] A Rack environment hash.
   #   (see: {http://rack.rubyforge.org/doc/SPEC.html})
   # @return [Hash{String => String}] A unproxified copy of the argument.
   # @raise PrettyProxy::ProxyError
@@ -269,20 +263,20 @@ class PrettyProxy < Rack::Proxy
   end
 
   # Mainly apply the proxify_html to the body of the response if it is a html.
-  #   Raise an error if the 'content-encoding' is other than deflate, gzip or
-  #   identity. Change the 'content-length' header for the new body bytesize.
-  #   Remove the 'transfer-encoding' if it is chunked, and act as not chunked.
-  #   This method is inherited of Rack::Proxy, but in the original it have only
-  #   the first parameter (the triplet). This version have the request Rack env
-  #   to the proxy and the rewritten Rack env as second and third parameters,
-  #   respectively.
+  # Raise an error if the 'content-encoding' is other than deflate, gzip or
+  # identity. Change the 'content-length' header for the new body bytesize.
+  # Remove the 'transfer-encoding' if it is chunked, and act as not chunked.
+  # This method is inherited of Rack::Proxy, but in the original it have only
+  # the first parameter (the triplet). This version have the request Rack env
+  # to the proxy and the rewritten Rack env as second and third parameters,
+  # respectively.
   # @param triplet [Array<(Integer, Hash{String => String}, #each)>] A Rack
   #   response (see {http://rack.rubyforge.org/doc/SPEC.html}) for the request
   #   to the original site.
-  # @param [Hash{String => String}] A Rack environment hash. The requested to
-  #   the proxy version.
-  # @param [Hash{String => String}] A Rack environment hash. The rewritten by
-  #   the proxy to point to the original version.
+  # @param requested_to_proxy_env [Hash{String => String}] A Rack environment
+  #   hash. The requested to the proxy version.
+  # @param rewritten_env [Hash{String => String}] A Rack environment hash.
+  #   The rewritten by the proxy to point to the original version.
   # @return [Array<(Integer, Hash{String => String}, #each)>] A unproxified
   #   copy of the first argument.
   # @raise PrettyProxy::ProxyError
@@ -336,27 +330,27 @@ class PrettyProxy < Rack::Proxy
 
   # @abstract This method is called only over (X)HTML responses, after they are
   #   decompressed and the hyperlinks proxified, before they are compressed
-  #   again and the new content-length calculated. The body of the triplet is
-  #   a String and not a object who respond to #each, the same has to be true
-  #   in the return. Return a modified clone of the response, don't change
-  #   the argument.
+  #   again and the new content-length calculated.
+  # @note The body of the triplet is a String and not a object who respond to #each,
+  #   the same has to be true in the return. Return a modified clone of the
+  #   response, don't change the argument.
   # @param triplet [Array<(Integer, Hash{String => String}, String)>] Not a
   #   valid Rack response, the third element is a string with the response body.
-  # @param [Hash{String => String}] A Rack environment hash. The requested to
-  #   the proxy version.
-  # @param [Hash{String => String}] A Rack environment hash. The rewritten by
-  #   the proxy to point to the original version.
+  # @param requested_to_proxy_env [Hash{String => String}] A Rack environment
+  #   hash. The requested to the proxy version.
+  # @param rewritten_env [Hash{String => String}] A Rack environment hash.
+  #   The rewritten by the proxy to point to the original version.
   # @return [Array<(Integer, Hash{String => String}, String)>] A unproxified
   #   copy of the first argument.
   def sugared_rewrite_response(triplet, requested_to_proxy_env, rewritten_env)
     triplet
   end
 
-  # Make this class a Rack app. Is overriden to repass to the rewrite_response
-  #   the original Rack environment (request to the proxy) and the rewritten env
-  #   (modified to point the original page request).
-  #   If you don't know the parameters and return of this method, please read
-  #   {http://rack.rubyforge.org/doc/SPEC.html}.
+  # Make this class a Rack app. It's overriden to repass to the rewrite_response
+  # the original Rack environment (request to the proxy) and the rewritten env
+  # (modified to point the original page request).
+  # If you don't know the parameters and return of this method, please read
+  # {http://rack.rubyforge.org/doc/SPEC.html}.
   def call(env)
     # in theory we only need to repass the rewritten_env, any original env info
     #  needed can be passed as a environment application variable
@@ -372,7 +366,7 @@ class PrettyProxy < Rack::Proxy
     Utils.same_domain?(@original_domain, uri)
   end
 
-  # Check if the URI::HTTP(S) is a page who can be accessed through the proxy
+  # Check if the URI::HTTP(S) is a page who can be accessed through the proxy.
   def inside_proxy_control?(uri)
     same_domain_as_original?(uri) &&
       valid_path_for_proxy?(@proxy_path + uri.path[1..-1])
@@ -402,7 +396,7 @@ class PrettyProxy < Rack::Proxy
   end
 
   # api private Don't use the methods of this class. They are for internal use only.
-  class Utils
+  module Utils
     def self.relative_path?(hyperlink)
       ! hyperlink.scheme
     end
@@ -414,6 +408,7 @@ class PrettyProxy < Rack::Proxy
     end
 
     def self.validate_proxy_path(proxy_path)
+      fail ConfigError, "proxy_path argument don't start with a '/'" unless proxy_path.start_with? '/'
       fail ConfigError, "proxy_path argument don't end with a '/'" unless proxy_path.end_with? '/'
       # NOTE: if the user want to proxify 'www.site.net', and not 'www.site.net/'?
       # Well, majority of the internet answers for this are 'the right way is to use the trailing slash'

data/spec/pretty_proxy_spec.rb

@@ -83,6 +83,10 @@ describe PrettyProxy do
 
     # TODO: Add specs for '/' in the start of the proxy_path
     let (:right_args) { correct_new_args_example }
+    context "when proxy_path doesn't start with a '/'" do
+      it { expect {new.call('proxy/', right_args[1], right_args[2])}.to raise_error(PrettyProxy::ConfigError) }
+    end
+
     context "when proxy_path doesn't end with a '/'" do
       it { expect {new.call('/proxy', right_args[1], right_args[2])}.to raise_error(PrettyProxy::ConfigError) }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Henrique Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -176,4 +176,4 @@ specification_version: 4
 summary: A Rack::Proxy child pretty url oriented
 test_files:
 - spec/pretty_proxy_spec.rb
-has_rdoc: 
+has_rdoc: true