mac-event-monitor 0.1.0 → 0.2.0

data/README.md

@@ -9,13 +9,26 @@ A Library to Monitor User Interactions
 ## Usage
 
     require 'mac-event-monitor'
-
+    
     monitor = Mac::EventMonitor::Monitor.new
+
+### Monitor Mouse Event
+
     monitor.add_listener(:mouse_down) do |event|
       puts [event.location.x, event.location.y].join(',')
     end
     monitor.run
 
+### Monitor Keyboard Event
+
+You need to enable "Access to assistive devices" in the Universal Access preference pane to monitor keyboard event.
+
+    monitor.add_listener(:key_down) do |event|
+      p event.keycode
+      p event.shift_key?
+    end
+    monitor.run
+
 ## Contributing
 
 1. Fork it

data/ext/event_monitor/event_monitor.h

@@ -1,4 +1,4 @@
-#include <ruby.h>
+#include <ruby/ruby.h>
 #import <AppKit/AppKit.h>
 
 @interface EventMonitorAppDelegate : NSObject <NSApplicationDelegate> {

data/ext/event_monitor/event_monitor.m

@@ -29,6 +29,7 @@ NSEventMask mask =
   NSEvent *event;
 
   [NSEvent removeMonitor:[timer userInfo]];
+  [timer invalidate];
   [timer release];
 
   [[NSApplication sharedApplication] stop:nil];
@@ -49,6 +50,22 @@ NSEventMask mask =
 
 @end
 
+double getScreenHeight()
+{
+  NSScreen *mainScreen = [NSScreen mainScreen];
+  NSScreen *firstScreen = [[NSScreen screens] objectAtIndex:0];
+
+  NSRect screenRect = [mainScreen visibleFrame];
+  double screenHeight = NSHeight(screenRect);
+
+  // http://stackoverflow.com/questions/3163343/how-can-i-detemine-which-screen-holds-the-menubar
+  if(mainScreen == firstScreen) {
+    screenHeight += 22;
+  }
+
+  return screenHeight;
+}
+
 static VALUE rb_cMonitor;
 
 static VALUE cMonitor_run_app(int argc, VALUE *argv, VALUE self)
@@ -66,7 +83,7 @@ static VALUE cMonitor_run_app(int argc, VALUE *argv, VALUE self)
 
   eventMonitor = [NSEvent addGlobalMonitorForEventsMatchingMask:mask
                                                         handler:^(NSEvent *incomingEvent) {
-      rb_funcall(self, rb_intern("receive_event"), 1, rb_str_new2([[incomingEvent description] UTF8String]));
+      rb_funcall(self, rb_intern("receive_event"), 2, rb_str_new2([[incomingEvent description] UTF8String]), rb_float_new(getScreenHeight()));
     }];
 
   if(stopAfter != Qnil) {

data/lib/mac-event-monitor/event/keyboard_event.rb

@@ -3,8 +3,8 @@ module Mac
     class KeyboardEvent < Event
       attr_reader :keycode, :flags
 
-      def initialize(type, keycode, flags)
-        super(type)
+      def initialize(type, time, location, keycode, flags)
+        super(type, time, location)
 
         @keycode = keycode.to_i
         @flags   = flags.to_i(16)
@@ -38,6 +38,10 @@ module Mac
         check_flag(23)
       end
 
+      def data
+        super + [keycode, flags.to_s(16)]
+      end
+
       private
 
       def check_flag(shift)

data/lib/mac-event-monitor/event/mouse_event.rb

@@ -1,19 +1,16 @@
 module Mac
   module EventMonitor
     class MouseEvent < Event
-      attr_reader :location, :button
+      attr_reader :button
 
-      def initialize(type, location_as_str, button)
-        super(type)
+      def initialize(type, time, location, button)
+        super(type, time, location)
 
-        @location = parse_location(location_as_str)
-        @button = button
+        @button = button && button.to_sym
       end
 
-      private
-
-      def parse_location(location_as_str)
-        Struct.new(:x, :y).new(*location_as_str.scan(/[\d\.]+/).map {|v| v.to_f })
+      def data
+        super + [button]
       end
     end
   end

data/lib/mac-event-monitor/event.rb

@@ -1,10 +1,12 @@
 module Mac
   module EventMonitor
     class Event
-      attr_reader :type
+      include JsonSerializable
+
+      attr_reader :type, :time, :location
 
       class << self
-        def create_from_description(description)
+        def create_from_description(description, screen_height)
           _, *atts_as_string = description.split(/ +/)
 
           attrs = (atts_as_string.join(' ') + ' ').scan(/([^=]+)=([^=]+) (?=\w?)/).inject({}) do |result, pair|
@@ -13,37 +15,52 @@ module Mac
             result
           end
 
+          location = parse_location(attrs[:loc])
+          location.y = screen_height - location.y
+
+          time = attrs[:time].to_f
+
           case attrs[:type]
           when 'LMouseUp'
-            MouseEvent.new(:mouse_up, attrs[:loc], :left)
+            MouseEvent.new(:mouse_up,    time, location, :left)
           when 'RMouseUp'
-            MouseEvent.new(:mouse_up, attrs[:loc], :right)
+            MouseEvent.new(:mouse_up,    time, location, :right)
           when 'OMouseUp'
-            MouseEvent.new(:mouse_up, attrs[:loc], :other)
+            MouseEvent.new(:mouse_up,    time, location, :other)
           when 'LMouseDown'
-            MouseEvent.new(:mouse_down, attrs[:loc], :left)
+            MouseEvent.new(:mouse_down,  time, location, :left)
           when 'RMouseDown'
-            MouseEvent.new(:mouse_down, attrs[:loc], :right)
+            MouseEvent.new(:mouse_down,  time, location, :right)
           when 'OMouseDown'
-            MouseEvent.new(:mouse_down, attrs[:loc], :other)
+            MouseEvent.new(:mouse_down,  time, location, :other)
           when 'MouseMoved'
-            MouseEvent.new(:mouse_move, attrs[:loc], nil)
+            MouseEvent.new(:mouse_move,  time, location, nil)
           when 'LMouseDragged'
-            MouseEvent.new(:mouse_drag, attrs[:loc], :left)
+            MouseEvent.new(:mouse_drag,  time, location, :left)
           when 'RMouseDragged'
-            MouseEvent.new(:mouse_drag, attrs[:loc], :right)
+            MouseEvent.new(:mouse_drag,  time, location, :right)
           when 'OMouseDragged'
-            MouseEvent.new(:mouse_drag, attrs[:loc], :other)
+            MouseEvent.new(:mouse_drag,  time, location, :other)
           when 'KeyDown'
-            KeyboardEvent.new(:key_down, attrs[:keyCode], attrs[:flags])
+            KeyboardEvent.new(:key_down, time, location, attrs[:keyCode], attrs[:flags])
           when 'KeyUp'
-            KeyboardEvent.new(:key_up, attrs[:keyCode], attrs[:flags])
+            KeyboardEvent.new(:key_up,   time, location, attrs[:keyCode], attrs[:flags])
           end
         end
+
+        def parse_location(location_as_str)
+          Location.new(*location_as_str.scan(/[\d\.]+/).map {|v| v.to_f })
+        end
+      end
+
+      def initialize(type, time, location)
+        @type     = type.to_sym
+        @time     = time
+        @location = location
       end
 
-      def initialize(type)
-        @type = type
+      def data
+        [type, time, location]
       end
     end
   end

data/lib/mac-event-monitor/location.rb

@@ -0,0 +1,18 @@
+module Mac
+  module EventMonitor
+    class Location
+      include JsonSerializable
+
+      attr_accessor :x, :y
+
+      def initialize(x, y)
+        @x = x
+        @y = y
+      end
+
+      def data
+        [x, y]
+      end
+    end
+  end
+end

data/lib/mac-event-monitor/monitor.rb

@@ -2,24 +2,33 @@ module Mac
   module EventMonitor
     class Monitor
       def initialize
-        @listeners = {}
+        @listeners     = {}
+        @any_listeners = []
       end
 
-      def add_listener(type, &block)
-        @listeners[type] ||= []
-        @listeners[type] << block
+      def add_listener(type = nil, &block)
+        if type
+          @listeners[type] ||= []
+          @listeners[type] << block
+        else
+          @any_listeners << block
+        end
       end
 
       def run(stop_after = nil)
         run_app(stop_after)
       end
 
-      def receive_event(str)
-        event = Event.create_from_description(str)
+      def receive_event(str, screen_height)
+        event = Event.create_from_description(str, screen_height)
 
         (@listeners[event.type] || []).each do |block|
           block.call(event)
         end
+
+        @any_listeners.each do |block|
+          block.call(event)
+        end
       end
     end
   end

data/lib/mac-event-monitor/serializable.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module Mac
+  module EventMonitor
+    module JsonSerializable
+      def self.included(klass)
+        klass.instance_eval do
+          def json_create(o)
+            new(*o['data'])
+          end
+        end
+      end
+
+      def to_json(*a)
+        {
+          'json_class' => self.class.name,
+          'data'       => data
+        }.to_json(*a)
+      end
+    end
+  end
+end

data/lib/mac-event-monitor/version.rb

@@ -1,5 +1,5 @@
 module Mac
   module EventMonitor
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/mac-event-monitor.rb

@@ -6,7 +6,9 @@ module Mac
 end
 
 require 'event_monitor'
+require 'mac-event-monitor/serializable.rb'
 require 'mac-event-monitor/monitor.rb'
 require 'mac-event-monitor/event.rb'
 require 'mac-event-monitor/event/mouse_event.rb'
 require 'mac-event-monitor/event/keyboard_event.rb'
+require 'mac-event-monitor/location.rb'

data/mac-event-monitor.gemspec

@@ -16,7 +16,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Mac::EventMonitor::VERSION
 
+  gem.add_dependency('json')
   gem.add_development_dependency('rspec', ['~> 2.8.0'])
   gem.add_development_dependency('mac-robot')
   gem.add_development_dependency('eventmachine')
+  gem.add_development_dependency('rake')
 end

data/spec/mac-event-monitor/event_spec.rb

@@ -1,24 +1,59 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
+require 'json'
+
 include Mac::EventMonitor
 
 describe Event do
-  it 'should create event from description' do
-    event = Event.create_from_description('NSEvent: type=LMouseDown loc=(618,524) time=1136789.4 flags=0x100 win=0x0 winNum=17310 ctxt=0x0 evNum=14883 click=1 buttonNumber=0 pressure=1')
-
-    event.should be_an_instance_of(MouseEvent)
-    event.type.should equal(:mouse_down)
-    event.button.should equal(:left)
-    event.location.x.should be_an_instance_of(Float)
-    event.location.y.should be_an_instance_of(Float)
+  describe '.create_from_description' do
+    it 'should create event from description' do
+      event = Event.create_from_description('NSEvent: type=LMouseDown loc=(618,524) time=1136789.4 flags=0x100 win=0x0 winNum=17310 ctxt=0x0 evNum=14883 click=1 buttonNumber=0 pressure=1', 768)
+
+      event.should be_an_instance_of(MouseEvent)
+      event.type.should equal(:mouse_down)
+      event.button.should equal(:left)
+      event.location.x.should eql(618.0)
+      event.location.y.should eql(244.0)
+      event.time.should eql(1136789.4)
+    end
+
+    it 'should create event from description with space' do
+      event = Event.create_from_description('NSEvent: type=KeyDown loc=(184,646) time=68067.5 flags=0x20104 win=0x0 winNum=0 ctxt=0x0 chars=" " unmodchars=" " repeat=0 keyCode=49', 768)
+
+      event.should be_an_instance_of(KeyboardEvent)
+      event.type.should equal(:key_down)
+      event.keycode.should equal(49)
+      event.shift_key?.should be_true
+      event.location.x.should eql(184.0)
+      event.location.y.should eql(122.0)
+      event.time.should eql(68067.5)
+    end
   end
 
-  it 'should create event from description with space' do
-    event = Event.create_from_description('NSEvent: type=KeyDown loc=(184,646) time=68067.5 flags=0x20104 win=0x0 winNum=0 ctxt=0x0 chars=" " unmodchars=" " repeat=0 keyCode=49')
+  describe '#to_json' do
+    it 'serializes mouse event to json' do
+      event = Event.create_from_description('NSEvent: type=LMouseDown loc=(618,524) time=1136789.4 flags=0x100 win=0x0 winNum=17310 ctxt=0x0 evNum=14883 click=1 buttonNumber=0 pressure=1', 768)
+      event = JSON.parse(event.to_json)
+
+      event.should be_an_instance_of(MouseEvent)
+      event.type.should equal(:mouse_down)
+      event.button.should equal(:left)
+      event.location.x.should eql(618.0)
+      event.location.y.should eql(244.0)
+      event.time.should eql(1136789.4)
+    end
+
+    it 'serializes mouse event to json' do
+      event = Event.create_from_description('NSEvent: type=KeyDown loc=(184,646) time=68067.5 flags=0x20104 win=0x0 winNum=0 ctxt=0x0 chars=" " unmodchars=" " repeat=0 keyCode=49', 768)
+      event = JSON.parse(event.to_json)
 
-    event.should be_an_instance_of(KeyboardEvent)
-    event.type.should equal(:key_down)
-    event.keycode.should equal(49)
-    event.shift_key?.should be_true
+      event.should be_an_instance_of(KeyboardEvent)
+      event.type.should equal(:key_down)
+      event.keycode.should equal(49)
+      event.shift_key?.should be_true
+      event.location.x.should eql(184.0)
+      event.location.y.should eql(122.0)
+      event.time.should eql(68067.5)
+    end
   end
 end

data/spec/mac-event-monitor/monitor_spec.rb

@@ -50,7 +50,6 @@ describe Monitor do
       [1, 1.5].each do |t|
         EM.add_timer(t) do
           robot.key_press(0x04)
-          #robot.key_release(0x04)
         end
       end
 
@@ -65,4 +64,39 @@ describe Monitor do
 
     result.should be >= 2
   end
+
+  it 'should monitor all' do
+    result = 0
+    robot = Mac::Robot.new
+
+    @monitor.add_listener do |event|
+      result += 1
+    end
+
+    result.should be_zero
+
+    EM.run do
+      [1, 1.5].each do |t|
+        EM.add_timer(t) do
+          robot.mouse_press
+        end
+      end
+
+      [2, 2.5].each do |t|
+        EM.add_timer(t) do
+          robot.key_press(0x04)
+        end
+      end
+
+      EM.add_timer(3) do
+        EM.stop
+      end
+
+      EM.add_periodic_timer(0.1) do
+        @monitor.run(0.1)
+      end
+    end
+
+    result.should be >= 4
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mac-event-monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
 description: A Library to Monitor User Interactions
 email:
 - youpy@buycheapviagraonlinenow.com
@@ -81,7 +113,9 @@ files:
 - lib/mac-event-monitor/event.rb
 - lib/mac-event-monitor/event/keyboard_event.rb
 - lib/mac-event-monitor/event/mouse_event.rb
+- lib/mac-event-monitor/location.rb
 - lib/mac-event-monitor/monitor.rb
+- lib/mac-event-monitor/serializable.rb
 - lib/mac-event-monitor/version.rb
 - mac-event-monitor.gemspec
 - spec/mac-event-monitor/event_spec.rb
@@ -101,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3347223318557235811
+      hash: 420514610567595612
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -110,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3347223318557235811
+      hash: 420514610567595612
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24