online 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b676e3f37ff58fe5ad57c2bebe0afafeb9c522e18113ff6098f456f18b4d4df0
-  data.tar.gz: c388c79309f619b4f9c5ffc58a680859281396d029ebf6fb3dbb2feddcf3571c
+  metadata.gz: e39ddd7a39de7638e54b088e1f350444bf0922860082e55d0705524b1df08dec
+  data.tar.gz: 88cdb650e021f7f195c7394c23b84166a54345d322c75ee603ab51e4033d88fd
 SHA512:
-  metadata.gz: 5576f41fd242027a3401a428c491b9b507550460dab23505ae24b17ea833f5d352336a8485b6099b01de031d9b9d5b3ecdcc52ba4d32fb929aadddfcef38fd49
-  data.tar.gz: '0068189a76b8a4da93194471c7d0798fb102c608f09c8e5cbccb9ada926e44b6dbed4f95939da4276d9c52ba364571fbb40b00a6913b270b0e793ac7bcb00e2b'
+  metadata.gz: 7103a153d77be803ba028d2c5321cbb7a4ea76df9d77fe0a5d0922ef2bd8ab9f7ca27599a1466ed787f8f6e2e528589321c625aa8879a3c6b38cb8af418030fd
+  data.tar.gz: 0d52eed0528be475ae2346833af45d7df78fc54d2160467e80b614c45e5313ac1509042f47ae7eb9961006be26dc8d4a2e8bf04b1730a0ec2351fa88d34bd56a

data/Gemfile.lock

@@ -11,34 +11,34 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ansi (1.5.0)
     ast (2.4.3)
-    bigdecimal (3.2.2)
+    bigdecimal (3.3.1)
     builder (3.3.0)
-    crack (1.0.0)
+    crack (1.0.1)
       bigdecimal
       rexml
     docile (1.4.1)
-    hashdiff (1.2.0)
-    json (2.13.2)
+    hashdiff (1.2.1)
+    json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    minitest (5.25.5)
+    minitest (5.26.2)
     minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
+    prism (1.5.2)
     public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
-    regexp_parser (2.11.2)
-    rexml (3.4.2)
-    rubocop (1.80.2)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -46,20 +46,20 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.46.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.46.0)
+    rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.2)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
-    rubocop-performance (1.26.0)
+    rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
@@ -74,14 +74,14 @@ GEM
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     timeout (0.4.3)
-    unicode-display_width (3.1.5)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    webmock (3.25.1)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    webmock (3.26.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.37)
+    yard (0.9.38)
 
 PLATFORMS
   aarch64-linux

data/README.md

@@ -44,6 +44,15 @@ if online?(ttl: 3)
 end
 ```
 
+You can specify HTTP timeout (in seconds) to prevent hanging on slow connections,
+for example:
+
+```ruby
+if online?(timeout: 2)
+  # We are online, if the timeout has not expired
+end
+```
+
 That's it.
 
 ## How to contribute

data/Rakefile

@@ -33,6 +33,7 @@ require 'yard'
 desc 'Build Yard documentation'
 YARD::Rake::YardocTask.new do |t|
   t.files = ['lib/**/*.rb']
+  t.options = ['--fail-on-warning']
 end
 
 require 'rubocop/rake_task'

data/lib/online.rb

@@ -30,8 +30,9 @@ module Kernel
   # for checking internet availability before performing network-dependent operations
   # or for implementing offline-mode functionality in applications.
   #
-  # @param uri [String] the URI to check connectivity against (default: 'http://www.google.com')
+  # @param uri [String] the URI to check connectivity against (default: 'https://www.google.com/generate_204')
   # @param ttl [Integer] time-to-live for cached results in seconds (default: 300 seconds = 5 minutes)
+  # @param timeout [Integer] open, read and write HTTP timeout (default: 10 seconds)
   # @return [Boolean] true if the URI is reachable and returns HTTP success, false otherwise
   #
   # @example Basic usage - check internet connectivity
@@ -85,18 +86,28 @@ module Kernel
   # @note Returns false for any network-related errors including timeouts, DNS failures,
   #   and unreachable hosts
   # @note Results are cached with a default TTL of 5 minutes to reduce network requests
-  def online?(uri: 'http://www.google.com', ttl: 300)
+  def online?(uri: 'https://www.google.com/generate_204', ttl: 300, timeout: 10)
     raise 'The URI is nil' if uri.nil?
     raise 'The TTL is nil' if ttl.nil?
     key = uri.to_s
     OnlineOrOffline.mutex.synchronize do
       entry = OnlineOrOffline.cache[key]
       return entry[:status] if entry && (Time.now - entry[:time]) < ttl
+      uri = URI(uri) unless uri.is_a?(URI)
       status =
-        Timeout.timeout(10) do
-          Net::HTTP.get_response(URI(uri)).is_a?(Net::HTTPSuccess)
+        begin
+          Net::HTTP.start(
+            uri.hostname,
+            uri.port,
+            use_ssl: uri.scheme == 'https',
+            open_timeout: timeout,
+            read_timeout: timeout,
+            write_timeout: timeout
+          ) do |http|
+            http.request_get(uri, {}).is_a?(Net::HTTPSuccess)
+          end
         rescue \
-          Timeout::Error, Timeout::ExitException, Socket::ResolutionError,
+          Socket::ResolutionError, Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout,
           Errno::EHOSTUNREACH, Errno::EINVAL, Errno::EADDRNOTAVAIL, Errno::EBADF
           false
         end

data/online.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'online'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'Checks whether we are currently online or offline'
   s.description =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: online
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko