stratumn_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb3eee12791c77b0f6419290a6e86932b6d3062a
+  data.tar.gz: e1508ba9ea5e2936359488146e4cbe5fdca748dc
+SHA512:
+  metadata.gz: 32896b423d268bfcae34ce7a01fbe5d432efaf001f1ae32b0bffbe52fa18fff57f54cb518dd0342ccea1b45e8fbd5421965d1c3fb3cf4a22420363b2db37d037
+  data.tar.gz: d69042a394cc1cbd4d3c08ef34bbcb7d3a3a8da65140c82bf72c6f8c0ed6488eb46e2765ed2e17148752a433cc08842bc50cd2eb9f98b27bf07eb64dc2ca3adc

data/.gitignore

@@ -0,0 +1 @@
+doc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.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 stratumn_sdk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    stratumn_sdk (0.0.1)
+      http (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.20160615)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.0)
+    http (2.0.3)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.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.2)
+      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)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  stratumn_sdk!
+  vcr (~> 3.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 adrien
+
+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.

data/README.md

@@ -0,0 +1,155 @@
+# Stratumn SDK for Ruby
+
+[![build status](https://travis-ci.org/stratumn/stratumn-sdk-ruby.svg?branch=master)](https://travis-ci.org/stratumn/stratumn-sdk-ruby.svg?branch=master)
+
+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:
+
+```ruby
+gem 'stratumn-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stratumn-sdk
+
+## Quickstart
+
+```ruby
+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.
+ 
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+puts application.id
+```
+
+#### StratumnSdk::Application#create_map(*args)
+
+Creates a new map in the application.
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+link = application.create_map('My message map')
+```
+
+#### StratumnSdk::get_link(hash)
+
+Returns an existing link.
+
+```ruby
+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.
+
+```ruby
+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.
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+links = application.get_branches('aee5427', ['tag1', 'tag2'])
+```
+
+#### StratumnSdk::Link#previous
+
+Returns the previous link of a link (its parent).
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+link = application.get_link('aee5427')
+previous = link.previous
+```
+
+#### StratumnSdk::Link#load
+
+Load a full link. Can be useful when you only have the meta data of links.
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+links = application.get_branches('aee5427')
+
+links.map { |link| link.load }
+```
+
+#### StratumnSdk::Link#get_branches(tags)
+
+Returns the links whose previous hashes are the hash of the link, optionally filters by tags.
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+link = application.get_link('aee5427')
+link.get_branches(['tag1'])
+```
+
+#### StratumnSdk::Link#transition_function(*args)
+
+Executes a transition function and returns the new link.
+
+```ruby
+application = StratumnSdk::Application.load('quickstart')
+link = application.get_link('aee5427')
+new_link = link.addMessage('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).
+
+## 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stratumn_sdk"
+
+# 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/stratumn_sdk.rb

@@ -0,0 +1,39 @@
+require 'stratumn_sdk/version'
+require 'stratumn_sdk/request'
+require 'stratumn_sdk/application'
+require 'stratumn_sdk/link'
+
+require 'yaml'
+
+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 {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  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
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+end

data/lib/stratumn_sdk/application.rb

@@ -0,0 +1,56 @@
+module StratumnSdk
+  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)
+
+      self.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

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

data/lib/stratumn_sdk/request.rb

@@ -0,0 +1,27 @@
+require 'http'
+
+module StratumnSdk
+  module Request
+
+    def get(*args)
+      request(:get, *args)
+    end
+
+    def post(*args)
+      result = request(:post, *args)
+
+      raise result['meta']['errorMessage'] if result['meta'] && result['meta']['errorMessage']
+
+      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/stratumn_sdk/version.rb

@@ -0,0 +1,3 @@
+module StratumnSdk
+  VERSION = "0.0.1"
+end

data/stratumn_sdk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stratumn_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stratumn_sdk"
+  spec.version       = StratumnSdk::VERSION
+  spec.authors       = ["Stratumn Team"]
+  spec.email         = ["stratumn@gmail.com"]
+
+  spec.summary       = %q{Interact with your Stratumn agent from your ruby application}
+  spec.homepage      = "https://github.com/stratumn/stratumn-sdk-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+
+  spec.add_runtime_dependency "http", '~> 2.0'
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: stratumn_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stratumn Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-11 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: 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"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stratumn_sdk.rb
+- lib/stratumn_sdk/application.rb
+- lib/stratumn_sdk/link.rb
+- lib/stratumn_sdk/request.rb
+- lib/stratumn_sdk/version.rb
+- stratumn_sdk.gemspec
+homepage: https://github.com/stratumn/stratumn-sdk-ruby
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Interact with your Stratumn agent from your ruby application
+test_files: []