stratumn_agent_client 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b54b413a5421c8b91a0b4bbe410c076b740e8ec5
-  data.tar.gz: b24c9d169294fc6636fa60db3abd307fc0a00e06
+  metadata.gz: 5dc1d9233eb9b69631fa998886084001f7115c6b
+  data.tar.gz: 8333c017990136820863e091cdd149ad266089e2
 SHA512:
-  metadata.gz: 38484bf60b05fe23bd7a5209f90254cc0a9af2ccbcf2a04886bd992844bd53f20596251050c9a6d5bdcdd70a2532735d5a63f21b48b53799a262b0dd9ff588f0
-  data.tar.gz: a91bd644ab5aae6e4ecd3859d14f03d6d1e15336a092c712488c9512b6dc7c9f4799111f04d4803bb8b7af710a63191752004947d128a456ad2eeaab1bb87be2
+  metadata.gz: 35b965f742d54ef11e3d8bbc271b614a5bcbd6678be280a228e8531dec875d89c4e49945efff7380f46f0423fc29a794a7d7a2060f5686e953a31b4d355e3242
+  data.tar.gz: bc5aae0dacdd99d19cd31ef34bae849568fcd5f49d5fb1e5acf378e0ba860e168a4bc3bcfe0c8a8637c3360c7fcc7e00c53bd44cffc7e7150019b8292aad67cf

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in stratumn_sdk.gemspec
+# Specify your gem's dependencies in agent_client.gemspec
 gemspec

data/Gemfile.lock

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

data/README.md

@@ -1,15 +1,15 @@
-# Agent client for Ruby
+# Agent client for Ruby [ALPHA - incompatible with production]
 
 [![build status](https://travis-ci.org/stratumn/agent-client-ruby.svg?branch=master)](https://travis-ci.org/stratumn/agent-client-ruby.svg?branch=master)
-[![Gem Version](https://badge.fury.io/rb/agent_client.svg)](https://badge.fury.io/rb/stratumn_sdk)
+[![Gem Version](https://badge.fury.io/rb/agent_client.svg)](https://badge.fury.io/rb/stratumn_agent_client)
 
-Interact with your Stratumn agent from your ruby application
+Interact with your Stratumn agent from your ruby agent
 
 code  :: https://github.com/stratumn/agent-client-ruby
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your agent's Gemfile:
 
 ```ruby
 gem 'agent-client'
@@ -26,110 +26,119 @@ Or install it yourself as:
 ## Quickstart
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
+agent = AgentClient::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
 
-#### AgentClient::Application.load(name)
+#### AgentClient::Agent.load(url)
 
-Returns an instance of AgentClient::Application.
+Returns an instance of AgentClient::Agent.
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-puts application.id
+agent = AgentClient::Agent.load('http://localhost:3000')
+puts agent.agent_info
 ```
 
-#### AgentClient::Application#create_map(*args)
+#### AgentClient::Agent#create_map(*args)
 
-Creates a new map in the application.
+Creates a new map in the agent.
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-link = application.create_map('My message map')
+agent = AgentClient::Agent.load('http://localhost:3000')
+segment = agent.create_map('My message map')
 ```
 
-#### AgentClient::Application.get_link(hash)
+#### AgentClient::Agent.get_segment(hash)
 
-Returns an existing link.
+Returns an existing segment.
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-link = application.get_link('aee5427')
-puts link.link_hash
+agent = AgentClient::Agent.load('http://localhost:3000')
+segment = agent.get_segment('aee5427')
+puts segment.link_hash
 ```
 
-#### AgentClient::Application.get_map(map_id, tags = [])
+#### AgentClient::Agent.find_segments(options = {})
 
-Returns the links in a map, optionally filtered by tags.
+Returns existing segments.
 
-```ruby
-application = AgentClient::Application.load('quickstart')
-links = application.get_map('aee5427', ['tag1', 'tag2'])
-```
-
-#### AgentClient::Application.get_branches(hash, tags = [])
-
-Returns he links whose previous hashes are the given hash, optionally filters by tags.
+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)
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-links = application.get_branches('aee5427', ['tag1', 'tag2'])
+agent = AgentClient::Agent.load('http://localhost:3000')
+segments = agent.find_segments(tags: ['tag1', 'tag2'])
 ```
 
-#### AgentClient::Link#previous
+#### AgentClient::Segment.from
 
-Returns the previous link of a link (its parent).
+Returns segment from a given raw object.
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-link = application.get_link('aee5427')
-previous = link.previous
+segment = AgentClient::Agent.from(raw_segment)
+puts segment.agent
+puts segment.link_hash
 ```
 
-#### AgentClient::Link#load
+#### AgentClient::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 = AgentClient::Application.load('quickstart')
-links = application.get_branches('aee5427')
-
-links.map { |link| link.load }
+agent = AgentClient::Agent.load('http://localhost:3000')
+segment = agent.get_segment('aee5427')
+previous = segment.previous
 ```
 
-#### AgentClient::Link#get_branches(tags)
+#### AgentClient::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 = AgentClient::Application.load('quickstart')
-link = application.get_link('aee5427')
-link.get_branches(['tag1'])
+agent = AgentClient::Agent.load('http://localhost:3000')
+segments = agent.find_segments
+
+segments.map { |segment| segment.load }
 ```
 
-#### AgentClient::Link#transition_function(*args)
+#### AgentClient::Segment#transition_function(*args)
 
-Executes a transition function and returns the new link.
+Executes a transition function and returns the new segment.
 
 ```ruby
-application = AgentClient::Application.load('quickstart')
-link = application.get_link('aee5427')
-new_link = link.addMessage('Hello, World!')
+agent = AgentClient::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
 
 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](https://rubygems.org)
+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
+```

data/agent_client.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['stratumn@gmail.com']
 
   spec.summary       = 'Interact with your Stratumn agent from your ruby app'
-  spec.homepage      = 'https://github.com/stratumn/stratumn-sdk-ruby'
+  spec.homepage      = 'https://github.com/stratumn/agent-client-ruby'
   spec.license       = 'MPL-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'stratumn_sdk'
+require 'agent_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/agent_client/agent.rb

@@ -0,0 +1,54 @@
+# Copyright (C) 2017  Stratumn SAS
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+module AgentClient
+  ##
+  # Represents a Stratumn agent
+  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/agent_client/{link.rb → segment.rb}

@@ -7,57 +7,52 @@
 module AgentClient
   ##
   # Represents a link in a Stratumn application
-  class Link
+  class Segment
     include Request
     include Helper
 
-    attr_accessor :application, :meta, :state, :link, :link_hash
+    attr_accessor :agent, :meta, :state, :link, :link_hash
 
-    def initialize(application, obj)
-      self.application = application
+    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']
 
-      application.agent_info['functions'].each do |(method, _)|
+      agent.agent_info['actions'].each do |(method, _)|
         add_transition_method(method)
       end
     end
 
     def previous
-      application.get_link(meta['prevLinkHash']) if meta['prevLinkHash']
+      agent.get_segment(meta['prevLinkHash']) if meta['prevLinkHash']
     end
 
-    def get_branches(tags)
-      application.get_branches(link_hash, tags)
+    def find_segments(options = {})
+      agent.find_segments(options)
     end
 
     def load
-      application.get_link(link_hash)
+      agent.get_segment(link_hash)
     end
 
-    def self.load(segment)
-      meta = segment['meta']
+    def self.from(segment)
+      agent = Agent.load(segment['meta']['agentUrl'])
 
-      application = Application.load(
-        meta['application'],
-        meta['applicationLocation']
-      )
-
-      application.get_link(meta['linkHash'])
+      new(agent, segment)
     end
 
     private
 
     def add_transition_method(method)
       define_singleton_method(method) do |*args|
-        url = "#{application.url}/links/#{link_hash}/#{method}"
+        url = "#{agent.url}/segments/#{link_hash}/#{method}"
 
         result = post(url, json: args)
 
-        self.class.new(application, result)
+        self.class.new(agent, result)
       end
 
       singleton_class.send(:alias_method, underscore(method), method)

data/lib/agent_client/version.rb

@@ -5,5 +5,5 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 module AgentClient
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/agent_client.rb

@@ -7,8 +7,8 @@
 require 'agent_client/version'
 require 'agent_client/request'
 require 'agent_client/helper'
-require 'agent_client/application'
-require 'agent_client/link'
+require 'agent_client/agent'
+require 'agent_client/segment'
 
 require 'yaml'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stratumn_agent_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stratumn Team
@@ -128,12 +128,12 @@ files:
 - bin/console
 - bin/setup
 - lib/agent_client.rb
-- lib/agent_client/application.rb
+- lib/agent_client/agent.rb
 - lib/agent_client/helper.rb
-- lib/agent_client/link.rb
 - lib/agent_client/request.rb
+- lib/agent_client/segment.rb
 - lib/agent_client/version.rb
-homepage: https://github.com/stratumn/stratumn-sdk-ruby
+homepage: https://github.com/stratumn/agent-client-ruby
 licenses:
 - MPL-2.0
 metadata: {}

data/lib/agent_client/application.rb

@@ -1,66 +0,0 @@
-# Copyright (C) 2017  Stratumn SAS
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-module AgentClient
-  ##
-  # 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 ||
-            AgentClient.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)
-
-      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