tag-it 0.1.0

data/.bundle/config

@@ -0,0 +1,3 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"
+BUNDLE_PATH: ruby-serialport

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1 @@
+ruby-serialport/**/*.*

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'jeweler'
+gem 'ruby-serialport'
+gem 'mocha'
+gem 'test-unit'
+gem 'thoughtbot-shoulda'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    ruby-serialport (0.7.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    test-unit (2.1.1)
+    thoughtbot-shoulda (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  mocha
+  ruby-serialport
+  test-unit
+  thoughtbot-shoulda

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 evizitei
+
+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.rdoc

@@ -0,0 +1,17 @@
+= tag-it
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 evizitei. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tag-it"
+    gem.summary = %Q{interaction with RFID receiver through a serial port.}
+    gem.description = %Q{Interacting with RFID receivers through serial ports is not much fun.  This makes it a little better.  tag-it provides a class that will monitor a serial port for you, and will dispatch events through ruby's standard "observer" functionality when a tag comes into range and leaves.}
+    gem.email = "ethan.vizitei@gmail.com"
+    gem.homepage = "http://github.com/evizitei/tag-it"
+    gem.authors = ["evizitei"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tag-it #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tag_it/tag_tracker.rb

@@ -0,0 +1,78 @@
+require "observer"
+require "timeout"
+
+module TagIt
+  class TagTracker
+    include Observable
+    include Timeout
+    
+    def initialize(port)
+      @port = port
+      @tag_map ||= {}
+    end
+    
+    def start!
+      char = nil
+      tag_name = ""
+      
+      #dont start reporting until after the first space, 
+      #so we don't have to deal with partial tagnames
+      clean_start_flag = false 
+      
+      #128 is the stop character we're adding so the tests can cutoff the loop.  
+      #Production will loop infinitely until shutdown
+      while char != 128  
+        begin
+          # Don't take longer than 3 seconds to find a char, or there aren't any
+          Timeout::timeout(3) do
+            char = @port.getc
+          end
+          if char == 32 
+            flush_tag!(tag_name) if clean_start_flag #don't send until after first space
+            depart_dormant_tags!
+            tag_name = ""
+            clean_start_flag = true #here's a space, start sending tags
+          else
+            tag_name = "#{tag_name}#{char.chr}"
+          end
+        rescue Timeout::Error
+          depart_all_tags!
+        end
+      end
+    end
+    
+    def flush_tag!(tag_name)
+      tag_name,strength = split_tag_data(tag_name)
+      if @tag_map[tag_name].nil?
+        changed
+        notify_observers(tag_name,strength,:tag_arrived)
+      end
+      @tag_map[tag_name] = Time.now
+    end
+    
+    def depart_all_tags!
+      @tag_map.keys.each do |tag_name|
+        changed
+        notify_observers(tag_name,0,:tag_departed)
+      end
+      @tag_map.clear
+    end
+    
+    def depart_dormant_tags!
+      tags_to_depart = []
+      @tag_map.each do |tag_name,last_time|
+        tags_to_depart << tag_name if((Time.now - last_time) > 8)
+      end
+      
+      tags_to_depart.each do |tag_name|
+        changed
+        notify_observers(tag_name,0,:tag_departed)
+        @tag_map.delete(tag_name)
+      end
+    end
+    
+    def split_tag_data(tag_name)
+      [tag_name[0,4],tag_name[4,tag_name.size - 4].to_i]
+    end
+  end
+end

data/lib/tag_it.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'serialport'
+require 'tag_it/tag_tracker'
+
+# port = SerialPort.new("/dev/tty.usbserial",:baud=>9600,:data_bits=>8,:stop_bits=>1)
+# 
+# count = 0
+# while count < 1000
+#   printf("%c",port.getc)
+#   count += 1
+# end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'mock_serial_port'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tag_it'
+
+class Test::Unit::TestCase
+end

data/test/mock_serial_port.rb

@@ -0,0 +1,34 @@
+class MockSerialPort
+  def initialize(data)
+    @data = []
+    data.each_byte{|b| @data << b}
+    @data << 128
+  end
+  
+  def getc
+    char = @data.delete_at 0
+    char_hook(char)
+    char = 128 if char.nil?
+    return char
+  end
+  
+  def char_hook(char)
+    #do nothing
+  end
+end
+
+class TimeoutSerialPort < MockSerialPort
+  def char_hook(char)
+    if char == 128
+      sleep(5)
+    end
+  end
+end
+
+class PacingSerialPort < MockSerialPort
+  def char_hook(char)
+    if char == 32
+      sleep(1)
+    end
+  end
+end

data/test/test_tag_tracker.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class TestTagTracker < Test::Unit::TestCase
+  context "TagTracker" do
+    should "report full tag names" do
+      data = " 1nri85 1nwP79 "
+      watcher = TagObserver.new
+      watcher.expects(:update).with("1nri",85,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nwP",79,:tag_arrived).times(1)
+      check_data_extract(data,watcher)
+    end
+    
+    should "only report tags after the first space" do
+      data = "P79 1m2342 1ksR81 "
+      watcher = TagObserver.new
+      watcher.expects(:update).with("1m23",42,:tag_arrived).times(1)
+      watcher.expects(:update).with("1ksR",81,:tag_arrived).times(1)
+      check_data_extract(data,watcher)
+    end
+    
+    should "only report each individual tag the first time" do
+      data = " 1nri85 1nwP79 1nri85 1nwP79 1nri85 1nwP79 "
+      watcher = TagObserver.new
+      watcher.expects(:update).with("1nri",85,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nwP",79,:tag_arrived).times(1)
+      check_data_extract(data,watcher)
+    end
+    
+    should "clear send out departing events when no tags in range" do
+      data = " 1nri85 1nwP79 1nri85 1nwP79 1nri85 1nwP79 "
+      watcher = TagObserver.new
+      watcher.expects(:update).with("1nri",85,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nwP",79,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nri",0,:tag_departed).times(1)
+      watcher.expects(:update).with("1nwP",0,:tag_departed).times(1)
+      check_data_extract(data,watcher,TimeoutSerialPort)
+    end
+    
+    should "dispatch a departing event when one tag leaves" do
+      data = " 1nri85 1nwP79 1nwP79 1nwP79 1nwP79 1nwP79 1nwP79 1nwP79 1nwP79 1nwP79 "
+      watcher = TagObserver.new
+      watcher.expects(:update).with("1nri",85,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nwP",79,:tag_arrived).times(1)
+      watcher.expects(:update).with("1nri",0,:tag_departed).times(1)
+      check_data_extract(data,watcher,PacingSerialPort)
+    end
+  end
+  
+  def check_data_extract(data,watcher,port_mocker = MockSerialPort)
+    port = port_mocker.new(data)
+    tracker = TagIt::TagTracker.new(port)
+    tracker.add_observer(watcher)
+    tracker.start!
+  end
+end
+
+class TagObserver
+  def update(tag_id,strength,event)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: tag-it
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- evizitei
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: thoughtbot-shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+description: Interacting with RFID receivers through serial ports is not much fun.  This makes it a little better.  tag-it provides a class that will monitor a serial port for you, and will dispatch events through ruby's standard "observer" functionality when a tag comes into range and leaves.
+email: ethan.vizitei@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .bundle/config
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tag_it.rb
+- lib/tag_it/tag_tracker.rb
+- test/helper.rb
+- test/mock_serial_port.rb
+- test/test_tag_tracker.rb
+has_rdoc: true
+homepage: http://github.com/evizitei/tag-it
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: interaction with RFID receiver through a serial port.
+test_files: 
+- test/helper.rb
+- test/mock_serial_port.rb
+- test/test_tag_tracker.rb