proxy_tester 0.0.1

data/files/example-test_case.rb.erb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+# You can place files in "<%= lookup('example_directory') %>" and require them here.
+# 
+# File "file.rb" in "<%= lookup('example_directory') %>" becomes
+#
+# require 'examples/file'
+#
+# in your spec.
+#
+describe '<%= lookup('description') %>' do
+<% Array(lookup('proxies')).each do |p| -%>
+  context '<%= p[:host] %>:<%= p[:port] %>' do
+    before :each do
+      use_proxy host: '<%= p[:host] %>', port: <%= p[:port] %>
+    end
+
+<% Array(lookup('urls')).each do |url| -%>
+    it 'works with <%= url[:uri] %>' do
+      visit '<%= url[:uri] %>'
+      expect(page).to have_content('<%= url[:content] %>')
+    end
+
+<% end -%>
+  end
+
+<% end -%>
+end

data/files/example-test_cases-gemfile.rb.erb

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+<% Array(lookup('gems')).each do |l| -%>
+# *<%= l[:name] %>*
+# <%= l[:description] %>
+# Please see "<%= l[:url] %>" for further information
+gem '<%= l[:name] %>'<%- if l[:require] == false %>, require: false<% elsif l[:require] %>, require: '<%= l[:require] %>'<% end %>
+
+<% end -%>

data/files/example-user_file.erb

@@ -0,0 +1,4 @@
+"name","password","description"
+<% lookup('users').each do |u| -%>
+"<%= u[:name] %>","<%= u[:password] %>","<%= u[:description] %>"
+<% end -%>

data/lib/proxy_tester/actions/add_examples_to_test_cases_directory.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class AddExamplesToTestCasesDirectory
+      private
+
+      attr_reader :examples_directory, :options 
+
+      public
+
+      def initialize(examples_directory, options = {})
+        @examples_directory = examples_directory
+        @options            = options
+      end
+
+      def run
+        if need_to_run? || options[:force] == true
+          Actions::CreateDirectory.new(File.join(examples_directory, 'support'), force: options[:force]).run
+          Actions::CreateFile.new(:'example-test_case.rb', File.join(examples_directory, 'example_spec.rb'), test_case_data, force: options[:force], create_directories: true).run
+          Actions::CreateFile.new(:'example-test_cases-gemfile.rb', File.join(examples_directory, 'Gemfile'), test_spec_helper_data, force: options[:force], create_directories: true).run
+          Actions::CreateFile.new(:'example-spec_helper.rb', File.join(examples_directory, 'spec_helper.rb'), test_spec_helper_data, force: options[:force], create_directories: true).run
+        else
+          ProxyTester.ui_logger.warn "Directory with examples already exists at \"#{examples_directory}\" . Do not create it again!."
+        end
+      end
+
+      private
+
+      def test_spec_helper_data
+        Data.new(
+          OpenStruct.new(
+            libraries: [
+              { 
+                name: 'open-uri',
+                require: 'open-uri',
+                description: 'Easier use of urls in scripts',
+                url: 'http://www.ruby-doc.org/stdlib-2.1.1/libdoc/open-uri/rdoc/OpenURI.html',
+              },
+            ],
+            gems: [
+              { 
+                name: 'pry',
+                description: 'REPL shell with completion to make writing specs easier',
+                url: 'http://pryrepl.org/',
+              },
+              { 
+                name: 'pry-debugger',
+                description: 'Integration debugger into pry',
+                require: false,
+                url: 'https://github.com/nixme/pry-debugger',
+              },
+              { 
+                name: 'pry-doc',
+                description: 'Documentation for pry',
+                require: false,
+                url: 'http://pryrepl.org/',
+              },
+              { 
+                name: 'debugger',
+                description: 'The debugger for ruby. Please install the ruby gem "pry-debugger" for integration with pry.',
+                url: 'http://pryrepl.org/',
+              },
+              { 
+                name: 'debugger-completion',
+                require: 'debugger/completion',
+                description: 'Completion for debugger shell',
+                url: 'https://github.com/cldwalker/debugger-completion',
+              },
+              { 
+                name: 'nokogiri',
+                description: 'HTML parser to make writing tests easier.',
+                url: 'http://nokogiri.org/',
+              },
+              { 
+                name: 'excon',
+                description: 'HTTP library with proxy support',
+                url: 'https://github.com/geemus/excon',
+              },
+              { 
+                name: 'awesome_print',
+                require: 'ap',
+                description: 'Output data in repl shell',
+                url: 'https://github.com/michaeldv/awesome_print',
+              },
+            ],
+          )
+        )
+      end
+
+      def test_case_data
+        Data.new(
+          OpenStruct.new(
+            example_directory: examples_directory,
+            description: 'This is an example test case',
+            proxies: [
+              {
+                host: 'proxy.example.org',
+                port: 8080,
+              },
+              {
+                host: 'proxy2.example.org',
+                port: 3128,
+              },
+            ],
+            urls: [
+              {
+                uri: 'http://www.example.org',
+                content: 'Example Domain',
+              },
+              {
+                uri: 'http://www.example.net',
+                content: 'Example Domain',
+              }
+            ]
+          )
+        )
+
+      end
+
+      def need_to_run?
+        !::File.exists? examples_directory
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/clone_repository.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class CloneRepository
+      private
+
+      attr_reader :source, :destination, :options 
+
+      public
+
+      def initialize(source, destination, options = {})
+        @source               = ::File.expand_path(source)
+        @destination          = ::File.expand_path(destination)
+        @options            = options
+      end
+
+      def run
+        if need_to_run? || options[:force] == true
+          ProxyTester.ui_logger.warn "Cloning repository from \"#{source}\" to \"#{destination}\"."
+
+          if !need_to_run? && options[:force] == true
+            ProxyTester.ui_logger.warn "This action does not support \":force\"-flag. Please move away the destination repository yourself."
+            return 
+          end
+
+          GitRepository.clone(source, destination, bare: options.fetch(:bare, false))
+        else
+          ProxyTester.ui_logger.warn "Destination \"#{destination}\" already exists. Do not create it again!"
+        end
+      end
+
+      private
+
+      def need_to_run?
+        !::File.exists? destination
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/create_directory.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class CreateDirectory
+      private
+
+      attr_reader :fs_engine, :path, :options
+
+      public
+
+      def initialize(path, options = {}, fs_engine = FileUtils)
+        @path      =::File.expand_path(path)
+        @options   = options
+        @fs_engine = fs_engine
+      end
+
+      def run
+        if need_to_run? || options[:force] == true
+          ProxyTester.ui_logger.warn "Creating directory \"#{path}\"."
+          fs_engine.mkdir_p(path)
+        else
+          ProxyTester.ui_logger.warn "Directory \"#{path}\" already exists. Do not create it again!."
+        end
+      end
+
+      private
+
+      def need_to_run?
+        !::File.exists?(path)
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/create_file.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class CreateFile
+      private
+
+      attr_reader :name, :destination, :data, :options, :engine, :repository
+
+      public
+
+      def initialize(name, destination, data, options = {}, engine = ErbGenerator, repository = TemplateRepository.new)
+        @name        = name
+        @destination =::File.expand_path(destination)
+        @data        = data
+        @options     = options
+        @engine      = engine
+        @repository  = repository
+      end
+
+      def run
+        if need_to_run? || options[:force] == true
+          ProxyTester.ui_logger.warn "Creating file \"#{destination}\"."
+
+          create_directories if options[:create_directories] == true
+
+          file = template(name, ::File.new(destination, 'w'), data)
+          FileUtils.chmod('+x', file) if options[:executable] == true
+        else
+          ProxyTester.ui_logger.warn "File \"#{destination}\" already exists. Do not create it again!."
+        end
+      end
+
+      private
+
+      def create_directories
+        FileUtils.mkdir_p(::File.dirname(destination))
+      end
+
+      def template(local_name, local_destination, local_data)
+        template = repository.find(local_name)
+
+        generator = engine.new(local_data)
+        generator.compile(template, local_destination)
+
+        local_destination
+      rescue Errno::ENOENT
+        fail Exceptions::ErbTemplateIsUnknown, JSON.dump(message: "Unknown erb template \"#{template_path}\".")
+      end
+
+      def need_to_run?
+        !::File.exists?(destination)
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/create_output.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class CreateOutput
+      private
+
+      attr_reader :name, :output, :engine, :repository, :data
+
+      public
+
+      def initialize(name, output, data, engine = ErbGenerator, repository = TemplateRepository.new)
+        @name        = name
+        @output      = output
+        @data        = data
+        @engine      = engine
+        @repository  = repository
+      end
+
+      def run
+        ProxyTester.ui_logger.info "Creating example configuration:"
+        template(name, output, data)
+      end
+
+      private
+
+      def template(local_name, local_destination, local_data)
+        template = repository.find(local_name)
+
+        generator = engine.new(local_data)
+        generator.compile(template, local_destination)
+      rescue Errno::ENOENT
+        fail Exceptions::ErbTemplateIsUnknown, JSON.dump(message: "Unknown erb template \"#{template_path}\".")
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/handle_error.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class HandleError
+
+      private
+
+      attr_reader :exception, :original_message, :handler_klass
+
+      public
+
+      def initialize(exception, handler_klass = ErrorHandler)
+        @exception        = exception.class
+        @original_message = exception.message
+        @handler_klass    = handler_klass
+      end
+
+      def run
+        handler = handler_klass.find exception
+        handler.original_message = original_message
+
+        handler.execute(parsed_message)
+      end
+
+      private
+
+      def parsed_message
+        result = JSON.parse(original_message)
+        return {} unless result.kind_of? Hash
+
+        result
+      rescue JSON::ParserError
+        {}
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/initialize_application.rb

@@ -0,0 +1,70 @@
+module ProxyTester
+  module Actions
+    class InitializeApplication
+
+      private
+
+      attr_reader :config, :options
+
+      public
+
+      def initialize(options = {}, config = ProxyTester.config)
+        @options = options
+        @config  = config
+      end
+
+      def run
+        create_test_cases_directory if options[:create_test_cases_directory]
+        create_user_file if options[:create_user_file]
+        create_config_file if options[:create_config_file]
+
+        pre_seed if options[:pre_seed]
+
+        show_example_config
+      end
+
+      private
+
+      def create_test_cases_directory
+        ProxyTester.ui_logger.info "Creating test case directory : #{config.test_cases_directory}"
+        Actions::CreateDirectory.new(config.test_cases_directory, force: options[:force]).run
+      end
+
+      def create_config_file
+        ProxyTester.ui_logger.info "Creating config file at \"#{config.config_file}\"."
+        Actions::CreateFile.new(:'example-config', config.config_file, Data.new(config), force: options[:force], create_directories: true).run
+      end
+
+      def create_user_file
+        ProxyTester.ui_logger.info "Creating user file at \"#{config.user_file}\"."
+
+        data = OpenStruct.new(
+          users: [
+            {
+              name: 'user1',
+              password: 'password1',
+              description: 'description',
+            },
+            {
+              name: 'user2',
+              password: 'password2',
+              description: 'description',
+            },
+          ]
+        )
+
+        Actions::CreateFile.new(:'example-user_file', config.user_file, Data.new(data), force: options[:force], create_directories: true).run
+      end
+
+      def show_example_config
+        ProxyTester.ui_logger.info "Showing the configuration of proxy_tester on your system."
+        Actions::CreateOutput.new(:'example-config', $stdout, Data.new(config)).run
+      end
+
+      def pre_seed
+        ProxyTester.ui_logger.info "Adding examples to at #{config.examples_directory}"
+        Actions::AddExamplesToTestCasesDirectory.new(config.examples_directory, force: options[:force]).run
+      end
+    end
+  end
+end

data/lib/proxy_tester/actions/show_config.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module ProxyTester
+  module Actions
+    class ShowConfig
+      def run
+        puts ProxyTester.config
+      end
+    end
+  end
+end

data/lib/proxy_tester/capybara_proxy.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module ProxyTester
+  class CapybaraProxy
+
+    attr_accessor :host, :user
+    attr_reader :port, :type
+
+    def port=(value)
+      @port = value.to_i
+    end
+
+    def type=(value)
+      case value
+      when :none
+        @type = 'none'
+      when :socks5
+        @type = 'socks5'
+      when :http
+        @type = 'http'
+      else
+        raise Exceptions::ProxyTypeInvalid, JSON.dump(type: value)
+      end
+    end
+
+    def to_sym
+      return :no_proxy if host.blank? or port.blank?
+
+      "#{host}_#{port}".to_sym
+    end
+
+    def as_phantomjs_arguments
+      result = []
+      result << "--proxy=#{proxy_string}" if host || port
+      result << "--proxy-type=#{type}" if type
+      result << "--proxy-auth=#{user_string}" if user
+
+      result
+    end
+
+    def blank?
+      host.blank? and port.blank?
+    end
+
+    private
+
+    def proxy_string
+      "#{host}:#{port}".shellescape
+    end
+
+    def user_string
+      user.to_string.shellescape
+    end
+  end
+end

data/lib/proxy_tester/capybara_proxy_pac.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+module ProxyTester
+  class CapybaraProxyPac
+
+    attr_accessor :client_ip, :time, :pac_file, :url, :resul
+
+    def host
+      @result ||= result
+
+      result.proxy
+    end
+
+    def port
+      @result ||= result
+
+      result.proxy_port
+    end
+
+    def blank?
+      host.blank? or port.blank?
+    end
+
+    def direct?
+      @result ||= result
+
+      result.request_type == 'DIRECT'
+    end
+
+    def pac_file=(source)
+      uri = Addressable::URI.heuristic_parse(source)
+
+      if uri.host.blank?
+        @pac_file = File.read(source)
+      else
+        @pac_file = open(uri, { proxy: false })
+      end
+
+      @pac_file
+    rescue Errno::ENOENT
+      raise Exceptions::PacFileNotFound, JSON.dump(file: pac_file)
+    end
+
+    private
+
+    def result
+      return PacResult.new if pac_file.blank?
+
+      env_hash = {}
+      env_hash[:client_ip] = client_ip if client_ip
+      env_hash[:time]      = time if time
+
+      parser = ProxyPacRb::Parser.new(ProxyPacRb::Environment.new(env_hash))
+
+      file = parser.source(pac_file)
+      result = PacResult.new(file.find(url))
+
+      raise Exceptions::PacResultResult, JSON.dump(file: pac_file, result: result) if result.blank?
+
+      result
+    end
+  end
+end

data/lib/proxy_tester/cli/main.rb

@@ -0,0 +1,59 @@
+# encoding
+module ProxyTester
+  module Cli
+    class Main < Thor
+      class_option :config_file, type: :string, desc: 'Config file'
+      class_option :log_level, type: :string, desc: 'Log level for ui logging'
+      class_option :debug_mode, type: :boolean, desc: 'Run application in debug mode'
+
+      desc 'test', 'Run tests'
+      option :test_cases_directory, type: :string, desc: 'Directory with test cases'
+      option :tags, type: :array, desc: 'Filter tests based on tags'
+      def test
+        ProxyTester.config = ProxyTester::Config.new(options[:config_file]) if options[:config_file]
+        ProxyTester.config.log_level            = options[:log_level] if options[:log_level]
+        ProxyTester.config.debug_mode           = options[:debug_mode] if options[:debug_mode]
+        ProxyTester.config.test_cases_directory = options[:test_cases_directory] if options[:test_cases_directory]
+        ProxyTester.config.lock
+
+        ProxyTester.ui_logger.level = ProxyTester.config.log_level
+        ProxyTester.enable_debug_mode if ProxyTester.config.debug_mode
+
+        ProxyTester::RspecRunner.new.run(options[:tags])
+      end
+
+      desc 'init', 'Create files/directories to use proxy_tester'
+      option :force, type: :boolean, default: false, desc: 'Overwrite existing files?'
+      option :pre_seed, type: :boolean, default: false, desc: 'Add examples to test cases directory'
+      option :test_cases_directory, type: :string, desc: 'Directory with test cases'
+      option :user_file, type: :string, desc: 'Path to user file'
+
+      option :create_config_file, type: :boolean, desc: 'Create config file', default: true
+      option :create_user_file, type: :boolean, desc: 'Create user file', default: true
+      option :create_test_cases_directory, type: :boolean, desc: 'Create directory to store test cases', default: true
+      def init
+        ProxyTester.config = ProxyTester::Config.new(options[:config_file]) if options[:config_file]
+
+        ProxyTester.config.log_level            = options[:log_level] if options[:log_level]
+        ProxyTester.config.debug_mode           = options[:debug_mode] if options[:debug_mode]
+        ProxyTester.config.test_cases_directory = options[:test_cases_directory] if options[:test_cases_directory]
+        ProxyTester.config.user_file            = options[:user_file] if options[:user_file]
+        ProxyTester.config.lock
+
+        ProxyTester.ui_logger.level = ProxyTester.config.log_level
+        ProxyTester.enable_debug_mode if ProxyTester.config.debug_mode
+
+        ProxyTester.ui_logger.debug('Options: ' + options.to_s)
+        ProxyTester.ui_logger.debug("Config:\n" + ProxyTester.config.to_s)
+
+        Actions::InitializeApplication.new(
+          force: options[:force], 
+          pre_seed: options[:pre_seed], 
+          create_config_file: options[:create_config_file],
+          create_user_file: options[:create_user_file],
+          create_test_cases_directory: options[:create_test_cases_directory],
+        ).run
+      end
+    end
+  end
+end