libroute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d093523558122cc8e521e21c316f93bf3289e1a
+  data.tar.gz: 7b7989390d2ae25b6afc9297904bae9447dac209
+SHA512:
+  metadata.gz: eba54ff35cefb2409f9979d72ef9eaf2e16f6a4632faf78449e3ff72587ef681c7df35efe8c04a25a319fe16993b34b5131929ffd9091fc19d770567382d4c5f
+  data.tar.gz: 733c25332d5d443eeccc855a31355405a84d656e6a2cc1dade50e05ed7c38743ec21d19a67481b51c9c9c3e088647bc97cb011bfd5f1809ec062f233482e8f45

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 XS Research Ltd
+
+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,114 @@
+# Libroute
+{http://libroute.io Home}
+{https://github.com/xsresearch/libroute-client-ruby GitHib}
+
+Libroute is a generic client interface to libraries which standardises and simplifies the process of running third party libraries.
+
+No need to battle with compile and build processes - install libroute once for a standard interface to third party libraries providing compute, scientific and mathematical functions.
+
+Libroute offers several benefits over installing libraries locally:
+
+* **Automated installation**
+
+No manual compile, build or installation process, start using third party libraries within minutes.
+
+* **Efficient processing**
+
+Interact with the library in its native language with a common, straightforward interface.
+
+* **Cross-platform capability**
+
+Make calls to the library using standard TCP sockets from any platform, anywhere.
+
+#### Quick start tutorial
+
+Visit the {http://libroute.io/getting-started getting started} page for a 5 minute tutorial on using libroute.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libroute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libroute
+
+Note: Docker is required to use libroute. This can be installed depending on your operating system using either of the following:
+
+    $ apt-get install docker
+    $ yum install docker
+
+## Libroute Client Usage
+
+Libroute is installed on the command line. The full range of options can be obtained by running the command:
+
+    $ libroute --help
+
+Running libroute consists of 3 steps
+
+1. Downloading the library onto your local machine
+2. Building and installing the library (an automated process)
+3. Running the library using the libroute command
+
+### Downloading the library
+
+First download and extract the library to a local directory. See the {http://libroute.io/libraries libroute libraries} page for instructions on how to download the currently supported libraries.
+
+If the library you wish to use is not supported, see the section on 'Adding support for additional libraries' below.
+
+### Building and installing the library
+
+To build a library called mylib which has been downloaded to /home/user/mylib, use the command:
+
+    $ libroute -l MYLIB -b /home/user/mylib
+
+The library will be built and installed. This process can take several minutes after which the library will be ready for use.
+
+### Running the library
+
+The installed library can be run either from the command line or directly from Ruby.
+
+#### From the command line
+
+To run a library called mylib with parameters param1 and param2 with values value1 and value2 correspondingly, use the command:
+
+    $ libroute -l mylib -p "param1=value1,param2=value2"
+
+#### From Ruby
+
+If necessary, require that the gem is loaded using:
+
+```ruby
+require 'libroute'
+```
+
+The following example shows how to launch a library called mylib with parameters param1 and param2 equal to value1 and value2:
+
+```ruby
+l = Libroute.exec('mylib', {'param1'=>'value1','param2'=>'value2'})
+```
+
+The return value is a Hash object with keys and values set. Check each library interface implementation for details on the return values.
+
+
+### Supporting additional libraries
+
+Support for additional libraries can be added by implementing the libroute-component interface.
+
+See the libroute-component gem for more information on how to do this.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xsresearch/libroute-ruby-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'libroute'
+
+
+  options = Libroute.parse(ARGV)
+
+  if options.library.empty?
+    puts "Error: No LIBRARY specified"
+    exit 1
+  end
+
+  if !options.build.empty?
+    puts "Building #{options.library} library... (todo)"
+    Libroute.build(options)
+    exit 0
+  end
+
+  puts "Running #{options.library} library... (todo)"
+  
+  params = options.params.split(",")
+  paramshash = Hash.new
+  params.each do |p|
+    key,val = p.split("=",2)
+    paramshash[key]=val
+  end
+
+  result = Libroute.exec(options.library, paramshash)
+
+  result.each do |k,v|
+    puts k + ": " + v
+  end
+

data/lib/libroute/librouteexec.rb

@@ -0,0 +1,64 @@
+module Libroute
+
+  class << self
+
+  def build(options)
+    puts "Building #{options.library} from directory #{options.build}"
+    im = Docker::Image.build_from_dir(options.build) do |v|
+      if (log = JSON.parse(v)) && log.has_key?("stream")
+        puts log["stream"]
+      end
+    end
+    im.tag('repo' => 'libroute_image-'+options.library)
+  end
+
+  def exec(library, params)
+
+    # Check if existing container running
+    c = Docker::Container.all(all: true).select{|c| c.info['Names'][0].eql?('/libroute_instance-' + library)}
+
+    if c.length == 1
+      # Check status
+      if c[0].info['State'].eql?('exited')
+        # Kill and request start
+        c[0].delete
+        c = []
+      end
+    end
+
+    if c.length == 0
+
+      # Launch container from image
+      image = Docker::Image.all.select{|x| x.info['RepoTags'][0].split(':')[0].include?('libroute_image-' + library)}.first
+      c = Docker::Container.create('Image' => image.id, 'name' => 'libroute_instance-' + library, 'Tty' => true)
+      c.start
+
+      # Wait for container to start
+      sleep 1
+
+    else
+      c = c[0]
+    end
+
+    ip_address = c.json['NetworkSettings']['IPAddress']
+
+    # Send and retrieve data from container
+    #s = TCPSocket.new(ip_address, 2000)
+    #s.write(Marshal.dump(params))
+    #s.close_write
+    #outp = Marshal.load(s.read)
+    #s.close
+
+    s = TCPSocket.new(ip_address, 2000)
+    s.write(params.to_bson.to_s)
+    s.close_write
+    outp = Hash.from_bson(BSON::ByteBuffer.new(s.read))
+    s.close
+
+    # Return response
+    return outp
+
+  end
+  end
+
+end

data/lib/libroute/librouteparse.rb

@@ -0,0 +1,71 @@
+module Libroute
+
+  class << self
+
+  CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
+  CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
+
+  #
+  # Return a structure describing the options.
+  #
+  def parse(args)
+    # The options specified on the command line will be collected in *options*.
+    # We set default values here.
+    options = OpenStruct.new
+    options.library = []
+    options.build = []
+    options.params = []
+    options.showhelp = false
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: libroute.rb [options]"
+
+      opts.separator ""
+      opts.separator "Required:"
+
+      # Mandatory argument.
+      #opts.on("-r", "--require LIBRARY",
+      #        "Require the LIBRARY before executing your script") do |lib|
+      #  options.library << lib
+      #end
+
+      opts.on("-l", "--lib LIBRARY","Name of the LIBRARY") do |lib|
+        options.library = lib
+      end
+
+      opts.separator ""
+      opts.separator "Options:"
+
+      opts.on("-b","--build DIR","Build the library from the specified directory") do |o|
+        options.build = o
+      end
+
+      opts.on("-p","--params PARAMETERS","Parameters","Comma separated list of parameters") do |p|
+        options.params = p
+      end
+
+      opts.on_tail("-h", "--help", "Show command options","Show library options (-l LIBRARY)") do |h|
+        if options.library.empty?
+          puts opts
+          exit
+        else
+          options.showhelp = h
+        end
+      end
+
+      # Another typical switch to print the version.
+      opts.on_tail("--version", "Show version") do
+        puts Libroute::VERSION
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+    options
+
+  end  # parse()
+
+  end
+
+end
+

data/lib/libroute/version.rb

@@ -0,0 +1,3 @@
+module Libroute
+  VERSION = "0.1.0"
+end

data/lib/libroute.rb

@@ -0,0 +1,18 @@
+require 'docker'
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require 'pp'
+require 'bson'
+
+require 'libroute/librouteexec'
+require 'libroute/librouteparse'
+require 'libroute/version'
+
+module Libroute
+
+  class << self
+
+  end
+
+end

data/libroute.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'libroute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "libroute"
+  spec.version       = Libroute::VERSION
+  spec.authors       = ["David Lisk (XS Research Ltd)"]
+  spec.email         = ["david.lisk@xsresearch.co.uk"]
+
+  spec.summary       = %q{Libroute standardises and simplifies the process of running third party libraries}
+  spec.homepage      = "http://libroute.io"
+  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_runtime_dependency "docker-api", "~> 1.31"
+  spec.add_runtime_dependency "bson", "~> 4.1"  
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: libroute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Lisk (XS Research Ltd)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- david.lisk@xsresearch.co.uk
+executables:
+- libroute
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/libroute
+- lib/libroute.rb
+- lib/libroute/librouteexec.rb
+- lib/libroute/librouteparse.rb
+- lib/libroute/version.rb
+- libroute.gemspec
+homepage: http://libroute.io
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Libroute standardises and simplifies the process of running third party libraries
+test_files: []