hidemyass 0.1.4 → 0.2.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/README.md

@@ -20,45 +20,40 @@ Or install it yourself as:
 
 ## Usage
 
-    @uri = URI('http://www.iana.org/domains/example/')
-    @request = Net::HTTP::Get.new(@uri.request_uri)
-    @request['Referer'] = @uri.host
-    
-    response = HideMyAss::HTTP.start(@uri.host, @uri.port) do |http|
-      http.request(@request)
-    end
-    
-    response
-    => #<Net::HTTPOK 200 OK readbody=true>
-    
-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.options[:max_concurrency] = 3
+    response = HideMyAss.get("www.google.com", timeout: 2)
+    => #<Typhoeus::Response @options={:return_code=>:ok ...>
+
+`HideMyAss::Request.get` will try successive proxies until one returns an HTTP
+code (between 200 and 300).
+
+If you want more control, 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|
-        http.request(@request)
-      end
-      if response.class.ancestors.include?(Net::HTTPRedirection)
-        # ...
+      request = Typhoeus::Request.post(base_url, options)
+      request.on_complete do |response|
+
+        if # some success condition...
+          @response = response
+          HideMyAss.hydra.abort
+        end
       end
     end
-    
-To try connecting through local machine before trying proxies:
 
-    HideMyAss.options[:local] = true
-    HideMyAss::HTTP.start ...
-    
+    @response # holds successful response
+
 To clear the cached proxies on every request (disabled by default):
 
     HideMyAss.options[:clear_cache] = true
-    
+
 or simply run:
 
     HideMyAss.clear_cache
-    
+
 ## Roadmap
 
-* Get proxies from all pages
+* Hijack HTTP requests automatically
+* Get proxies form other page numbers (currently first 50 results only)
 * Improve tests suite
 * Clean code and refactor
 

data/hidemyass.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/hidemyass/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -16,5 +15,6 @@ Gem::Specification.new do |gem|
   gem.version       = HideMyAss::VERSION
 
   gem.add_dependency "nokogiri", "~> 1.5.6"
+  gem.add_dependency "typhoeus", "~> 0.6.1"
   gem.add_development_dependency "rspec", "~> 2.13.0"
 end

data/lib/hidemyass.rb

@@ -1,48 +1,55 @@
-require 'open-uri'
-require 'net/http'
 require 'nokogiri'
+require 'typhoeus'
 
 require 'hidemyass/version'
-require 'hidemyass/ip'
-require 'hidemyass/http'
 require 'hidemyass/logger'
+require 'hidemyass/ip'
+require 'hidemyass/request'
 require 'hidemyass/railtie' if defined?(Rails)
 
 module HideMyAss
+  extend self
   extend Logger
+  extend Request::Actions
 
   SITE     = "http://hidemyass.com".freeze
   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
+  LOG_PREFIX = "** [hidemyass]"
+
+  def options
     @options ||= {
       :log   => true,
       :local => false,
-      :clear_cache => false
+      :clear_cache => false,
+      :max_concurrency => 10
     }
   end
 
+  # Hydra will handle how many requests you can
+  # make in parallel.
+  #
+  # Typhoeus built-in limit is 200,
+  # but this depends heavily on your implementation.
+  # If you want to return as soon as you get a successful response,
+  # you should set a much, much lower limit, e.g. 10
+  def hydra
+    @hydra ||= begin
+      opts = if options[:max_concurrency]
+        { :max_concurrency => options[:max_concurrency] }
+      end
+
+      Typhoeus::Hydra.new(opts || {})
+    end
+  end
+
   # Clears cached proxies.
-  def self.clear_cache
+  def clear_cache
     @proxies = nil
   end
 
   # Returns HMA proxies.
-  def self.proxies
+  def proxies
     clear_cache if options[:clear_cache]
 
     @proxies ||= begin
@@ -55,16 +62,16 @@ module HideMyAss
           host: ip.address,
           port: node.at_xpath('td[3]').content.strip
         }
-      end
+      end.compact
     end
   end
 
   # Sets form data to support custom searches.
-  def self.form_data=(data)
+  def form_data=(data)
     @form_data = data if data
   end
 
-  # Set form data for HMA search
+  # Form data for HMA search
   #
   # c[]  - Countries
   # p    - Port. Defaults to all ports.
@@ -78,17 +85,17 @@ module HideMyAss
   # sortBy - Sort by. Defaults to date.
   #
   # Returns form data hash.
-  def self.form_data
+  def form_data
     @form_data ||= {
-      "c[]"  => ["Brazil", "Mexico", "United States"],
-      "p"    => nil,
-      "pr[]" => [0,1],
-      "a[]"  => [0,1,2,3],
-      "sp[]" => [2,3],
-      "ct[]" => [2,3],
-      "s"    => 0,
-      "o"    => 0,
-      "pp"   => 2,
+      "c"  => ["Brazil", "Mexico", "United States"],
+      "p"  => nil,
+      "pr" => [0],
+      "a"  => [0,1,2,3],
+      "sp" => [2,3],
+      "ct" => [2,3],
+      "s"  => 0,
+      "o"  => 0,
+      "pp" => 2,
       "sortBy" => "date"
     }
   end
@@ -96,18 +103,10 @@ module HideMyAss
   private
 
   # 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
-      res.body
-    when Net::HTTPRedirection then
-      Net::HTTP.get_response(URI(SITE + res['location'])).body
-    else
-      res.value
-    end
+  def get_hma_body
+    res = Typhoeus.post(ENDPOINT, body: form_data,
+      followlocation: true)
 
-    return Nokogiri::HTML(body)
+    return Nokogiri::HTML(res.body)
   end
 end

data/lib/hidemyass/ip.rb

@@ -1,14 +1,12 @@
-# HideMyAss masks real IPs with CSS classes
-# in order to prevent crawlers from grabbing them.
+# http://hidemyass.com masks the IP addresses
+# with decoy CSS classes and styles so it's hard to read them.
 #
-# Here we emulate what our browser does
-# so we can get the real IP addresses.
-
+# Let's emulate what our browser does in order to get the real address.
 module HideMyAss
   class IP
-    attr_accessor :decoys, :address
 
-    VALID_TAGS = %w(span div text).freeze
+    attr_accessor :decoys, :address
+    TAGS = %w(span div text).freeze
 
     def initialize(encoded_address)
       # Select decoy CSS classes: those which result in a hidden element
@@ -19,7 +17,7 @@ module HideMyAss
       elements = encoded_address.children
 
       # Process elements and get rid of those with decoy classes
-      decode(elements)
+      elements = decode(elements)
 
       # Finally grab enclosing elements content, which is the real IP
       @address = elements.map(&:content).join
@@ -27,15 +25,23 @@ module HideMyAss
     end
 
     # Receives an array of elements
-    # and removes those that are invisible.
+    # and returns another without invisibles.
     def decode(elements)
       elements.each do |element|
-        if !VALID_TAGS.include?(element.name) || (element["style"] && element["style"] =~ /none/)
+
+        # Remove elements with CSS style "none"
+        if !TAGS.include?(element.name) || (element["style"] && element["style"] =~ /none/)
           element.children.remove
+
+        # Get rid of decoy children
         elsif element["class"]
-          decoys.each { |decoy| element.children.remove if decoy.include?(element["class"]) }
+          decoys.each do |decoy|
+            element.children.remove if decoy.include?(element["class"])
+          end
         end
       end
+
+      elements
     end
 
     # Make sure the IP has a valid format.

data/lib/hidemyass/logger.rb

@@ -2,11 +2,12 @@ require 'logger'
 
 module HideMyAss
   module Logger
+
     def log(message)
       logger.info("#{LOG_PREFIX} #{message}") if logging?
     end
 
-    def logger #:nodoc:
+    def logger
       @logger ||= options[:logger] || ::Logger.new(STDOUT)
     end
 
@@ -14,8 +15,9 @@ module HideMyAss
       @logger = logger
     end
 
-    def logging? #:nodoc:
+    def logging?
       options[:log]
     end
-  end
-end
+
+  end # Logger
+end # HideMyAss

data/lib/hidemyass/railtie.rb

@@ -2,9 +2,10 @@ require 'hidemyass'
 
 module HideMyAss
   class Railtie < Rails::Railtie
+
     initializer "hidemyass.configure_rails_initialization" do
       HideMyAss.options[:logger] = Rails.logger if defined?(Rails)
       HideMyAss.options[:logger] = ActiveRecord::Base.logger if defined?(ActiveRecord)
     end
-  end
-end
+  end # Railtie
+end # HideMyAss

data/lib/hidemyass/request.rb

@@ -0,0 +1,26 @@
+require 'hidemyass/request/actions'
+require 'hidemyass/request/operations'
+
+module HideMyAss
+
+  # TODO: Hijack HTTP calls automatically
+  class Request
+    extend  Request::Actions
+    include Request::Operations
+
+    # Returns the provided base url.
+    attr_accessor :base_url
+
+    # Returns options, which includes default parameters.
+    attr_accessor :options
+
+    # Returns the response.
+    attr_accessor :response
+
+    def initialize(base_url, options = {})
+      self.base_url = base_url
+      self.options  = options
+      self.response = nil
+    end
+  end # Request
+end # HideMyAss

data/lib/hidemyass/request/actions.rb

@@ -0,0 +1,53 @@
+# TODO: Hijack HTTP calls automatically
+
+module HideMyAss
+
+  # Pass request messages to Typhoeus.
+  class Request
+    module Actions
+
+      # Make a get request.
+      #
+      # Example:
+      # HideMyAss.get("www.example.com")
+      #
+      # @options (See https://github.com/typhoeus/typhoeus)
+      #
+      # Returns Typhoeus::Response instance.
+      def get(base_url, options = {})
+        Request.new(base_url, options.merge!(:method => :get)).run
+      end
+
+      # Make a post request.
+      #
+      # Example:
+      # HideMyAss.post("www.example.com")
+      #
+      # Returns Typhoeus::Response instance.
+      def post(base_url, options = {})
+        Request.new(base_url, options.merge!(:method => :post)).run
+      end
+
+      # Make a put request.
+      #
+      # Example:
+      # HideMyAss.put("www.example.com/posts/1")
+      #
+      # Returns Typhoeus::Response instance.
+      def put(base_url, options = {})
+        Request.new(base_url, options.merge!(:method => :put)).run
+      end
+
+      # Make a delete request.
+      #
+      # Example:
+      # HideMyAss.delete("www.example.com/posts/1")
+      #
+      # Returns Typhoeus::Response instance.
+      def delete(base_url, options = {})
+        Request.new(base_url, options.merge!(:method => :delete)).run
+      end
+
+    end # Actions
+  end # Request
+end # HideMyAss

data/lib/hidemyass/request/operations.rb

@@ -0,0 +1,42 @@
+module HideMyAss
+  class Request
+
+    module Operations
+
+      # Run a request through the proxies.
+      # Returns on successful http response.
+      #
+      # Example:
+      # HideMyAss.get("www.google.com")
+      #
+      # Returns Typhoeus::Response instance
+      def run
+        HideMyAss.log "Connecting to #{base_url} through:"
+
+        HideMyAss.proxies.each do |proxy|
+          options[:proxy] = "http://#{proxy[:host]}:#{proxy[:port]}"
+
+          # Pass request to Typhoeus
+          request = Typhoeus::Request.new(base_url, options)
+          request.on_complete do |response|
+            HideMyAss.log "#{request.options[:proxy]} : #{response.code}"
+
+            # Return on successful http code
+            if (200..300).member?(response.code)
+              @response = response and HideMyAss.hydra.abort
+            end
+          end
+
+          # Queue parallel requests
+          HideMyAss.hydra.queue(request)
+        end
+
+        HideMyAss.hydra.run
+
+        # Return response saved on successful completion.
+        @response
+      end
+
+    end # Operations
+  end # Request
+end # HideMyAss

data/lib/hidemyass/version.rb

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

data/spec/lib/{ip_spec.rb → hidemyass/ip_spec.rb}

@@ -1,13 +1,13 @@
 require "spec_helper"
 
 describe HideMyAss::IP do
-  
+
   # Tipically we would use webmock here to fake the http request,
   # but hidemyass.com seems to be changing their encoding strategy often.
   # By having real data we ensure this gem is working.
   it "decodes encoded address" do
-    html = HideMyAss.get_hma_body
-    
+    html = HideMyAss.send(:get_hma_body)
+
     HideMyAss::IP.new(html.at_xpath('//table[@id="listtable"]/tr/td[2]/span'))
       .should be_valid
   end

data/spec/lib/hidemyass/request_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe HideMyAss::Request do
+
+  let(:url)     { "127.0.0.1" }
+  let(:res)     { stub(on_complete: nil).as_null_object }
+  let(:hydra)   { stub.as_null_object }
+  let(:proxies) { [{host: "1.2.3.4", port: "80"}] }
+  let(:proxy)   { "http://#{proxies[0][:host]}:#{proxies[0][:port]}" }
+
+  before do
+    HideMyAss.stub(:hydra).and_return(hydra)
+    HideMyAss.stub(:proxies).and_return(proxies)
+  end
+
+  [:get, :post, :put, :delete].each do |http_method|
+    describe ".#{http_method}" do
+      it "passes :#{http_method} message to typhoeus" do
+        Typhoeus::Request.should_receive(:new).
+          with(url, { :method => http_method }.merge(proxy: proxy)).
+          and_return(res)
+
+        HideMyAss.send(http_method, url)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,19 +1,9 @@
 require "hidemyass"
+HideMyAss.options[:log] = false
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hidemyass
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,12 +75,15 @@ files:
 - Rakefile
 - hidemyass.gemspec
 - lib/hidemyass.rb
-- lib/hidemyass/http.rb
 - lib/hidemyass/ip.rb
 - lib/hidemyass/logger.rb
 - lib/hidemyass/railtie.rb
+- lib/hidemyass/request.rb
+- lib/hidemyass/request/actions.rb
+- lib/hidemyass/request/operations.rb
 - lib/hidemyass/version.rb
-- spec/lib/ip_spec.rb
+- spec/lib/hidemyass/ip_spec.rb
+- spec/lib/hidemyass/request_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jassa/hidemyass
 licenses: []
@@ -92,5 +111,6 @@ specification_version: 3
 summary: Hide My Ass! lets you connect anonymously, fetch proxies from hidemyass.com
   and try each one until a successful connection is made.
 test_files:
-- spec/lib/ip_spec.rb
+- spec/lib/hidemyass/ip_spec.rb
+- spec/lib/hidemyass/request_spec.rb
 - spec/spec_helper.rb

data/lib/hidemyass/http.rb

@@ -1,44 +0,0 @@
-# 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
-        rescue *HTTP_ERRORS => error
-          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)
-
-          HideMyAss.log response.class.to_s
-
-          if response.class.ancestors.include?(Net::HTTPSuccess)
-            return response
-          end
-        rescue *HTTP_ERRORS => error
-          HideMyAss.log error
-        end
-      end
-
-      response
-    end
-  end
-end