proxy_rb 0.4.0 → 0.5.0

data/lib/proxy_rb/initializer.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+require 'thor/group'
+require 'thor/actions'
+
+# ProxyRb
+module ProxyRb
+  # Initializers
+  #
+  # Initialize project with proxy_rb configuration files
+  module Initializers
+    # Common initializer
+    #
+    # @private
+    class CommonInitializer < Thor::Group
+      include Thor::Actions
+
+      # Add gem to gemfile
+      def add_gem
+        file = 'Gemfile'
+        creator = if File.exist? file
+                    :append_to_file
+                  else
+                    :create_file
+                  end
+
+        content = if File.exist? file
+                    %(gem 'proxy_rb', '~> #{ProxyRb::VERSION}')
+                  else
+                    %(source 'https://rubygems.org'\ngem 'proxy_rb', '~> #{ProxyRb::VERSION}'\n)
+                  end
+        send creator, file, content
+      end
+    end
+  end
+end
+
+# ProxyRb
+module ProxyRb
+  # Initializers
+  module Initializers
+    # Default Initializer
+    #
+    # This handles invalid values for initializer.
+    #
+    # @private
+    class FailingInitializer
+      class << self
+        def match?(*)
+          true
+        end
+
+        def start(*)
+          raise ArgumentError, %(Unknown test framework. Please use "rspec" )
+        end
+      end
+    end
+  end
+end
+
+# ProxyRb
+module ProxyRb
+  # Initializer
+  module Initializers
+    # Add proxy_rb + rspec to project
+    #
+    # @private
+    class RSpecInitializer < Thor::Group
+      include Thor::Actions
+
+      no_commands do
+        def self.match?(framework)
+          :rspec == framework.downcase.to_sym
+        end
+      end
+
+      def create_helper
+        file = 'spec/spec_helper.rb'
+        creator = if File.exist? file
+                    :append_to_file
+                  else
+                    :create_file
+                  end
+
+        send creator, file, <<~EOS
+        $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+        ::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+        ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+        EOS
+      end
+
+      def create_support_file
+        create_file 'spec/support/proxy_rb.rb', <<~EOS
+        require 'proxy_rb/rspec'
+        EOS
+      end
+    end
+  end
+end
+
+# ProxyRb
+module ProxyRb
+  # The whole initializer
+  #
+  # This one uses the specific initializers to generate the needed files.
+  #
+  # @private
+  class Initializer
+    private
+
+    attr_reader :initializers
+
+    public
+
+    def initialize
+      @initializers = []
+      @initializers << Initializers::RSpecInitializer
+    end
+
+    # Create files etc.
+    def call(test_framework)
+      begin
+        initializers.find { |i| i.match? test_framework }.start [], {}
+      rescue ArgumentError => e
+        $stderr.puts e.message
+        exit 0
+      end
+
+      Initializers::CommonInitializer.start [], {}
+    end
+  end
+end

data/lib/proxy_rb/matchers/be_forbidden.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :be_forbidden do
+  match do |actual|
+    values_match?(403, actual.status_code)
+  end
+
+  failure_message do |actual|
+    %(expected that response has status code 403, but has #{actual.status_code})
+  end
+
+  failure_message_when_negated do
+    %(expected that response does not have status code 403)
+  end
+end

data/lib/proxy_rb/matchers/be_successful.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :be_successful do
+  match do |actual|
+    actual.status_code.to_s.start_with?('2', '3')
+  end
+
+  failure_message do |actual|
+    %(expected that response has status code 2xx, but has #{actual.status_code})
+  end
+
+  failure_message_when_negated do
+    %(expected that response does not have status code 2xx)
+  end
+end

data/lib/proxy_rb/matchers/have_mime_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :have_mime_type do |expected|
+  match do |actual|
+    @actual = actual.mime_type
+    values_match?(expected, @actual)
+  end
+end
+
+RSpec::Matchers.alias_matcher :be_of_mime_type, :have_mime_type

data/lib/proxy_rb/password_fetchers/basic_password_fetcher.rb

@@ -7,6 +7,31 @@ module ProxyRb
       def call(_user_name)
         raise NotImplementedError, 'You need to implement `#call` for a valid password fetcher'
       end
+
+      private
+
+      def read(_string)
+        raise NotImplementedError, 'You need to implement `#read` for a valid password fetcher'
+      end
+
+      # @param [String] user_name
+      #
+      # @raise [ArgumentError]
+      #   Raised if password cannot be retrieved for user
+      #
+      # @return [String]
+      #   The password
+      def fetch_password_for_user(user_name)
+        if read(user_name.upcase)
+          read(user_name.upcase)
+        elsif read(user_name.downcase)
+          read(user_name.downcase)
+        elsif read(user_name)
+          read(user_name)
+        else
+          raise ArgumentError, %(Failed to fetch password for username "#{user_name}")
+        end
+      end
     end
   end
 end

data/lib/proxy_rb/password_fetchers/chaining_password_fetcher.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'proxy_rb/password_fetchers/basic_password_fetcher'
+
+module ProxyRb
+  # Fetch password for user...
+  module PasswordFetchers
+    # ... process environment
+    class ChainingPasswordFetcher < BasicPasswordFetcher
+      include Contracts::Core
+      include Contracts::Builtin
+
+      protected
+
+      attr_reader :fetchers
+
+      public
+
+      # Prefix of key in Environment
+      def initialize(fetchers)
+        @fetchers = Array(fetchers)
+      end
+
+      # @param [String] user_name
+      #   Look up user name
+      Contract String => String
+      def call(user_name)
+        fetch_password_for_user(user_name)
+      end
+
+      private
+
+      def fetch_password_for_user(user_name)
+        result = nil
+
+        fetchers.each do |f|
+          begin
+            result = f.call(user_name)
+          rescue ArgumentError
+            result = nil
+          end
+
+          break unless result.nil?
+        end
+
+        raise ArgumentError, %(Failed to fetch password for username "#{user_name}") if result.nil?
+
+        result
+      end
+
+      # Not needed for this fetcher
+      def read(_string); end
+    end
+  end
+end

data/lib/proxy_rb/password_fetchers/environment_password_fetcher.rb

@@ -26,9 +26,15 @@ module ProxyRb
       Contract String => String
       def call(user_name)
         UserPasswords::EnvironmentUserPassword.new(
-          ENV[format('%s_%s', prefix, user_name.upcase)]
+          fetch_password_for_user(user_name)
         ).to_s
       end
+
+      private
+
+      def read(string)
+        ENV[format('%s_%s', prefix, string)]
+      end
     end
   end
 end

data/lib/proxy_rb/password_fetchers/vault_password_fetcher.rb

@@ -38,10 +38,16 @@ module ProxyRb
       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))
+            fetch_password_for_user(user_name)
           ).to_s
         end
       end
+
+      private
+
+      def read(string)
+        ::Vault.logical.read(File.join(prefix, string))
+      end
     end
   end
 end

data/lib/proxy_rb/proxy_url.rb

@@ -78,5 +78,13 @@ module ProxyRb
 
       self.class.build(h)
     end
+
+    # Return url as hash
+    #
+    # @return [Hash]
+    #   the converted url
+    def to_hash
+      url.to_hash
+    end
   end
 end

data/lib/proxy_rb/request.rb

@@ -1,24 +1,16 @@
 # frozen_string_literal: true
+require 'delegate'
+
 # ProxyRb
 module ProxyRb
   # An HTTP request
-  class Request
-    protected
-
-    attr_reader :page
-
-    public
-
-    def initialize(page)
-      @page = page
-    end
-
+  class Request < SimpleDelegator
     # Was the request successful
     #
     # @return [TrueClass, FalseClass]
     #   The result
     def successful?
-      page.status_code.to_s.start_with?('2', '3')
+      __getobj__.status_code.to_s.start_with?('2', '3')
     end
 
     # The request is forbidden
@@ -26,15 +18,7 @@ module ProxyRb
     # @return [TrueClass, FalseClass]
     #   The result
     def forbidden?
-      page.status_code == 403
+      __getobj__.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

@@ -1,27 +1,31 @@
 # frozen_string_literal: true
 require 'addressable/uri'
+require 'proxy_rb/credentials'
 
 # ProxyRb
 module ProxyRb
   # A resource
   class Resource
     attr_accessor :content
-
-    private
-
-    attr_reader :url
-
-    public
+    attr_reader :credentials, :url
 
     def initialize(url)
       @url = Addressable::URI.parse(url)
     end
 
+    # Return credentials from url
+    #
+    # @return [Credentials]
+    #   The credentials from url
+    def credentials
+      Credentials.new(url.user, url.password)
+    end
+
     # Convert resource to url
     #
     # @return [String] url
     #   The url
-    def to_url
+    def to_s
       url.to_s
     end
   end

data/lib/proxy_rb/response.rb

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
+require 'delegate'
+
 # ProxyRb
 module ProxyRb
   # A response
-  class Response
-    protected
-
-    attr_reader :page
-
-    public
-
-    def initialize(page)
-      @page = page
+  class Response < SimpleDelegator
+    def mime_type
+      __getobj__.driver.response_headers['Content-Type']
     end
-
-    # def forbidden?
-    #   page.status_code == 403
-    # end
   end
 end

data/lib/proxy_rb/rspec.rb

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
-require 'rspec'
-require 'capybara/rspec'
-
-require 'proxy_rb'
-require 'proxy_rb/no_proxy'
-
-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')
+require 'proxy_rb/api'
 
 # Main Module
 module ProxyRb
@@ -18,7 +9,35 @@ module ProxyRb
 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
+  config.include ProxyRb::Api, type: :http_proxy
+
+  # Setup ProxyRb
+  config.before :each do |_example|
+    next unless self.class.include? ProxyRb::Api
+
+    setup_proxy_rb
+  end
+
+  config.before :each do |example|
+    next unless self.class.include? ProxyRb::Api
+
+    example.metadata.each { |k, v| proxy_rb.config.set_if_option(k, v) }
+  end
+
+  # Activate announcers based on rspec metadata
+  config.before :each do |example|
+    next unless self.class.include? ProxyRb::Api
+
+    proxy_rb.announcer.activate(:proxy) if example.metadata[:announce_proxy]
+    proxy_rb.announcer.activate(:proxy_user) if example.metadata[:announce_proxy_user]
+    proxy_rb.announcer.activate(:resource) if example.metadata[:announce_resource]
+    proxy_rb.announcer.activate(:resource_user) if example.metadata[:announce_resource_user]
+
+    if example.metadata[:announce]
+      proxy_rb.announcer.activate(:proxy)
+      proxy_rb.announcer.activate(:proxy_user)
+      proxy_rb.announcer.activate(:resource)
+      proxy_rb.announcer.activate(:resource_user)
+    end
+  end
 end

data/lib/proxy_rb/runtime.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'proxy_rb/configuration'
+require 'proxy_rb/configuration_wrapper'
+require 'proxy_rb/events'
+require 'proxy_rb/event_bus'
+require 'proxy_rb/announcer'
+
+module ProxyRb
+  # Runtime of proxy_rb
+  #
+  # Most methods are considered private. Please look for `(private)` in the
+  # attribute descriptions. Only a few like `#current_directory`,
+  # '#root_directory` and `#config` are considered to be part of the public
+  # API.
+  class Runtime
+    # @!attribute [r] config
+    #   Access configuration of proxy_rb
+    #
+    # @!attribute [r] announcer
+    #   Announce information
+    #
+    # @!attribute [r] event_bus
+    #   Handle events (private)
+    #
+    attr_accessor :config, :announcer, :event_bus
+
+    def initialize(opts = {})
+      @event_bus       = EventBus.new(EventBus::NameResolver.new(ProxyRb::Events))
+      @announcer       = opts.fetch(:announcer, ProxyRb::Announcer.new)
+      @config          = opts.fetch(:config, ConfigurationWrapper.new(ProxyRb.config.make_copy, @event_bus))
+
+      @setup_done = false
+    end
+
+    # @private
+    #
+    # Setup of proxy_rb is finshed. Should be used only internally.
+    def setup_done
+      @setup_done = true
+    end
+
+    # @private
+    #
+    # Has proxy_rb already been setup. Should be used only internally.
+    def setup_already_done?
+      @setup_done == true
+    end
+  end
+end

data/lib/proxy_rb/setup.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# Proxy Rb
+module ProxyRb
+  # Setup proxy rb
+  class Setup
+    private
+
+    attr_reader :runtime
+
+    public
+
+    def initialize(runtime)
+      @runtime = runtime
+    end
+
+    def call
+      return if runtime.setup_already_done?
+
+      events
+
+      runtime.setup_done
+
+      self
+    end
+
+    private
+
+    # disable Metrics/MethodLength
+    def events
+      runtime.event_bus.register(
+        :proxy_set,
+        proc do |event|
+          runtime.announcer.announce :proxy, event.entity
+        end
+      )
+
+      runtime.event_bus.register(
+        :proxy_user_set,
+        proc do |event|
+          runtime.announcer.announce :proxy_user, event.entity
+        end
+      )
+
+      runtime.event_bus.register(
+        :resource_set,
+        proc do |event|
+          runtime.announcer.announce :resource, event.entity
+        end
+      )
+
+      runtime.event_bus.register(
+        :resource_user_set,
+        proc do |event|
+          runtime.announcer.announce :resource_user, event.entity
+        end
+      )
+    end
+    # enable Metrics/MethodLength
+  end
+end

data/lib/proxy_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Main Module
 module ProxyRb
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/proxy_rb.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = ProxyRb::VERSION
   spec.authors       = ['Max Meyer']
   spec.email         = ['dev@fedux.org']
+  spec.licenses      = ['MIT']
 
   spec.summary       = 'This gem makes testing your proxy easy.'
   spec.homepage      = 'https://github.com/fedux-org/proxy_rb'
@@ -19,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_runtime_dependency 'capybara'
   spec.add_runtime_dependency 'capybara-webkit'
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'contracts'
   spec.add_runtime_dependency 'excon'
 
-  spec.add_runtime_dependency 'rspec'
+  spec.add_runtime_dependency 'rspec', '~> 3.3'
 
   spec.required_ruby_version = '~> 2.3'
 end