stratumn_sdk 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb3eee12791c77b0f6419290a6e86932b6d3062a
-  data.tar.gz: e1508ba9ea5e2936359488146e4cbe5fdca748dc
+  metadata.gz: 6d2abf779f1c0a8fcad745acab0014ea92a5b4e7
+  data.tar.gz: f9dd2942de0d88d5d7ca5da57e940e4169488224
 SHA512:
-  metadata.gz: 32896b423d268bfcae34ce7a01fbe5d432efaf001f1ae32b0bffbe52fa18fff57f54cb518dd0342ccea1b45e8fbd5421965d1c3fb3cf4a22420363b2db37d037
-  data.tar.gz: d69042a394cc1cbd4d3c08ef34bbcb7d3a3a8da65140c82bf72c6f8c0ed6488eb46e2765ed2e17148752a433cc08842bc50cd2eb9f98b27bf07eb64dc2ca3adc
+  metadata.gz: 015046b2b340eec30585a45d9d1c55e9686f741923b251ae865086dd5242e30ef1b67697fcf21753a3b17a11d04da0a6538f1c5f403e84afb4f1a8e458acca68
+  data.tar.gz: 18f15da26bb9ba77c65dd5ee5c7f9f6f58ac33b20f13bdc92018ab753687315e9ff765eea7e58c29ed6493886522c613bc9150925bb998f0345658c0c3a964bf

data/.gitignore

@@ -1 +1 @@
-doc
+pkg

data/.travis.yml

@@ -3,3 +3,6 @@ language: ruby
 rvm:
   - 2.3.0
   - 2.2
+script:
+  - bundle exec rake spec
+  - bundle exec rake rubocop

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    stratumn_sdk (0.0.1)
+    stratumn_sdk (0.1.0)
       http (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
+    ast (2.3.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
@@ -23,6 +24,10 @@ GEM
       domain_name (~> 0.5)
     http-form_data (1.0.1)
     http_parser.rb (0.6.0)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -37,10 +42,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.7.5)
     safe_yaml (1.0.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.2)
+    unicode-display_width (1.1.0)
     vcr (3.0.3)
     webmock (2.1.0)
       addressable (>= 2.3.6)
@@ -54,6 +67,7 @@ DEPENDENCIES
   bundler (~> 1.12)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.42)
   stratumn_sdk!
   vcr (~> 3.0)
   webmock (~> 2.1)

data/README.md

@@ -1,6 +1,7 @@
 # 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)
+[![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
 
@@ -121,6 +122,9 @@ Executes a transition function and returns the new link.
 application = StratumnSdk::Application.load('quickstart')
 link = application.get_link('aee5427')
 new_link = link.addMessage('Hello, World!')
+
+# underscore version is also available
+new_link = link.add_message('Hello, World!')
 ```
 
 ## Development

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "stratumn_sdk"
+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.
@@ -10,5 +10,5 @@ require "stratumn_sdk"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/stratumn_sdk/application.rb

@@ -1,4 +1,6 @@
 module StratumnSdk
+  ##
+  # Represents a Stratumn application
   class Application
     include Request
     extend Request
@@ -6,10 +8,14 @@ module StratumnSdk
     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)
+      url = application_location ||
+            StratumnSdk.config[:application_url].gsub('%s', application_name)
       attributes = get(url)
 
-      self.new(url, attributes['id'], attributes['name'], attributes['agentInfo'])
+      new(url,
+          attributes['id'],
+          attributes['name'],
+          attributes['agentInfo'])
     end
 
     def initialize(url, id, name, agent_info)

data/lib/stratumn_sdk/helper.rb

@@ -0,0 +1,13 @@
+module StratumnSdk
+  # 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/stratumn_sdk/link.rb

@@ -1,6 +1,9 @@
 module StratumnSdk
+  ##
+  # Represents a link in a Stratumn application
   class Link
     include Request
+    include Helper
 
     attr_accessor :application, :meta, :state, :link, :linkHash
 
@@ -13,14 +16,7 @@ module StratumnSdk
       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
+        add_transition_method(method)
       end
     end
 
@@ -39,9 +35,26 @@ module StratumnSdk
     def self.load(segment)
       meta = segment['meta']
 
-      application = Application.load(meta['application'], meta['applicationLocation'])
+      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/#{linkHash}/#{method}"
+
+        result = post(url, json: args)
+
+        self.class.new(application, result)
+      end
+
+      singleton_class.send(:alias_method, underscore(method), method)
+    end
   end
 end

data/lib/stratumn_sdk/request.rb

@@ -1,8 +1,9 @@
 require 'http'
 
 module StratumnSdk
+  ##
+  # Wrapper around HTTP.request that parses the response and raises on error
   module Request
-
     def get(*args)
       request(:get, *args)
     end
@@ -10,18 +11,21 @@ module StratumnSdk
     def post(*args)
       result = request(:post, *args)
 
-      raise result['meta']['errorMessage'] if result['meta'] && result['meta']['errorMessage']
+      if result['meta'] && result['meta']['errorMessage']
+        raise result['meta']['errorMessage']
+      end
 
       result
     end
 
     private
-      def request(verb, *args)
-        result = HTTP.request(verb, *args).parse
 
-        raise result['error'] if result.is_a?(Hash) && result['error']
+    def request(verb, *args)
+      result = HTTP.request(verb, *args).parse
 
-        result
-      end
+      raise result['error'] if result.is_a?(Hash) && result['error']
+
+      result
+    end
   end
 end

data/lib/stratumn_sdk/version.rb

@@ -1,3 +1,3 @@
 module StratumnSdk
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'.freeze
 end

data/lib/stratumn_sdk.rb

@@ -1,33 +1,39 @@
 require 'stratumn_sdk/version'
 require 'stratumn_sdk/request'
+require 'stratumn_sdk/helper'
 require 'stratumn_sdk/application'
 require 'stratumn_sdk/link'
 
 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'
-            }
+    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}
+    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))
+      config = YAML.load(IO.read(path_to_yaml_file))
     rescue Errno::ENOENT
-      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+      puts 'YAML configuration file couldn\'t be found. Using defaults.'
+      return
     rescue Psych::SyntaxError
-      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+      puts 'YAML configuration file contains invalid syntax. Using defaults.'
+      return
     end
 
     configure(config)

data/stratumn_sdk.gemspec

@@ -4,26 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stratumn_sdk/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "stratumn_sdk"
+  spec.name          = 'stratumn_sdk'
   spec.version       = StratumnSdk::VERSION
-  spec.authors       = ["Stratumn Team"]
-  spec.email         = ["stratumn@gmail.com"]
+  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.summary       = 'Interact with your Stratumn agent from your ruby app'
+  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.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.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_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_development_dependency 'rubocop', '~> 0.42'
 
-  spec.add_runtime_dependency "http", '~> 2.0'
+  spec.add_runtime_dependency 'http', '~> 2.0'
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stratumn_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Stratumn Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - bin/setup
 - lib/stratumn_sdk.rb
 - lib/stratumn_sdk/application.rb
+- lib/stratumn_sdk/helper.rb
 - lib/stratumn_sdk/link.rb
 - lib/stratumn_sdk/request.rb
 - lib/stratumn_sdk/version.rb
@@ -138,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Interact with your Stratumn agent from your ruby application
+summary: Interact with your Stratumn agent from your ruby app
 test_files: []