Skip to content
Stream updates from Rubygems.org as they happen
Ruby Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
gem_stream.gemspec

README.md

GemStream

GemStream is a gem that allows you to follow along as new gems are published on Rubygems.org.

Installation

Add this line to your application's Gemfile:

gem 'gem_stream'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gem_stream

Usage

Configure

First, you'll need to configure GemStream to handle two events.

Specify a proc for on_version, which receives a hash of version attributes as an argument. It will be called once for each ruby gem version that's published.

Specify a proc for on_synced, which receives no arguments. It will be called when the stream is up to date.

Example:

GemStream.configure do |c|
  c.on_version = -> (version) { YourVersionHandler.handle(version) }
  c.on_synced = -> () { YourSyncHandler.handle }
end

You can also configure the api call interval. Rubygems.org does have a rate limit (10 req/s), so you can configure an interval as low as 0.1. If you don't configure an interval, the default interval will be applied (1 second).

Follow

Once you've handled configuration, you can use GemStream like this:

# start_time being an instance of Time, from which you'd like to begin streaming.
GemStream::Follower.follow_from(start_time)

Errors

If a Rubygems api error is encountered, GemStream will raise a GemStream::ApiError. In most cases, you can rescue this error and start a new follower from where you left of at. To get the time that you left off at, you can check the GemStream::Follower instance synced_up_to_time attribute. Note that restarting from this time may replay some on_version callbacks, as synced_up_to_time only represents the beginning of the last time frame you queried, not the published time of the most recent gem version you received back.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fwilkens/gem_stream.

You can’t perform that action at this time.