tcp-client 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91bdfe4046f3e4baeefe4a140d7a2bdb0cac02d3c069102e9c574fe02e5ca1c8
-  data.tar.gz: e26cc5ce187d50aba43d06403730445f3605667a4cffc5d4c7105dd549ca4c9a
+  metadata.gz: 3c5d814647f45ebfc5a5d43b6b0ae208092c36493bdc839c7e4e722c3ff4b1f0
+  data.tar.gz: 6187b371bb275f0cc88c63091dce51e91f45b79c5257580f881616433c581345
 SHA512:
-  metadata.gz: dfc647093949536fa3c040f9140ec5039a37934e1b77ccc3150f9c16a8de824123c7e8b374faa9479c5572a84f7cb9e08a051e356fe76e79d9245e10efd61bf4
-  data.tar.gz: 6046435c921660e284838c0e33559540f81de5f8b4c150ab63bf37ee72fc7605bc128d5c2b79d8ac7cb6cf657267bc445a4bef36103508ffaed4d6b0961d023c
+  metadata.gz: c48c0b4b0b9f14545895ae489f27d2a75a2c400598a342b553f8e7bbace7f2b4d9d9874f70e85ff40fe3ff4c59e2ea1973e8f324aceacb2705c7982fb1ebb772
+  data.tar.gz: 9c8259dcb4b9b351224627f08a84041d2d8bdf543233d0cefc2b14ed265d67a4b7a2b128bfe75fa4fd8a6b44bab527bb81a815a1edeefafcd85a4733d0064087

data/README.md

@@ -1,6 +1,6 @@
 # TCPClient
 
-A TCP client implementation with working timeout support.
+Use your TCP connections with working timeout.
 
 - Gem: [rubygems.org](https://rubygems.org/gems/tcp-client)
 - Source: [github.com](https://github.com/mblumtritt/tcp-client)
@@ -8,7 +8,8 @@ A TCP client implementation with working timeout support.
 
 ## Description
 
-This Gem implements a TCP client with (optional) SSL support. It is an easy to use, versatile configurable client that can correctly handle time limits. Unlike other implementations, this client respects predefined/configurable time limits for each method (`connect`, `read`, `write`). Deadlines for a sequence of read/write actions can also be monitored.
+This gem implements a customizable TCP client class that gives you control over time limits. You can set time limits for individual read or write calls or set a deadline for entire call sequences.
+It has a very small footprint, no dependencies and is easily useable.
 
 ## Sample
 
@@ -37,7 +38,7 @@ response =
 puts(response)
 ```
 
-For more samples see [the samples dir](https://github.com/mblumtritt/tcp-client/tree/main/sample)
+For more samples see [the examples dir](https://github.com/mblumtritt/tcp-client/tree/main/examples)
 
 ## Installation
 
@@ -61,7 +62,7 @@ To install the gem globally use:
 gem install tcp-client
 ```
 
-After that you need only a single line of code in your project to have on board:
+After that you need only a single line of code in your project to have it on board:
 
 ```ruby
 require 'tcp-client'

data/lib/tcp-client/version.rb

@@ -2,5 +2,5 @@
 
 class TCPClient
   # The current version number.
-  VERSION = '0.11.0'
+  VERSION = '0.11.1'
 end

metadata

@@ -1,79 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
-- !ruby/object:Gem::Dependency
-  name: yard
-  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'
+date: 2022-07-30 00:00:00.000000000 Z
+dependencies: []
 description: |
-  This Gem implements a TCP client with (optional) SSL support.
-  It is an easy to use, versatile configurable client that can correctly
-  handle time limits.
-  Unlike other implementations, this client respects
-  predefined/configurable time limits for each method
-  (`connect`, `read`, `write`). Deadlines for a sequence of read/write
-  actions can also be monitored.
+  This gem implements a customizable TCP client class that gives you control
+  over time limits. You can set time limits for individual read or write calls
+  or set a deadline for entire call sequences.
+  It has a very small footprint, no dependencies and is easily useable.
 email:
 executables: []
 extensions: []
@@ -81,11 +22,8 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- ".gitignore"
-- ".yardopts"
 - LICENSE
 - README.md
-- gems.rb
 - lib/tcp-client.rb
 - lib/tcp-client/address.rb
 - lib/tcp-client/configuration.rb
@@ -97,23 +35,13 @@ files:
 - lib/tcp-client/tcp_socket.rb
 - lib/tcp-client/version.rb
 - lib/tcp_client.rb
-- rakefile.rb
-- sample/google.rb
-- sample/google_ssl.rb
-- spec/helper.rb
-- spec/tcp-client/address_spec.rb
-- spec/tcp-client/configuration_spec.rb
-- spec/tcp-client/default_configuration_spec.rb
-- spec/tcp-client/version_spec.rb
-- spec/tcp_client_spec.rb
-- tcp-client.gemspec
 homepage: https://github.com/mblumtritt/tcp-client
 licenses:
 - BSD-3-Clause
 metadata:
   source_code_uri: https://github.com/mblumtritt/tcp-client
   bug_tracker_uri: https://github.com/mblumtritt/tcp-client/issues
-  documentation_uri: https://rubydoc.info/github/mblumtritt/tcp-client
+  documentation_uri: https://rubydoc.info/gems/tcp-client
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -132,11 +60,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A TCP client implementation with working timeout support.
-test_files:
-- spec/helper.rb
-- spec/tcp-client/address_spec.rb
-- spec/tcp-client/configuration_spec.rb
-- spec/tcp-client/default_configuration_spec.rb
-- spec/tcp-client/version_spec.rb
-- spec/tcp_client_spec.rb
+summary: Use your TCP connections with working timeout.
+test_files: []

data/.gitignore

@@ -1,6 +0,0 @@
-tmp/
-pkg/
-local/
-doc/
-.yardoc/
-gems.locked

data/.yardopts

@@ -1,5 +0,0 @@
---readme README.md
---title 'tcp-client Documentation'
---charset utf-8
---markup markdown
-'lib/**/*.rb' - 'LICENSE'

data/gems.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-gemspec

data/rakefile.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake/clean'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yard'
-
-$stdout.sync = $stderr.sync = true
-
-CLEAN << '.yardoc'
-CLOBBER << 'prj' << 'doc'
-
-task(:default) { exec('rake --tasks') }
-task(test: :spec)
-RSpec::Core::RakeTask.new { |task| task.ruby_opts = %w[-w] }
-YARD::Rake::YardocTask.new { |task| task.stats_options = %w[--list-undoc] }

data/sample/google.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tcp-client'
-
-# global configuration.
-# - 0.5 seconds to connect the server
-# - 0.25 seconds to write a single data junk
-# - 0.25 seconds to read some bytes
-TCPClient.configure do |cfg|
-  cfg.connect_timeout = 0.5
-  cfg.write_timeout = 0.25
-  cfg.read_timeout = 0.25
-end
-
-# request to Google:
-# - send a simple HTTP get request
-# - read 12 byte: "HTTP/1.1 " + 3 byte HTTP status code
-TCPClient.open('www.google.com:80') do |client|
-  p client.write("GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n")
-  p client.read(12)
-end

data/sample/google_ssl.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tcp-client'
-
-# create a configuration:
-# - don't use internal buffering
-# - use TLS 1.2 or TLS 1.3
-cfg =
-  TCPClient::Configuration.create(
-    buffered: false,
-    ssl_params: {
-      min_version: :TLS1_2,
-      max_version: :TLS1_3
-    }
-  )
-
-# request to Google.com:
-# - limit all network interactions to 1.5 seconds
-# - use the Configuration cfg
-# - send a simple HTTP get request
-# - read the returned message and headers
-response =
-  TCPClient.with_deadline(1.5, 'www.google.com:443', cfg) do |client|
-    client.write("GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n") #=> 40
-    client.readline("\r\n\r\n") #=> header, see response
-  end
-
-puts(response)

data/spec/helper.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec/core'
-require_relative '../lib/tcp-client'
-
-$stdout.sync = $stderr.sync = true
-
-RSpec.configure do |config|
-  config.disable_monkey_patching!
-  config.warnings = true
-  config.order = :random
-end

data/spec/tcp-client/address_spec.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../helper'
-
-RSpec.describe TCPClient::Address do
-  describe '.new' do
-    context 'when called with an Integer parameter' do
-      subject(:address) { TCPClient::Address.new(42) }
-
-      it 'points to the given port on localhost' do
-        expect(address.hostname).to eq 'localhost'
-        expect(address.port).to be 42
-        expect(address.to_s).to eq 'localhost:42'
-      end
-
-      it 'uses IPv6' do
-        expect(address.addrinfo.ip?).to be true
-        expect(address.addrinfo.ipv6?).to be true
-        expect(address.addrinfo.ipv4?).to be false
-      end
-    end
-
-    context 'when called with an Addrinfo' do
-      subject(:address) { TCPClient::Address.new(addrinfo) }
-      let(:addrinfo) { Addrinfo.tcp('::1', 42) }
-
-      it 'uses the given Addrinfo' do
-        expect(address.addrinfo).to eq addrinfo
-      end
-
-      it 'points to the given host and port' do
-        expect(address.hostname).to eq 'localhost'
-        expect(address.port).to be 42
-        expect(address.to_s).to eq 'localhost:42'
-      end
-
-      it 'uses IPv6' do
-        expect(address.addrinfo.ip?).to be true
-        expect(address.addrinfo.ipv6?).to be true
-        expect(address.addrinfo.ipv4?).to be false
-      end
-    end
-
-    context 'when called with a String' do
-      context 'when a host name and port is provided' do
-        subject(:address) { TCPClient::Address.new('localhost:42') }
-
-        it 'points to the given host and port' do
-          expect(address.hostname).to eq 'localhost'
-          expect(address.port).to be 42
-          expect(address.to_s).to eq 'localhost:42'
-          expect(address.addrinfo.ip?).to be true
-        end
-
-      end
-
-      context 'when only a port is provided' do
-        subject(:address) { TCPClient::Address.new(':42') }
-
-        it 'points to the given port on localhost' do
-          expect(address.hostname).to eq 'localhost'
-          expect(address.port).to be 42
-          expect(address.to_s).to eq 'localhost:42'
-          expect(address.addrinfo.ip?).to be true
-        end
-      end
-
-      context 'when an IPv6 address is provided' do
-        subject(:address) { TCPClient::Address.new('[::1]:42') }
-
-        it 'points to the given port on localhost' do
-          expect(address.hostname).to eq '::1'
-          expect(address.port).to be 42
-          expect(address.to_s).to eq '[::1]:42'
-          expect(address.addrinfo.ip?).to be true
-        end
-      end
-    end
-  end
-
-  describe '#to_h' do
-    subject(:address) { TCPClient::Address.new('localhost:42') }
-
-    it 'returns itself as an Hash' do
-      expect(address.to_h).to eq(host: 'localhost', port: 42)
-    end
-  end
-
-  describe 'comparison' do
-    context 'comparing two equal instances' do
-      let(:address_a) { TCPClient::Address.new('localhost:42') }
-      let(:address_b) { TCPClient::Address.new('localhost:42') }
-
-      it 'compares to equal' do
-        expect(address_a).to eq address_b
-      end
-
-      context 'using the == operator' do
-        it 'compares to equal' do
-          expect(address_a == address_b).to be true
-        end
-      end
-
-      context 'using the === operator' do
-        it 'compares to equal' do
-          expect(address_a === address_b).to be true
-        end
-      end
-    end
-
-    context 'comparing two non-equal instances' do
-      let(:address_a) { TCPClient::Address.new('localhost:42') }
-      let(:address_b) { TCPClient::Address.new('localhost:21') }
-
-      it 'compares not to equal' do
-        expect(address_a).not_to eq address_b
-      end
-
-      context 'using the == operator' do
-        it 'compares not to equal' do
-          expect(address_a == address_b).to be false
-        end
-      end
-
-      context 'using the === operator' do
-        it 'compares not to equal' do
-          expect(address_a === address_b).to be false
-        end
-      end
-    end
-  end
-end