leap-motion-ws 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad2f348b76ec5ba36959631f0358b128a2501d6a
-  data.tar.gz: 138cf8fac6634bcce856f07b344cefb2d576d556
+  metadata.gz: b27639657797b35580926d29c4c602055b3a6fb5
+  data.tar.gz: 0b2e9b8fe95693bc7c16a14124d253fb51807d1e
 SHA512:
-  metadata.gz: b93617d0af9307fc94903677f85aade0b54fae4e26e969ebf98aa556dca609b8aee1ec98b02d4980ed01ba6e3da17652cae102f42f13fa75cf9215b6cc3384bb
-  data.tar.gz: 751881faa2cc40ae20ba740aeb44659aad1c65b3312c25e7866a64cb53ada4c833cc67c5429d7d30f4b7d62b10d25831b424e2b90cf6f00d00c8070ba974cbb4
+  metadata.gz: d7d3271db65abf83b26933269c6bd7485bf75620b0a91689156a404656e84a16c6ca0ff0259e1105723dad5e7e1f9050524883b86942fdc11e7fb2a2463b792d
+  data.tar.gz: 89a2ab1d862e865d529e02065965fa79658ab086701bf8919ff26624451e349ae178fa7a12f1ef6ecbce186e0294a381c02983ce67260f6f4a9c2f1f7f14ac19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    leap-motion-ws (0.0.1)
+    leap-motion-ws (0.0.2)
       json
       websocket-eventmachine-client
 
@@ -11,25 +11,19 @@ GEM
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
-    bourne (1.4.0)
-      mocha (~> 0.13.2)
     eventmachine (1.0.3)
     i18n (0.6.1)
     json (1.7.7)
-    metaclass (0.0.1)
-    mocha (0.13.3)
-      metaclass (~> 0.0.1)
     multi_json (1.7.3)
     rake (10.0.4)
     rdoc (4.0.1)
       json (~> 1.4)
-    shoulda (3.4.0)
+    shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (~> 1.0, >= 1.4.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
     shoulda-context (1.1.1)
-    shoulda-matchers (1.5.6)
+    shoulda-matchers (2.1.0)
       activesupport (>= 3.0.0)
-      bourne (~> 1.3)
     websocket (1.0.7)
     websocket-eventmachine-base (1.0.2)
       eventmachine (~> 1.0)

data/Rakefile

@@ -10,7 +10,6 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
-task :test => :compile
 
 task :default => :test
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/leap-motion-ws.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
 
   s.authors  = ["Gregoire Lejeune"]
   s.email    = "gregoire.lejeune@free.fr"
-  s.homepage = "http://github.com/glejeune/leap-motion-ws"
+  s.homepage = "https://github.com/glejeune/ruby-leap-motion-ws"
   s.license  = "MIT"
 
   s.files      = `git ls-files`.split("\n")

data/lib/leap/motion/utils/history.rb

@@ -0,0 +1,25 @@
+module LEAP
+  class Motion
+    module Utils
+      class History < Array
+        attr_reader :max_size
+
+        def initialize(max_size, enum = nil)
+          @max_size = max_size
+          enum.each { |e| self << e } if enum
+        end
+
+        def <<(el)
+          if self.size < @max_size || @max_size.nil?
+            super
+          else
+            self.shift
+            self.push(el)
+          end
+        end
+
+        alias :push :<<
+      end
+    end
+  end
+end

data/lib/leap/motion/ws.rb

@@ -2,56 +2,154 @@ require 'rubygems'
 require 'websocket-eventmachine-client'
 require 'json'
 require 'leap/motion/ws/frame'
+require 'leap/motion/utils/history'
 
 module LEAP
   class Motion
+    # Public: Class to be subclassed to interface with the Leap Motion
+    #
+    # Example
+    #
+    #   class MyLeap < LEAP::Motion::WS
+    #     def initialize(...)
+    #       #...
+    #     end
+    #
+    #     def on_frame(frame)
+    #       # ...
+    #     end
+    #
+    #     def on_connect
+    #       # ...
+    #     end
+    #
+    #     def on_disconnect
+    #       # ...
+    #     end
+    #
+    #     def on_error(message)
+    #       # ...
+    #     end
+    #   end
+    #
+    # on-frame is the only mandatory function.
     class WS
+      # Public: Initialize a LEAP::Motion::WS 
+      #
+      # options - The Hash options used to initialize the Leap access (default: {:uri => "ws://127.0.0.1:6437", :enable_gesture => false, :history_size => 1000}):
+      #       :uri - the String uri for the WebSocket::EventMachine::Client connection (optional)
+      #       :enable_gesture - boolean to indicate if we want to enable gesture or not (optional)
+      #       :history_size : the Integer size of the history ()
       def initialize(options = {})
-        @options = {:uri => "ws://127.0.0.1:6437", :enable_gesture => false}.merge(options)
-        @gesture_enables = false
-        @ws = nil
+        @options = {:uri => "ws://127.0.0.1:6437", :enable_gesture => false, :history_size => 1000}.merge(options)
+        @history = LEAP::Motion::Utils::History.new(@options[:history_size])
       end
 
+      # Public: Return true if gestures are enabled, false otherwise
       def gestures?
-        @gesture_enables
+        options[:enable_gesture] 
       end
 
+      # Public: Return the Frame History
+      def history
+        @history ||= LEAP::Motion::Utils::History.new(options[:history_size])
+      end
+
+      # Public: Enable gestures
+      #
+      # Return nothing.
       def gesture!
         unless @ws.nil?
           data = JSON "enableGestures" => true
-          @ws.send data
+          options[:enable_gesture] = ws.send data
         end
       end
 
+      # Public: Start the interface
+      #
+      # enable_gesture : boolean to indicate if we want to enable gesture or not (default: false)
+      #
+      # Examples
+      #
+      #   class MyLeap < LEAP::Motion::WS
+      #     ...
+      #   end
+      #   MyLeap.new.start
+      #
+      # Returns self
       def start(enable_gesture = false)
         EM.run do
-          @ws = WebSocket::EventMachine::Client.connect(:uri => @options[:uri])
-
-          @ws.onopen do
+          ws.onopen do
             on_connect if respond_to? :on_connect
-            gesture! if enable_gesture or @options[:enable_gesture]
+            gesture! if enable_gesture or options[:enable_gesture]
           end
 
-          @ws.onmessage do |msg, type|
+          ws.onmessage do |msg, type|
             message = JSON(msg)
             if message.key?("id") and message.key?("timestamp")
-              on_frame LEAP::Motion::WS::Frame.new(message) 
+              frame = LEAP::Motion::WS::Frame.new(message)
+              history << frame
+              on_frame frame
             end
           end
 
-          @ws.onerror do |err|
+          ws.onerror do |err|
             on_error(err) if respond_to? :on_error
           end
 
-          @ws.onclose do
+          ws.onclose do
             on_disconnect if respond_to? :on_disconnect
           end
         end
+
+        return self
+      end
+
+      # Public: Start the interface
+      #
+      # enable_gesture : boolean to indicate if we want to enable gesture or not (default: false)
+      #
+      # Examples
+      #
+      #   class MyLeap < LEAP::Motion::WS
+      #     ...
+      #   end
+      #   MyLeap.start
+      #
+      # Returns the LEAP::Motion::WS subclass object
+      def self.start(enable_gesture = false)
+        _leap = new
+        _leap.start(enable_gesture)
       end
 
+
+      # Public: Stop the interface
+      #
+      # Examples
+      #
+      #   class MyLeap < LEAP::Motion::WS
+      #     ...
+      #   end
+      #   my_leap = MyLeap.start
+      #   ...
+      #   my_leap.stop
+      #
+      # Returns self
       def stop
         EM::stop_event_loop
       end
+
+      private
+
+      # private: Get the options hash
+      def options
+        @options ||= {:uri => "ws://127.0.0.1:6437", :enable_gesture => false, :history_size => 1000}
+      end
+
+      # Private: Get the WebSocket::EventMachine::Client connection
+      def ws
+        @ws ||= WebSocket::EventMachine::Client.connect(:uri => options[:uri])
+      end
     end
   end
 end

data/lib/leap/motion/ws/gesture.rb

@@ -1,24 +1,65 @@
 module LEAP
   class Motion
     class WS
+      # Recognized movement by the user
+      #
+      # There is 4 Gesture subclasses :
+      #
+      #   Circle - A circular movement by a finger.
+      #   Swipe - A straight line movement by the hand with fingers extended.
+      #   KeyTap -  A downward tapping movement by a finger.
+      #   ScreenTap - A forward tapping movement by a finger.
       class Gesture
+        class Error < StandardError; end
+
         def self.list(data)
           gestures = []
           if data["gestures"]
             data["gestures"].each do |gesture|
-              gestures << LEAP::Motion::WS::Gesture.new(gesture)
+              gestures << make_gesture(gesture)
             end
           end
           return gestures
         end
 
-        def initialize(data)
-          @data = data
+        def self.make_gesture(data)
+          unless data.has_key? "type"
+            raise Error, "gesture type unknown"
+          end
+          name = data["type"][0].upcase << data["type"][1..-1]
+          unless class_exists?(name)
+            raise Error, "gesture class `#{self}::#{name}' invalid"
+          end
+          const_get(name).new(data)
         end
 
-        def method_missing(mid)
-          @data[mid.id2name]
+        private
+
+        def self.class_exists?(class_name)
+          klass = const_get(class_name)
+          return klass.is_a?(Class)
+        rescue NameError
+          return false
         end
+
+        def self.define_gesture *names
+          names.each do |n|
+            name = n.to_s
+            unless class_exists?(name)
+              c = Class.new(self) do
+                def initialize(data)
+                  data.each do |k, v|
+                    instance_variable_set("@#{k}", v)
+                    self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+                  end
+                end
+              end
+              const_set name, c
+            end
+          end
+        end
+
+        define_gesture :Circle, :KeyTap, :ScreenTap, :Swipe
       end
     end
   end

data/lib/leap/motion/ws/hand.rb

@@ -13,11 +13,10 @@ module LEAP
         end
 
         def initialize(data)
-          @data = data
-        end
-
-        def method_missing(mid)
-          @data[mid.id2name]
+          data.each do |k, v|
+            instance_variable_set("@#{k}", v)
+            self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+          end
         end
       end
     end

data/lib/leap/motion/ws/pointable.rb

@@ -13,11 +13,10 @@ module LEAP
         end
 
         def initialize(data)
-          @data = data
-        end
-
-        def method_missing(mid)
-          @data[mid.id2name]
+          data.each do |k, v|
+            instance_variable_set("@#{k}", v)
+            self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+          end
         end
       end
     end

data/samples/motion_gesture_sample.rb

@@ -0,0 +1,38 @@
+$:.unshift "../lib"
+
+require 'leap-motion-ws'
+
+class LeapTest < LEAP::Motion::WS
+  def on_connect
+    puts "Connect"
+  end
+
+  def on_frame frame
+    puts "Frame ##{frame.id}, timestamp: #{frame.timestamp}, hands: #{frame.hands.size}, pointables: #{frame.pointables.size}" if frame.gestures.size > 0
+    frame.gestures.each do |gesture|
+      puts "  -> ##{gesture.id} : #{gesture.type} / #{gesture.state}"
+    end
+  end
+
+  def on_disconnect
+    puts "disconect"
+    stop
+  end
+end
+
+leap = LeapTest.new(:enable_gesture => true)
+
+Signal.trap("TERM") do
+  puts "Terminating..."
+  leap.stop
+end
+Signal.trap("KILL") do
+  puts "Terminating..."
+  leap.stop
+end
+Signal.trap("INT") do
+  puts "Terminating..."
+  leap.stop
+end
+
+leap.start

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+require 'shoulda'
+require 'pathname'
+
+cur = Pathname.new(File.expand_path("..", __FILE__))
+lib = cur.join('..', 'lib')
+
+$LOAD_PATH.unshift(lib.to_s, cur.to_s)
+require 'leap-motion-ws'
+

data/test/test_history.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestHistory < Test::Unit::TestCase
+  context "a new history" do
+    setup do
+      @h = LEAP::Motion::Utils::History.new(3)
+    end
+
+    should "be empty with a max_size of 3" do
+      assert_equal 0, @h.size
+      assert_equal 3, @h.max_size
+    end
+
+    should "have 3 elements" do
+      @h << "one"
+      @h << "two"
+      @h << "three"
+      assert_equal 3, @h.size
+      assert_equal 3, @h.max_size
+      assert_equal true, @h.include?("one")
+
+      @h << "four"
+      assert_equal 3, @h.size
+      assert_equal 3, @h.max_size
+      assert_equal false, @h.include?("one")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leap-motion-ws
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gregoire Lejeune
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-eventmachine-client
@@ -111,17 +111,19 @@ files:
 - VERSION
 - leap-motion-ws.gemspec
 - lib/leap-motion-ws.rb
-- lib/leap/motion/utils/ring.rb
+- lib/leap/motion/utils/history.rb
 - lib/leap/motion/ws.rb
 - lib/leap/motion/ws/frame.rb
 - lib/leap/motion/ws/gesture.rb
 - lib/leap/motion/ws/hand.rb
 - lib/leap/motion/ws/pointable.rb
 - samples/itunes_controller.rb
-- samples/motion_ws_sample.rb
-- samples/ring_sample.rb
+- samples/motion_gesture_sample.rb
+- samples/motion_sample.rb
 - samples/rock_paper_scissors.rb
-homepage: http://github.com/glejeune/leap-motion-ws
+- test/helper.rb
+- test/test_history.rb
+homepage: https://github.com/glejeune/ruby-leap-motion-ws
 licenses:
 - MIT
 metadata: {}
@@ -141,8 +143,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the Leap Motion Controller (via WebSocket)
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_history.rb

data/lib/leap/motion/utils/ring.rb

@@ -1,19 +0,0 @@
-class Ring < Array
-  attr_reader :max_size
-
-  def initialize(max_size, enum = nil)
-    @max_size = max_size
-    enum.each { |e| self << e } if enum
-  end
-
-  def <<(el)
-    if self.size < @max_size || @max_size.nil?
-      super
-    else
-      self.shift
-      self.push(el)
-    end
-  end
-
-  alias :push :<<
-end

data/samples/ring_sample.rb

@@ -1,19 +0,0 @@
-$:.unshift "../lib"
-
-require 'leap/motion/utils/ring'
-
-x = Ring.new(3)
-
-x << "A"
-x << "B"
-x << "C"
-p x
-
-x << "D"
-p x
-
-x << "E"
-p x
-
-x << "F"
-p x