Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Ruby wrapper for the Yammer REST API

tree: 783341df6b

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

The Yammer Ruby Gem

A Ruby wrapper for the Yammer REST APIs

This wrapper is heavily inspired by the Twitter Ruby Gem (which is AWESOME and you should definitely check)

This gem wouldn't have been possible with the awesomeness of the Twitter Gem and the work all their contributors have put into it (and all the other great libraries we depend upon). Please consider financially supporting the development of the Twitter Ruby Gem.

Installation

gem install yammer

What's in 0.1.0?

This release offers the most basic support for the messages API (creation and consuming) for Yammer's REST API. This gem is far from finished or offering complete coverage of all the API methods offered by Yammer. It's our first release covering our basic needs to hook into the messages API.

We are releasing this early version in order to share the path we have taken, offer the community a new Ruby Gem to interact with the Yammer API and build upon it with more support of others that might find it useful.

I am eternally grateful for the work that the team that created the awesome (did I say how awesome that Gem is already? ;) ) Twitter Ruby Gem put into it and made it open and free. THANK YOU :)

TODO

  • Specs, specs and specs ... we lack tests even basic ones.
  • Support for the following APIs
    • Likes
    • Groups
    • Topics
    • Users
    • Group Memberships
    • Networks
    • Search

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing tests
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by closing issues
  • by reviewing patches

All contributors will be added to the HISTORY file and will receive the respect and gratitude of the community.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system.

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add documentation for your feature or bug fix.
  5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
  6. Commit and push your changes.
  7. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

Copyright

Copyright (c) 2011, Bruno Mattarollo bruno@road.ly See LICENSE for details.

Something went wrong with that request. Please try again.