https://github.com/threez/istat

an istat client library for ruby
https://github.com/threez/istat

Last synced: 4 months ago
JSON representation

an istat client library for ruby

• Host: GitHub
• URL: https://github.com/threez/istat
• Owner: threez
• Created: 2011-04-29T10:54:07.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2012-04-26T20:04:58.000Z (about 14 years ago)
• Last Synced: 2025-12-05T07:44:10.036Z (7 months ago)
• Language: Ruby
• Homepage: https://github.com/threez/istat
• Size: 117 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# istat Client

It is a client for the istatd service from [bjango](http://bjango.com/iphone/istat/). The Protocol has implementations for

Mac and [Linux/Solaris/FreeBSD](https://github.com/tiwilliam/istatd). Therefore I implemented a simple client in ruby.

## Installation

Just install the gem using:

    sudo gem install istat

## Usage

Connect to an istat server with this sample code:

    client = Istat::Client.new("example.com", 5109, "secret")

    client.start do |session|

      begin

        response = session.fetch

        p response.cpu

        sleep 1

      end while true

    end

    

## Contribute

Write tests, fork, write issues, ...

## Test

If you want to hack on the client, here is the way to start the tests:

    TEST_SERVER=istat://any:secret@example.com:5109/ rspec spec

    

Replace *secret*, and *example.com* with your code and host.

    

## License

Copyright (c) 2011 Vincent Landgraf

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.