hidemyass 0.1.3 → 0.1.4

data/README.md

@@ -31,8 +31,8 @@ Or install it yourself as:
     response
     => #<Net::HTTPOK 200 OK readbody=true>
     
-This method defaults to return on HTTPSuccess (2xx)
-If you want more control to follow redirections or whatever, you can retrieve the proxies list and connect manually
+This method will try successive proxies until one returns HTTPSuccess (2xx).
+If you want more control (e.g. to follow redirections), you can retrieve the proxies list and connect manually
 
     HideMyAss.proxies.each do |proxy|
       response = Net::HTTP::Proxy(proxy[:host], proxy[:port]).start(@uri.host, @uri.port) do |http|
@@ -58,15 +58,14 @@ or simply run:
     
 ## Roadmap
 
-* Improve the quality of returned proxies: currently I'm using the custom search url, but it seems to expire every n-days
-* Get proxies from other pages
+* Get proxies from all pages
 * Improve tests suite
 * Clean code and refactor
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b my-new-feature`), and make sure to include specs
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/hidemyass.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "hidemyass"
   gem.require_paths = ["lib"]
   gem.version       = HideMyAss::VERSION
-  
-  gem.add_dependency "nokogiri", "~> 1.5.5"
-  gem.add_development_dependency "rspec", "~> 2.12.0"
+
+  gem.add_dependency "nokogiri", "~> 1.5.6"
+  gem.add_development_dependency "rspec", "~> 2.13.0"
 end

data/lib/hidemyass.rb

@@ -15,53 +15,74 @@ module HideMyAss
   ENDPOINT = "http://hidemyass.com/proxy-list/".freeze
 
   LOG_PREFIX = '** [hidemyass] '
-  
-  HTTP_ERRORS = [Timeout::Error,
-                 Errno::EINVAL,
-                 Errno::ECONNRESET,
-                 Errno::ECONNREFUSED,
-                 Errno::ETIMEDOUT,
-                 EOFError,
-                 Net::HTTPBadResponse,
-                 Net::HTTPHeaderSyntaxError,
-                 Net::ProtocolError]
-                 
-   def self.options
-     @options ||= {
-       :log => true,
-       :local => false,
-       :clear_cache => false
-     }
-   end
 
+  HTTP_ERRORS = [
+    Timeout::Error,
+    Errno::EINVAL,
+    Errno::ECONNRESET,
+    Errno::ECONNREFUSED,
+    Errno::ETIMEDOUT,
+    EOFError,
+    Net::HTTPBadResponse,
+    Net::HTTPHeaderSyntaxError,
+    Net::ProtocolError
+  ]
+
+  def self.options
+    @options ||= {
+      :log   => true,
+      :local => false,
+      :clear_cache => false
+    }
+  end
+
+  # Clears cached proxies.
+  def self.clear_cache
+    @proxies = nil
+  end
+
+  # Returns HMA proxies.
   def self.proxies
     clear_cache if options[:clear_cache]
 
-    unless @proxies
+    @proxies ||= begin
       html = get_hma_body
-    end
 
-    @proxies ||= html.xpath('//table[@id="listtable"]/tr').collect do |node|
-      ip = HideMyAss::IP.new(node.at_xpath('td[2]/span'))
-      next unless ip.valid?
-      { 
-        host: ip.address,
-        port: node.at_xpath('td[3]').content.strip
-      }
+      html.xpath('//table[@id="listtable"]/tr').collect do |node|
+        ip = HideMyAss::IP.new(node.at_xpath('td[2]/span'))
+        next unless ip.valid?
+        {
+          host: ip.address,
+          port: node.at_xpath('td[3]').content.strip
+        }
+      end
     end
   end
-  
-  def self.clear_cache
-    @proxies = nil
-  end
 
-  private
+  # Sets form data to support custom searches.
+  def self.form_data=(data)
+    @form_data = data if data
+  end
 
-  def self.get_hma_body
-    data = {
-      "c[]"  => ["United States"],
+  # Set form data for HMA search
+  #
+  # c[]  - Countries
+  # p    - Port. Defaults to all ports.
+  # pr[] - Protocol. 0..2 = HTTP, HTTPS, socks4/5
+  # a[]  - Anonymity level. 0..4 = None, Low, Medium, High, High +KA
+  # sp[] - Speed. 0..2 = Slow, Medium, Fast.
+  # ct[] - Connection time. 0..2 = Slow, Medium, Fast
+  # s    - Sort. 0..3 = Response time, Connection time, Country A-Z.
+  # o    - Order. 0, 1 = DESC, ASC.
+  # pp   - Per Page. 0..3 = 10, 25, 50, 100.
+  # sortBy - Sort by. Defaults to date.
+  #
+  # Returns form data hash.
+  def self.form_data
+    @form_data ||= {
+      "c[]"  => ["Brazil", "Mexico", "United States"],
       "p"    => nil,
-      "pr[]" => [0,1,2],
+      "pr[]" => [0,1],
       "a[]"  => [0,1,2,3],
       "sp[]" => [2,3],
       "ct[]" => [2,3],
@@ -70,8 +91,13 @@ module HideMyAss
       "pp"   => 2,
       "sortBy" => "date"
     }
+  end
+
+  private
 
-    res  = Net::HTTP.post_form(URI(ENDPOINT), data)
+  # Returns HMA body as a Nokogiri HTML Document.
+  def self.get_hma_body
+    res = Net::HTTP.post_form(URI(ENDPOINT), form_data)
 
     body = case res
     when Net::HTTPSuccess then

data/lib/hidemyass/http.rb

@@ -1,13 +1,19 @@
+# TODO: Hijack HTTP calls automatically
+
 module HideMyAss
   module HTTP
+
     def HTTP.start(address, *arg, &block)
       HideMyAss.log 'Connecting to ' + address + ' through:'
       response = nil
-  
+
       if HideMyAss.options[:local]
         begin
           HideMyAss.log 'localhost...'
           response = Net::HTTP.start(address, *arg, &block)
+
+          HideMyAss.log response.class.to_s
+
           if response.class.ancestors.include?(Net::HTTPSuccess)
             return response
           end
@@ -15,12 +21,15 @@ module HideMyAss
           HideMyAss.log error
         end
       end
-      
+
       HideMyAss.proxies.each do |proxy|
         begin
           HideMyAss.log proxy[:host] + ':' + proxy[:port]
-          response = Net::HTTP::Proxy(proxy[:host], proxy[:port]).start(address, *arg, &block)
+          response = Net::HTTP::Proxy(proxy[:host],
+            proxy[:port]).start(address, *arg, &block)
+
           HideMyAss.log response.class.to_s
+
           if response.class.ancestors.include?(Net::HTTPSuccess)
             return response
           end

data/lib/hidemyass/ip.rb

@@ -1,19 +1,33 @@
+# HideMyAss masks real IPs with CSS classes
+# in order to prevent crawlers from grabbing them.
+#
+# Here we emulate what our browser does
+# so we can get the real IP addresses.
+
 module HideMyAss
   class IP
-    
     attr_accessor :decoys, :address
-    
+
     VALID_TAGS = %w(span div text).freeze
-    
+
     def initialize(encoded_address)
-      @decoys  = encoded_address.css("style").text.split("\n").select {|style| style =~ /none/}
+      # Select decoy CSS classes: those which result in a hidden element
+      @decoys = encoded_address.css("style").text.split("\n").
+        select {|style| style =~ /none/}
+
+      # Find enclosing IP elements
       elements = encoded_address.children
+
+      # Process elements and get rid of those with decoy classes
       decode(elements)
+
+      # Finally grab enclosing elements content, which is the real IP
       @address = elements.map(&:content).join
-      
       self
     end
-    
+
+    # Receives an array of elements
+    # and removes those that are invisible.
     def decode(elements)
       elements.each do |element|
         if !VALID_TAGS.include?(element.name) || (element["style"] && element["style"] =~ /none/)
@@ -23,14 +37,15 @@ module HideMyAss
         end
       end
     end
-    
+
+    # Make sure the IP has a valid format.
     def valid?
       address.split(".").reject(&:empty?).size == 4
     end
-    
+
     def inspect
       "#<#{self.class}> @address=#{address}>"
     end
-    
+
   end # IP
 end # HideMyAss

data/lib/hidemyass/version.rb

@@ -1,3 +1,3 @@
 module HideMyAss
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hidemyass
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-30 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
 description: Hide My Ass! fetches and connects to proxies at www.hidemyass.com
 email:
 - javier@tractical.com