webvalve 0.9.0

data/lib/webvalve/fake_service_config.rb

@@ -0,0 +1,53 @@
+module WebValve
+  class FakeServiceConfig
+    ENABLED_VALUES = %w(1 t true)
+
+    attr_reader :service
+
+    def initialize(service:, url: nil)
+      @service = service
+      @custom_service_url = url
+    end
+
+    def should_intercept?
+      Rails.env.test? ||
+        (WebValve.enabled? && !service_enabled_in_env?)
+    end
+
+    def service_url
+      @service_url ||= begin
+        url = custom_service_url || default_service_url
+        raise missing_url_message if url.blank?
+        strip_basic_auth url
+      end
+    end
+
+    private
+
+    attr_reader :custom_service_url
+
+    def missing_url_message
+      <<~MESSAGE
+        There is no URL defined for #{service.name}.
+        Configure one by setting the ENV variable "#{service_name.to_s.upcase}_API_URL"
+        or by using WebValve.register #{service.name}, url: "http://something.dev"
+      MESSAGE
+    end
+
+    def strip_basic_auth(url)
+      url.to_s.sub(%r(\Ahttp(s)?://[^@/]+@), 'http\1://')
+    end
+
+    def service_enabled_in_env?
+      ENABLED_VALUES.include?(ENV["#{service_name.to_s.upcase}_ENABLED"])
+    end
+
+    def default_service_url
+      ENV["#{service_name.to_s.upcase}_API_URL"]
+    end
+
+    def service_name
+      @service_name ||= service.name.demodulize.underscore.sub 'fake_', ''
+    end
+  end
+end

data/lib/webvalve/fake_service_wrapper.rb

@@ -0,0 +1,18 @@
+module WebValve
+  class FakeServiceWrapper
+    # lazily resolve the app constant to leverage rails class reloading
+    def initialize(app)
+      @app_klass_name = app.name
+    end
+
+    def call(env)
+      app.call(env)
+    end
+
+    private
+
+    def app
+      @app_klass_name.constantize
+    end
+  end
+end

data/lib/webvalve/instrumentation.rb

@@ -0,0 +1,4 @@
+require 'webvalve/instrumentation/middleware'
+require 'webvalve/instrumentation/log_subscriber'
+
+WebValve::Instrumentation::LogSubscriber.attach_to :webvalve

data/lib/webvalve/instrumentation/log_subscriber.rb

@@ -0,0 +1,16 @@
+module WebValve
+  module Instrumentation
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def request(event)
+        return unless logger.debug?
+        status = event.payload[:status]
+        method = event.payload[:method].to_s.upcase
+        url = event.payload[:url]
+        host = event.payload[:host]
+        name = '%s %s (%.1fms)' % ["WebValve", "Request Captured", event.duration]
+        details = "#{host} #{method} #{url} [#{status}]"
+        debug "  #{color(name, YELLOW, true)}  #{color(details, BOLD, true)}"
+      end
+    end
+  end
+end

data/lib/webvalve/instrumentation/middleware.rb

@@ -0,0 +1,24 @@
+module WebValve
+  module Instrumentation
+    class Middleware
+      METHOD = 'REQUEST_METHOD'.freeze
+      PATH = 'PATH_INFO'.freeze
+      HOST = 'SERVER_NAME'.freeze
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        ActiveSupport::Notifications.instrument('request.webvalve') do |payload|
+          payload[:method] = env[METHOD]
+          payload[:url] = env[PATH]
+          payload[:host] = env[HOST]
+          @app.call(env).tap do |status, _header, _body|
+            payload[:status] = status
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webvalve/manager.rb

@@ -0,0 +1,76 @@
+require 'webmock'
+require 'singleton'
+require 'set'
+
+module WebValve
+  # @api private
+  class Manager
+    include Singleton
+
+    def register(fake_service, **args)
+      raise "#{fake_service.inspect} already registered" if fake_service_configs.any? { |c| c.service == fake_service }
+      fake_service_configs << FakeServiceConfig.new(service: fake_service, **args)
+    end
+
+    def whitelist_url(url)
+      raise "#{url} already registered" if whitelisted_urls.include?(url)
+      whitelisted_urls << url
+    end
+
+    def setup
+      fake_service_configs.each do |config|
+        if config.should_intercept?
+          webmock_service config
+        else
+          whitelist_service config
+        end
+      end
+
+      WebMock.enable!
+      WebMock.disable_net_connect! webmock_disable_options
+    end
+
+    # @api private
+    def reset
+      whitelisted_urls.clear
+      fake_service_configs.clear
+    end
+
+    # @api private
+    def fake_service_configs
+      @fake_service_configs ||= []
+    end
+
+    # @api private
+    def whitelisted_urls
+      @whitelisted_urls ||= Set.new
+    end
+
+    private
+
+    def webmock_disable_options
+      { allow_localhost: true }.tap do |opts|
+        opts[:allow] = whitelisted_url_regexps unless Rails.env.test?
+      end
+    end
+
+    def whitelisted_url_regexps
+      whitelisted_urls.map { |url| url_to_regexp url }
+    end
+
+    def webmock_service(config)
+      WebMock.stub_request(
+        :any,
+        url_to_regexp(config.service_url)
+      ).to_rack(FakeServiceWrapper.new(config.service))
+    end
+
+    def whitelist_service(config)
+      whitelisted_urls << config.service_url
+    end
+
+    def url_to_regexp(url)
+      %r(\A#{Regexp.escape url})
+    end
+  end
+end

data/lib/webvalve/rspec.rb

@@ -0,0 +1,8 @@
+require 'webvalve'
+require 'webmock/rspec'
+
+RSpec.configure do |c|
+  c.before do
+    WebValve.setup
+  end
+end

data/lib/webvalve/version.rb

@@ -0,0 +1,3 @@
+module WebValve
+  VERSION = "0.9.0"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "webvalve"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end