Stratumn SDK for Ruby

build status Gem Version

Interact with your Stratumn agent from your ruby application

code :: https://github.com/stratumn/stratumn-sdk-ruby

Installation

Add this line to your application's Gemfile:

gem 'stratumn-sdk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stratumn-sdk

Quickstart

application = StratumnSdk::Application.load('quickstart')

link = application.create_map('My message map')

link = link.addMessage('Hello, World')

puts link.meta
puts link.state

Reference

StratumnSdk::Application.load(name)

Returns an instance of StratumnSdk::Application.

application = StratumnSdk::Application.load('quickstart')
puts application.id

StratumnSdk::Application#create_map(*args)

Creates a new map in the application.

application = StratumnSdk::Application.load('quickstart')
link = application.create_map('My message map')

Returns an existing link.

application = StratumnSdk::Application.load('quickstart')
link = application.get_link('aee5427')

StratumnSdk::get_map(map_id, tags = [])

Returns the links in a map, optionally filtered by tags.

application = StratumnSdk::Application.load('quickstart')
links = application.get_map('aee5427', ['tag1', 'tag2'])

StratumnSdk::get_branches(hash, tags = [])

Returns he links whose previous hashes are the given hash, optionally filters by tags.

application = StratumnSdk::Application.load('quickstart')
links = application.get_branches('aee5427', ['tag1', 'tag2'])

Returns the previous link of a link (its parent).

application = StratumnSdk::Application.load('quickstart')
link = application.get_link('aee5427')
previous = link.previous

Load a full link. Can be useful when you only have the meta data of links.

application = StratumnSdk::Application.load('quickstart')
links = application.get_branches('aee5427')

links.map { |link| link.load }

Returns the links whose previous hashes are the hash of the link, optionally filters by tags.

application = StratumnSdk::Application.load('quickstart')
link = application.get_link('aee5427')
link.get_branches(['tag1'])

Executes a transition function and returns the new link.

application = StratumnSdk::Application.load('quickstart')
link = application.get_link('aee5427')
new_link = link.addMessage('Hello, World!')

# underscore version is also available
new_link = link.add_message('Hello, World!')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

License:

(The MIT License)

Copyright (c) 2016 FIX

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.