proxy_rb 0.1.0 → 0.2.0

data/lib/proxy_rb/http_proxy.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'shellwords'
+
+require 'proxy_rb/credentials'
+require 'proxy_rb/proxy_url_parser'
+
+# ProxyRb
+module ProxyRb
+  # Represent proxy
+  class HttpProxy
+    protected
+
+    attr_reader :url, :credentials
+
+    public
+
+    def initialize(parser)
+      @url         = parser.proxy_url
+      @credentials = parser.credentials
+    end
+
+    # Convert to parameters for PhantomJS
+    #
+    # @return [Array]
+    #   An array of parameters for PhantomJS
+    def to_phantom_js
+      result = []
+      result << "--proxy=#{url}" unless url.empty?
+      result << "--proxy-auth=#{credentials}" unless credentials.empty?
+
+      result
+    end
+
+    # Convert to symbol to reference the proxy
+    #
+    # @return [Symbol]
+    #   <host>_<port>_<credentials>
+    def to_sym
+      Shellwords.escape(*[host, port, credentials.user_name].compact.join('_')).to_sym
+    end
+
+    private
+
+    def host
+      url.host
+    end
+
+    def port
+      url.port
+    end
+  end
+end

data/lib/proxy_rb/main.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+require 'logger'
+
 # Main
 module ProxyRb
   @debug_mode = false
+  @logger     = Logger.new($stderr)
 
   class << self
-    private
+    protected
 
     attr_accessor :debug_mode
 
     public
 
+    attr_reader :logger
+
     def debug_mode_enabled?
       debug_mode == true
     end
@@ -18,7 +24,7 @@ module ProxyRb
       %w(pry byebug).each { |l| require l }
     end
 
-    def require_file_matching_pattern(pattern)
+    def require_files_matching_pattern(pattern)
       root = File.expand_path('../', __FILE__)
       path = File.join(root, pattern)
       Dir.glob(path).each { |f| require_relative f }

data/lib/proxy_rb/no_proxy.rb

@@ -0,0 +1,26 @@
+# No proxy
+class NoProxy
+  def self.to_s
+    ""
+  end
+
+  def self.nil?
+    true
+  end
+
+  def self.empty?
+    true
+  end
+
+  def nil?
+    self.class.nil?
+  end
+
+  def empty?
+    self.class.empty?
+  end
+
+  def to_s
+    ""
+  end
+end

data/lib/proxy_rb/password_fetchers/basic_password_fetcher.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ProxyRb
+  # Fetch password for user...
+  module PasswordFetchers
+    # ... process environment
+    class BasicPasswordFetcher
+      def call(_user_name)
+        raise NotImplementedError, 'You need to implement `#call` for a valid password fetcher'
+      end
+    end
+  end
+end

data/lib/proxy_rb/password_fetchers/environment_password_fetcher.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'proxy_rb/password_fetchers/basic_password_fetcher'
+require 'proxy_rb/user_passwords/environment_user_password'
+
+module ProxyRb
+  # Fetch password for user...
+  module PasswordFetchers
+    # ... process environment
+    class EnvironmentPasswordFetcher < BasicPasswordFetcher
+      include Contracts::Core
+      include Contracts::Builtin
+
+      protected
+
+      attr_reader :prefix
+
+      public
+
+      # Prefix of key in Environment
+      def initialize(prefix:)
+        @prefix = prefix
+      end
+
+      # @param [String] user_name
+      #   Look up user name
+      Contract String => String
+      def call(user_name)
+        UserPasswords::EnvironmentUserPassword.new(
+          ENV[format('%s_%s', prefix, user_name.upcase)]
+        ).to_s
+      end
+    end
+  end
+end

data/lib/proxy_rb/password_fetchers/vault_password_fetcher.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'proxy_rb/password_fetchers/basic_password_fetcher'
+require 'proxy_rb/user_passwords/vault_user_password'
+
+begin
+  require 'vault'
+rescue LoadError
+  ProxyRb.logger.error 'Please add `vault` to your `Gemfile` to use this password fetcher'
+end
+
+module ProxyRb
+  # Fetch password for user...
+  module PasswordFetchers
+    # ... from HashiCorp Vault
+    class VaultPasswordFetcher < BasicPasswordFetcher
+      include Contracts::Core
+      include Contracts::Builtin
+
+      protected
+
+      attr_reader :prefix, :client
+
+      public
+
+      # @param [String] prefix
+      #   Prefix used to look up password for user name
+      #
+      # @param [Vault::Client] client
+      #   The client used to connect to central "Vault" server
+      def initialize(prefix:, client: ::Vault::Client.new(address: ENV['VAULT_ADDR']))
+        @prefix = prefix
+        @client = client
+      end
+
+      # @param [String] user_name
+      #   Look up user name
+      Contract String => String
+      def call(user_name)
+        client.with_retries(::Vault::HTTPConnectionError, ::Vault::HTTPError) do |_attempt, _e|
+          UserPasswords::VaultUserPassword.new(
+            ::Vault.logical.read(File.join(prefix, user_name))
+          ).to_s
+        end
+      end
+    end
+  end
+end

data/lib/proxy_rb/password_fetchers.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module ProxyRb
+  # Fetch password for user...
+  module PasswordFetcher
+  end
+end

data/lib/proxy_rb/proxy_url.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'addressable/uri'
+
+# ProxyRb
+module ProxyRb
+  # A ProxyURL
+  class ProxyUrl
+    #  Build a URL from hash
+    #
+    #  @param [Hash] hash
+    #    An Hash representing the url parts
+    #
+    # @return [ProxyUrl]
+    #   The built url
+    def self.build(hash)
+      new(Addressable::URI.new(hash))
+    end
+
+    # Create URL from string
+    #
+    # @param [String] string
+    #   The url
+    #
+    # @return [ProxyUrl]
+    #   The parsed url
+    def self.parse(string)
+      new(Addressable::URI.heuristic_parse(string.to_s))
+    end
+
+    protected
+
+    attr_reader :url
+
+    public
+
+    def initialize(url)
+      @url = url
+    end
+
+    %i(host user password port).each do |m|
+      define_method m do
+        return nil if empty?
+
+        url.public_send m
+      end
+    end
+
+    def to_s
+      return "" if empty?
+
+      url.to_s
+    end
+
+    # Check if url is empty
+    def empty?
+      url.nil? || url.empty?
+    end
+
+    # Return URL without user name and password
+    #
+    # @return [ProxyUrl]
+    #   The cleaned url
+    def without_user_name_and_password
+      return self.class.new(nil) if empty?
+
+      h = url.to_hash
+      h.delete :user
+      h.delete :password
+
+      self.class.build(h)
+    end
+  end
+end

data/lib/proxy_rb/proxy_url_parser.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'uri'
+require 'addressable/uri'
+require 'proxy_rb/proxy_url'
+
+# ProxyRb
+module ProxyRb
+  # Parse urls for proxies
+  class ProxyUrlParser
+    protected
+
+    attr_reader :raw_url
+
+    public
+
+    attr_reader :proxy_url, :credentials
+
+    # @param [String] url
+    #   The url for the proxy configuration
+    def initialize(url)
+      temporary_url = ProxyUrl.parse(url)
+
+      @proxy_url   = temporary_url.without_user_name_and_password
+      @credentials = Credentials.new(temporary_url.user, temporary_url.password)
+    end
+
+    private
+
+    def url_hash_for_hostname_port
+      splitted_url = raw_url.to_s.split(/:/)
+
+      url_hash = {}
+      url_hash[:host] = splitted_url.first
+      url_hash[:path] = '/'
+      url_hash[:port] = splitted_url.last unless splitted_url.first == splitted_url.last
+
+      url_hash
+    end
+
+    def url_hash_for_url
+      Addressable::URI.parse(raw_url).to_hash
+    end
+
+    def url?(u)
+      url = Addressable::URI.parse(u)
+
+      return false if url.nil?
+      return false unless /\A[[:alnum:]]+\Z/ === url.scheme
+      return true if url && url.host
+
+      false
+    rescue Addressable::URI::InvalidURIError
+      false
+    end
+  end
+end

data/lib/proxy_rb/request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # An HTTP request
+  class Request
+    protected
+
+    attr_reader :page
+
+    public
+
+    def initialize(page)
+      @page = page
+    end
+
+    # Was the request successful
+    #
+    # @return [TrueClass, FalseClass]
+    #   The result
+    def successful?
+      page.status_code.to_s.start_with?('2', '3')
+    end
+
+    # def forbidden?
+    #   page.status_code == 403
+    # end
+
+    # def invalid?
+    #   page.status_code == 401
+    # end
+
+    # def redirected?
+    #   page.status_code.to_s.start_with? '3'
+    # end
+  end
+end

data/lib/proxy_rb/resource.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'addressable/uri'
+
+# ProxyRb
+module ProxyRb
+  # A resource
+  class Resource
+    attr_accessor :content
+
+    private
+
+    attr_reader :url
+
+    public
+
+    def initialize(url)
+      @url = Addressable::URI.parse(url)
+    end
+
+    # Convert resource to url
+    #
+    # @return [String] url
+    #   The url
+    def to_url
+      url.to_s
+    end
+  end
+end

data/lib/proxy_rb/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # A response
+  class Response
+    protected
+
+    attr_reader :page
+
+    public
+
+    def initialize(page)
+      @page = page
+    end
+
+    # def forbidden?
+    #   page.status_code == 403
+    # end
+  end
+end

data/lib/proxy_rb/rspec/helpers/http_proxy.rb

@@ -1,11 +1,89 @@
+# frozen_string_literal: true
+require 'capybara/poltergeist'
+
+require 'proxy_rb'
+require 'proxy_rb/resource'
+require 'proxy_rb/http_downloader'
+require 'proxy_rb/http_proxy'
+require 'proxy_rb/request'
+require 'proxy_rb/response'
+
 # Main Module
 module ProxyRb
   # Main Module
   module Rspec
     # Helpers
     module Helpers
+      # Non includable internal helper methods
+      #
+      # Not for use by normal users
+      module NonIncludes
+        class << self
+          def clear_environment
+            %w(
+              http_proxy
+              https_proxy
+              HTTP_PROXY
+              HTTPS_PROXY
+            ).each { |v| ENV.delete v }
+          end
+
+          def register_capybara_driver_for_proxy(proxy)
+            options = {
+              phantomjs_options: proxy.to_phantom_js,
+              js_errors: false,
+              phantomjs_logger: $stderr
+            }
+
+            ::Capybara.register_driver proxy.to_sym do |app|
+              ::Capybara::Poltergeist::Driver.new(app, options)
+            end
+
+            ::Capybara.run_server = false
+            ::Capybara.current_driver = proxy.to_sym
+          end
+        end
+      end
+
       # For http proxy
       module HttpProxy
+        include ::Capybara::DSL
+
+        # The proxy based on subject
+        def proxy
+          ProxyRb::HttpProxy.new(ProxyUrlParser.new(subject))
+        end
+
+        # Visit an URL
+        #
+        # @param [String] url
+        def visit(url)
+          resource = Resource.new(url)
+
+          NonIncludes.clear_environment
+          NonIncludes.register_capybara_driver_for_proxy(proxy)
+
+          begin
+            super(resource.to_url)
+          rescue ::Capybara::Poltergeist::TimeoutError
+            raise ProxyRb::UrlTimeoutError, "Failed to fetch #{resource.to_url}: Timeout occured."
+          end
+        end
+
+        # !@method download
+        #
+        # @see #visit
+        alias download visit
+
+        # Get access to the request made
+        def request
+          Request.new(page)
+        end
+
+        # Get access to the response get
+        def response
+          Response.new(page)
+        end
       end
     end
   end

data/lib/proxy_rb/rspec/helpers/passwords.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'contracts'
+
+# ProxyRb
+module ProxyRb
+  # Rspec
+  module Rspec
+    # Helpers
+    module Helpers
+      # Helpers to access passwords
+      module Passwords
+        include Contracts::Core
+        include Contracts::Builtin
+
+        Contract Or[String, Symbol] => Maybe[String]
+        # Get password for user
+        #
+        # @param [String] user_name
+        #   The user name
+        #
+        # @return [String]
+        #   The password
+        def password(user_name)
+          ProxyRb.config.password_fetcher.call(user_name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/proxy_rb/rspec.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require 'rspec'
-require 'capybara/poltergeist'
 require 'capybara/rspec'
 
-require 'proxy_rb/rspec'
+require 'proxy_rb'
+require 'proxy_rb/no_proxy'
 
-ProxyRb.require_file_matching_pattern('rspec/helpers/*.rb')
-ProxyRb.require_file_matching_pattern('rspec/matchers/*.rb')
-ProxyRb.require_file_matching_pattern('rspec/shared_examples/*.rb')
-ProxyRb.require_file_matching_pattern('rspec/shared_contexts/*.rb')
+ProxyRb.require_files_matching_pattern('rspec/helpers/*.rb')
+ProxyRb.require_files_matching_pattern('rspec/matchers/*.rb')
+ProxyRb.require_files_matching_pattern('rspec/shared_examples/*.rb')
+ProxyRb.require_files_matching_pattern('rspec/shared_contexts/*.rb')
 
 # Main Module
 module ProxyRb
@@ -18,4 +19,6 @@ end
 
 RSpec.configure do |config|
   config.include ProxyRb::Rspec::Helpers::HttpProxy, type: :http_proxy
+  config.include ProxyRb::Rspec::Helpers::Passwords, type: :http_proxy
+  config.include Capybara::RSpecMatchers, type: :http_proxy
 end

data/lib/proxy_rb/user_passwords/environment_user_password.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # User passwords
+  module UserPasswords
+    # Be a password from environment
+    class EnvironmentUserPassword
+      include Contracts::Core
+      include Contracts::Builtin
+
+      protected
+
+      attr_reader :response
+
+      public
+
+      def initialize(response)
+        @response = response
+      end
+
+      # Return password
+      #
+      # @return [String]
+      Contract None => String
+      def to_s
+        response.to_s
+      end
+    end
+  end
+end

data/lib/proxy_rb/user_passwords/vault_user_password.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # User Passwords
+  module UserPasswords
+    # Be a password return from vault
+    class VaultUserPassword
+      include Contracts::Core
+      include Contracts::Builtin
+
+      protected
+
+      attr_reader :response
+
+      public
+
+      def initialize(response)
+        @response = response.data
+      end
+
+      Contract None => String
+      def to_s
+        response[:password].to_s
+      end
+    end
+  end
+end

data/lib/proxy_rb/user_passwords.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # User Passwords
+  module UserPasswords
+  end
+end

data/lib/proxy_rb/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # Main Module
 module ProxyRb
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/proxy_rb.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'proxy_rb/version'
+require 'proxy_rb/configuration'
 require 'proxy_rb/main'
 
 # Main module

data/proxy_rb.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'proxy_rb/version'
@@ -24,8 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'poltergeist'
 
   spec.add_runtime_dependency 'addressable'
-  spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'uglifier'
+  spec.add_runtime_dependency 'contracts'
+  spec.add_runtime_dependency 'excon'
+  #  spec.add_runtime_dependency 'phantomjs'
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '~> 2.3'
 end