millworker 0.1.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-08-22
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2012 Tom Kersten
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+History.txt
+LICENSE
+Manifest.txt
+README.md
+Rakefile
+bin/millworker
+example_tasks/log_to_csv.rb
+lib/millworker.rb
+lib/millworker/version.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,83 @@
+# millworker
+
+* http://github.com/tomkersten/millworker
+
+## DESCRIPTION:
+
+A Ruby gem which takes the pain of continuously reading data from a serial port
+away and lets you focus on dealing with the data received.
+
+This was written specifically for reading in data from an ID-20
+RFID card reader and running custom scripts to automatically perform
+various tasks when patrons scanned their badge at the
+[MN Mill](http://mnmill.org) (logging attendance, etc).
+
+
+Custom scripts are loaded from `ENV["HOME"]/millworker/tasks` and are executed
+in alphabetical order. Each script is executed with the ID of the badge passed
+in as an argument. For example, a script called `tweet_id.rb` existed in the
+afformentioned directory, it would be executed as if you had opened up a
+command terminal and typed `tweet_id.rb RFID_TAG_ID_HERE`.
+
+## SYNOPSIS:
+
+Install the millworker gem (see below for instructions).
+
+In order read from the correct port on your computer, we need to do a bit of
+setup.
+
+```bash
+millworker setup
+#...you will be prompted for the name of the serial port
+```
+
+Provided you keep the device connected to the same port, you should only
+have to run this one time. In the event that things stop working for some
+odd reason, you can re-run this as many times as necessary to overwrite 
+and/or verify your settings.
+
+Next, start the worker by issuing the following command
+
+```bash
+millworker start
+```
+
+Each time the reader receives a card, an entry in the logfile is written, which
+includes a timestamp and the data which was read over the serial port. After
+logging this information, each script located in the `millworker/scripts`
+directory is executed with the received data passed in as an argument.
+
+You can stop the worker any time by issuing the following command:
+
+```bash
+millworker stop
+```
+
+## REQUIREMENTS:
+
+* Ruby 1.9.3+
+* Please refer to the Gemfile for gem dependencies.
+
+## INSTALL:
+
+From the command line:
+
+```bash
+gem install millworker
+```
+
+## UNINSTALL:
+
+From the command line:
+
+```bash
+gem uninstall millworker
+```
+
+__Note:__ You may also want to removes the entire `ENV['HOME']/millworker`
+          directory. This is not done automatically to prevent accidental data
+          loss.
+
+## LICENSE:
+
+See the LICENSE file (hint: MIT)

data/Rakefile

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :bundler
+Hoe.plugin :git
+
+Hoe.spec 'millworker' do
+  developer 'Tom Kersten', 'tom@whitespur.com'
+  dependency 'gli', "~> 2.0"
+  dependency 'dante', "~> 0.1"
+  dependency 'serialport', "~> 1.1"
+
+  self.readme_file      = 'README.md'
+  self.extra_rdoc_files = FileList['README.md', 'LICENSE']
+  self.extra_dev_deps = [['rake'],
+                         ['aruba'],
+                         ['hoe-bundler'],
+                         ['hoe-git']
+                        ]
+end
+
+# vim: syntax=ruby

data/bin/millworker

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'dante'
+require 'fileutils'
+require 'logger'
+require 'serialport'
+
+require 'millworker'
+
+include GLI::App
+
+program_desc 'Listen to a serial port and execute custom scripts with data received.'
+
+version Millworker::VERSION
+
+SERIAL_PORT     = ENV['MILLWORKER_SERIAL_PORT']
+BASE_PATH       = ENV['MILLWORKER_PATH'] || File.expand_path(ENV['HOME'] + '/millworker')
+CONFIG_PATH     = "#{BASE_PATH}/config.yml"
+TASKS_DIR       = "#{BASE_PATH}/tasks"
+TMP_DIR         = "#{BASE_PATH}/tmp"
+LOG_DIR         = "#{BASE_PATH}/log"
+LOG_PATH        = "#{LOG_DIR}/millworker.log"
+DAEMON_LOG_PATH = "#{LOG_DIR}/millworkerd.log"
+PID_PATH        = "#{TMP_DIR}/willworker.pid"
+EXAMPLE_TASKS_DIR = File.join(File.dirname(File.dirname(__FILE__)), "example_tasks")
+
+def execute(executable)
+  result = system(executable) ? "success" : "failure"
+  yield result
+end
+
+def config
+  @config ||= File.exists?(CONFIG_PATH) ? YAML.load(File.open(CONFIG_PATH)) : {}
+end
+
+def serial_port
+  SerialPort.new(SERIAL_PORT || config[:serial_port])
+end
+
+
+desc "Set up machine to use `millworker` executable"
+command :setup do |c|
+  c.action do |g, o, a|
+    puts "Setting up millworker directory structure in #{BASE_PATH}"
+    [BASE_PATH, TMP_DIR, LOG_DIR, TASKS_DIR].each do |dir|
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    end
+    puts ""
+
+    port_name = nil
+    until !port_name.nil?
+      puts "What is the name of the serial port you'd like to read from? (eg: COM1): "
+      port_name= gets
+      port_name.strip!
+    end
+
+    File.open(CONFIG_PATH, "w") {|f| f.write({serial_port: port_name}.to_yaml)}
+
+    puts "Copying example tasks to #{TASKS_DIR}"
+    Dir["#{EXAMPLE_TASKS_DIR}/*"].map { |file|
+      FileUtils.cp file, TASKS_DIR
+      FileUtils.chmod 0755, "#{TASKS_DIR}/#{File.basename(file)}"
+    }
+
+    puts "Done. Now run 'millworker start' and you should be set!"
+  end
+end
+
+desc "Start lisening for data on an attached ID20 card reader."
+command :start do |c|
+  c.switch :stdin, desc: 'Read input from STDIN (command line) instead of a serial port.'
+
+  c.action do |g, options, args|
+    Dante::Runner.new('millworker').execute(daemonize: !options[:stdin],
+                                            pid_path: PID_PATH,
+                                            log_path: DAEMON_LOG_PATH) {
+
+      FileUtils.mkdir_p(LOG_DIR) unless File.directory?(LOG_DIR)
+      logger = Logger.new(LOG_PATH)
+
+      input = options[:stdin] ? ARGF : serial_port
+
+      loop do
+        data = input.gets
+
+        unless data.nil? || data.empty?
+          data.strip! # Take off newline from serial read
+
+          logger.info "received: '#{data.chomp}'"
+
+          # Read task list in every time so the daemon does not need to be
+          # restarted after changes
+          tasks = Dir["#{TASKS_DIR}/*"]
+
+          if tasks.empty?
+            logger.warn "No tasks to execute in '#{TASKS_DIR}'. Skipping."
+            next
+          else
+            tasks.each do |task|
+              command = "#{task} #{data}"
+
+              execute(command) { |result|
+                logger.info("executed: '#{command}', result: #{result}")
+              }
+            end
+          end
+        end
+      end
+    }
+  end
+end
+
+desc "Stops a running application currently lisening for data."
+command :stop do |c|
+  c.action do
+    Dante::Runner.new('millworker').execute(kill: true, pid_path: PID_PATH)
+  end
+end
+
+exit run(ARGV)

data/example_tasks/log_to_csv.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'csv'
+
+CSV_FILENAME = "millworker_log.csv"
+CSV_DIR = ENV["MILLWORKER_CSV_DIR"] || File.expand_path("#{ENV['HOME']}/Desktop")
+CSV_PATH = "#{CSV_DIR}/#{CSV_FILENAME}"
+
+when_new_file = !File.exists?(CSV_PATH)
+
+CSV_OPTIONS = {headers: %w(timestamp card_id),
+               write_headers: when_new_file,
+               force_quotes: true
+              }
+CSV.open(CSV_PATH, "a+", CSV_OPTIONS) {|csv| csv << [Time.now, ARGV[0]]}

data/lib/millworker.rb

@@ -0,0 +1,4 @@
+require 'millworker/version'
+
+module Millworker
+end

data/lib/millworker/version.rb

@@ -0,0 +1,3 @@
+module Millworker
+  VERSION = '0.1.0'
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format
+profile
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'lib/<lib_name>'
+
+Dir.glob('spec/support/**/*.rb').each {|f| require f}

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: millworker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Kersten
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURNRENDQWhpZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREErTVF3d0NnWURWUVFEREFOMGIy
+  MHgKR1RBWEJnb0praWFKay9Jc1pBRVpGZ2wzYUdsMFpYTndkWEl4RXpBUkJn
+  b0praWFKay9Jc1pBRVpGZ05qYjIwdwpIaGNOTVRFd05ESXlNRFF6T1RBNVdo
+  Y05NVEl3TkRJeE1EUXpPVEE1V2pBK01Rd3dDZ1lEVlFRRERBTjBiMjB4CkdU
+  QVhCZ29Ka2lhSmsvSXNaQUVaRmdsM2FHbDBaWE53ZFhJeEV6QVJCZ29Ka2lh
+  SmsvSXNaQUVaRmdOamIyMHcKZ2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJ
+  QkR3QXdnZ0VLQW9JQkFRRHB4b3pEUWdWTi9vWmxqR2xJOW9wbQpDcmhOVkEv
+  bHNOaVhaQlVtamZRQzVYUlBZSHptbHVvbjJaejQwNTBsak9ES1grYi90a3ov
+  V1ZaNng3YStMb3AyCnlDTExXTGNITmdCMTBqM2ozazZiTTBsM2NmQ2RDdnpl
+  dkU3WmdwdzNvL2J6YXpTVDV4MHBOenVyYXNTMW91UWsKeC8ybzlFNnFxSlJ1
+  QjUxa2h1WktuaCtNYTUyL0kxS1FhTUo0Ylc2Tk9ncXVGQ0VJdW04TUpKQkpX
+  RWRHbTRJdAp2aFMvZGFSZS9BRGtZbGdXbDFZMWs3THh1SCsxVkN4N3pNRk1l
+  MUUwQ01KemhHZjd6dU1TMHcrZHF3Ykw1bTNOCk1MRTh2Z3h3VEVPc093R3o0
+  d0Q2ek1VZEJZNkZHWXdSazhMR2p2bG9rbjBwWjFqeVdIV1NnMmJVdi8xR0My
+  aTkKQWdNQkFBR2pPVEEzTUFrR0ExVWRFd1FDTUFBd0N3WURWUjBQQkFRREFn
+  U3dNQjBHQTFVZERnUVdCQlRONjFBegp5a0RZaGVSSHR6c2p3RTdmaUxoWW16
+  QU5CZ2txaGtpRzl3MEJBUVVGQUFPQ0FRRUFMd29Jbld1YkpYSllWSDJOClhu
+  Q01UNFlseE5zUW9ZZERTeEVhZ05PbVpqSzJlS3RqdTBWOUdqWkFueVlCMnEy
+  TExpbHZiTXlWdGcvNkFOMEkKWGhDanlZWlJSQ0FEeXZGR1Y0YUJWdjd5aktG
+  UXJJeVh5OEpUMWlYeEhDMU4ybzFESmxaVWx0Q1lOb3pKQmhzTwpWTmJuU3Fl
+  OFlZY2V6c3VRMi93OWlhdldYQ2Y5MVFQd25yZkhQWlRyRlBPdmVza0pjdG04
+  SGluRjQxZkt3RzVCCmlVSHk4cVZXR0JDcERGWXo2S3orSnRpZ2FJQ2NtMkQ0
+  L1dHTHNEVk9tZ0orZzR4b09pQ2U5WkVrZGE4SytsL0YKeVhXcUluUmxGSWxU
+  dXdGVHhqMjZqYXVCb3NrQlBvejViZmtaRmphVlJoeVVuUm5Ha2E2Nmx2Y0RP
+  R2ZrUlpXUQpOVkFESkE9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dante
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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'
+- !ruby/object:Gem::Dependency
+  name: hoe-bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  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'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! 'A Ruby gem which takes the pain of continuously reading data from
+  a serial port
+
+  away and lets you focus on dealing with the data received.
+
+
+  This was written specifically for reading in data from an ID-20
+
+  RFID card reader and running custom scripts to automatically perform
+
+  various tasks when patrons scanned their badge at the
+
+  [MN Mill](http://mnmill.org) (logging attendance, etc).
+
+
+
+  Custom scripts are loaded from `ENV["HOME"]/millworker/tasks` and are executed
+
+  in alphabetical order. Each script is executed with the ID of the badge passed
+
+  in as an argument. For example, a script called `tweet_id.rb` existed in the
+
+  afformentioned directory, it would be executed as if you had opened up a
+
+  command terminal and typed `tweet_id.rb RFID_TAG_ID_HERE`.'
+email:
+- tom@whitespur.com
+executables:
+- millworker
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+- LICENSE
+files:
+- .autotest
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/millworker
+- example_tasks/log_to_csv.rb
+- lib/millworker.rb
+- lib/millworker/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- .gemtest
+homepage: http://github.com/tomkersten/millworker
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: millworker
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby gem which takes the pain of continuously reading data from a serial
+  port away and lets you focus on dealing with the data received
+test_files: []