online 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5c935181fd3681e830413f863498954281f1f498b5456a5920cb89937d4780b
-  data.tar.gz: f22371f34837a12d6efaf0b5491820606139ab68e7921b75720bea78d3150951
+  metadata.gz: b676e3f37ff58fe5ad57c2bebe0afafeb9c522e18113ff6098f456f18b4d4df0
+  data.tar.gz: c388c79309f619b4f9c5ffc58a680859281396d029ebf6fb3dbb2feddcf3571c
 SHA512:
-  metadata.gz: d75348162f7d9de1725c54bedff46f5b7ddaccfa2c91e3e9750a495857dc590a2eb61aecf65c4147536109663cd5c4430777b7321b842c990c27b7100794f8e4
-  data.tar.gz: 34c271a32fe2bcad4048b5d2e0f8890bd24e5c3a968c7048c4b5ce0076f25554be1076929d25fd66e651d96c613857bf1a6a1142cd9c6f9f7e2b7ed2fe132586
+  metadata.gz: 5576f41fd242027a3401a428c491b9b507550460dab23505ae24b17ea833f5d352336a8485b6099b01de031d9b9d5b3ecdcc52ba4d32fb929aadddfcef38fd49
+  data.tar.gz: '0068189a76b8a4da93194471c7d0798fb102c608f09c8e5cbccb9ada926e44b6dbed4f95939da4276d9c52ba364571fbb40b00a6913b270b0e793ac7bcb00e2b'

data/Gemfile

@@ -10,10 +10,10 @@ gem 'minitest', '~>5.25', require: false
 gem 'minitest-reporters', '~>1.7', require: false
 gem 'rake', '~>13.2', require: false
 gem 'rubocop', '~>1.73', require: false
-gem 'rubocop-minitest', '>0', require: false
-gem 'rubocop-performance', '>0', require: false
-gem 'rubocop-rake', '>0', require: false
+gem 'rubocop-minitest', '~>0.38', require: false
+gem 'rubocop-performance', '~>1.25', require: false
+gem 'rubocop-rake', '~>0.7', require: false
 gem 'simplecov', '~>0.22', require: false
-gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'simplecov-cobertura', '~>3.0', require: false
 gem 'webmock', '~>3.25', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -18,7 +18,7 @@ GEM
       rexml
     docile (1.4.1)
     hashdiff (1.2.0)
-    json (2.12.2)
+    json (2.13.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     minitest (5.25.5)
@@ -28,7 +28,7 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
@@ -36,9 +36,9 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
-    regexp_parser (2.10.0)
-    rexml (3.4.1)
-    rubocop (1.77.0)
+    regexp_parser (2.11.2)
+    rexml (3.4.2)
+    rubocop (1.80.2)
       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.45.1, < 2.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
+    rubocop-ast (1.46.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-minitest (0.38.1)
+    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.25.0)
+    rubocop-performance (1.26.0)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
@@ -68,13 +68,13 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
+    simplecov-cobertura (3.1.0)
       rexml
       simplecov (~> 0.19)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     timeout (0.4.3)
-    unicode-display_width (3.1.4)
+    unicode-display_width (3.1.5)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     webmock (3.25.1)
@@ -99,11 +99,11 @@ DEPENDENCIES
   online!
   rake (~> 13.2)
   rubocop (~> 1.73)
-  rubocop-minitest (> 0)
-  rubocop-performance (> 0)
-  rubocop-rake (> 0)
+  rubocop-minitest (~> 0.38)
+  rubocop-performance (~> 1.25)
+  rubocop-rake (~> 0.7)
   simplecov (~> 0.22)
-  simplecov-cobertura (~> 2.1)
+  simplecov-cobertura (~> 3.0)
   webmock (~> 3.25)
   yard (~> 0.9)
 

data/README.md

@@ -26,6 +26,26 @@ if online?
 end
 ```
 
+You can also check a particular URL:
+
+```ruby
+if online?(uri: 'https://api.github.com')
+  # GitHub API is accessible
+end
+```
+
+The `online?()` function doesn't make an HTTP request on each call, but
+instead caches the previous result for five minutes. You can change this
+interval to three seconds, for example:
+
+```ruby
+if online?(ttl: 3)
+  # We are online, let's run integration tests!
+end
+```
+
+That's it.
+
 ## How to contribute
 
 Read

data/lib/online.rb

@@ -86,6 +86,8 @@ module Kernel
   #   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)
+    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]
@@ -95,7 +97,7 @@ module Kernel
           Net::HTTP.get_response(URI(uri)).is_a?(Net::HTTPSuccess)
         rescue \
           Timeout::Error, Timeout::ExitException, Socket::ResolutionError,
-          Errno::EHOSTUNREACH, Errno::EINVAL, Errno::EADDRNOTAVAIL
+          Errno::EHOSTUNREACH, Errno::EINVAL, Errno::EADDRNOTAVAIL, Errno::EBADF
           false
         end
       OnlineOrOffline.cache[key] = { status: status, time: Time.now }

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.0.1'
+  s.version = '0.1.0'
   s.license = 'MIT'
   s.summary = 'Checks whether we are currently online or offline'
   s.description =
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'https://github.com/yegor256/online'
-  s.files = `git ls-files`.split($RS)
+  s.files = `git ls-files | grep -v -E '^(test/|\\.|renovate)'`.split($RS)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: online
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -33,22 +33,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".0pdd.yml"
-- ".gitattributes"
-- ".github/workflows/actionlint.yml"
-- ".github/workflows/codecov.yml"
-- ".github/workflows/copyrights.yml"
-- ".github/workflows/markdown-lint.yml"
-- ".github/workflows/pdd.yml"
-- ".github/workflows/rake.yml"
-- ".github/workflows/reuse.yml"
-- ".github/workflows/typos.yml"
-- ".github/workflows/xcop.yml"
-- ".github/workflows/yamllint.yml"
-- ".gitignore"
-- ".pdd"
-- ".rubocop.yml"
-- ".rultor.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -58,9 +42,6 @@ files:
 - Rakefile
 - lib/online.rb
 - online.gemspec
-- renovate.json
-- test/test__helper.rb
-- test/test_online.rb
 homepage: https://github.com/yegor256/online
 licenses:
 - MIT
@@ -81,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Checks whether we are currently online or offline
 test_files: []

data/.0pdd.yml

@@ -1,8 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-errors:
-  - yegor256@gmail.com
-# alerts:
-#   github:
-#     - yegor256

data/.gitattributes

@@ -1,7 +0,0 @@
-# Check out all text files in UNIX format, with LF as end of line
-# Don't change this file. If you have any ideas about it, please
-# submit a separate issue about it and we'll discuss.
-
-* text=auto eol=lf
-*.java ident
-*.xml ident

data/.github/workflows/actionlint.yml

@@ -1,25 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: actionlint
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  actionlint:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - name: Download actionlint
-        id: get_actionlint
-        run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
-        shell: bash
-      - name: Check workflow files
-        run: ${{ steps.get_actionlint.outputs.executable }} -color
-        shell: bash

data/.github/workflows/codecov.yml

@@ -1,25 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: codecov
-'on':
-  push:
-    branches:
-      - master
-jobs:
-  codecov:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.3
-          bundler-cache: true
-      - run: bundle config set --global path "$(pwd)/vendor/bundle"
-      - run: bundle install --no-color
-      - run: bundle exec rake
-      - uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

data/.github/workflows/copyrights.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: copyrights
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  copyrights:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.12

data/.github/workflows/markdown-lint.yml

@@ -1,23 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: markdown-lint
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-    paths-ignore: ['paper/**', 'sandbox/**']
-concurrency:
-  group: markdown-lint-${{ github.ref }}
-  cancel-in-progress: true
-jobs:
-  markdown-lint:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: DavidAnson/markdownlint-cli2-action@v20.0.0

data/.github/workflows/pdd.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: pdd
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  pdd:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -1,28 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: rake
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  rake:
-    strategy:
-      matrix:
-        os: [ubuntu-24.04, macos-15]
-        ruby: [3.3]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle config set --global path "$(pwd)/vendor/bundle"
-      - run: bundle install --no-color
-      - run: bundle exec rake

data/.github/workflows/reuse.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: reuse
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  reuse:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: fsfe/reuse-action@v5

data/.github/workflows/typos.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: typos
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  typos:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: crate-ci/typos@v1.33.1

data/.github/workflows/xcop.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: xcop
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  xcop:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: g4s8/xcop-action@master

data/.github/workflows/yamllint.yml

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-name: yamllint
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  yamllint:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ibiqlik/action-yamllint@v3

data/.gitignore

@@ -1,13 +0,0 @@
-
-.bundle/
-.DS_Store
-.idea/
-.yardoc/
-*.gem
-**/.claude/settings.local.json
-coverage/
-doc/
-node_modules/
-rdoc/
-temp/
-vendor/

data/.pdd

@@ -1,7 +0,0 @@
---source=.
---verbose
---exclude target/**/*
---exclude coverage/**/*
---rule min-words:20
---rule min-estimate:15
---rule max-estimate:90

data/.rubocop.yml

@@ -1,53 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'assets/**/*'
-    - 'vendor/**/*'
-  DisplayCopNames: true
-  TargetRubyVersion: 3.2
-  SuggestExtensions: false
-  NewCops: enable
-plugins:
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-Minitest/EmptyLineBeforeAssertionMethods:
-  Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
-Style/GlobalVars:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-Layout/CaseIndentation:
-  Enabled: false
-Naming/MethodParameterName:
-  MinNameLength: 2
-Layout/EndOfLine:
-  EnforcedStyle: lf
-Layout/MultilineAssignmentLayout:
-  Enabled: true
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-require: []

data/.rultor.yml

@@ -1,26 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
----
-# yamllint disable rule:line-length
-docker:
-  image: yegor256/ruby
-assets:
-  rubygems.yml: yegor256/home#assets/rubygems.yml
-install: |
-  pdd -f /dev/null
-  bundle install --no-color
-release:
-  pre: false
-  script: |-
-    [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
-    bundle exec rake
-    rm -rf *.gem
-    sed -i "s/0\.0\.0/${tag}/g" online.gemspec
-    git add online.gemspec
-    git commit -m "version set to ${tag}"
-    gem build online.gemspec
-    chmod 0600 ../rubygems.yml
-    gem push *.gem --config-file ../rubygems.yml
-merge:
-  script: |-
-    bundle exec rake

data/renovate.json

@@ -1,6 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:base"
-  ]
-}

data/test/test__helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
-
-$stdout.sync = true
-
-require 'simplecov'
-require 'simplecov-cobertura'
-unless SimpleCov.running || ENV['PICKS']
-  SimpleCov.command_name('test')
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
-    [
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::CoberturaFormatter
-    ]
-  )
-  SimpleCov.minimum_coverage 95
-  SimpleCov.minimum_coverage_by_file 95
-  SimpleCov.start do
-    add_filter 'test/'
-    add_filter 'vendor/'
-    add_filter 'target/'
-    track_files 'lib/**/*.rb'
-    track_files '*.rb'
-  end
-end
-
-require 'minitest/autorun'
-require 'minitest/reporters'
-Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]

data/test/test_online.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
-
-require 'webmock/minitest'
-require_relative 'test__helper'
-require_relative '../lib/online'
-
-# Test.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
-# License:: MIT
-class TestOnline < Minitest::Test
-  def setup
-    Kernel::OnlineOrOffline.cache = {}
-  end
-
-  def test_when_online
-    WebMock.disable_net_connect!
-    stub_request(:get, 'http://www.google.com/').to_return(body: '')
-    assert_predicate(self, :online?)
-  end
-
-  def test_when_offline
-    WebMock.disable_net_connect!
-    stub_request(:get, 'http://www.google.com/').to_raise(Socket::ResolutionError, 'failure')
-    refute_predicate(self, :online?)
-  end
-
-  def test_cache_returns_same_result
-    WebMock.disable_net_connect!
-    stub_request(:get, 'http://www.google.com/').to_return(body: '')
-    assert_predicate(self, :online?)
-    WebMock.reset!
-    stub_request(:get, 'http://www.google.com/').to_raise(Socket::ResolutionError, 'failure')
-    assert_predicate(self, :online?)
-  end
-
-  def test_cache_expires_after_ttl
-    WebMock.disable_net_connect!
-    stub_request(:get, 'http://www.google.com/').to_return(body: '')
-    assert online?(ttl: 0)
-    WebMock.reset!
-    stub_request(:get, 'http://www.google.com/').to_raise(Socket::ResolutionError, 'failure')
-    refute online?(ttl: 0)
-  end
-
-  def test_different_uris_cached_separately
-    WebMock.disable_net_connect!
-    stub_request(:get, 'http://www.google.com/').to_return(body: '')
-    stub_request(:get, 'http://example.com/').to_raise(Socket::ResolutionError, 'failure')
-    assert online?(uri: 'http://www.google.com')
-    refute online?(uri: 'http://example.com')
-  end
-end