Stratumn SDK for Ruby [ALPHA - incompatible with production]

build status Gem Version

Interact with your Stratumn agent from your ruby agent

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

Installation

Add this line to your agent's Gemfile:

gem 'stratumn-sdk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stratumn-sdk

Quickstart

agent = StratumnSdk::Agent.load('quickstart')

segment = agent.create_map('My message map')

segment = segment.add_essage('Hello, World')

puts segment.meta
puts segment.state

Reference

StratumnSdk::Agent.load(url)

Returns an instance of StratumnSdk::Agent.

agent = StratumnSdk::Agent.load('http://localhost:3000')
puts agent.agent_info

StratumnSdk::Agent#create_map(*args)

Creates a new map in the agent.

agent = StratumnSdk::Agent.load('http://localhost:3000')
segment = agent.create_map('My message map')

StratumnSdk::Agent.get_segment(hash)

Returns an existing segment.

agent = StratumnSdk::Agent.load('http://localhost:3000')
segment = agent.get_segment('aee5427')
puts segment.link_hash

StratumnSdk::Agent.find_segments(options = {})

Returns existing segments.

Available options are:

  • offset: offset of first returned segments
  • limit: limit number of returned segments
  • mapId: return segments with specified map ID
  • prevLinkHash: return segments with specified previous link hash
  • tags: return segments that contains all the tags (array)
agent = StratumnSdk::Agent.load('http://localhost:3000')
segments = agent.find_segments(tags: ['tag1', 'tag2'])

StratumnSdk::Segment.from

Returns segment from a given raw object.

segment = StratumnSdk::Agent.from(raw_segment)
puts segment.agent
puts segment.link_hash

StratumnSdk::Segment#previous

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

agent = StratumnSdk::Agent.load('http://localhost:3000')
segment = agent.get_segment('aee5427')
previous = segment.previous

StratumnSdk::Segment#load

Loads a full segment. Can be useful when you only have the meta data of links.

agent = StratumnSdk::Agent.load('http://localhost:3000')
segments = agent.find_segments

segments.map { |segment| segment.load }

StratumnSdk::Segment#transition_function(*args)

Executes a transition function and returns the new segment.

agent = StratumnSdk::Agent.load('http://localhost:3000')
segment = agent.get_segment('aee5427')
new_segment = segment.addMessage('Hello, World!')

# underscore version is also available
new_segment = segment.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.

Tests

Tests are run against a mock agent whose results are recorded by vcr. Should you need to regenerate the cassettes or add new tests, the mock agent can be launched on port 3333.

$ cd spec/agent
$ npm install
$ node index.js

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.