bane 0.4.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2M3MGZkYWY0NDNhNjZlYTY5M2I2MGViMDljNjY3YzRiYmY2MDg3OA==
-  data.tar.gz: !binary |-
-    OWY2YTY3ZDFmNDU4Y2I1MzEwZjViNDIzZGU0YzMzNzk4ZjdiMmIxOA==
+SHA256:
+  metadata.gz: 6f238270f71940d8a67a36a5a57f99c0ba77f05ba8c5af3a9ea9805c1d527d12
+  data.tar.gz: 7da73073b9fcd740d5c64e609d963191ccd411b20dd2fbd700618b9c21744cd1
 SHA512:
-  metadata.gz: !binary |-
-    ODE5MDJlYzkyMzNmYzllYzRlMTAwY2RjYjNhYzlkNjA1NTU0ODRiZmNhOGZh
-    NjczN2E4ZjM4YjcyMjUyYTBlODUxNjVkM2NiODc4MjIyM2Q2MjE3OWNmYzk0
-    YmFjZmVlNzVmYjMyOGE4ZmJhZmYzYzU3MTljOWMyODc5YjRiYjM=
-  data.tar.gz: !binary |-
-    MmI5ZjZmYjM5YTczYzQ0NjFmYjNlMTBlY2I5ZmJiY2ZkMmQ4MDM5MjczYjgw
-    MTJkMWQxOTVkOTExN2FiMjVjNjUxOGRlOWU1YTc3OGUxMjUxNDM1Mjk1Zjkw
-    NDU5YzgzYzE2OGQ0MTY4OTdlY2RjYzNlNDM0ZDEyZmEyMGI3YzI=
+  metadata.gz: 59df1b491b22c50e6ab0cd4adeaa633f6d3089c05b489fafeffad196c5ce75376940454575d3d208e65efb7b5cf618ceedaae0fd9cec87de0f37108149cab0d8
+  data.tar.gz: 662f09c29e1dbe1da105fac39891ee68893afc014dd1f56f49f099986c13ef8c3d7a0964b470bd495900310b104e8a34f28cc1d86d30337b202e5a377a4ddf2e

data/HISTORY.md

@@ -0,0 +1,49 @@
+# master
+
+## 1.0.0
+
+### Changed
+ * Support Ruby 2.5+. This meant adding a dependency on 'gserver', which was moved out of the standard library.
+
+## 0.4.0
+
+### Added
+ * The EchoResponse behavior which replies with each line sent
+ * The TimeoutInListenQueue server which binds to a port but never calls listen(2)
+ * Trap SIGINT to gracefully stop servers without a messy exception stacktrace
+
+### Removed
+ * The fancy, flexible ConfigurationParser has been deleted. Command-line invocation now uses the CommandLineConfiguration parser.  For programmatic invocation, see the examples.
+ * Ruby 1.8.7 support
+
+### Changed
+  * Rearranged packages to create Bane::Behaviors::Servers and Bane::Beaviors::Responders.  Servers may be started and stopped; Responders simply interact with an already connected socket.
+  * Added Bane::Behaviors::Servers::LOCALHOST (127.0.0.1) and deprecated Bane::Behaviors::Servers::DEFAULT_HOST; please use LOCALHOST when specifying a host to listen on.
+
+## 0.3.0
+
+### Added
+ * Servers can now listen on all hosts or localhost via the command-line options -a / --listen-on-all-hosts or -l / --listen-on-localhost.  The default is to listen on localhost.
+
+
+### Changed
+ * Behaviors receive their parameters through their constructors instead of being passed via the serve method.  That is,
+  the serve(io, options) method has been changed to serve(io).  Behaviors that need to accept user-specified parameters
+  should accept them via constructor arguments, and should provide a default version since the command-line interface
+  does not specify options.  e.g.
+
+```
+class MyBehavior
+   def initialize(options = {})
+   ...
+```
+
+* BehaviorServer no longer accepts options; instead these are created with the Behavior objects.
+* Configuration() and ConfigurationParser class are deprecated and will be removed in the next release.  Instead of 
+  using these classes, please directly instantiate a BehaviorServer with the required arguments.  This class is being
+  deprecated and removed because the flexibility of the code creates a structure that is harder to read and maintain.
+  I'm also not sure anyone is using this method -- if so, please open a GitHub Issue and let me know if you're using 
+  it -- and if so, how.
+
+
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010, Daniel J. Wellman
+Copyright (c) 2021, Daniel J. Wellman
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/README.md

@@ -16,7 +16,7 @@ Bane is available as a Ruby gem.  Install it with
 
 Note that Bane installs an executable, `bane`.  Simply invoke `bane` with no arguments to get a usage description.
 
-Bane requires Ruby 1.9 or later.  If you would like to use a Ruby 1.8.7-compatible version, install version 0.3.0.
+Bane requires Ruby 2.5 or later.
 
 ## Usage
 
@@ -80,6 +80,7 @@ Note that these are simple protocol-independent socket behaviors:
 * The server accepts a connection and then drops it immediately (CloseImmediately)
 * The service can send megabytes when kilobytes are expected. (rough approximation with the DelugeReponse)
 * The service can refuse all authentication credentials. (HttpRefuseAllCredentials)
+* The request can sit in a listen queue until the caller times out. (TimeoutInListenQueue)
 
 The following behaviors are not yet supported; they require the configuration of an HTTP server.
 See the implementation of HttpRefuseAllCredentials for a simple example of an HTTP behavior.
@@ -91,7 +92,6 @@ The following behaviors are not yet supported. These require the ability to mani
 TCP packets at a low level, which may require a C or C++ extension or raw sockets.
 
 * The connection can be refused.
-* The request can sit in a listen queue until the caller times out.
 * The remote end can reply with a SYN/ACK and then never send any data.
 * The remote end can send nothing but RESET packets.
 * The remote end can report a full receive window and never drain the data.

data/lib/bane/arguments_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module Bane

data/lib/bane/behavior_maker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
 
   class BehaviorMaker
@@ -28,12 +30,12 @@ module Bane
 
   class ResponderMaker
     def initialize(responder)
-      @responer = responder
+      @responder = responder
     end
 
     def make(port, host)
-      Behaviors::Servers::ResponderServer.new(port, @responer.new, host)
+      Behaviors::Servers::ResponderServer.new(port, @responder.new, host)
     end
   end
 
-end
+end

data/lib/bane/behaviors/responders/close_after_pause.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/close_immediately.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/deluge_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/echo_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/exported.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/fixed_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/for_each_line.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/http_refuse_all_credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/never_respond.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/newline_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/random_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/responders/slow_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Responders

data/lib/bane/behaviors/servers/exported.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
   module Behaviors
     module Servers

data/lib/bane/behaviors/servers/responder_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gserver'
 
 module Bane

data/lib/bane/behaviors/servers/timeout_in_listen_queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module Bane

data/lib/bane/command_line_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
 
   def self.find_makeables

data/lib/bane/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless Class.respond_to?(:unqualified_name)
   class Class
     def unqualified_name

data/lib/bane/launcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bane
 
   class Launcher

data/lib/bane/naive_http_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NaiveHttpResponse
 
   CRLF        = "\r\n"

data/lib/bane/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bane
+  VERSION = '1.0.0'
+end

data/lib/bane.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bane/extensions'
 require 'bane/behavior_maker'
 require 'bane/behaviors/responders/for_each_line'

metadata

@@ -1,104 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: bane
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Wellman
 - Joe Leo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.5
-- !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '6.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '6.3'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: gserver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
-  type: :development
+        version: 0.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! "    Bane is a test harness used to test your application's interaction
-  with\n    other servers. It is based upon the material from Michael Nygard's \"Release\n
-  \   It!\" book as described in the \"Test Harness\" chapter.\n"
-email: dan@danielwellman.com
+        version: 0.0.1
+description: |
+  Bane is a test harness used to test your application's interaction with
+      other servers. It is based upon the material from Michael Nygard's "Release
+      It!" book as described in the "Test Harness" chapter.
+email:
+- dan@danielwellman.com
 executables:
 - bane
 extensions: []
@@ -107,14 +67,11 @@ extra_rdoc_files:
 - README.md
 - TODO
 files:
+- HISTORY.md
 - LICENSE
 - README.md
-- Rakefile
 - TODO
 - bin/bane
-- examples/multiple_behaviors.rb
-- examples/readme_example.rb
-- examples/single_behavior.rb
 - lib/bane.rb
 - lib/bane/arguments_parser.rb
 - lib/bane/behavior_maker.rb
@@ -137,50 +94,30 @@ files:
 - lib/bane/extensions.rb
 - lib/bane/launcher.rb
 - lib/bane/naive_http_response.rb
-- test/bane/acceptance_test.rb
-- test/bane/arguments_parser_test.rb
-- test/bane/bane_test.rb
-- test/bane/behaviors/responders/close_after_pause_test.rb
-- test/bane/behaviors/responders/close_immediately_test.rb
-- test/bane/behaviors/responders/deluge_response_test.rb
-- test/bane/behaviors/responders/echo_response_test.rb
-- test/bane/behaviors/responders/fixed_response_test.rb
-- test/bane/behaviors/responders/for_each_line_test.rb
-- test/bane/behaviors/responders/http_refuse_all_credentials_test.rb
-- test/bane/behaviors/responders/never_respond_test.rb
-- test/bane/behaviors/responders/newline_response_test.rb
-- test/bane/behaviors/responders/random_response_test.rb
-- test/bane/behaviors/responders/slow_response_test.rb
-- test/bane/behaviors/servers/responder_server_test.rb
-- test/bane/behaviors/servers/timeout_in_listen_queue_test.rb
-- test/bane/command_line_configuration_test.rb
-- test/bane/extensions_test.rb
-- test/bane/fake_connection_test.rb
-- test/bane/launchable_role_tests.rb
-- test/bane/naive_http_response_test.rb
-- test/test_helper.rb
-homepage: http://github.com/danielwellman/bane
+- lib/bane/version.rb
+homepage: https://github.com/danielwellman/bane
 licenses:
 - BSD
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/danielwellman/bane
+  changelog_uri: https://github.com/danielwellman/bane/blob/main/HISTORY.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A test harness for socket connections based upon ideas from Michael Nygard's
   'Release It!'

data/Rakefile

@@ -1,51 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "bane"
-  gem.homepage = "http://github.com/danielwellman/bane"
-  gem.license = "BSD"
-  gem.summary = "A test harness for socket connections based upon ideas from Michael Nygard's 'Release It!'"
-  gem.description = <<-END
-    Bane is a test harness used to test your application's interaction with
-    other servers. It is based upon the material from Michael Nygard's "Release
-    It!" book as described in the "Test Harness" chapter.
-  END
-  gem.authors = ["Daniel Wellman", "Joe Leo"]
-  gem.email = "dan@danielwellman.com"
-  gem.files = FileList[ 'lib/**/*', 'bin/*', 'test/**/*', 'examples/*',
-    'Rakefile' ]
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.test_files =  FileList['test/**/*_test.rb']
-  test.verbose    =  true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "list #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/examples/multiple_behaviors.rb

@@ -1,25 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-include Behaviors
-
-# This example creates several behavior listening on distinct ports.
-# Note the FixedResponse port specifies to listen to all hosts (0.0.0.0), all
-# other servers listen to localhost only by default (127.0.0.1).
-
-close_immediately = Responders::CloseImmediately.new
-never_respond = Responders::NeverRespond.new
-fixed_response = Responders::FixedResponse.new(message: "OK")
-
-launcher = Launcher.new([Servers::ResponderServer.new(3000, close_immediately),
-                         Servers::ResponderServer.new(8000, never_respond),
-                         Servers::ResponderServer.new(8080, fixed_response, Servers::ALL_INTERFACES)])
-launcher.start
-# To run until interrupt, use the following line:
-#launcher.join
-
-# For examples, we'll let these sleep for a few seconds and then shut down'
-sleep 10
-launcher.stop
-

data/examples/readme_example.rb

@@ -1,10 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-include Behaviors
-
-launcher = Launcher.new(
-        [Servers::ResponderServer.new(3000, Responders::FixedResponse.new(message: "Shall we play a game?"))])
-launcher.start
-launcher.join

data/examples/single_behavior.rb

@@ -1,19 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-include Behaviors
-
-# This example creates a single behavior listening on port 3000.
-# Note that the behavior, CloseAfterPause, specifies a default duration to pause - 60 seconds.
-
-behavior = Servers::ResponderServer.new(3000, Responders::CloseAfterPause.new(duration: 60))
-launcher = Launcher.new([behavior])
-launcher.start
-# To run until interrupt, use the following line:
-#launcher.join
-
-# For examples, we'll let these sleep for a few seconds and then shut down'
-sleep 10
-launcher.stop
-

data/test/bane/acceptance_test.rb

@@ -1,65 +0,0 @@
-require_relative '../test_helper'
-require 'mocha/setup'
-
-class BaneAcceptanceTest < Test::Unit::TestCase
-
-  include ServerTestHelpers
-
-  TEST_PORT = 4000
-
-  def test_uses_specified_port_and_server
-    run_server_with(TEST_PORT, Bane::Behaviors::Responders::FixedResponse) do
-      with_response_from TEST_PORT do |response|
-        assert !response.empty?, "Should have had a non-empty response"
-      end
-    end
-  end
-
-  def test_serves_http_requests
-    run_server_with(TEST_PORT, Bane::Behaviors::Responders::HttpRefuseAllCredentials) do
-      assert_match /401/, status_returned_from("http://localhost:#{TEST_PORT}/some/url")
-    end
-  end
-
-  def test_supports_command_line_interface
-    run_server_with_cli_arguments(["--listen-on-localhost", TEST_PORT, "FixedResponse"]) do
-      with_response_from TEST_PORT do |response|
-        assert !response.empty?, "Should have had a non-empty response"
-      end
-    end
-  end
-
-  private
-
-  def run_server_with(port, behavior, &block)
-    behavior = Bane::Behaviors::Servers::ResponderServer.new(port, behavior.new)
-    launcher = Bane::Launcher.new([behavior], quiet_logger)
-    launch_and_stop_safely(launcher, &block)
-    sleep 0.1 # Until we can fix the GServer stopping race condition (Issue #7)
-  end
-
-  def run_server_with_cli_arguments(arguments, &block)
-    config = Bane::CommandLineConfiguration.new(Bane.find_makeables)
-    launcher = Bane::Launcher.new(config.process(arguments), quiet_logger) { |error| raise error }
-    launch_and_stop_safely(launcher, &block)
-    sleep 0.1 # Until we can fix the GServer stopping race condition (Issue #7)
-  end
-
-  def quiet_logger
-    StringIO.new
-  end
-
-  def status_returned_from(uri)
-    Net::HTTP.get_response(URI(uri)).code
-  end
-
-  def with_response_from(port)
-    begin
-      connection = TCPSocket.new "localhost", port
-      yield connection.read
-    ensure
-      connection.close if connection
-    end
-  end
-
-end