mycroft 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2014, The Society of Software Engineers
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Society of Software Engineers nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE SOCIETY OF SOFTWARE ENGINEERS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,81 @@
+# Mycroft
+
+Gem for creating mycroft application in ruby.
+
+### Install
+Install bundler:
+~~~
+gem install bundler
+~~~
+
+From inside the ruby app directory
+
+~~~
+bundle install
+rake install
+~~~
+If we ever put this on ruby gems:
+
+```
+gem install mycroft
+```
+
+### Create a new App
+`mycroft-ruby new [APPNAME]`
+
+## Running your app
+`ruby YOUR_APP.rb [--no-tls]`
+
+### Example App
+```ruby
+require 'mycroft'
+
+class MockAppRuby < Mycroft::Client
+
+  def initialize(host, port)
+    @key = ''
+    @cert = ''
+    @manifest = './mock_app_ruby.json'
+    @verified = false
+    super
+  end
+
+  on 'APP_DEPENDENCY' do |data|
+    up
+    broadcast({message: "I'm broadcasting things"})
+  end
+end
+
+Mycroft::start(MockAppRuby)
+```
+
+### Overview of MockRubyApp
+
+#### initialize
+Specify the path to key, path to cert, path to app manifest, and whether it's verified or not. Set that to false.
+
+#### on
+For each of the different messages, you create an event handler using the `on` method. You can also do this for `CONNECT`, `CONNECTION_CLOSED`, and `ERROR`. You can create multiple handlers per message if that's what you want to do. The Base class creates 3 for you. On `APP_MANIFEST_OK` `@verified` is set to `true`. On `APP_MANIFEST_FAIL` and `MSG_GENERAL_FAILURE`, it raises an error. On `APP_DEPENDENCY`, `@depedencies` is updated with current dependencies.
+
+### Helper Methods
+
+#### up
+Sends `APP_UP` to mycroft
+
+#### down
+Sends `APP_DOWN` to mycroft
+
+#### in_use
+Sends `APP_IN_USE` to mycroft
+
+#### query(capability, action, data, priority = 30, instance_id = nil)
+Sends a `MSG_QUERY` to mycroft
+
+#### broadcast(content)
+Sends a `MSG_BROADCAST` to mycroft
+
+#### query_success(id, ret)
+Sends a `MSG_QUERY_SUCCESS` to mycroft
+
+#### query_fail(id, message)
+Sends a `MSG_QUERY_FAIL` to mycroft

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/mycroft-ruby

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'mycroft/version'
+require 'mycroft/cli'
+
+Mycroft::CLI.start(ARGV)

data/lib/mycroft.rb

@@ -0,0 +1,14 @@
+require 'mycroft/version'
+require 'mycroft/cli'
+require 'mycroft/helpers'
+require 'mycroft/messages'
+require 'mycroft/client'
+
+module Mycroft
+  extend self
+  MYCROFT_PORT = 1847
+
+  def start(app, host='localhost', port=MYCROFT_PORT)
+    app.new(host, port)
+  end
+end

data/lib/mycroft/cli.rb

@@ -0,0 +1,39 @@
+require 'thor'
+require 'active_support/lazy_load_hooks'
+require 'active_support/core_ext/string'
+require 'highline/import'
+
+module Mycroft
+  class CLI < Thor
+    desc "new [APPNAME]", "create a new app with the name APPNAME"
+    def new(app_name=nil)
+      app_name = ask("App Name: ") if app_name.nil?
+      dn = ask("Display Name: ")
+      instance_id = ask("Instance Id: ")
+      desc = ask("Description: ")
+      camelcase = app_name.camelize
+      underscore = app_name.underscore
+      dashed = app_name.dasherize
+      path = "#{Gem.dir}/gems/mycroft-#{Mycroft::VERSION}/lib/mycroft/templates/"
+      app_template = File.read("#{path}/app_template")
+      app_template.gsub!(/%%APPNAME%%/, camelcase)
+      app_template.gsub!(/%%UNDERSCORE%%/, underscore)
+
+      app_manifest = File.read("#{path}/app_manifest")
+      app_manifest.gsub!(/%%DASHED%%/, dashed)
+      app_manifest.gsub!(/%%DISPLAYNAME%%/, dn)
+      app_manifest.gsub!(/%%INSTANCEID%%/, instance_id)
+      app_manifest.gsub!(/%%DESC%%/, desc)
+
+      app_file = File.open("./#{underscore}.rb", 'w')
+      app_file.puts app_template
+      app_file.close
+      puts "Successfully created #{underscore}.rb"
+
+      app_file = File.open("./app.json", 'w')
+      app_file.puts app_manifest
+      app_file.close
+      puts "Successfully created app.json"
+    end
+  end
+end

data/lib/mycroft/client.rb

@@ -0,0 +1,74 @@
+require 'socket'
+require 'io/wait'
+
+module Mycroft
+  class Client
+    include Messages
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+      @name ||= 'mycroft'
+      connect_to_mycroft
+      if @threaded
+        Thread.new do
+          setup
+        end
+      else
+        setup
+      end
+    rescue Exception => e
+      instance_exec(e, &@@handlers['ERROR']) unless @@handlers['ERROR'].nil?
+    end
+
+    def setup
+      send_manifest
+      instance_eval &@@handlers['CONNECT'] unless @@handlers['CONNECT'].nil?
+      run
+    end
+
+    def self.on(type, &block)
+      @@handlers ||= {}
+      @@handlers[type] = block
+    end
+
+    def run
+      loop do
+        if @client.ready?
+          size = @client.readline
+          data = @client.read(size.to_i)
+          parsed = parse_message(data)
+          unless @@handlers[parsed[:type]].nil?
+            instance_exec(parsed[:data], &@@handlers[parsed[:type]])
+          else
+          end
+        end
+        on_event_loop if methods.include?(:on_event_loop)
+      end
+    ensure
+      shutdown
+    end
+
+    def shutdown
+      instance_eval &@@handlers['CONNECTION_CLOSED'] unless @@handlers['CONNECTION_CLOSED'].nil?
+      down
+      @client.close
+    end
+
+    on 'APP_MANIFEST_OK' do |data|
+      @verified = true
+    end
+
+    on 'APP_MANIFEST_FAIL' do |data|
+      raise 'Invalid application manifest'
+    end
+
+    on 'MSG_GENERAL_FAILURE' do |data|
+      raise data.message
+    end
+
+    on 'APP_DEPENDENCY' do |data|
+      update_dependencies(data)
+    end
+  end
+end

data/lib/mycroft/helpers.rb

@@ -0,0 +1,40 @@
+module Mycroft
+  module Helpers
+
+    # Parses a message
+    def parse_message(msg)
+      msg = msg.to_s
+      re = /([A-Z_]+) ({.*})$/
+      msg_split = re.match(msg)
+      if msg_split.nil?
+        re = /^([A-Z_]+)$/
+        msg_split = re.match(msg)
+        raise "Error: Malformed Message" if not msg_split
+        type = msg_split[1]
+        data = {}
+      else
+        type = msg_split[1]
+        data = JSON.parse(msg_split[2])
+      end
+      {type: type, data: data}
+    end
+
+    # Sends a message of a specific type
+    def send_message(type, message=nil)
+      message = message.nil? ? message = '' : message.to_json
+      body = type + ' ' + message
+      body.strip!
+      length = body.bytesize
+      @client.write("#{length}\n#{body}")
+    end
+
+    def update_dependencies(deps)
+      deps.each do |capability, instance|
+        @dependencies[capability] ||= {}
+        instance.each do |app_id, status|
+          @dependencies[capability][app_id] = status
+        end
+      end
+    end
+  end
+end

data/lib/mycroft/messages.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'securerandom'
+require 'socket'
+
+module Mycroft
+  module Messages
+    include Helpers
+
+    # connects to mycroft aka starts tls if necessary
+    def connect_to_mycroft
+      if ARGV.length == 1 and ARGV[0] == '--no-tls'
+        @client = TCPSocket.open(@host, @port)
+      else
+        socket = TCPSocket.new(@host, @port)
+        ssl_context = OpenSSL::SSL::SSLContext.new
+        ssl_context.cert = OpenSSL::X509::Certificate.new(File.open(@cert))
+        ssl_context.key = OpenSSL::PKey::RSA.new(File.open(@key))
+        @client = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+        begin
+          @client.connect
+        rescue
+        end
+      end
+    end
+
+    # Sends the app manifest to mycroft
+    def send_manifest
+      begin
+        manifest = JSON.parse(File.read(@manifest))
+        manifest['instanceId'] = "#{Socket.gethostname}_#{SecureRandom.uuid}" if @generate_instance_ids
+        @instance_id = manifest['instanceId']
+      rescue
+      end
+      send_message('APP_MANIFEST', manifest)
+    end
+
+    # Sends app up to mycroft
+    def up
+      send_message('APP_UP')
+    end
+
+    # Sends app down to mycroft
+    def down
+      send_message('APP_DOWN')
+    end
+
+    def in_use(priority)
+      send_message('APP_IN_USE', {priority: (priority or 30)})
+    end
+
+    # Sends a query to mycroft
+    def query(capability, action, data, priority = 30, instance_id = nil)
+      query_message = {
+        id: SecureRandom.uuid,
+        capability: capability,
+        action: action,
+        data: data,
+        priority: priority,
+        instanceId: []
+      }
+      query_message[:instanceId] = instance_id unless instance_id.nil?
+
+      send_message('MSG_QUERY', query_message)
+    end
+
+    def query_success(id, ret)
+      query_success_message = {
+        id: id,
+        ret: ret
+      }
+      send_message('MSG_QUERY_SUCCESS', query_success_message)
+    end
+
+    def query_fail(id, message)
+      query_fail_message = {
+        id: id,
+        message: message
+      }
+      send_message('MSG_QUERY_FAIL', query_fail_message)
+    end
+
+    # Sends a broadcast to the mycroft message board
+    def broadcast(content)
+      message = {
+        id: SecureRandom.uuid,
+        content: content
+      }
+
+      send_message('MSG_BROADCAST', message)
+    end
+  end
+end

data/lib/mycroft/templates/app_manifest

@@ -0,0 +1,14 @@
+{
+    "version": "0.0.0",
+    "name": "%%DASHED%%",
+    "displayName": "%%DISPLAYNAME%%",
+    "instanceId": "%%INSTANCEID%%",
+    "capabilities": {
+
+    },
+    "API": 0,
+    "description": "%%DESC%%",
+    "dependencies": {
+
+    }
+}

data/lib/mycroft/templates/app_template

@@ -0,0 +1,21 @@
+require 'mycroft'
+
+class %%APPNAME%% < Mycroft::Client
+
+  def initialize(host, port)
+    @key = '/path/to/key'
+    @cert = '/path/to/cert'
+    @manifest = './app.json'
+    @verified = false
+    super
+  end
+
+  on 'APP_DEPENDENCY' do |data|
+    # Your code here
+  end
+
+  # Any other event handlers
+
+end
+
+Mycroft.start(%%APPNAME%%)

data/lib/mycroft/version.rb

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

data/mycroft.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mycroft/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mycroft"
+  spec.version       = Mycroft::VERSION
+  spec.authors       = ["rit-sse"]
+  spec.description   = %q{Gem for creating a mycroft app in ruby.}
+  spec.summary       = %q{Gem for creating a mycroft app in ruby.}
+  spec.homepage      = "https://github.com/rit-sse-mycroft/template-ruby"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "i18n"
+  spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "highline"
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+
+describe Mycroft::Helpers do
+  let(:client) {Mycroft::MockMycroftClient.new}
+  context 'message parsing' do
+    it 'should parse messages with a body' do
+      message = 'MSG_QUERY {"something": "something else"}'
+      hash = client.parse_message(message)
+      expect(hash).to eql({type: 'MSG_QUERY', data: {'something' => 'something else'}})
+    end
+
+    it 'should parse messages without a body' do
+      message = 'APP_UP'
+      hash = client.parse_message(message)
+      expect(hash).to eql({type: 'APP_UP', data: {}})
+    end
+
+    context 'malformed message' do
+      it 'should raise error for backwards message' do
+        message = '{"something": "something else"} MSG_QUERY'
+        expect{ client.parse_message(message) }.to raise_error
+      end
+
+      it 'should raise an error for just a json object' do
+        message = '{"something": "something else"}'
+        expect{ client.parse_message(message) }.to raise_error
+      end
+
+      it 'should raise an error for empty string' do
+        expect{ client.parse_message('') }.to raise_error
+      end
+    end
+  end
+
+  context 'sending messages' do
+    it 'will send message with a body' do
+      client.send_message('MSG_QUERY',{something: 'something else'})
+      expect(client.server.read).to eql({size: 40, message: 'MSG_QUERY {"something":"something else"}'})
+    end
+
+    it 'will send message without a body' do
+      client.send_message('APP_UP')
+      expect(client.server.read).to eql({size: 6, message: 'APP_UP'})
+    end
+  end
+
+  context 'updating dependencies' do
+    it 'will update dependencies without existing dependencies' do
+      deps = {'stt' => {'stt1' => 'up', 'stt2' => 'down'}, 'logger' => {'logger1' => 'up', 'logger2' => 'down'}}
+      client.update_dependencies(deps)
+      expect(client.dependencies).to eql(deps)
+    end
+
+    it 'will update dependencies with existing dependencies'do
+      client.dependencies = {'stt' => {'stt1' => 'up', 'stt2' => 'down'}, 'logger' => {'logger1' => 'up', 'logger2' => 'down'}}
+      client.update_dependencies({'stt' => {'stt1' => 'down'}})
+      client.update_dependencies({'tts' => {'tts1' => 'up'}})
+      new_deps = {'stt' => {'stt1' => 'down', 'stt2' => 'down'}, 'logger' => {'logger1' => 'up', 'logger2' => 'down'}, 'tts' => {'tts1' => 'up'}}
+      expect(client.dependencies).to eql(new_deps)
+    end
+  end
+end

data/spec/mock.rb

@@ -0,0 +1,38 @@
+require 'stringio'
+module Mycroft
+  class MockClient
+    def initialize(server)
+      @server = server
+    end
+    def write(bytes)
+      @server.stream.write(bytes)
+    end
+  end
+
+  class MockServer
+    attr_reader :stream
+
+    def initialize
+      @stream = StringIO.new
+    end
+
+    def read
+      @stream.rewind
+      size = @stream.readline
+      message = @stream.read(size.to_i)
+      {size: size.to_i, message: message}
+    end
+  end
+
+  class MockMycroftClient
+    include Messages
+
+    attr_accessor :server, :dependencies
+
+    def initialize
+      @dependencies = {}
+      @server = MockServer.new
+      @client = MockClient.new(@server)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'mycroft')
+require 'mock'

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: mycroft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- rit-sse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for creating a mycroft app in ruby.
+email: 
+executables:
+- mycroft-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/mycroft-ruby
+- lib/mycroft.rb
+- lib/mycroft/cli.rb
+- lib/mycroft/client.rb
+- lib/mycroft/helpers.rb
+- lib/mycroft/messages.rb
+- lib/mycroft/templates/app_manifest
+- lib/mycroft/templates/app_template
+- lib/mycroft/version.rb
+- mycroft.gemspec
+- spec/helpers_spec.rb
+- spec/mock.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rit-sse-mycroft/template-ruby
+licenses:
+- BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: Gem for creating a mycroft app in ruby.
+test_files:
+- spec/helpers_spec.rb
+- spec/mock.rb
+- spec/spec_helper.rb