/stream-ruby

Ruby client for use with activity stream services

Primary LanguageRubyBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Realself::Stream Circle CI

Documentation

Sample Stream Service

Installation

Add this line to your application's Gemfile:

gem 'realself-stream', '~> 2.0.0', :git => 'ssh://git@github.com/RealSelf/stream-ruby.git'

And then execute:

$ bundle install

Usage

Running Tests

The preferred method for running tests is via rake tasks.

# run all integration and unit tests
$ bundle exec rake test

# run integration tests only
$ bundle exec rake test:integration

# run unit tests only
$ bundle exec rake test:unit

# skip TTL test, while running all others
$ SKIP_TTL_TESTS=true bundle exec rake test
  • Integration tests assume MongoDB ``~>2.6.0is running locally and listening on port27017`.
  • bundle exec rspec will run all integration and unit tests
  • The TTL integration test must allow the TTL to expire to compleate all tests. To skip waiiting for the timeout, set the SKIP_TTL_TESTS environment variable to true.

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