sdk-ruby

(in development, part of elasticfeed ICSE, Intelligent Content Streaming Engine)

Minimalistic Elasticfeed SDK and cli client for ruby

Installation

gem install elasticfeed

API coverage

The Elasticfeed Public API follows the principles of the REST architectural style to expose a number of internal resources which enable programmatic access to Elasticfeed’s features. Current implementation support only a few of API features.

Resource	Get All	Get One	Create	Update	Delete	- Provider-
Application	+	+				store
Feed	+	+				store
Entry	+	+	+		+	store
Workflow	+	+	+	+	+	store
Plugin	+	+			+	system
Viewer						store
Organisation	+	+				store
Admin						store
Token						store

Library usage

Source code itself is well-documented so when writing code it should auto-complete and hint in all supported usages.

Client

Most important part of the api is client. In order to make any request you need to instantiate client with correct params.

client = Elasticfeed::Client.new('username', 'api_key')

This client is used by all other classes connecting to api no matter if it's Resource or helper class like Agent.

Agent

Agent is simple wrapper class for listing all accessible resources.

client = Elasticfeed::Client.new('username', 'api_key')
agent = Elasticfeed::Agent.new(client)

agent.apps.each do |app|
    puts app.name
end

List of resource-listing agent methods:

• orgs
• apps
• feeds
• entries
• workflows
• plugins

Resources

You can find lists of resource by using agent as pointed above, or by various resource methods. Each resource have a find method loading certain resource with provided id (plus corresponding parent ids), e.g.

client = new Elasticfeed::Client.new('username', 'api_key')
app = Elasticfeed::Resource::Application.find(client, 'app_id')

Additionally some resources have additional instance methods to retrieve sub-resources, e.g.

client = new Elasticfeed::Client.new('username', 'api_key')
org = Elasticfeed::Resource::Organisation.find(client, 'org_id')
apps = org.applications

Cli usage

There is a built-in cli with several commands retrieving api resource lists.

Configuration

Cli uses configuration with all values set to default ones. Config itself has config_file property which merges itself with params from the file. By default config_file points to home directory, but it can be changed to points to any file.

[email protected]
apikey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
apiurl=https://api.elasticfeed.io/v1
default_org_id=your-org-id
default_app_id=your-app-id
default_feed_id=your-feed-id

Additionally some options can be modified using cli options.

Available commands

$ elasticfeed --help
Usage:
     [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
    SUBCOMMAND                    subcommand
    [ARG] ...                     subcommand arguments

Subcommands:
    org                          Organisations
    app                          Applications
    feed                         Feeds
    entry                        Entries
    workflow                     Workflows
    plugin                       Plugins

Options:
    -h, --help                      print help
    -u, --username <string>         Elasticfeed user
    -k, --apikey <string>           Elasticfeed api-key
    -a, --apiurl <string>           Elasticfeed api url. Full url including version: https://api.elasticfeed.io/api/public/v1.0
    -v, --version                   Version
    -o, --default-org-id <string>   Default Elasticfeed organisation id
    -p, --default-app-id <string>   Default Elasticfeed application id
    -f, --default-feed-id <string>  Default Elasticfeed feed id
    --cfg <string>                  Config file path
    -i, --ignore                    Ignore flag of --default-xxx-id (default: false)
    -j, --json                      Print JSON output (default: false)
    -l, --limit <integer>           Limit for result items