github.com/spider-gazelle/pinger

Microlibrary to perform ping requests with Crystal Lang

11 stars
3 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  pinger:
    github: spider-gazelle/pinger
    version: ~> 1.1.2

Then run:

shards install

shard.yml

Crystal
>= 0.36.1
License
MIT
Author
Caspian Baska

Dependencies

Development Dependencies

  • ameba*github: crystal-ameba/amebadev

README

pinger

CI

Microlib to generate ICMP ping requests.
Avoids sudo requirement of using raw sockets by shelling out to ping and thus pinger has an implicit dependency of ping.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      pinger:
        github: spider-gazelle/pinger
  2. Run shards install

Usage

require "pinger"

hostname = "www.duckduckgo.com"
pinger = Pinger.new(hostname, count: 3)

pinger.ping # => true / false
puts {
    host: pinger.ip,
    pingable: pinger.pingable,
    warning: pinger.warning,
    exception: pinger.exception
}

Or if you would like an error raised


require "pinger"

hostname = "www.doesnotexist.com"
pinger = Pinger.new(hostname, count: 3)

pinger.ping! # => self / raise pinger.exception

Todo

  • [ ] utilise Crystal::Config.default_target rather than shelling out to uname

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors