ruby-orchestrate.io

A Ruby interface to the Orchestrate.io API

Installation

Add this line to your application's Gemfile:

gem 'orchestrate.io'

And then execute:

$ bundle

Or install it yourself as:

$ gem install orchestrate.io

Initializes the OrchestrateIo class with your API key to create a new object that you perform the following API calls with.

require 'orchestrate.io'
require 'json'

@io = OrchestrateIo.new(api_key: 'abc')
@json_data = JSON.dump({a: 1})
@search_query = "hello dolly"

NOTE: You can create a new collection by performing a Key/Value PUT to the collection.

Deletes an entire collection.

@io.collection :delete do
  collection "foo"
  force       true
end.perform

Gets the latest value assigned to a key.

@io.key_value :get do
  collection "foo"
  key        "bar"
end.perform

Creates or updates the value at the collection/key specified.

@io.key_value :put do
  collection "foo"
  key        "bar"
  data        @json_data
end.perform

Sets the value of a key to a null object.

@io.key_value :delete do
  collection "foo"
  key        "bar"
end.perform

Returns list of items matching the lucene query.

@io.search :get do
  collection "foo"
  query       @query_string
end.perform

Returns a list of events, optionally limited to specified time range in reverse chronological order.

@io.event :get do
  collection "foo"
  key        "bar"
  type       "log"
　from        1384224210
　to          1384224213
end.perform

Puts an event with an optional user defined timestamp.

@io.event :put do
  collection "foo"
  key        "bar"
  type       "log"
  data        @json_data
　timestamp   1384224213
end.perform

Returns relation’s collection, key, ref, and values.

@io.graph :get do
  collection "foo"
  key        "bar1"
  relation   "friends"
end.perform

Creates a relationship between two objects. Relations can span collections.

@io.graph :put do
  collection    "foo"
  key           "bar1"
  relation      "friends"
  to_collection "hoge"
  to_key        "bar2"
end.perform