dream_cheeky 0.0.1 → 0.2.0

data/README.md

@@ -1,3 +1,57 @@
 # Dream Cheeky
 
+Make your Dream Cheeky USB Device do something cool.
+
 World, the time has come to PUSH THE BUTTON!
+
+## Support
+The following Dream Cheeky USB Devices are supported `(vendor_id:product_id)`
+
+Big Red Button ``(1d34:000d)``  
+USB Fidget ``(1d34:0001)``  
+
+Please get in touch if you have an unsupported Dream Cheeky device.
+
+## Usage
+
+Simple:
+
+```ruby
+require 'rubygems'
+require 'dream_cheeky'
+
+DreamCheeky::UsbFidget.run do
+  push do
+    `say "BEEP!"`
+  end
+end
+```
+
+Advanced:
+
+```ruby
+require 'rubygems'
+require 'dream_cheeky'
+require 'watir-webdriver'
+
+DreamCheeky::BigRedButton.run do
+  browser = Watir::Browser.new
+
+  open do
+    browser.goto 'devastatingexplosions.com'
+  end
+
+  close do
+    browser.close
+  end
+
+  push do
+    browser.object(:id => 'flashcontent').click
+  end
+end
+```
+
+## Requirements
+
+1. A supported Dream Cheeky USB Device. Example: http://dreamcheeky.com/big-red-button
+2. Mac OS X with Developer Tools installed. (Support for Linux and Windows is planned).

data/dream_cheeky.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Derrick Spell"]
   s.email       = ["derrick.spell@gmail.com"]
   s.homepage    = ""
-  s.summary     = "Ruby Inteface to Dream Cheeky(TM) USB Devices"
-  s.description = "Ruby Inteface to Dream Cheeky(TM) USB Devices"
+  s.summary     = "Ruby Interface to Dream Cheeky(TM) USB Devices"
+  s.description = "Ruby Interface to Dream Cheeky(TM) USB Devices"
 
   s.rubyforge_project = "dream_cheeky"
 

data/examples/big_red_button-browse.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'dream_cheeky'
+require 'watir-webdriver'
+
+DreamCheeky::BigRedButton.run do
+  browser = ""
+
+  open do
+    ## to use google chrome instead of default firefox add :chrome after new (with a space) and add the ChromeDriver http://code.google.com/p/chromedriver/downloads/list to your $PATH
+    browser = Watir::Browser.new
+    browser.goto 'devastatingexplosions.com'
+  end
+
+  close do
+    browser.close
+  end
+
+  push do
+    browser.object(:id => 'flashcontent').click
+  end
+end

data/examples/big_red_button-speak.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'dream_cheeky'
+
+DreamCheeky::BigRedButton.run do
+  open do
+    `say "World, the time has come to"`
+    `say -v Zarvox -r 100 "Push the button"`
+  end
+
+  close do
+    `say -v Bad "Dum dum da dum dum da dum da dum da dum"`
+  end
+
+  push do
+    `say "Boom!" -r 10`
+    `say "Oh, the humanity!"`
+  end
+end

data/examples/usb_fidget-speak.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'dream_cheeky'
+
+DreamCheeky::UsbFidget.run do
+  push do
+    `say "BEEP!"`
+  end
+end

data/ext/dream_cheeky/dream_cheeky.c

@@ -7,4 +7,5 @@ void Init_dream_cheeky(void)
   mDreamCheeky = rb_define_module("DreamCheeky");
 
   Init_dream_cheeky_big_red_button();
+  Init_dream_cheeky_usb_fidget();
 }

data/ext/dream_cheeky/dream_cheeky.h

@@ -1,11 +1,12 @@
 #ifndef RUBY_DREAM_CHEEKY
 #define RUBY_DREAM_CHEEKY
- 
-#include <ruby.h>;
-#include <hidapi.h>;
 
-#include <dream_cheeky_big_red_button.h>;
- 
+#include <ruby.h>
+#include <hidapi.h>
+
+#include <dream_cheeky_big_red_button.h>
+#include <dream_cheeky_usb_fidget.h>
+
 extern VALUE mDreamCheeky;
- 
+
 #endif

data/ext/dream_cheeky/dream_cheeky_big_red_button.c

@@ -29,12 +29,12 @@ static VALUE get_current_state(VALUE self)
 
   Data_Get_Struct(self, hid_device, handle);
 
-	// Set up the command buffer.
-	memset(buf,0x00,sizeof(buf));
-	buf[0] = 0x08;
-	buf[7] = 0x02;
+  // Set up the command buffer.
+  memset(buf,0x00,sizeof(buf));
+  buf[0] = 0x08;
+  buf[7] = 0x02;
 
-	hid_write(handle, buf, 8);
+  hid_write(handle, buf, 8);
   res = 0;
   while (0 == res) {
     res = hid_read(handle, buf, 8);

data/ext/dream_cheeky/dream_cheeky_usb_fidget.c

@@ -0,0 +1,56 @@
+#include <dream_cheeky_usb_fidget.h>
+
+
+static void deallocate(void * handle)
+{
+  hid_close((hid_device *)handle);
+}
+
+static VALUE allocate(VALUE klass)
+{
+  hid_device * handle;
+
+  handle = hid_open(0x1d34, 0x0001, NULL);
+  if(!handle) {
+    rb_exc_raise(rb_exc_new2(rb_eRuntimeError, "No USB Fidget Detected"));
+  }
+
+  hid_set_nonblocking(handle, 1);
+
+  return Data_Wrap_Struct(klass, NULL, deallocate, handle);
+}
+
+static VALUE get_current_state(VALUE self)
+{
+  hid_device * handle;
+  int res;
+  unsigned char buf[8];
+
+  Data_Get_Struct(self, hid_device, handle);
+
+  // Set up the command buffer.
+  memset(buf,0x00,sizeof(buf));
+  buf[0] = 0x08;
+  buf[7] = 0x02;
+
+  hid_write(handle, buf, 8);
+  res = 0;
+  while (0 == res) {
+    res = hid_read(handle, buf, 8);
+    if (res == 0) {
+      hid_write(handle, buf, 8);
+      usleep(10000);
+    }
+  }
+
+  return INT2NUM(buf[0]);
+}
+
+
+void Init_dream_cheeky_usb_fidget()
+{
+  VALUE cDreamCheekyUsbFidget = rb_define_class_under(mDreamCheeky, "UsbFidget", rb_cObject);
+
+  rb_define_alloc_func(cDreamCheekyUsbFidget, allocate);
+  rb_define_method(cDreamCheekyUsbFidget, "get_current_state", get_current_state, 0);
+}

data/ext/dream_cheeky/dream_cheeky_usb_fidget.h

@@ -0,0 +1,8 @@
+#ifndef RUBY_DREAM_CHEEKY_USB_FIDGET
+#define RUBY_DREAM_CHEEKY_USB_FIDGET
+ 
+#include <dream_cheeky.h>
+ 
+void Init_dream_cheeky_usb_fidget();
+ 
+#endif

data/lib/dream_cheeky.rb

@@ -1,3 +1,4 @@
 require 'dream_cheeky/version'
 require 'dream_cheeky/dream_cheeky'
 require 'dream_cheeky/big_red_button'
+require 'dream_cheeky/usb_fidget'

data/lib/dream_cheeky/usb_fidget.rb

@@ -0,0 +1,53 @@
+module DreamCheeky
+  class UsbFidget
+
+    DEPRESSED = 0x1E
+
+    def self.run(&block)
+      brb = new
+      brb.instance_eval(&block)
+      brb.run
+    end
+
+    def push(&block)
+      @button_pushed_callback = block
+    end
+
+    def run
+      poll_usb
+    end
+
+
+    private ####################################################################
+
+    attr_accessor :prior_state, :current_state
+
+    def poll_usb
+      init_loop
+      begin
+        case check_button
+        when DEPRESSED
+          push! unless already_pushed?
+        end
+      end while(true)
+    end
+
+    def init_loop
+      self.prior_state = self.current_state = get_current_state
+    end
+
+    def check_button
+      self.prior_state = current_state
+      self.current_state = get_current_state
+    end
+
+    def push!
+      @button_pushed_callback && @button_pushed_callback.call
+    end
+
+    def already_pushed?
+      DEPRESSED == prior_state
+    end
+
+  end
+end

data/lib/dream_cheeky/version.rb

@@ -1,3 +1,3 @@
 module DreamCheeky
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/spec/dream_cheeky/usb_fidget_spec.rb

@@ -0,0 +1,9 @@
+require 'dream_cheeky'
+
+describe DreamCheeky::UsbFidget do
+
+  it "should raise an error when instantiated if it can't find a UsbFidget device" do
+    pending
+    expect { subject }.to raise_error
+  end
+end

data/spec/dream_cheeky_spec.rb

@@ -6,4 +6,8 @@ describe DreamCheeky do
     expect { DreamCheeky::BigRedButton.new }.to_not raise_error(NameError)
   end
 
+  it "should contain a UsbFidget class" do
+    expect { DreamCheeky::UsbFidget.new }.to_not raise_error(NameError)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dream_cheeky
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70258907999700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70258907999700
-description: Ruby Inteface to Dream Cheeky(TM) USB Devices
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Interface to Dream Cheeky(TM) USB Devices
 email:
 - derrick.spell@gmail.com
 executables: []
@@ -34,17 +39,24 @@ files:
 - README.md
 - Rakefile
 - dream_cheeky.gemspec
+- examples/big_red_button-browse.rb
+- examples/big_red_button-speak.rb
+- examples/usb_fidget-speak.rb
 - ext/dream_cheeky/dream_cheeky.c
 - ext/dream_cheeky/dream_cheeky.h
 - ext/dream_cheeky/dream_cheeky_big_red_button.c
 - ext/dream_cheeky/dream_cheeky_big_red_button.h
+- ext/dream_cheeky/dream_cheeky_usb_fidget.c
+- ext/dream_cheeky/dream_cheeky_usb_fidget.h
 - ext/dream_cheeky/extconf.rb
 - ext/dream_cheeky/hidapi-mac.c
 - ext/dream_cheeky/hidapi.h
 - lib/dream_cheeky.rb
 - lib/dream_cheeky/big_red_button.rb
+- lib/dream_cheeky/usb_fidget.rb
 - lib/dream_cheeky/version.rb
 - spec/dream_cheeky/big_red_button_spec.rb
+- spec/dream_cheeky/usb_fidget_spec.rb
 - spec/dream_cheeky_spec.rb
 homepage: ''
 licenses: []
@@ -66,10 +78,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: dream_cheeky
-rubygems_version: 1.8.11
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Ruby Inteface to Dream Cheeky(TM) USB Devices
+summary: Ruby Interface to Dream Cheeky(TM) USB Devices
 test_files:
 - spec/dream_cheeky/big_red_button_spec.rb
+- spec/dream_cheeky/usb_fidget_spec.rb
 - spec/dream_cheeky_spec.rb