Kreepr

Kreepr is gem for consuming the Kreepr API. As defined on the Kreepr, aka Feed Engine project page, the API should produce JSON output and expect JSON payloads for creation and updating actions.

As an authenticated API user (using an API key) you can:

  • Read any publically viewable trip feed via GET, and filter only feed items created directly on Kreepr (text)
  • Read any private trip feed to which the user has access via GET, and filter only feed items created directly on Kreepr (text)
  • Publish a text feed item given the appropriate arguments, via POST

Installation

Add this line to your application's Gemfile:

gem 'kreepr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kreepr

Getting Started

Let's get Kreeping!

First, you'll need to create a Kreepr account, then navigate to your account page to retrieve your API key.

Once you have your key, configure the gem by setting your API key as such:

client = Kreepr::Client.new(:api_key => <your api key>)

That's it! You're ready to talk to Feed Engine.

Usage Examples

Retrieve feed items for a specific trip (trip must be public, or you must have permissions to view it):

client.feed(:username => <username>, :trip_id => <trip id>)

Retrieve only notes posted from Kreepr:

client.feed(:username => <username>, :trip_id => <trip id>, :only => :text)

Publish a text feed item given the appropriate arguments, via POST. (Next version)

client.post_note(:username => <username>, :trip_id => <trip id>, :text => <text>)

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 new Pull Request