Kismet

This gem provides a simple method of writing data to an AWS Kinesis stream.

Add this line to your application's Gemfile:

gem 'kismet'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kismet

To write to a Kismet stream, initialize your writer:

writer = Kismet::Writer.new('YOUR-STREAM-NAME')

To write, simply call put!

writer.put!('FIRE!')

It works with numerics as well:

writer.put!(8675309)

And hashes!

writer.put!({ structured: 'data' })

Set your own custom partition keys for more control:

writer.put!('Partition me plz', 'custom-partition-key')

If the write was successful, you will receive a hash containing information on the sequence:

{
  shard_id: 'shardId-000000000000',
  sequence_number: "4958346487696888260659175585929606951089842765911.....",
  encryption_type: nil
}

If the write failed, it will return nil.

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kismet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Kismet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.