rspec-httpd 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce5a7956af7f5d0fa605929340963f4b212b1eca01a638bb52829fbe190716b5
-  data.tar.gz: 426cf96fa555de1949629f65cb1f619f8be7b4980fde0e47e2ed9b5d1432cc7a
+  metadata.gz: e88c3329bebe29bcae34340feeb0585974fdc35b5a8b35f0451d7208e51f9c4f
+  data.tar.gz: a56d6764673da02062227b36b141ba8bdc163cb864489688f988a0f47a63f036
 SHA512:
-  metadata.gz: d2c05620102049c75517f09cdc042e068503600d4633b87228adb2be70bd75a85cc0372876dd3bee2404b301f6d3c61adb2358daea265eff6ea3691355abe837
-  data.tar.gz: ad091863872c48f7f356afa9422a83fc8d25bdd8fa80f6bd53682228f962940e9d64f72426af4c751b987517c63d364f106c46e5a45bd645a3013dfcc2c9dec6
+  metadata.gz: 9e1ac270f0c7e49cb2a923964bdc3ebbb7b0f91e64442768dff60a04063051ac4cce35d68cd3ab8860b0c4103c55c79c5526e3d0a834e987e32a405c3a212d13
+  data.tar.gz: 13a98bb4462fcdebb3cc33f40975e15a658a73f1c9e70e299dfa8c9a21b8ef407d316b3b24fca8cf5909c79d486d8e1040dc3a21ec454383cd690a9ac3e6c9a8

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/rspec/httpd.rb

@@ -0,0 +1,78 @@
+require "rspec/core"
+require "forwardable"
+require "logger"
+
+module RSpec::Httpd
+end
+
+require_relative "httpd/version"
+require_relative "httpd/server"
+require_relative "httpd/client"
+require_relative "httpd/config"
+require_relative "httpd/expectation"
+
+module RSpec::Httpd
+  extend self
+
+  attr_reader :config
+
+  # Set the configuration for the default client.
+  #
+  # See also: RSpec::Httpd.http
+  def configure(&block)
+    @config = Config.new.tap(&block)
+  end
+
+  def logger #:nodoc:
+    @logger ||= Logger.new(STDERR).tap { |logger| logger.level = Logger::INFO }
+  end
+
+  # builds and returns a client.
+  #
+  # You can use this method to retrieve a client connection to a server
+  # specified via host:, port:, and, optionally, a command.
+  def client(host:, port:, command: nil)
+    @clients ||= {}
+    @clients[[host, port, command]] ||= begin
+      Server.start!(host: host, port: port, command: command) if command
+      Client.new host: host, port: port
+    end
+  end
+
+  private
+
+  # returns the default client
+  #
+  # The default client is the one configured via RSpec::Httpd.configure.
+  def http
+    config = ::RSpec::Httpd.config ||
+             raise("RSpec::Httpd configuration missing; run RSpec::Httpd.configure { |config| ... }")
+
+    client(host: config.host, port: config.port, command: config.command)
+  end
+
+  public
+
+  def expect_response(expected = nil, status: nil, client: nil)
+    client ||= http
+
+    # only check status? This lets us write
+    #
+    #    expect_response 201
+    #
+    if expected.is_a?(Integer) && status.nil?
+      expect(client.status).to eq(expected)
+      return
+    end
+
+    # do_expect_last_request is implemented in RSpec::Httpd::Expectation, and mixed in
+    # here, because it needs access to the expect() implementation.
+
+    expect(client.status).to eq(status || 200)
+    unless expected.nil?
+      do_expect_last_request(expected: expected, client: client)
+    end
+  end
+
+  include RSpec::Httpd::Expectation
+end

data/lib/rspec/httpd/client.rb

@@ -0,0 +1,122 @@
+require "net/http"
+require "json"
+
+module RSpec::Httpd
+  class Client
+    # host and port. Set at initialization
+    attr_reader :host
+    attr_reader :port
+
+    def initialize(host:, port:)
+      @host, @port = host, port
+    end
+
+    # request, response, and status, set during a request/response cycle
+    attr_reader :request
+    attr_reader :response
+
+    def status
+      Integer(response.code)
+    end
+
+    # returns the headers of the latest response
+    def headers
+      @headers ||= HeadersHash.new(response)
+    end
+
+    # returns the parsed response of the latest request
+    def result
+      @result ||= ResponseParser.parse(response)
+    end
+
+    # A GET request
+    def get(url, headers: {})
+      run_request(::Net::HTTP::Get, url, body: nil, headers: headers)
+    end
+
+    # A POST request
+    def post(url, body, headers: {})
+      run_request(::Net::HTTP::Post, url, body: body, headers: headers)
+    end
+
+    # A PUT request
+    def put(url, body, headers: {})
+      run_request(::Net::HTTP::Put, url, body: body || {}, headers: headers)
+    end
+
+    # A DELETE request
+    def delete(url, headers: {})
+      run_request(::Net::HTTP::Delete, url, body: nil, headers: headers)
+    end
+
+    private
+
+    def run_request(request_klass, url, body:, headers:)
+      @result = nil
+
+      build_request!(request_klass, url, body: body, headers: headers)
+      log_request!
+      @response = Net::HTTP.start(host, port) { |http| http.request(request) }
+    end
+
+    def build_request!(request_klass, url, body:, headers:)
+      @request = request_klass.new url, headers
+      if body
+        @request["Content-Type"] = "application/json"
+        @request.body = JSON.generate body
+      end
+    end
+
+    def log_request!
+      if request.body
+        RSpec::Httpd.logger.info "#{request.method} #{request.uri} #{body.inspect[0..100]}"
+      else
+        RSpec::Httpd.logger.info "#{request.method} #{request.uri}"
+      end
+    end
+
+    class HeadersHash < Hash
+      def initialize(response)
+        response.each_header do |k, v|
+          case self[k]
+          when Array then self[k].concat v
+          when nil   then self[k] = v
+          else            self[k].concat(v)
+          end
+        end
+      end
+
+      def [](key)
+        super key.downcase
+      end
+
+      private
+
+      def []=(key, value)
+        super key.downcase, value
+      end
+    end
+
+    module ResponseParser
+      def self.parse(response)
+        content_type = response["content-type"]
+
+        result = if content_type&.include?("application/json")
+                   JSON.parse(response.body)
+                 else
+                   response.body.force_encoding("utf-8").encode
+                 end
+
+        result.extend(self)
+        result.__response__ = response
+        result
+      end
+
+      attr_accessor :__response__
+
+      def status
+        Integer(__response__.code)
+      end
+    end
+  end
+end

data/lib/rspec/httpd/config.rb

@@ -0,0 +1,11 @@
+class RSpec::Httpd::Config
+  attr_accessor :host
+  attr_accessor :port
+  attr_accessor :command
+
+  def initialize
+    self.host = "127.0.0.1"
+    self.port = 12_345
+    self.command = "bundle exec rackup -E test -p 12345"
+  end
+end

data/lib/rspec/httpd/expectation.rb

@@ -0,0 +1,40 @@
+require "rspec/core"
+require "forwardable"
+require "logger"
+
+module RSpec::Httpd::Expectation
+  def do_expect_last_request(expected:, client:)
+    actual = client.result
+
+    ctx = {
+      request: client.request, actual: actual, expected: expected
+    }
+
+    case expected
+    when Regexp then expect(actual).to match(expected), -> { format_failure SHOULD_MATCH_ERROR, ctx }
+    when Hash   then expect(actual).to include(expected), -> { format_failure SHOULD_INCLUDE_ERROR, ctx }
+    else             expect(actual).to eq(expected), -> { format_failure SHOULD_EQUAL_ERROR, ctx }
+    end
+  end
+
+  SHOULD_MATCH_ERROR    = "%request -- %actual should match %expected".freeze
+  SHOULD_INCLUDE_ERROR  = "%request -- %actual should include %expected".freeze
+  SHOULD_EQUAL_ERROR    = "%request -- %actual should equal %expected".freeze
+
+  private
+
+  def format_failure(format, ctx)
+    format.gsub(/\%(\S+)/) do
+      value = ctx.fetch(Regexp.last_match(1).to_sym)
+      case value
+      when Net::HTTPGenericRequest
+        request = value
+        s = "#{request.method} #{request.path}"
+        s += " body:#{request.body.inspect}" if request.body
+        s
+      else
+        value.inspect
+      end
+    end
+  end
+end

data/lib/rspec/httpd/server.rb

@@ -0,0 +1,72 @@
+# rubocop:disable Lint/HandleExceptions
+
+require "socket"
+require "timeout"
+
+module RSpec::Httpd
+  module Server
+    MAX_STARTUP_TIME = 10
+
+    extend self
+
+    # builds and returns a server object.
+    #
+    # You can use this method to retrieve a client connection to a server
+    # specified via host:, port:, and, optionally, a command.
+    def start!(host:, port:, command:)
+      @servers ||= {}
+      @servers[[host, port, command]] ||= do_start(host, port, command)
+    end
+
+    private
+
+    def do_start(host, port, command)
+      logger = RSpec::Httpd.logger
+      logger.debug "Starting server: #{command}"
+
+      pid = spawn(command)
+
+      at_exit do
+        begin
+          logger.debug "Stopping server at pid #{pid}: #{command}"
+          Process.kill("KILL", pid)
+          sleep 0.2
+        rescue Errno::ESRCH
+        end
+
+        die "Cannot stop server at pid #{pid}: #{command}" if port_open?(host, port)
+      end
+
+      unless wait_for_server(host: host, port: port, pid: pid, timeout: MAX_STARTUP_TIME)
+        logger.error "server didn't start at http://#{host}:#{port} pid #{pid}: #{command}"
+        exit 1
+      end
+
+      logger.info "Started server at pid #{pid}: #{command}"
+      pid
+    end
+
+    def wait_for_server(host:, port:, pid:, timeout:)
+      while timeout > 0
+        sleep 0.1
+        return true if port_open?(host, port)
+        return false if Process.waitpid(pid, Process::WNOHANG)
+
+        timeout -= 0.1
+        next if timeout > 0
+
+        return false
+      end
+    end
+
+    def port_open?(host, port)
+      Timeout.timeout(0.01) do
+        s = TCPSocket.new(host, port)
+        s.close
+        return true
+      end
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
+      false
+    end
+  end
+end

data/lib/rspec/httpd/version.rb

@@ -0,0 +1,26 @@
+module RSpec::Httpd
+  module GemHelper
+    extend self
+
+    def version(name)
+      spec = Gem.loaded_specs[name]
+      return "unreleased" unless spec
+
+      version = spec.version.to_s
+      version += "+unreleased" if unreleased?(spec)
+      version
+    end
+
+    private
+
+    def unreleased?(spec)
+      return false unless defined?(Bundler::Source::Gemspec)
+      return true if spec.source.is_a?(::Bundler::Source::Gemspec)
+      return true if spec.source.is_a?(::Bundler::Source::Path)
+
+      false
+    end
+  end
+
+  VERSION = GemHelper.version "rspec-httpd"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-httpd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Enrico Thierbach
@@ -58,16 +58,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
 - README.md
-- Rakefile
 - VERSION
-- bin/console
-- bin/rubocop
 - lib/rspec-httpd.rb
-- rspec-httpd.gemspec
-- scripts/release
-- scripts/release.rb
+- lib/rspec/httpd.rb
+- lib/rspec/httpd/client.rb
+- lib/rspec/httpd/config.rb
+- lib/rspec/httpd/expectation.rb
+- lib/rspec/httpd/server.rb
+- lib/rspec/httpd/version.rb
 homepage: https://github.com/radiospiel/rspec-httpd
 licenses:
 - Nonstandard

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,18 +0,0 @@
-require "rubocop/rake_task"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new(:rubocop)
-
-desc "Run rspec and then rubocop"
-task default: [:spec, :rubocop]
-
-desc "release a new development gem version"
-task :release do
-  sh "scripts/release.rb"
-end
-
-desc "release a new stable gem version"
-task "release:stable" do
-  sh "BRANCH=stable scripts/release.rb"
-end

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-root=File.expand_path "#{File.dirname(__FILE__)}/.."
-$: << "#{root}/lib"
-
-require "bundler"
-Bundler.require
-
-require "irb"
-require "rspec-httpd"
-
-
-IRB.start
- 

data/bin/rubocop

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rubocop' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rubocop", "rubocop")

data/rspec-httpd.gemspec

@@ -1,23 +0,0 @@
-Gem::Specification.new do |s|
-  s.name        = "rspec-httpd"
-  s.version     = File.read("VERSION").chomp
-  s.date        = "2019-03-01"
-  s.summary     = "RSpec testing for HTTP requests"
-  s.description = "RSpec testing for HTTP requests"
-  s.authors     = ["Enrico Thierbach"]
-  s.email       = "eno@open-lab.org"
-  s.homepage    = "https://github.com/radiospiel/rspec-httpd"
-  s.license     = "Nonstandard"
-  s.files       = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).reject { |f| f.match(%r{tasks/|spec/|log/|^\.}) }
-
-  # Runtime dependencies of this gem:
-  # s.add_dependency 'activesupport', '~> 4.2.10'
-  # s.add_dependency 'expectation',   '1.1.1'
-  # s.add_dependency 'faraday',       '> 0.9'
-  # s.add_dependency 'uri_template',  '~> 0.7', '>= 0.7.0'
-
-  # Gems for dev and test env:
-  s.add_development_dependency "rake",        "~> 12.0"
-  s.add_development_dependency "rspec",       "~> 3.4"
-  s.add_development_dependency "rubocop",     "~> 0.65.0"
-end

data/scripts/release

@@ -1,2 +0,0 @@
-#!/bin/bash
-$0.rb "$@"

data/scripts/release.rb

@@ -1,92 +0,0 @@
-#!/usr/bin/env ruby
-
-# -- helpers ------------------------------------------------------------------
-
-def sys(cmd)
-  STDERR.puts "> #{cmd}"
-  system cmd
-  return true if $?.success?
-
-  STDERR.puts "> #{cmd} returned with exitstatus #{$?.exitstatus}"
-  $?.success?
-end
-
-def sys!(cmd, error: nil)
-  return true if sys(cmd)
-  STDERR.puts error if error
-  exit 1
-end
-
-def die!(msg)
-  STDERR.puts msg
-  exit 1
-end
-
-ROOT = File.expand_path("#{File.dirname(__FILE__)}/..")
-
-GEMSPEC = Dir.glob("*.gemspec").first || die!("Missing gemspec file.")
-
-# -- Version reading and bumping ----------------------------------------------
-
-module Version
-  extend self
-
-  VERSION_FILE = "#{Dir.getwd}/VERSION"
-
-  def read_version
-    version = File.exist?(VERSION_FILE) ? File.read(VERSION_FILE) : "0.0.1"
-    version.chomp!
-    raise "Invalid version number in #{VERSION_FILE}" unless version =~ /^\d+\.\d+\.\d+$/
-    version
-  end
-
-  def auto_version_bump
-    old_version_number = read_version
-    old = old_version_number.split('.')
-
-    current = old[0..-2] << old[-1].next
-    current.join('.')
-  end
-
-  def bump_version
-    next_version = ENV["VERSION"] || auto_version_bump
-    File.open(VERSION_FILE, "w") { |io| io.write next_version }
-  end
-end
-
-# -- check, bump, release a new gem version -----------------------------------
-
-Dir.chdir ROOT
-$BASE_BRANCH = ENV['BRANCH'] || 'master'
-
-# ENV["BUNDLE_GEMFILE"] = "#{Dir.getwd}/Gemfile"
-# sys! "bundle install"
-
-sys! "git diff --exit-code > /dev/null", error: 'There are unstaged changes in your working directory'
-sys! "git diff --cached --exit-code > /dev/null", error: 'There are staged but uncommitted changes'
-
-sys! "git checkout #{$BASE_BRANCH}"
-sys! "git pull"
-
-Version.bump_version
-version = Version.read_version
-
-sys! "git add VERSION"
-sys! "git commit -m \"bump gem to v#{version}\""
-sys! "git tag -a v#{version} -m \"Tag #{version}\""
-
-sys! "gem build #{GEMSPEC}"
-
-sys! "git push origin #{$BASE_BRANCH}"
-sys! 'git push --tags --force'
-
-sys! "gem push #{Dir.glob('*.gem').first}"
-
-sys! "mkdir -p pkg"
-sys! "mv *.gem pkg"
-
-STDERR.puts <<-MSG
-================================================================================
-Thank you for releasing a new gem version. You made my day.
-================================================================================
-    MSG