millworker 0.1.3 → 0.2.0

data.tar.gz.sig

@@ -1,3 +1,5 @@
-�x�y#�)�L
-��kom����1��%?].ő��
-L�+%��������F��׆
����[��ӲeK\[�U/��h������>H�1-�?#�}�9
+��#׬�(��6A�T*��ut�V�u�#��+�J�T&d�@�ؽ3����M�!�/w|i����
+�{��7�4T=A�ċ�테(j6BQx�._m�+z*g���8Y��J�q�t�y��
+Ek�˚wT:�g*
+_�66�pKBj���KM���d�oM��d�SA���Ot	�+�n�J��I���r���Z҃
+Vh�抸ek��p�Ör!GT��~6��)ǚ�)

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.2.0 / 2012-10-19
+
+* 2 minor enhancements:
+
+  * Added Salesforce "checking logger" script
+  * Only execute tasks which do not end in ".example"
+
+* 2 bug fixes:
+
+  * Added documentation for log_to_csv.rb.example script
+  * Rename all example tasks to end in ".example"
+
 === 0.1.3 / 2012-09-18
 
 * 1 bug fix:

data/Manifest.txt

@@ -5,7 +5,8 @@ Manifest.txt
 README.md
 Rakefile
 bin/millworker
-example_tasks/log_to_csv.rb
+example_tasks/log_to_csv.rb.example
+example_tasks/sf_logger.rb.example
 lib/millworker.rb
 lib/millworker/version.rb
 spec/spec.opts

data/bin/millworker

@@ -61,7 +61,7 @@ command :setup do |c|
     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|
+    Dir["#{EXAMPLE_TASKS_DIR}/*.example"].map { |file|
       FileUtils.cp file, TASKS_DIR
       FileUtils.chmod 0755, "#{TASKS_DIR}/#{File.basename(file)}"
     }
@@ -99,14 +99,15 @@ command :start do |c|
         next if rfid_id.nil?
 
         # Read task list in every time so the daemon does not need to be
-        # restarted after changes
-        tasks = Dir["#{TASKS_DIR}/*"]
+        # restarted after changes (ignore '.example' tasks)
+        tasks = Dir["#{TASKS_DIR}/*"].reject {|task| task[/\.example/]}
 
         if tasks.empty?
           logger.warn "No tasks to execute in '#{TASKS_DIR}'. Skipping."
           next
         else
           tasks.each do |task|
+
             command = "#{task} #{rfid_id}"
 
             execute(command) { |result|

data/example_tasks/log_to_csv.rb.example

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# Overview
+# ========
+#
+# Logs the identifier passed in with a timestamp of when it occurred to a CSV
+# file named "millworker_log.csv".
+#
+# NOTE: Please read the 'Requirements' section before attempting to use this
+#       script as it will outline any customizations you must do or software you
+#       need to install in order for it to work properly.
+#
+# NOTE: You must rename this file so the filename does not end in ".example".
+#       The instructions below assume you have only removed the ".example" when
+#       you renamed the file.
+#
+# Usage
+# =====
+#
+# ./log_to_csv.rb [BADGE ID HERE]
+#
+# Example
+# ======
+#
+# ./log_to_csv.rb 12345
+#
+#
+# Requirements
+# ============
+#
+# - There are no requirements for this script outside of using Ruby 1.9.3+.
+#   However, if you would like to customize where the "millworker_log.csv" file
+#   is written, you can set the "MILLWORKER_CSV_DIR" environment variable to
+#   the full path to a directory you'd like it written to
+#   (default: $HOME/Desktop).
+
+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/example_tasks/sf_logger.rb.example

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+# Overview
+# ========
+#
+# Logs a "Checkin" event in Salesforce for the person with the specified
+# badge number (a unique identifier passed in as an argument).
+#
+# NOTE: Please read the 'Requirements' section before attempting to use this
+#       script as it will outline any customizations you must do or software you
+#       need to install in order for it to work properly.
+#
+# NOTE: You must rename this file so the filename does not end in ".example".
+#       The instructions below assume you have only removed the ".example" when
+#       you renamed the file.
+#
+# Usage
+# =====
+#
+# ./sf_checkin_logger.rb [BADGE ID HERE]
+#
+# Example
+# ======
+#
+# ./sf_checkin_logger.rb 12345
+#
+#
+# Requirements
+# ============
+#
+# Script modification requirements
+# --------------------------------
+# - You must set the hostname, username, etc variables in the code below
+#   (denoted with "CUSTOM SETTINGS BELOW HERE" and
+#   "CUSTOM SETTINGS ABOVE HERE" lines)
+#
+# Software requirements:
+# ----------------------
+# - the databasedotcom ruby gem (run `gem install databasedotcom`)
+#
+# Requirements on Salesforce:
+# ---------------------------
+# - API access must be set up
+# - Account credentials (security token, password, etc)
+# - Custom "Check_in__c" object with the following fields (at a minimum)
+#   - Person__c
+#     - stores the Id of the Account to associate the checkin with
+#   - Check_In_Time_Date__c
+#     - stores a timestamp of when the "checkin" occurred
+#   - Incident__c
+#     - boolean field which was a required field of the system this was
+#       originally written for
+#   - Paid_Shift__c
+#     - boolean field which was a required field of the system this was
+#       originally written for
+
+
+# CUSTOM SETTINGS BELOW HERE
+hostname = "CHANGE_ME"        # eg: "test.salesforce.com"
+username = "CHANGE_ME"        # eg: "jdoe@example.com"
+password = "CHANGE_ME"        # eg: "password"
+security_token = "CHANGE_ME"  # eg: "Ejy3282382923dsjsj"
+client_secret = "CHANGE_ME"   # eg: "74439232ds2832"
+client_id = "CHANGE_ME"       # eg: '3MVG9-REALLY-LONG-STRING-HERE'
+# CUSTOM SETTINGS ABOVE HERE
+
+# NOTE: No changes should be necessary below this line!
+
+[hostname,
+ username,
+ password,
+ security_token,
+ client_secret,
+ client_id
+].each {|custom_setting|
+  if custom_setting == "CHANGE_ME"
+    $stderr.puts "Please verify all custom settings have been updated. Exiting."
+    exit 3
+  end
+}
+
+begin
+  require 'databasedotcom'
+  include Databasedotcom
+rescue LoadError
+  $stderr.puts "You must install the 'databasedotcom' gem (run `gem install databasedotcom`). Exiting."
+  exit 1
+end
+
+badge_id = ARGV[0]
+
+client = Client.new(host: hostname,
+                    client_secret: client_secret,
+                    client_id: client_id,
+                    debugging: false)
+
+client.authenticate :username => "info@mnmill.org.sandbox", :password => "#{password}#{security_token}"
+
+Account = client.materialize("Account")
+CheckIn = client.materialize("Check_in__c")
+
+account = Account.find_by_Id_Badge__c(badge_id)
+checkin_time = DateTime.now
+
+if account.nil?
+  $stderr.puts "Could not find account with ID of #{badge_id}. Exiting."
+  exit 1
+end
+
+checkin = CheckIn.new(:Person__c => account.Id,
+                      :Check_In_Time_Date__c => checkin_time,
+                      :Incident__c => false,
+                      :Paid_Shift__c => false)
+
+if checkin.save
+  $stdout.puts "Checkin for #{account.Name} (ID: #{account.Id}) logged to Salesforce at '#{checkin_time.to_s}'"
+  exit 0
+else
+  $stderr.puts "Checkin for #{account.Name} (ID: #{account.Id}) was not saved successfully for some reason. Please manually verify the script is functioning correctly. Exiting."
+  exit 2
+end

data/lib/millworker/version.rb

@@ -1,3 +1,3 @@
 module Millworker
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: millworker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   L1dHTHNEVk9tZ0orZzR4b09pQ2U5WkVrZGE4SytsL0YKeVhXcUluUmxGSWxU
   dXdGVHhqMjZqYXVCb3NrQlBvejViZmtaRmphVlJoeVVuUm5Ha2E2Nmx2Y0RP
   R2ZrUlpXUQpOVkFESkE9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -209,7 +209,8 @@ files:
 - README.md
 - Rakefile
 - bin/millworker
-- example_tasks/log_to_csv.rb
+- example_tasks/log_to_csv.rb.example
+- example_tasks/sf_logger.rb.example
 - lib/millworker.rb
 - lib/millworker/version.rb
 - spec/spec.opts

metadata.gz.sig

@@ -1,2 +1,4 @@
-��$w����K���ړ^�e�62Y��
#�|��i�f������]8	�enE}�E��m���~uM\��^��2i�BbP�:�D��O����,��z��:Ti�e�O7�Ƞ󞻞�fb�p�E���$�q�2_�;W>x��].Hih�H���{�[��A��F@�����[��R�zaPd��<k���E��D��]�/~�|i�Q�1�
-b��Ԅޣ��7&/m� +����K8�?�VP���$�[�pE
+�I2o������7f�8=��f:��}:��}��li�N���1�͋����}��V�a�̾�A���C/� ��]��S�T��"GE���g�i
+� ��+j��]װ���q
+MJN�M0'�ӗ%z��+簢}#^=�PƊ��3=�*��C
+�c��_�2����.�c2�&(�xa���}_��0E+��g>Yx0@��

data/example_tasks/log_to_csv.rb

@@ -1,14 +0,0 @@
-#!/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]]}