indigoframework_agent_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fcb8dfb24e0b1e4919da336c4100ecdde5c6396
+  data.tar.gz: a715e03eb304aa28820e017b61eb274178fa427f
+SHA512:
+  metadata.gz: 566600c75ec4e3dcf0d6fcac677bd140d9e747e546ae36dc11cbdf201cf6974c503f1c69147c1996e4322eb73cfa1a669d4c74fc72c6b2ab7c02bb21b4e46460
+  data.tar.gz: c43b6586522c74e973d2c54917e420fef333d1fbed9d56e351f8d7a2b03931358428011d14803dfde00c9ef9e9a1b6d130245e4b485596d02496bdb5d7022e5d

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 64

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2
+script:
+  - bundle exec rake spec
+  - bundle exec rake rubocop

data/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at adrien.montfort@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    indigoframework_agent_client (0.2.0)
+      http (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ast (2.3.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.2)
+    http (2.2.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    public_suffix (2.0.5)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.3.0)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  indigoframework_agent_client!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52)
+  vcr (~> 3.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,156 @@
+# Agent client for Ruby
+
+[![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/stratumn_agent_client.svg)](https://badge.fury.io/rb/stratumn_agent_client)
+
+Interact with your Indigo agent from your ruby code.
+
+code :: https://github.com/stratumn/agent-client-ruby
+
+## Installation
+
+Add this line to your agent's Gemfile:
+
+```ruby
+gem 'indigoframework_agent_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install indigoframework_agent_client
+
+## Quickstart
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+
+raise 'No process detected in Agent' if agent.list_processes.empty?
+
+process = agent.get('process_name')
+
+segment = process.create_map('My message map')
+
+segment = segment.add_message('Hello, World', 'POTUS')
+
+puts segment.meta
+puts segment.state
+```
+
+## Reference
+
+#### AgentClient::Agent.load(url)
+
+Returns an instance of AgentClient::Agent containing several processes
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+puts agent.list_processes()
+```
+
+#### AgentClient::Process#create_map(references, \*args)
+
+Creates a new map in the agent.
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segment = process.create_map([], 'My message map')
+```
+
+#### AgentClient::Agent.get_segment(hash)
+
+Returns an existing segment.
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segment = process.get_segment('aee5427')
+puts segment.link_hash
+```
+
+#### AgentClient::Agent.find_segments(options = {})
+
+Returns existing segments.
+
+Available options are:
+
+* `offset`: offset of first returned segments
+* `limit`: limit number of returned segments
+* `mapIds`: return segments with one of the specified map IDs
+* `prevLinkHash`: return segments with specified previous link hash
+* `tags`: return segments that contains all the tags (array)
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segments = process.find_segments(tags: ['tag1', 'tag2'])
+segments = process.find_segments(limit: 10)
+```
+
+#### AgentClient::Segment.from
+
+Returns segment from a given raw object.
+
+```ruby
+segment = AgentClient::Segment.from(raw_segment)
+puts segment.process
+puts segment.link_hash
+```
+
+#### AgentClient::Segment#previous
+
+Returns the previous segment of a segment (its parent).
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segment = process.get_segment('aee5427')
+previous = segment.previous
+```
+
+#### AgentClient::Segment#load
+
+Loads a full segment. Can be useful when you only have the meta data of links.
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segments = process.find_segments
+
+segments.map { |segment| segment.load }
+```
+
+#### AgentClient::Segment#transition_function(references, \*args)
+
+Executes a transition function and returns the new segment.
+
+```ruby
+agent = AgentClient::Agent.load('http://localhost:3000')
+process = agent.get('process_name')
+segment = process.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](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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :spec

data/agent_client.gemspec

@@ -0,0 +1,46 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agent_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'indigoframework_agent_client'
+  spec.version       = AgentClient::VERSION
+  spec.authors       = ['Stratumn Team']
+  spec.email         = ['stratumn@gmail.com']
+
+  spec.summary       = 'Interact with your Indigo agent from your ruby app'
+  spec.homepage      = 'https://github.com/stratumn/agent-client-ruby'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+
+  spec.add_runtime_dependency 'http', '~> 2.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/agent_client.rb

@@ -0,0 +1,60 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'agent_client/version'
+require 'agent_client/request'
+require 'agent_client/helper'
+require 'agent_client/agent'
+require 'agent_client/process'
+require 'agent_client/segment'
+
+require 'yaml'
+
+##
+# Allows interacting with your Stratumn agent from your ruby app
+module AgentClient
+  # 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.safe_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/agent_client/agent.rb

@@ -0,0 +1,60 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module AgentClient
+  ##
+  # Represents an Indigo agent
+  class Agent
+    include Request
+    extend Request
+
+    attr_reader :url
+
+    def self.load(url)
+      result = get(url)
+      instance = new(url)
+
+      process_list = result['processes']
+      raise('Agent has not sent the processes') if process_list.nil?
+
+      if process_list.respond_to?('each')
+        process_list.each do |pname, pcontent|
+          instance.add_new_process(pname, pcontent)
+        end
+      end
+      instance
+    end
+
+    def list_processes
+      @processes.values
+    end
+
+    def get(process_name)
+      @processes[process_name]
+    end
+
+    def initialize(url)
+      @url = url
+      @processes = {}
+    end
+
+    def add_new_process(name, content)
+      process = Process.new(url,
+                            name,
+                            content['processInfo'],
+                            content['storeInfo'])
+      @processes[name] = process
+    end
+  end
+end

data/lib/agent_client/helper.rb

@@ -0,0 +1,27 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module AgentClient
+  # We would like to avoid depending on ActiveSupport
+  module Helper
+    def underscore(string)
+      word = string.to_s.dup
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/agent_client/process.rb

@@ -0,0 +1,55 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module AgentClient
+  ##
+  # Represents an Indigo process
+  class Process
+    include Request
+    extend Request
+
+    attr_accessor :process_name, :process_url, :info, :store_info
+
+    def initialize(url, process_name, process_info, store_info)
+      self.process_name = process_name
+      self.process_url = "#{url}/#{process_name}"
+      self.info = process_info
+      self.store_info = store_info
+    end
+
+    def create_map(*args)
+      result = post(process_url + '/segments', json: args)
+
+      Segment.new(self, result)
+    end
+
+    def get_map_ids(options = {})
+      get(process_url + '/maps?' + URI.encode_www_form(options))
+    end
+
+    def find_segments(options = {})
+      result = get(process_url + '/segments?' + URI.encode_www_form(options))
+
+      result.map do |link|
+        Segment.new(self, link)
+      end
+    end
+
+    def get_segment(link_hash)
+      result = get(process_url + '/segments/' + link_hash)
+
+      Segment.new(self, result)
+    end
+  end
+end

data/lib/agent_client/request.rb

@@ -0,0 +1,41 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'http'
+
+module AgentClient
+  ##
+  # Wrapper around HTTP.request that parses the response and raises on error
+  module Request
+    def get(*args)
+      request(:get, *args)
+    end
+
+    def post(*args)
+      result = request(:post, *args)
+
+      result
+    end
+
+    private
+
+    def request(verb, *args)
+      result = HTTP.request(verb, *args).parse
+
+      raise result['error'] if result.is_a?(Hash) && result['error']
+
+      result
+    end
+  end
+end

data/lib/agent_client/segment.rb

@@ -0,0 +1,71 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module AgentClient
+  ##
+  # Represents a link in a Stratumn application
+  class Segment
+    include Request
+    include Helper
+
+    attr_accessor :process, :meta, :state, :link, :link_hash, :references
+
+    def initialize(process, obj)
+      self.process = process
+
+      self.link = obj['link']
+      self.meta = link['meta']
+      self.state = link['state']
+      self.link_hash = obj['meta']['linkHash']
+      self.references = meta['refs']
+
+      process.info['actions'].each do |(method, _)|
+        add_transition_method(method)
+      end
+    end
+
+    def previous
+      process.get_segment(meta['prevLinkHash']) if meta['prevLinkHash']
+    end
+
+    def find_segments(options = {})
+      process.find_segments(options)
+    end
+
+    def load
+      process.get_segment(link_hash)
+    end
+
+    def self.from(segment)
+      agent = Agent.load(segment['meta']['agentUrl'])
+      process = agent.get segment['link']['meta']['process']
+
+      new(process, segment)
+    end
+
+    private
+
+    def add_transition_method(method)
+      define_singleton_method(method) do |*args|
+        url = "#{process.process_url}/segments/#{link_hash}/#{method}"
+
+        result = post(url, json: args)
+
+        self.class.new(process, result)
+      end
+
+      singleton_class.send(:alias_method, underscore(method), method)
+    end
+  end
+end

data/lib/agent_client/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2017 Stratumn SAS. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module AgentClient
+  VERSION = '0.2.0'.freeze
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: indigoframework_agent_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Stratumn Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- stratumn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".vscode/settings.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- agent_client.gemspec
+- bin/console
+- bin/setup
+- lib/agent_client.rb
+- lib/agent_client/agent.rb
+- lib/agent_client/helper.rb
+- lib/agent_client/process.rb
+- lib/agent_client/request.rb
+- lib/agent_client/segment.rb
+- lib/agent_client/version.rb
+homepage: https://github.com/stratumn/agent-client-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Interact with your Indigo agent from your ruby app
+test_files: []