stratumn_sdk 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96a0f25a4a3767eeb3f3c54518300534355fda7a
-  data.tar.gz: d6e7507e0b4c4773988e0f593d72e3abc220b5c8
+  metadata.gz: 91ec9124a7287a16c372733fc37e220f4d52f31b
+  data.tar.gz: 5e04851a809d1444bd2a2e29efd601f0a5e16169
 SHA512:
-  metadata.gz: ec904a1adfe462f1eaf95b3b544239ba4fc842c477f63f6e73f7f3389640fdb5712ff9178a4bcbb903a45019c34daf7f6f08fc2647611eb76f01bff09ae3136e
-  data.tar.gz: b3ff43ad083c509e8026967149466663fae9b08ed6dd4fbd149d965cf79005feaeeed99aba920dfeb7bd28658f4fc844ae0533a5effd9e3ab75f8b4532cd7ba4
+  metadata.gz: afd69b95dd5c685aafa3e456323fa364e31fcc7ab48027238c9b6f3b85597ebebf8b5666da8d72a8492f64d9185516afeae723228e66907a639f38920ca2673b
+  data.tar.gz: f6826334b8421d829278f3f343b5df59142a49544f0698bf6e0be455deb8123082ebe80be5097459dde1524e8ac419f3ead962a42d8e176c11ee21bf8b3770bc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stratumn_sdk (0.2.0)
+    stratumn_sdk (1.0.0)
       http (~> 2.0)
 
 GEM

data/README.md

@@ -1,15 +1,15 @@
-# Stratumn SDK for Ruby
+# Stratumn SDK for Ruby [ALPHA - incompatible with production]
 
 [![build status](https://travis-ci.org/stratumn/stratumn-sdk-ruby.svg?branch=master)](https://travis-ci.org/stratumn/stratumn-sdk-ruby.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/stratumn_sdk.svg)](https://badge.fury.io/rb/stratumn_sdk)
 
-Interact with your Stratumn agent from your ruby application
+Interact with your Stratumn agent from your ruby agent
 
 code  :: https://github.com/stratumn/stratumn-sdk-ruby
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your agent's Gemfile:
 
 ```ruby
 gem 'stratumn-sdk'
@@ -26,106 +26,105 @@ Or install it yourself as:
 ## Quickstart
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
+agent = StratumnSdk::Agent.load('quickstart')
 
-link = application.create_map('My message map')
+segment = agent.create_map('My message map')
 
-link = link.addMessage('Hello, World')
+segment = segment.add_essage('Hello, World')
 
-puts link.meta
-puts link.state
+puts segment.meta
+puts segment.state
 ```
  
 ## Reference
  
-#### StratumnSdk::Application.load(name)
+#### StratumnSdk::Agent.load(url)
  
-Returns an instance of StratumnSdk::Application.
+Returns an instance of StratumnSdk::Agent.
  
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-puts application.id
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+puts agent.agent_info
 ```
 
-#### StratumnSdk::Application#create_map(*args)
+#### StratumnSdk::Agent#create_map(*args)
 
-Creates a new map in the application.
+Creates a new map in the agent.
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-link = application.create_map('My message map')
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segment = agent.create_map('My message map')
 ```
 
-#### StratumnSdk::get_link(hash)
+#### StratumnSdk::Agent.get_segment(hash)
 
-Returns an existing link.
+Returns an existing segment.
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-link = application.get_link('aee5427')
-puts link.link_hash
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segment = agent.get_segment('aee5427')
+puts segment.link_hash
 ```
 
-#### StratumnSdk::get_map(map_id, tags = [])
+#### StratumnSdk::Agent.find_segments(options = {})
 
-Returns the links in a map, optionally filtered by tags.
+Returns existing segments.
 
-```ruby
-application = StratumnSdk::Application.load('quickstart')
-links = application.get_map('aee5427', ['tag1', 'tag2'])
-```
-
-#### StratumnSdk::get_branches(hash, tags = [])
+Available options are:
 
-Returns he links whose previous hashes are the given hash, optionally filters by tags.
+- `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)
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-links = application.get_branches('aee5427', ['tag1', 'tag2'])
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segments = agent.find_segments(tags: ['tag1', 'tag2'])
 ```
 
-#### StratumnSdk::Link#previous
+#### StratumnSdk::Segment.from
 
-Returns the previous link of a link (its parent).
+Returns segment from a given raw object.
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-link = application.get_link('aee5427')
-previous = link.previous
+segment = StratumnSdk::Agent.from(raw_segment)
+puts segment.agent
+puts segment.link_hash
 ```
 
-#### StratumnSdk::Link#load
+#### StratumnSdk::Segment#previous
 
-Loads a full link. Can be useful when you only have the meta data of links.
+Returns the previous segment of a segment (its parent).
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-links = application.get_branches('aee5427')
-
-links.map { |link| link.load }
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segment = agent.get_segment('aee5427')
+previous = segment.previous
 ```
 
-#### StratumnSdk::Link#get_branches(tags)
+#### StratumnSdk::Segment#load
 
-Returns the links whose previous hashes are the hash of the link, optionally filters by tags.
+Loads a full segment. Can be useful when you only have the meta data of links.
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-link = application.get_link('aee5427')
-link.get_branches(['tag1'])
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segments = agent.find_segments
+
+segments.map { |segment| segment.load }
 ```
 
-#### StratumnSdk::Link#transition_function(*args)
+#### StratumnSdk::Segment#transition_function(*args)
 
-Executes a transition function and returns the new link.
+Executes a transition function and returns the new segment.
 
 ```ruby
-application = StratumnSdk::Application.load('quickstart')
-link = application.get_link('aee5427')
-new_link = link.addMessage('Hello, World!')
+agent = StratumnSdk::Agent.load('http://localhost:3000')
+segment = agent.get_segment('aee5427')
+new_segment = segment.addMessage('Hello, World!')
 
 # underscore version is also available
-new_link = link.add_message('Hello, World!')
+new_segment = segment.add_message('Hello, World!')
 ```
 
 ## Development
@@ -134,6 +133,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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](https://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)

data/lib/stratumn_sdk.rb

@@ -1,45 +1,12 @@
 require 'stratumn_sdk/version'
 require 'stratumn_sdk/request'
 require 'stratumn_sdk/helper'
-require 'stratumn_sdk/application'
-require 'stratumn_sdk/link'
+require 'stratumn_sdk/agent'
+require 'stratumn_sdk/segment'
 
 require 'yaml'
 
 ##
 # Allows interacting with your Stratumn agent from your ruby app
 module StratumnSdk
-  # Configuration defaults
-  @config = {
-    base_url: 'https://stratumn.rocks',
-    application_url: 'https://%s.stratumn.rocks'
-  }
-
-  @valid_config_keys = @config.keys
-
-  # Configure through hash
-  def self.configure(opts = {})
-    opts.each do |k, v|
-      @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym
-    end
-  end
-
-  # Configure through yaml file
-  def self.configure_with(path_to_yaml_file)
-    begin
-      config = YAML.load(IO.read(path_to_yaml_file))
-    rescue Errno::ENOENT
-      puts 'YAML configuration file couldn\'t be found. Using defaults.'
-      return
-    rescue Psych::SyntaxError
-      puts 'YAML configuration file contains invalid syntax. Using defaults.'
-      return
-    end
-
-    configure(config)
-  end
-
-  def self.config
-    @config
-  end
 end

data/lib/stratumn_sdk/agent.rb

@@ -0,0 +1,48 @@
+module StratumnSdk
+  ##
+  # Represents a Stratumn application
+  class Agent
+    include Request
+    extend Request
+
+    attr_accessor :url, :agent_info, :store_info
+
+    def self.load(url)
+      attributes = get(url)
+
+      new(url,
+          attributes['agentInfo'],
+          attributes['storeInfo'])
+    end
+
+    def initialize(url, agent_info, store_info)
+      self.url = url
+      self.agent_info = agent_info
+      self.store_info = store_info
+    end
+
+    def create_map(*args)
+      result = post(url + '/segments', json: args)
+
+      Segment.new(self, result)
+    end
+
+    def get_map_ids(options = {})
+      get(url + '/maps?' + URI.encode_www_form(options))
+    end
+
+    def find_segments(options = {})
+      result = get(url + '/segments?' + URI.encode_www_form(options))
+
+      result.map do |link|
+        Segment.new(self, link)
+      end
+    end
+
+    def get_segment(link_hash)
+      result = get(url + '/segments/' + link_hash)
+
+      Segment.new(self, result)
+    end
+  end
+end

data/lib/stratumn_sdk/segment.rb

@@ -0,0 +1,55 @@
+module StratumnSdk
+  ##
+  # Represents a link in a Stratumn application
+  class Segment
+    include Request
+    include Helper
+
+    attr_accessor :agent, :meta, :state, :link, :link_hash
+
+    def initialize(agent, obj)
+      self.agent = agent
+
+      self.link = obj['link']
+      self.meta = link['meta']
+      self.state = link['state']
+      self.link_hash = obj['meta']['linkHash']
+
+      agent.agent_info['actions'].each do |(method, _)|
+        add_transition_method(method)
+      end
+    end
+
+    def previous
+      agent.get_segment(meta['prevLinkHash']) if meta['prevLinkHash']
+    end
+
+    def find_segments(options = {})
+      agent.find_segments(options)
+    end
+
+    def load
+      agent.get_segment(link_hash)
+    end
+
+    def self.from(segment)
+      agent = Agent.load(segment['meta']['agentUrl'])
+
+      new(agent, segment)
+    end
+
+    private
+
+    def add_transition_method(method)
+      define_singleton_method(method) do |*args|
+        url = "#{agent.url}/segments/#{link_hash}/#{method}"
+
+        result = post(url, json: args)
+
+        self.class.new(agent, result)
+      end
+
+      singleton_class.send(:alias_method, underscore(method), method)
+    end
+  end
+end

data/lib/stratumn_sdk/version.rb

@@ -1,3 +1,3 @@
 module StratumnSdk
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stratumn_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stratumn Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,10 +127,10 @@ files:
 - bin/console
 - bin/setup
 - lib/stratumn_sdk.rb
-- lib/stratumn_sdk/application.rb
+- lib/stratumn_sdk/agent.rb
 - lib/stratumn_sdk/helper.rb
-- lib/stratumn_sdk/link.rb
 - lib/stratumn_sdk/request.rb
+- lib/stratumn_sdk/segment.rb
 - lib/stratumn_sdk/version.rb
 - stratumn_sdk.gemspec
 homepage: https://github.com/stratumn/stratumn-sdk-ruby
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Interact with your Stratumn agent from your ruby app

data/lib/stratumn_sdk/application.rb

@@ -1,62 +0,0 @@
-module StratumnSdk
-  ##
-  # Represents a Stratumn application
-  class Application
-    include Request
-    extend Request
-
-    attr_accessor :url, :id, :name, :agent_info
-
-    def self.load(application_name, application_location = nil)
-      url = application_location ||
-            StratumnSdk.config[:application_url].gsub('%s', application_name)
-      attributes = get(url)
-
-      new(url,
-          attributes['id'],
-          attributes['name'],
-          attributes['agentInfo'])
-    end
-
-    def initialize(url, id, name, agent_info)
-      self.url = url
-      self.id = id
-      self.name = name
-      self.agent_info = agent_info
-    end
-
-    def create_map(*args)
-      result = post(url + '/maps', json: args)
-
-      raise result['meta']['errorMessage'] if result['meta']['errorMessage']
-
-      Link.new(self, result)
-    end
-
-    def get_link(link_hash)
-      result = get(url + '/links/' + link_hash)
-
-      Link.new(self, result)
-    end
-
-    def get_map(map_id, tags = [])
-      query = tags.empty? ? '' : "?tags=#{tags.join('&tags=')}"
-
-      result = get(url + '/maps/' + map_id + query)
-
-      result.map do |link|
-        Link.new(self, link)
-      end
-    end
-
-    def get_branches(link_hash, tags = [])
-      query = tags.empty? ? '' : "?tags=#{tags.join('&tags=')}"
-
-      result = get(url + '/branches/' + link_hash + query)
-
-      result.map do |link|
-        Link.new(self, link)
-      end
-    end
-  end
-end

data/lib/stratumn_sdk/link.rb

@@ -1,60 +0,0 @@
-module StratumnSdk
-  ##
-  # Represents a link in a Stratumn application
-  class Link
-    include Request
-    include Helper
-
-    attr_accessor :application, :meta, :state, :link, :link_hash
-
-    def initialize(application, obj)
-      self.application = application
-
-      self.link = obj['link']
-      self.meta = link['meta']
-      self.state = link['state']
-      self.link_hash = obj['meta']['linkHash']
-
-      application.agent_info['functions'].each do |(method, _)|
-        add_transition_method(method)
-      end
-    end
-
-    def previous
-      application.get_link(meta['prevLinkHash']) if meta['prevLinkHash']
-    end
-
-    def get_branches(tags)
-      application.get_branches(link_hash, tags)
-    end
-
-    def load
-      application.get_link(link_hash)
-    end
-
-    def self.load(segment)
-      meta = segment['meta']
-
-      application = Application.load(
-        meta['application'],
-        meta['applicationLocation']
-      )
-
-      application.get_link(meta['linkHash'])
-    end
-
-    private
-
-    def add_transition_method(method)
-      define_singleton_method(method) do |*args|
-        url = "#{application.url}/links/#{link_hash}/#{method}"
-
-        result = post(url, json: args)
-
-        self.class.new(application, result)
-      end
-
-      singleton_class.send(:alias_method, underscore(method), method)
-    end
-  end
-end