https://github.com/keen/keen-gem-example

A Sinatra app that uses the keen gem to publish events asynchronously
https://github.com/keen/keen-gem-example

Last synced: 11 days ago
JSON representation

A Sinatra app that uses the keen gem to publish events asynchronously

• Host: GitHub
• URL: https://github.com/keen/keen-gem-example
• Owner: keen
• License: mit
• Created: 2013-01-06T04:18:52.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2015-06-18T20:16:47.000Z (over 9 years ago)
• Last Synced: 2024-11-07T12:52:20.259Z (13 days ago)
• Language: Ruby
• Homepage: http://keen-gem-example.herokuapp.com/
• Size: 274 KB
• Stars: 10
• Watchers: 42
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# keen-gem-example

This example Sinatra app shows how to use the

[Keen IO Ruby gem](https://github.com/keenlabs/keen-gem)

to publish asynchronous events via the Keen IO API.

See it in action at

[http://keen-gem-example.herokuapp.com/](http://keen-gem-example.herokuapp.com/).

The app lets you compare synchronous and asynchronous response

times, and vote for your **favorite Star Trek TNG character!**

### Usage

To play with your own copy, follow these steps:

Make sure you have a [Keen IO Account](https://keen.io/). Create a new project and note its Project ID and API key.

Clone this repository. cd into the new directory. Run `bundle install` to install dependencies.

Set the KEEN_API_KEY and KEEN_PROJECT_ID variables in a file called .env in the project root. This file is used by foreman.

    KEEN_PROJECT_ID=your-project-id

    KEEN_WRITE_KEY=your-write-key

    KEEN_READ_KEY=your-read-key

Use `foreman start` to start the server.

Navigate to `http://localhost:5000/` and start sending events!

Bonus: If you watch the server log as you send events, you can see

the exact moment that calls return, both in synchronous and

asynchronous cases.

### How it works

When publishing events via `publish_async`, the Keen IO Ruby

gem uses [em-http-request](https://github.com/igrigorik/em-http-request)

to make non-blocking calls. This shifts the calls to the event loop,

removing them from the critical path for the request.

### FAQ

##### Do I need an EventMachine server like thin to use the asynchronous calls?

No. In that case, just add `eventmachine` and `em-http-request` to your Gemfile and start EventMachine in a separate thread.

Put this code in an initiaizer:

    Thread.new {

      EventMachine.run

    }

For more background, here's a blog article about using [EventMachine and Passenger](http://railstips.org/blog/archives/2011/05/04/eventmachine-and-passenger/).

### Misc

If you have any questions, bugs, or suggestions, please

report them via Github Issues. Or, come chat with us anytime

at [users.keen.io](http://users.keen.io). We'd love to hear your feedback and ideas!