Wave

Wave is a ruby API Client for Raneen, supporting Raneen's API v1 for posting and creating feeds and messages. It should work beside raneen-omniauth gem to easily integrate any application with Raneen platform. It adds more felxibility to Raneen's API. It's tested on the following environment:

• Rails 3
• Ruby 1.9.3

Installation

Add this line to your application's Gemfile:

gem 'wave', github: 'mash-ltd/wave'

And then execute:

$ bundle

Usage

Configure wave with the following. Create YML file wave.yml under app/config with the following configuration options:

development:
  endpoint:     "URL_FOR_API"       # ex: 'http://localhost:3000/api/v1'
  format:       "REQUESTED_FORMAT"  # ex: 'json'
  access_token: "OAUTH_ACCESS_TOKEN"

DEFAULT_ENDPOINT    = "http://raneen.tamkeencapital.com/api/v1"
DEFAULT_METHOD      = :get
DEFAULT_ACCESS_TOKEN = nil
DEFAULT_FORMAT       = :json

OR you can pass your configuration to the Client directly without using the yml file by the following:

options = { endpoint: "URL_FOR_API", format: "REQUESTED_FORMAT", access_token: "OAUTH_ACCESS_TOKEN" }
@wave = Wave::Client.config(options)

You can set access_token afterwards to change it to the CLIENT_ACCESS_TOKEN if not available at the beginning by:

Wave::Client.instance.api_key(CLIENT_ACCESS_TOKEN)

After configuring your client API you can use it normally and send a message or post on Raneen's feed.

To send a message:

@message_hash = {
    message: {
        body: "Hey there from Wave API!", 
        recipient_ids: RECIPIENT_UID
    }
}
# RECIPIENT_TYPE which entity type you are talking to ex: "company" or "user" 
@wave.message(@message_hash, RECIPIENT_TYPE)

or you can use this method for sending a messsage without creating the hash yourself

# @param message ex: "Hey from wave"
# @param recipient_id
# @param recipient_type ex: "user"
@wave.send_message(message, recipient_id, recipient_type)

To post on current_user feed:

@wave.feed("Hey from Wave!")

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