robobot 0.0.1

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 robobot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Pramberger
+
+MIT License
+
+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,45 @@
+# Robobot
+
+TODO: Write a gem description
+
+**This gem works only on linux!**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'robobot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install robobot
+
+## Depencies
+
+You need to have xdotool installed
+
+    $ sudo apt-get install xdotool
+
+If you like notifications you need libnotify as well:
+
+    $ sudo apt-get install libnotify-bin
+
+And if you want to use the beep functions you need to:
+
+    $ modprobe pcspkr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/examples/build.sh

@@ -0,0 +1,6 @@
+cd ..
+rm *.gem
+gem build *.gemspec
+sudo gem install *.gem
+rm *.gem
+cd examples

data/examples/test.rb

@@ -0,0 +1,61 @@
+require 'robobot'
+require "robobot/window"
+require "robobot/notification"
+require "robobot/keyboard"
+require "robobot/mouse"
+require "robobot/workspaces"
+
+Robobot.debug = true
+
+Robobot::Notification.show "Select a window", :timeout => 500
+Robobot::Notification.beep :frequency => 150, :length => 100
+
+window = Robobot::Window.new :click
+puts "Window name:\t#{window.name}"
+puts "Window geo :\t#{window.geometry}"
+
+# set size may bugs if not hidden
+window.hide
+window.set_size 1920, 500
+window.show
+window.set_position 0, 0
+window.raise
+window.focus
+# window.kill
+
+# Test keyboard
+keyboard = Robobot::Keyboard.new window
+10.times do
+keyboard.key "space"
+end
+
+# Test mouse
+mouse = Robobot::Mouse.new window
+mouse.click
+sleep 1
+mouse.move 100, 100
+mouse.click 3
+sleep 0.5
+mouse.move 80, 80
+mouse.down
+sleep 0.2
+mouse.up
+mouse.click
+
+# Test workspaces
+puts "Workspaces: #{Robobot::Workspaces.count}"
+Robobot::Workspaces.count 4
+puts "Workspaces: #{Robobot::Workspaces.count}"
+
+puts "Current: #{Robobot::Workspaces.current}"
+Robobot::Workspaces.current 2
+sleep 0.5
+
+puts "Window is on: #{Robobot::Workspaces.get_workspace(window)}"
+Robobot::Workspaces.move window, 2
+puts "Window is now on: #{Robobot::Workspaces.get_workspace(window)}"
+
+window.focus
+sleep 1
+Robobot::Workspaces.move window, 0
+window.focus

data/lib/robobot.rb

@@ -0,0 +1,6 @@
+require "robobot/version"
+
+module Robobot
+	class << self; attr_accessor :debug; end
+	@debug = false
+end

data/lib/robobot/keyboard.rb

@@ -0,0 +1,52 @@
+# This class controls the keyboard
+
+# Author::    Roman Pramberger (mailto:roman@pramberger.ch)
+# License::   MIT
+
+module Robobot
+	class Keyboard
+
+		# Initialize keyboard
+		def initialize window = nil
+			@window = window
+		end
+
+		# Press key
+		#
+		# You may use any Syntax like:
+		#     space, Control+a, A, up, alt+r, 
+		#     BackSpace, Control, Control_R, shift, super, ...
+		#
+		def key key
+			cmd "key #{key}"
+		end
+
+		# Key down only
+		def keydown key
+			cmd "keydown #{key}"
+		end
+
+		# Key up
+		def keyup key
+			cmd "keyup #{key}"
+		end
+
+		# type text
+		def type text
+			cmd "type \"#{text}\""
+		end
+
+		private
+
+		# Command generator (add window if set)
+		def cmd command
+			command = command.split(" ",2)
+			cmd = "xdotool #{command[0]}"
+			cmd += " --window #{@window.id}" if @window
+			cmd += " #{command[1]}"
+			puts "#{cmd}"
+			`#{cmd}`
+		end
+
+	end
+end

data/lib/robobot/mouse.rb

@@ -0,0 +1,71 @@
+# This class controls the mouse
+
+# Author::    Roman Pramberger (mailto:roman@pramberger.ch)
+# License::   MIT
+
+module Robobot
+	class Mouse
+
+		# Initialize mouse
+		def initialize window = nil
+			@window = window
+		end
+
+		# Move mouse to x,y
+		def move x,y
+			cmd "mousemove --sync #{x} #{y}"
+		end
+
+		# Move relative to current position
+		def move_relative x,y
+			cmd "mousemove_relative --sync #{x} #{y}"
+		end
+
+		# Click
+		#
+		# Buttons:
+		#    1 = Left
+		#    2 = Middle
+		#    3 = Right
+		#    4 = Wheel up
+		#    5 = Wheel down
+		#
+		def click button = "1"
+			cmd "click #{button}"
+		end
+
+		# Mouse down (see Click)
+		def down button = "1"
+			cmd = "mousedown #{button}"
+		end
+
+		# Mouse up (see Click)
+		def up button = "1"
+			cmd = "mousedown #{button}"
+		end
+
+		# Get location
+		def location
+			location = `xdotool getmouselocation --shell`.split("\n")
+			return {
+				:x => location[0].split("=")[1],
+				:y => location[1].split("=")[1],
+				:screen => location[2].split("=")[1],
+				:window => location[3].split("=")[1]
+			}
+		end
+
+		private
+
+		# Command generator (add window if set)
+		def cmd command
+			command = command.split(" ",2)
+			cmd = "xdotool #{command[0]}"
+			cmd += " --window #{@window.id}" if @window
+			cmd += " #{command[1]}"
+			puts "#{cmd}"
+			`#{cmd}`
+		end
+
+	end
+end

data/lib/robobot/notification.rb

@@ -0,0 +1,57 @@
+# Notifications help to show results and information to the user
+# It uses: libnotify
+
+# Author::    Roman Pramberger (mailto:roman@pramberger.ch)
+# License::   MIT
+
+module Robobot
+	module Notification
+
+		# show a notification
+		# you must define a title
+		#
+		# Parameter
+		#    title:    required title
+		#    options:  see below
+		#
+		# Options
+		#    :msg      optional message
+		#    :icon     icon path
+		#    :urgency  low, normal or critical
+		#    :time     time in milliseconds
+		#
+		def self.show title, options
+			cmd = "notify-send \"#{title}\""
+			cmd += " \"#{options[:msg]}\"" if !options[:msg].nil?
+			cmd += " -i #{options[:icon]}" if !options[:icon].nil?
+			cmd += " -u #{options[:urgency]}" if !options[:urgency].nil?
+			cmd += " -t #{options[:timeout]}" if !options[:timeout].nil?
+			`#{cmd}`
+			puts cmd if Robobot.debug
+		end
+
+		# beeping :)
+		# in order to make it work you have to:
+		#     modprobe pcspkr
+		#
+		# Parameter
+		#    options:   see below
+		#
+		# Options
+		#    :frequency
+		#    :length
+		#    :repeat
+		#    :delay
+		#
+		def self.beep options
+			cmd = "beep"
+			cmd += " -f #{options[:frequency]}" if !options[:frequency].nil?
+			cmd += " -l #{options[:length]}" if !options[:length].nil?
+			cmd += " -r #{options[:repeat]}" if !options[:repeat].nil?
+			cmd += " -D #{options[:delay]}" if !options[:delay].nil?
+			`beep`
+			puts cmd if Robobot.debug
+		end
+
+	end
+end

data/lib/robobot/version.rb

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

data/lib/robobot/window.rb

@@ -0,0 +1,103 @@
+# This class handles the window on which the commands are used
+# Its fully optional, if now window is defined it will use
+# the current active one.
+
+# Author::    Roman Pramberger (mailto:roman@pramberger.ch)
+# License::   MIT
+
+module Robobot
+	class Window
+		require 'RMagick'
+		@window
+		@img
+
+		# Gets a window by process name (string) or process id (integer)
+		# you may also use :current to use the current active one
+		# or use :click to request clicking the window
+		def initialize name_or_pid
+			if name_or_pid == :current
+				@window = `xdotool getwindowfocus`.chomp
+			elsif name_or_pid == :click
+				@window = `xdotool selectwindow`.chomp
+			elsif name_or_pid.is_a? String
+				@window = `xdotool search #{name_or_pid} | head -1`.chomp
+			elsif name_or_pid.is_a? Integer
+				@window = `xdotool search --pid #{name_or_pid}`.chomp
+			else
+				raise 'Not a valid window value'
+			end
+			if Robobot.debug
+				puts "Window selected: #{@window}" 
+			end
+		end
+
+		# Return window id
+		def id
+			@window
+		end
+
+		# Return a windows name
+		def name
+			return `xdotool getwindowname #{@window}`.chomp
+		end
+
+		# Return window geometry
+		def geometry
+			geo = `xdotool getwindowgeometry #{@window}`.chomp.split("\n")
+			xy = geo[1].split(": ")[1].split(" ")[0].split(",")
+			screen = geo[1].split("(")[1].split(": ")[1].split(")")[0]
+			wh = geo[2].split(": ")[1].chomp.split("x")
+			out = { 
+				:x => xy[0].to_i, 
+				:y => xy[1].to_i,
+				:screen => screen.to_i,
+				:width => wh[0].to_i,
+				:height => wh[1].to_i
+			}
+			return out
+		end
+
+		# Set window size
+		def set_size width, height
+			`xdotool windowsize #{@window} #{width} #{height}`
+			puts "xdotool windowsize #{@window} #{width} #{height}" if Robobot.debug
+		end
+
+		# Set window position
+		def set_position x, y
+			`xdotool windowmove #{@window} #{x} #{y}`
+			puts "xdotool windowmove #{@window} #{x} #{y}" if Robobot.debug
+		end
+
+		# Hide window
+		def hide
+			`xdotool windowunmap #{@window}`
+			puts "xdotool windowunmap #{@window}" if Robobot.debug
+		end
+
+		# Show window
+		def show
+			`xdotool windowmap #{@window}`
+			puts "xdotool windowmap #{@window}" if Robobot.debug
+		end
+
+		# Raise window to the front
+		def raise
+			`xdotool windowraise #{@window}`
+			puts "xdotool windowraise #{@window}" if Robobot.debug
+		end
+
+		# Focus the window
+		def focus
+			# may work better than windowfocus, also switches workspaces
+			`xdotool windowactivate --sync #{@window}`
+			puts "xdotool windowactivate --sync #{@window}" if Robobot.debug
+		end
+
+		# Kill window
+		def kill
+			`xdotool windowkill #{@window}`
+			puts "xdotool windowkill #{@window}" if Robobot.debug
+		end
+	end
+end

data/lib/robobot/workspaces.rb

@@ -0,0 +1,38 @@
+# This module helps controling workspaces
+
+# Author::    Roman Pramberger (mailto:roman@pramberger.ch)
+# License::   MIT
+
+module Robobot
+	module Workspaces
+
+		# Get or Set current workspace count
+		def self.count num = nil
+			if num.nil?
+				return `xdotool get_num_desktops`
+			else
+				`xdotool set_num_desktops #{num}`
+			end
+		end
+
+		# Get or Set current workspace
+		def self.current workspace = nil
+			if workspace.nil?
+				return `xdotool get_desktop`
+			else
+				`xdotool set_desktop #{workspace}`
+			end
+		end
+
+		# Move window to workspace
+		def self.move window, workspace
+			`xdotool set_desktop_for_window #{window.id} #{workspace}`
+		end
+
+		# Get workspace of window
+		def self.get_workspace window
+			`xdotool get_desktop_for_window #{window.id}`
+		end
+
+	end
+end

data/robobot.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robobot/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "robobot"
+  gem.version       = Robobot::VERSION
+  gem.authors       = ["Roman Pramberger"]
+  gem.email         = ["roman@pramberger.ch"]
+  gem.description   = %q{Automate tasks with mouse and keyboard inputs.}
+  gem.summary       = %q{Automate tasks with mouse and keyboard inputs.}
+  gem.homepage      = ""
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: robobot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roman Pramberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-25 00:00:00.000000000 Z
+dependencies: []
+description: Automate tasks with mouse and keyboard inputs.
+email:
+- roman@pramberger.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/build.sh
+- examples/test.rb
+- lib/robobot.rb
+- lib/robobot/keyboard.rb
+- lib/robobot/mouse.rb
+- lib/robobot/notification.rb
+- lib/robobot/version.rb
+- lib/robobot/window.rb
+- lib/robobot/workspaces.rb
+- robobot.gemspec
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: Automate tasks with mouse and keyboard inputs.
+test_files: []