hybridgroup-sphero 1.0.1 → 1.1.0

data/CHANGELOG.rdoc

@@ -10,4 +10,12 @@
 
   * Works with Ruby 1.9.2 for us regular folks
   * Sphero.start method to endlessly retry when connecting
-  * I think heading might work again, not too sure
+  * I think heading might work again, not too sure
+
+=== 1.1.0 / 2013-01-04
+
+* 3 enhancements
+
+  * Pass a block to Sphero.start for DSL-awesomeness
+  * Use Sphero#keep_going as a nicer alias for Ruby's sleep command
+  * Add some additional test coverage

data/Manifest.txt

@@ -8,3 +8,4 @@ lib/sphero.rb
 lib/sphero/request.rb
 lib/sphero/response.rb
 test/test_sphero.rb
+test/test_sphero_request.rb

data/README.markdown

@@ -13,6 +13,29 @@ provided by the bluetooth connection.
 
 ## SYNOPSIS:
 
+You can easily start your Sphero and send it commands like this:
+
+```ruby
+Sphero.start "/dev/tty.Sphero-PRG-RN-SPP" do
+	ping
+
+	# Roll 0 degrees, speed 125
+	roll(125, 0)
+
+	# Turn 360 degrees, 30 degrees at a time
+	0.step(360, 30) { |h|
+  	h = 0 if h == 360
+
+  	# Set the heading to h degrees
+  	heading = h
+  	keep_going 1
+	}
+	keep_going 1
+	stop
+```
+
+Here is a another way to do the same thing via just normal method calls:
+
 ```ruby
 s = Sphero.new "/dev/tty.Sphero-PRG-RN-SPP"
 s.ping
@@ -45,6 +68,7 @@ s.stop
 (The MIT License)
 
 Copyright (c) 2012 Aaron Patterson
+Additional Copyright (c) 2012-2013 The Hybrid Group
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.plugins.delete :rubyforge
+Hoe.plugins.delete :flog
 Hoe.plugin :minitest
 Hoe.plugin :gemspec # `gem install hoe-gemspec`
 Hoe.plugin :git     # `gem install hoe-git`

data/lib/sphero.rb

@@ -4,18 +4,20 @@ require 'sphero/response'
 require 'thread'
 
 class Sphero
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   class << self
-    def start(dev)
-      self.new dev
+    def start(dev, &block)
+      sphero = self.new dev
+      sphero.instance_eval(&block) if block_given?
+      sphero
     rescue Errno::EBUSY
       retry
     end
   end
 
   def initialize dev
-    @sp   = SerialPort.new dev, 115200, 8, 1, SerialPort::NONE
+    initialize_serialport
     @dev  = 0x00
     @seq  = 0x00
     @lock = Mutex.new
@@ -85,7 +87,16 @@ class Sphero
     write Request::SetRotationRate.new(@seq, h)
   end
 
+  # just a nicer alias for Ruby's own sleep
+  def keep_going(duration)
+    sleep duration
+  end
+
   private
+  
+  def initialize_serialport
+    @sp = SerialPort.new dev, 115200, 8, 1, SerialPort::NONE
+  end
 
   def write packet
     header = nil
@@ -109,46 +120,3 @@ class Sphero
   end
 end
 
-if $0 == __FILE__
-  begin
-    s = Sphero.new "/dev/tty.Sphero-BRR-RN-SPP"
-  rescue Errno::EBUSY
-    retry
-  end
-
-  10.times {
-    p s.ping
-  }
-
-  trap(:INT) {
-    s.stop
-    exit!
-  }
-
-  #s.roll 100, 0
-
-  p s.user_led
-  exit
-  loop do
-    [0, 180].each do |dir|
-      s.heading = dir
-      sleep 10
-    end
-
-    #[
-    #  [0, 0, 0xFF],
-    #  [0xFF, 0, 0],
-    #  [0, 0xFF, 0],
-    #].each do |color|
-    #  s.rgb(*color)
-    #  sleep 5
-    #end
-  end
-
-  #36.times {
-  #  i = 10
-  #  p :step => i
-  #  s.heading = i
-  #  sleep 0.5
-  #}
-end

data/test/test_sphero.rb

@@ -1,14 +1,84 @@
 require 'minitest/autorun'
 require 'sphero'
+require 'mocha/setup'
 
 class TestSphero < MiniTest::Unit::TestCase
-  def test_ping_checksum
-    ping = Sphero::Request::Ping.new 0
-    assert_equal "\xFF\xFF\x00\x01\x00\x01\xFD", ping.to_str
+	def setup
+		Sphero.any_instance.stubs(:initialize_serialport)
+		@sphero = Sphero.new 'port123'
+		@seq = 0x00
+	end
+
+  def test_start_returns_new_sphero
+    assert_kind_of Sphero, Sphero.start('someport')
+  end
+
+  def test_ping
+  	Sphero::Request::Ping.expects(:new).with(@seq)
+  	@sphero.expects(:write)
+  	@sphero.ping
+  end
+
+  def test_version
+  	Sphero::Request::GetVersioning.expects(:new).with(@seq)
+  	@sphero.expects(:write)
+  	@sphero.version
+  end
+
+  def test_bluetooth_info
+  	Sphero::Request::GetBluetoothInfo.expects(:new).with(@seq)
+  	@sphero.expects(:write)
+  	@sphero.bluetooth_info
+  end
+
+  def test_auto_reconnect=
+  	@time_s = "10"
+  	Sphero::Request::SetAutoReconnect.expects(:new).with(@seq, @time_s)
+  	@sphero.expects(:write)
+  	@sphero.auto_reconnect = @time_s
+  end
+
+  def test_auto_reconnect
+  	@time_s = "10"
+  	packet = mock 'packet'
+  	packet.stubs(:time).returns(@time_s)
+ 
+  	Sphero::Request::GetAutoReconnect.expects(:new).with(@seq)
+  	@sphero.expects(:write).returns(packet)
+  	assert_equal @sphero.auto_reconnect, @time_s
+  end
+
+  def test_disable_auto_reconnect
+  	Sphero::Request::SetAutoReconnect.expects(:new).with(@seq, 0, 0x00)
+  	@sphero.expects(:write)
+  	@sphero.disable_auto_reconnect
+  end
+
+  def test_power_state
+  	Sphero::Request::GetPowerState.expects(:new).with(@seq)
+  	@sphero.expects(:write)
+  	@sphero.power_state
+  end
+  
+  def test_sleep
+  	wakeup = 1
+  	macro = 2
+  	Sphero::Request::Sleep.expects(:new).with(@seq, wakeup, macro)
+  	@sphero.expects(:write)
+  	@sphero.sleep wakeup, macro
+  end
+
+  def test_roll
+  	speed = 1
+  	heading = 2
+  	state = 1
+  	Sphero::Request::Roll.expects(:new).with(@seq, speed, heading, state)
+  	@sphero.expects(:write)
+  	@sphero.roll speed, heading, true
   end
 
-  def test_sleep_dlen
-    sleep = Sphero::Request::Sleep.new 0, 0, 0
-    assert_equal 0x04, sleep.dlen
+  def test_stop
+  	@sphero.expects(:roll).with(0, 0)
+  	@sphero.stop
   end
 end

data/test/test_sphero_request.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'sphero'
+
+class TestSpheroRequest < MiniTest::Unit::TestCase
+  def test_ping_checksum
+    ping = Sphero::Request::Ping.new 0
+    assert_equal "\xFF\xFF\x00\x01\x00\x01\xFD", ping.to_str
+  end
+
+  def test_sleep_dlen
+    sleep = Sphero::Request::Sleep.new 0, 0, 0
+    assert_equal 0x04, sleep.dlen
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hybridgroup-sphero
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
-  requirement: &2152670780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152670780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2152670180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *2152670180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2152669620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,18 +53,28 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *2152669620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2152669060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :development
   prerelease: false
-  version_requirements: *2152669060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: ! 'A ruby gem for controlling your Sphero ball.  Sends commands over
   the TTY
 
@@ -79,6 +99,7 @@ files:
 - lib/sphero/request.rb
 - lib/sphero/response.rb
 - test/test_sphero.rb
+- test/test_sphero_request.rb
 - .gemtest
 homepage: http://github.com/tenderlove/sphero
 licenses: []
@@ -102,9 +123,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hybridgroup-sphero
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A ruby gem for controlling your Sphero ball
 test_files:
 - test/test_sphero.rb
+- test/test_sphero_request.rb