proxy_tester 0.0.1

data/lib/proxy_tester/locales/en-rails.yml

@@ -0,0 +1,205 @@
+en:
+  date:
+    abbr_day_names:
+    - Sun
+    - Mon
+    - Tue
+    - Wed
+    - Thu
+    - Fri
+    - Sat
+    abbr_month_names:
+    -
+    - Jan
+    - Feb
+    - Mar
+    - Apr
+    - May
+    - Jun
+    - Jul
+    - Aug
+    - Sep
+    - Oct
+    - Nov
+    - Dec
+    day_names:
+    - Sunday
+    - Monday
+    - Tuesday
+    - Wednesday
+    - Thursday
+    - Friday
+    - Saturday
+    formats:
+      default: ! '%d-%m-%Y'
+      long: ! '%d %B, %Y'
+      short: ! '%d %b'
+    month_names:
+    -
+    - January
+    - February
+    - March
+    - April
+    - May
+    - June
+    - July
+    - August
+    - September
+    - October
+    - November
+    - December
+    order:
+    - :day
+    - :month
+    - :year
+  datetime:
+    distance_in_words:
+      about_x_hours:
+        one: about 1 hour
+        other: about %{count} hours
+      about_x_months:
+        one: about 1 month
+        other: about %{count} months
+      about_x_years:
+        one: about 1 year
+        other: about %{count} years
+      almost_x_years:
+        one: almost 1 year
+        other: almost %{count} years
+      half_a_minute: half a minute
+      less_than_x_minutes:
+        one: less than a minute
+        other: less than %{count} minutes
+      less_than_x_seconds:
+        one: less than 1 second
+        other: less than %{count} seconds
+      over_x_years:
+        one: over 1 year
+        other: over %{count} years
+      x_days:
+        one: 1 day
+        other: ! '%{count} days'
+      x_minutes:
+        one: 1 minute
+        other: ! '%{count} minutes'
+      x_months:
+        one: 1 month
+        other: ! '%{count} months'
+      x_seconds:
+        one: 1 second
+        other: ! '%{count} seconds'
+    prompts:
+      day: Day
+      hour: Hour
+      minute: Minute
+      month: Month
+      second: Seconds
+      year: Year
+  errors: &errors
+    format: ! '%{attribute} %{message}'
+    messages:
+      accepted: must be accepted
+      blank: can't be blank
+      confirmation: doesn't match confirmation
+      empty: can't be empty
+      equal_to: must be equal to %{count}
+      even: must be even
+      exclusion: is reserved
+      greater_than: must be greater than %{count}
+      greater_than_or_equal_to: must be greater than or equal to %{count}
+      inclusion: is not included in the list
+      invalid: is invalid
+      less_than: must be less than %{count}
+      less_than_or_equal_to: must be less than or equal to %{count}
+      not_a_number: is not a number
+      not_an_integer: must be an integer
+      odd: must be odd
+      record_invalid: ! 'Validation failed: %{errors}'
+      taken: has already been taken
+      too_long:
+        one: is too long (maximum is 1 character)
+        other: is too long (maximum is %{count} characters)
+      too_short:
+        one: is too short (minimum is 1 character)
+        other: is too short (minimum is %{count} characters)
+      wrong_length:
+        one: is the wrong length (should be 1 character)
+        other: is the wrong length (should be %{count} characters)
+    template:
+      body: ! 'There were problems with the following fields:'
+      header:
+        one: 1 error prohibited this %{model} from being saved
+        other: ! '%{count} errors prohibited this %{model} from being saved'
+  helpers:
+    select:
+      prompt: Please select
+    submit:
+      create: Create %{model}
+      submit: Save %{model}
+      update: Update %{model}
+  number:
+    currency:
+      format:
+        delimiter: ! ','
+        format: ! '%u%n'
+        precision: 2
+        separator: .
+        significant: false
+        strip_insignificant_zeros: false
+        unit: £
+    format:
+      delimiter: ! ','
+      precision: 3
+      separator: .
+      significant: false
+      strip_insignificant_zeros: false
+    human:
+      decimal_units:
+        format: ! '%n %u'
+        units:
+          billion: Billion
+          million: Million
+          quadrillion: Quadrillion
+          thousand: Thousand
+          trillion: Trillion
+          unit: ''
+      format:
+        delimiter: ''
+        precision: 3
+        significant: true
+        strip_insignificant_zeros: true
+      storage_units:
+        format: ! '%n %u'
+        units:
+          byte:
+            one: Byte
+            other: Bytes
+          gb: GB
+          kb: KB
+          mb: MB
+          tb: TB
+    percentage:
+      format:
+        delimiter: ''
+    precision:
+      format:
+        delimiter: ''
+  support:
+    array:
+      last_word_connector: ! ', and '
+      two_words_connector: ! ' and '
+      words_connector: ! ', '
+  time:
+    am: am
+    formats:
+      default: ! '%a, %d %b %Y %H:%M:%S %z'
+      long: ! '%d %B, %Y %H:%M'
+      short: ! '%d %b %H:%M'
+    pm: pm
+  # remove these aliases after 'activemodel' and 'activerecord' namespaces are removed from Rails repository
+  activemodel:
+    errors:
+      <<: *errors
+  activerecord:
+    errors:
+      <<: *errors

data/lib/proxy_tester/locales/en.yml

@@ -0,0 +1,42 @@
+---
+en:
+  errors:
+    default: 
+      summary: Unexpected Error...
+      details: Sorry, but I cannot fullfill your request. An unexpected error occured. Please ask your administrator for support.
+    internal_error: 
+      summary: Internal error...
+      details: 'Sorry, but I cannot fullfill your request. An internal error occured: "%{message}". Please notify the author of the software about the problem.'
+    user_error: 
+      summary: User Error...
+      details: Sorry, but I cannot fullfill your request. An error occured. There should be a better error message displayed here. Please notify the author of the software about the problem.
+    unreadable_config_file: 
+      summary: Unreadable config file...
+      details: 'Sorry, but I cannot fullfill your request. The config file "%{file}" given could not be read: "%{message}".'
+    invalid_proxy_user:
+      summary: Invalid proxy user...
+      details: 'Sorry, but you told me to use the user "#{user}" in your specs which does not exist in the user database. Please fix that and run the specs again.'
+    invalid_user_record:
+      summary: Invalid user record...
+      details: 'Sorry, but you told me to create a user resource from an invalid user record: "#{message}". Please fix that and run the specs again.'
+    unreadable_user_file:
+      summary: User file not found...
+      details: 'Sorry, but I cannot fullfill your request. I cannot find the user file "%{file}". Please fix that and run the specs again.'
+    request_timeout:
+      summary: Request timed out...
+      details: 'Sorry, but an error happend. A request timeout. Maybe the proxy or the web server is not reachable.'
+    invalid_synatx:
+      summary: Invalid syntax...
+      details: 'Sorry, but an error happend. The syntax used by you is invalid: %{message}.'
+    not_found_pac_file:
+      summary: Pac file not found...
+      details: 'Sorry, but I cannot fullfill your request. The pac file "%{file}" cannot be found.'
+    invalid_pac_result: 
+      summary: Invalid result from pac file...
+      details: 'Sorry, but I cannot fullfill your request. The result "%{result}" of proxy.pac "%{file}" is invalid. Please fix the proxy.pac and try again.'
+    invalid_proxy_type: 
+      summary: Invalid proxy type...
+      details: 'Sorry, but I cannot fullfill your request. You provided an invalid proxy type "%{type}". Allowed values are ":none", ":http" or ":socks5".'
+  views:
+    application:
+      title: Proxy Tester

data/lib/proxy_tester/main.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+module ProxyTester; 
+  @environment = ProxyTester::Environment.new
+  @config      = ProxyTester::Config.new
+  @ui_logger   = ProxyTester::UiLogger.new
+  @session     = ProxyTester::DatabaseSession.new
+
+  class << self
+    attr_accessor :session, :environment, :config, :ui_logger
+
+    def root_path
+      ::File.expand_path('../../..', __FILE__)
+    end
+
+    def enable_debug_mode
+      ProxyTester.ui_logger.info "Activating debug mode."
+
+      require 'pry'
+      require 'debugger'
+    rescue LoadError
+      ProxyTester.ui_logger.error "You tried to enable debug-mode, but either 'pry'- or 'debugger'-gem are not installed. Please fix that before using the debug-switch again."
+    end
+
+    def configure_i18n
+      I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+      I18n.load_path = Dir[::File.join(ProxyTester.root_path, 'lib', 'proxy_tester', 'locales', '*.yml')]
+      I18n.backend.load_translations
+      I18n.enforce_available_locales = true
+    end
+
+    def load_user_database
+      User.load_from(UserDatabase.new)
+    end
+
+    def clear_environment
+      %w{
+      http_proxy
+      https_proxy
+      HTTP_PROXY
+      HTTPS_PROXY
+      }.each { |var| ENV.delete(var) }
+    end
+  end
+end
+
+ProxyTester.configure_i18n

data/lib/proxy_tester/models/user.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module ProxyTester
+  class User < ActiveRecord::Base
+    #crypt_keeper :password, :encryptor => :aes, :key => ProxyTester.environment.password, salt: 'salt'
+
+    validates :name, presence: true
+    validates :password, presence: true
+
+    def self.load_from(source)
+      source.create_users(self)
+    end
+
+    def to_string
+      sprintf '%s:%s', name, password
+    end
+  end
+end

data/lib/proxy_tester/pac_result.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module ProxyTester
+  class PacResult
+
+    attr_reader  :proxy, :proxy_port, :request_type
+
+    def initialize(verbatim_content = nil)
+
+      if verbatim_content.blank?
+        parsed_content = {}
+      else
+        parsed_content = parse(verbatim_content) || {}
+      end
+
+      @proxy         = parsed_content[:proxy]
+      @proxy_port    = parsed_content[:proxy_port]
+      @request_type  = parsed_content[:request_type]
+    end
+
+    private
+
+    def parse(string)
+      regex.match(string)
+    end
+
+    def regex
+      %r{
+      \A
+      "?
+      (?<request_type>
+       [A-Z]+
+      )
+      (?:
+       \s+
+       (?<proxy>
+        [0-9]{1,3}(:?\.[0-9]{1,3}){3} || 
+        [[:alnum:]]+(?:\.[[:alnum:]]+)*\.?
+       )
+       (?:
+        :
+        (?<proxy_port>[0-9]+)
+       )?
+      )?
+      ;?
+       "?
+       \Z
+       }x
+    end
+  end
+end

data/lib/proxy_tester/rspec/helper.rb

@@ -0,0 +1,211 @@
+# encoding: utf-8
+module ProxyTester
+  module SpecHelper
+    module Capybara
+      include ::Capybara::DSL
+
+      @__runtime = Time.now.strftime('%Y-%m-%d_%H:%M:%S')
+
+      class << self
+        def runtime
+          @__runtime
+        end
+      end
+
+      def proxy
+        @__proxy
+      end
+
+      def proxy_pac
+        @__proxy_pac
+      end
+
+      def keep_report_directories
+        @__keep_report_directories ||= 5
+      end
+
+      def cleanup_reports
+        old_report_directories.each { |d| FileUtils.rm_rf d }
+      end
+
+      def take_screenshot
+        page.save_screenshot(screenshot_path, full: true)
+
+        screenshot_path
+      end
+
+      def view_screenshot
+        show_image(take_screenshot)
+      end
+      alias_method :show_screenshot, :view_screenshot
+
+      def use_user_agent(agent)
+        page.driver.headers = { "User-Agent" => agent } 
+      end
+
+      def visit(url)
+        @__proxy     ||= ProxyTester::CapybaraProxy.new
+        @__proxy_pac ||= ProxyTester::CapybaraProxyPac.new
+
+        proxy_pac.url = url
+
+        if !proxy_pac.blank? and !proxy_pac.direct?
+          proxy.host = proxy_pac.host
+          proxy.port = proxy_pac.port
+        end
+
+        register_driver proxy
+        use_driver proxy
+        use_user_agent 'Mozilla/5.0 (X11; Linux x86_64; rv:27.0) Gecko/20100101 Firefox/27.0'
+
+        begin
+          super(url)
+        rescue ::Capybara::Poltergeist::TimeoutError
+          raise ProxyTester::Exceptions::FetchUrlTimeout
+        end
+
+      end
+
+      def use_user(name)
+        @__proxy ||= ProxyTester::CapybaraProxy.new
+        proxy.user = ProxyTester::User.find_by!(name: name)
+
+      rescue ActiveRecord::RecordNotFound
+        ProxyTester.ui_logger.fatal "User \"#{name}\" could not be found. Please make use he's in the user database. Exiting."
+        raise ProxyTester::Exceptions::ProxyUserInvalid, user: name
+      end
+
+      def use_client_ip(ip)
+        @__proxy_pac ||= ProxyTester::CapybaraProxyPac.new
+
+        proxy_pac.client_ip = ip
+      end
+
+      def use_time(time)
+        @__proxy_pac ||= ProxyTester::CapybaraProxyPac.new
+
+        proxy_pac.time = time
+      end
+
+      def use_proxy(*args)
+        @__proxy     ||= ProxyTester::CapybaraProxy.new
+        @__proxy_pac ||= ProxyTester::CapybaraProxyPac.new
+
+        if args.first.kind_of? Symbol
+          case args.first
+          when :host
+            proxy.host, proxy.port = args.second.split(/:/)
+          when :pac
+            proxy_pac.pac_file = args.second
+          else
+            fail ProxyTester::Exceptions::SyntaxInvalid, message: "Unknown symbol: #{args.first}"
+          end
+        else
+          proxy.host, proxy.port = args.first.split(/:/)
+        end
+
+        proxy.type = args.last[:type] if args.last.kind_of? Hash
+      end
+
+      def use_timeout(threshold, &block)
+        old_timeout = ::Capybara.default_wait_time
+        ::Capybara.default_wait_time = threshold
+
+        block.call
+      ensure
+        ::Capybara.default_wait_time = old_timeout
+      end
+
+      private
+
+      def use_driver(proxy)
+        ::Capybara.current_driver = proxy.to_sym
+      end
+
+      def register_driver(local_proxy)
+        if local_proxy.blank?
+          options = {
+            js_errors: false,
+            phantomjs_logger: $stderr,
+          }
+        else 
+          options = {
+            phantomjs_options: local_proxy.as_phantomjs_arguments,
+            js_errors: false,
+            phantomjs_logger: $stderr,
+          }
+        end
+
+        ProxyTester.ui_logger.debug('options: ' + options.to_s)
+
+        ::Capybara.register_driver local_proxy.to_sym do |app|
+          ::Capybara::Poltergeist::Driver.new(app, options)
+        end
+
+        ::Capybara.run_server        = false
+      end
+
+      def screenshot_directory
+        if @__screenshot_dir.blank?
+          @__screenshot_dir = File.join(ProxyTester.config.reports_directory, ProxyTester::SpecHelper::Capybara.runtime)
+          FileUtils.mkdir_p @__screenshot_dir
+        end
+
+        @__screenshot_dir
+      end
+
+      def screenshot_path
+        return @__screenshot_path if @__screenshot_path
+
+        @__screenshot_path = File.join(screenshot_directory, "#{example.full_description.parameterize}.png")
+      end
+
+      def old_report_directories
+        Dir.glob(File.join(ProxyTester.config.reports_directory, '*')).keep_if { |d| FileTest.directory? d }.sort.reverse.drop(keep_report_directories)
+      end
+
+      def operating_system
+        case RUBY_PLATFORM.downcase
+        when /win32/
+          :win32
+        when /linux/
+          :linux
+        when /darwin/
+          :darwin
+        else
+          :unknown
+        end
+      end
+
+      def show_image(image)
+        viewer = case operating_system
+                 when :linux
+                   'xdg-open'
+                 when :win32
+                   'start'
+                 when :darwin
+                   'open'
+                 else
+                   'xdg-open'
+                 end
+
+        system("#{viewer} #{image.shellescape}")
+      end
+
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include ProxyTester::SpecHelper::Capybara
+
+  c.before :each do
+    @__proxy = ProxyTester::CapybaraProxy.new
+  end
+
+  c.before :all do
+    cleanup_reports
+  end
+end
+
+Capybara.default_driver = :poltergeist

data/lib/proxy_tester/rspec_runner.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'rspec'
+
+module ProxyTester
+  class RspecRunner
+    private 
+
+    attr_reader :test_cases_directory
+
+    public
+
+    def initialize(options = {})
+      @test_cases_directory = options.fetch(:test_cases_directory, ProxyTester.config.test_cases_directory)
+    end
+
+    def run(tags)
+      ProxyTester.load_user_database
+      ProxyTester.clear_environment
+
+      RSpec.configure do |c|
+        c.color = true
+        c.add_formatter 'Fuubar'
+        c.filter_run_including to_filter(tags) unless tags.blank?
+      end
+
+      $LOAD_PATH << test_cases_directory
+      RSpec::Core::Runner.run(spec_files)
+    end
+
+    private
+
+    def to_filter(a)
+      Hash[*a.collect { |e| e.to_sym }.zip([true] * a.size).flatten]
+    end
+
+    def spec_files
+      files = ::Dir.glob(::File.join(test_cases_directory, '**', '*_spec.rb'))
+      ProxyTester.ui_logger.warn "No spec files found at \"#{test_cases_directory}\"." if files.blank?
+
+      files
+    end
+  end
+end

data/lib/proxy_tester/template_file.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module ProxyTester
+  class TemplateFile
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = ::File.expand_path(path)
+    end
+
+    def name
+      ::File.basename(path, '.*').to_sym
+    end
+
+    def read
+      ::File.read(path)
+    end
+  end
+end

data/lib/proxy_tester/template_repository.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module ProxyTester
+  class TemplateRepository
+    private
+
+    attr_reader :root_directory, :creator
+
+    public
+
+    def initialize(root_directory = ::File.expand_path('../../../files', __FILE__), creator = TemplateFile)
+      @root_directory = ::File.expand_path(root_directory)
+      @creator        = creator
+    end
+
+    def find(name)
+      path = ::File.join(root_directory, "#{name.to_s}.erb")
+      fail Exceptions::ErbTemplateIsUnknown, "Template \"#{name}\" could not be found!" unless ::File.exist? path
+
+      creator.new(path)
+    end
+  end
+end

data/lib/proxy_tester/ui_logger.rb

@@ -0,0 +1,30 @@
+module ProxyTester
+  class UiLogger
+    def initialize
+      @logger = ::Logger.new($stderr)
+    end
+
+    def level=(l)
+      @logger.level = case l.to_s.to_sym
+                      when :unknown
+                        ::Logger::UNKNOWN
+                      when :fatal
+                        ::Logger::FATAL
+                      when :error
+                        ::Logger::ERROR
+                      when :warn
+                        ::Logger::WARN
+                      when :info
+                        ::Logger::INFO
+                      when :debug
+                        ::Logger::DEBUG
+                      else
+                        ::Logger::ERROR
+                      end
+    end
+
+    def method_missing(method, *args, &block)
+      @logger.public_send method, *args
+    end
+  end
+end