xremotebot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68c01bdb688bc6396fad2e903253c9cde49ec661
+  data.tar.gz: ac0874346c2ae60110ca1bf6fb22f4408b2a1520
+SHA512:
+  metadata.gz: a38b9ee64c67bc5749920b0535be85a093801bc78a105a32259976c29eb4cc2cd04b730941c07beb38cfcb066ef2c16bd73722b75960c3dc52512b84f6bcbb67
+  data.tar.gz: 7524d2da011156e8bd6fac20d88239cb86b5e971a2cb71dd4663ee77c79b8fa6b9296f464ab7370be35cdc144e4b12761b97479fcd88c041c468a4e3385f3ac7

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# Xremotebot
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xremotebot`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xremotebot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xremotebot
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/xremotebot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

data/bin/setup

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

data/lib/xremotebot.rb

@@ -0,0 +1,172 @@
+require 'xremotebot/version'
+require 'websocket'
+require 'json'
+
+module XRemoteBot
+  alias :wait :sleep
+
+  class WS
+    def initialize(host, port, path)
+      @sock = TCPSocket.new host, port
+      url = %Q(ws://#{host}:#{port}/#{path})
+      @handshake = WebSocket::Handshake::Client.new(url: url)
+      @sock.puts(@handshake)
+
+      @handshake << @sock.recv(4096)
+      while !@handshake.finished?
+        @handshake << @sock.recv(4096)
+      end
+
+      raise Exception unless @handshake.valid?
+
+    end
+
+    def send(data)
+      frame = WebSocket::Frame::Outgoing::Server.new(
+        version: @handshake.version,
+        data: data,
+        type: :text
+      )
+      @sock.send frame.to_s, 0
+    end
+
+    def receive()
+      frame = WebSocket::Frame::Incoming::Server.new(
+        version: @handshake.version
+      )
+      frame << @sock.recv(4096)
+      data = ''
+      loop do
+        part = frame.next
+        break if part.nil?
+        data += part.to_s
+      end
+      return data
+    end
+
+  end
+  class Server
+    attr_reader :ws
+    def initialize(host, port, path, api_key)
+      @ws = WS.new(host, port, path)
+      if authentication_required 
+        raise Exception, 'Authentication failed' unless authenticate(api_key)
+      end
+    end
+
+    def send_ws_msg(entity, method, *args)
+      msg = JSON.dump({
+        entity: entity,
+        method: method,
+        args: args,
+      })
+      ws.send(msg)
+      response = JSON.load ws.receive
+      raise Exception, response['message'] if response['response'] == 'error'
+      response['value']
+    end
+
+    def authentication_required
+      send_ws_msg 'global', 'authentication_required'
+    end
+
+    def authenticate(api_key)
+      send_ws_msg 'global', 'authenticate', api_key
+    end
+
+    def get_robots
+      send_ws_msg 'global', 'get_robots'
+    end
+
+    def fetch_robot
+      send_ws_msg 'global', 'fetch_robot'
+    end
+
+    def reserve(robot_model, robot_id)
+      send_ws_msg 'global', 'reserve', robot_model, robot_id
+    end
+  end
+
+  class Robot
+    def initialize(server, robot_obj)
+      @server = server
+      @robot_model = robot_obj['robot_model']
+      @robot_id = robot_obj['robot_id']
+    end
+
+    def send_ws_msg(msg, *args)
+      @server.send_ws_msg('robot',
+                          msg,
+                          {
+                            robot_model: @robot_model,
+                            robot_id: @robot_id,
+                          },
+                          *args)
+    end
+
+    def forward(speed=50, time=-1)
+      move('forward', speed, time)
+    end
+
+    def backward(speed=50, time=-1)
+      move('backward', speed, time)
+    end
+
+    def turnLeft(speed=50, time=-1)
+      move('turnLeft', speed, time)
+    end
+
+    def turnRight(speed=50, time=-1)
+      move('turnRight', speed, time)
+    end
+
+    def stop()
+      send_ws_msg 'stop'
+    end
+
+    def ping()
+      send_ws_msg 'ping'
+    end
+
+    def getObstacle()
+      send_ws_msg 'getObstacle'
+    end
+
+    def getLine()
+      send_ws_msg 'getLine'
+    end
+
+    private
+    def move(direction, speed=50, time=-1)
+      timed(time, self, :stop) do
+        send_ws_msg(direction, speed)
+      end
+    end
+
+    def timed(time, instance, method)
+      yield
+      if time >= 0
+        sleep time
+        instance.send method
+      end
+    end
+  end
+
+  def self.main
+    puts 'api_key:'
+    server = XRemoteBot::Server.new('xremotebot.example',
+                                    8000,
+                                    'api',
+                                    gets.strip)
+    print "Robots #{server.get_robots}\n"
+    robot = Robot.new server, server.fetch_robot
+    robot.forward 100, 1
+    robot.turnRight 100, 1
+    p robot.getLine
+    p robot.getObstacle
+  end
+end
+
+if __FILE__ == $0
+  XRemoteBot.main
+end

data/lib/xremotebot/version.rb

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

data/xremotebot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xremotebot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xremotebot"
+  spec.version       = XRemoteBot::VERSION
+  spec.authors       = ["'Fernando López'"]
+  spec.email         = ["'soportelihuen@linti.unlp.edu.ar'"]
+
+  spec.summary       = %q{Ruby client for XRemoteBot}
+  spec.description   = %q{Ruby client to control robots through the XRemoteBot server.}
+  spec.homepage      = "https://github.com/fernandolopez/xremotebot-clients"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.licenses      = ["MIT"]
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "websocket", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rb-readline", "~> 0.5"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: xremotebot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Fernando López'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Ruby client to control robots through the XRemoteBot server.
+email:
+- "'soportelihuen@linti.unlp.edu.ar'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xremotebot.rb
+- lib/xremotebot/version.rb
+- xremotebot.gemspec
+homepage: https://github.com/fernandolopez/xremotebot-clients
+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.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for XRemoteBot
+test_files: []