benevolent_gaze 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28fcf63625230998b7ad585fddbd471f4d1eb023
+  data.tar.gz: c559d5da2ca8030ab56228bf4b669619b2f4fe3c
+SHA512:
+  metadata.gz: 36f0ba0bfba56fc13e414fd5714a952af9177146352b6d71937139013bcf9766eefd0a3becbd06cca69db844a93042d786cd819a2653f025f9b27651894e50d6
+  data.tar.gz: 913cde1fb8f76c89d2290de620e3c9471d3e9e8e3370685b0670d756bfb487155fea3b5a395f3d83f5ae921f74d09982470b0664de28a171101502f732c8394c

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.amazon_keys
+.env
+kiosk/.env
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benevolent_gaze.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Will Schenk
+
+MIT License
+
+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.md

@@ -0,0 +1,112 @@
+# BenevolentGaze
+
+
+First, let's see if this version of Benevolent Gaze will work with your current network setup.  Run the following command from your terminal:
+
+```$ ifconfig -a |awk '/broadcast/ { print $2 }' | xargs host```
+
+If it returns something like:
+
+```21.1.168.192.in-addr.arpa domain name pointer Aarons-MBP.home.```
+
+You can use Benevolent Gaze! If it doesn't return a host name, you will have to wait for a future version of Benevolent Gaze.
+
+Now let's get down to business!
+
+## Install the gem
+
+```$ gem install benevolent_gaze```
+
+## Install a couple dependencies.
+
+You will need to install parallel and Redis. If you use Homebrew, it is as easy as:
+
+```$ brew install parallel```
+
+```$ brew install redis```
+
+You will also need to install Foreman.
+
+```$ gem install foreman```
+
+Then in the directory where you want your Benevolent Gaze related things to live (public folder, images etc.) Run the following command:
+
+```$ benevolent_gaze install wifi_username wifi_password```
+
+This requires two arguments, your wifi username and password so that guests know how to get on your network and be looked on by the Benevolent Gaze. 
+ 
+This command creates a folder caled bg_public which contains a Procfile to use with Foreman so that you can start the kiosk and the tracker.  The kiosk is the web UI that lives at localhost:4567.  The tracker is the script that scans your network and reports on who has joined.
+
+## Get your environment ready.
+
+If you ran the `benevolent_gaze  install` command above, you should now have a Procfile and .env file in your folder.  The Procfile is good to go. The .env file will need populated with relevant information however. Leave the PORT set to 4567.
+
+     AWS_ACCESS_KEY_ID='_insert_your_aws_access_key_here_'
+     AWS_CDN_BUCKET='_insert_your_aws_bucket_here_'
+     AWS_SECRET_ACCESS_KEY='_insert_your_aws_secret_access_key_here_'
+     BG_COMPANY_URL='http://www.yourcompanywebsite.com/where_you_mounted_the_benevolent_gaze_app'
+     IPORT=4567
+     PORT=4567
+
+
+***You can use your local file system to save image uploads instead of AWS by just not filling in your AWS creds.  It defaults to saving to your local file system if you haven't supplied any credentials.***
+
+## Add a register url to your site.
+
+If you want users to associate an image and a name other than their device name with their devices you should add the following to your web app that you want to add the registration url to. Add the following to your routes.rb file.
+
+```
+mount BenevolentGaze::BGApp, at: '/register'
+```
+
+And make sure that you've included the class in an initializer:
+
+```
+require 'benevolent_gaze/bgapp'
+```
+  
+This works by receiving information from the tracker you have running on your local network.  So when users hit yoursite.com/register they are redirected to where you have the local kiosk running.  Users can now upload a photo, and if they give their same name to all of their devices, they will all be grouped under one avatar.
+
+Animated gifs are supported as well.
+
+## Now that you are set up. Let's get it up and running!
+
+### Step 1. 
+
+Make sure you have Redis running both locally and on the app where you mounted the application. You will need to set your redistogo url in an environment variable called REDISTOGO_URL on heroku (or wherever you have deployed the app where you mounted the registration endpoint).
+
+```$ heroku config:set REDISTOGO_URL=''```
+
+### Step 2. 
+
+Start your local benevolent_gaze instance. Go into your bg_public folder and run:
+
+```$ foreman start```
+
+### Step 3. 
+
+Go to localhost:4567 and check out the interface. You should be able to see people on the right hand side of the screen like the screenshot above!
+
+### Step 4.
+
+Enjoy Benevolent Gaze with your friends and fellow colleagues!
+
+## We also provide a command line tool to help you add users.
+
+### You can add users one at a time in the following way:
+
+```$ benevolent_gaze add_user device name image```
+
+Running the above command using the device name of the users device, their real name and a url to their image will add them to redis and will help them be identified when they join the network.  You would use this if you already had this information.  Remember, they can register themselves as well, if you provide the registration URL mentioned above, or use http://www.happyfuncorp.com/register.
+
+### You can assign current users without names an image and a real name by using the following command:
+
+```$ benevolent_gaze assign_users```
+
+This will prompt you for the current users on the network, if any of them do not have a real name or image, it will ask you to provide one.
+
+### You can bulk assign users using a CSV by using the following command:
+
+```$ benevolent_gaze bulk_assign yourcsv.csv```
+
+This expects a csv formatted with the columns device-name, real-name, and image-url.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/benevolent_gaze.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benevolent_gaze/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benevolent_gaze"
+  spec.version       = BenevolentGaze::VERSION
+  spec.authors       = ["Will Schenk, Aaron Brocken"]
+  spec.email         = ["wschenk@gmail.com, aaron@happyfuncorp.com"]
+  spec.summary       = %q{See your coworkers.}
+  spec.description   = %q{See your coworkers.  Totally not creepy.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sinatra"
+  spec.add_dependency "redis"
+  spec.add_dependency "sinatra-support"
+  spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "thin"
+  spec.add_dependency "json"
+  spec.add_dependency "httparty"
+  spec.add_dependency "sinatra-cross_origin", "~> 0.3.1"
+  spec.add_dependency "aws-s3"
+  spec.add_dependency "mini_magick"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/benevolent_gaze

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'benevolent_gaze/cli'
+
+BenevolentGaze::Cli.start( ARGV )

data/frontend/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+# git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore cache
+/.sass-cache
+/.cache
+
+# Ignore .DS_store file
+.DS_Store

data/frontend/Gemfile

@@ -0,0 +1,21 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+gem "middleman", "~>3.3.7"
+gem "middleman-deploy"
+gem "middleman-meta-tags", github: "happyfuncode/middleman-meta-tags", branch: "develop"
+gem "middleman-livereload", "~> 3.1.0"
+gem 'middleman-bootstrap-navbar'
+
+gem "bootstrap-sass"
+gem "jquery-middleman"
+
+# For faster file watcher updates on Windows:
+gem "wdm", "~> 0.1.0", :platforms => [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem "tzinfo-data", platforms: [:mswin, :mingw]
+
+gem "builder", "~> 3.0"
+

data/frontend/Gemfile.lock

@@ -0,0 +1,162 @@
+GIT
+  remote: git://github.com/happyfuncode/middleman-meta-tags.git
+  revision: fd6d03f84216def82b684693aefb234af6534980
+  branch: develop
+  specs:
+    middleman-meta-tags (0.0.1)
+      middleman-core (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    bootstrap-navbar (2.2.2)
+      gem_config (~> 0.3)
+    bootstrap-sass (3.3.1.0)
+      sass (~> 3.2)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    chunky_png (1.3.3)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    compass (1.0.1)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.1)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.1)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    execjs (2.2.2)
+    ffi (1.9.6)
+    gem_config (0.3.1)
+    haml (4.0.5)
+      tilt
+    hike (1.2.3)
+    hitimes (1.2.2)
+    hooks (0.4.0)
+      uber (~> 0.0.4)
+    http_parser.rb (0.6.0)
+    i18n (0.6.11)
+    jquery-middleman (3.0.4)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    kramdown (1.5.0)
+    listen (2.8.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    middleman (3.3.7)
+      coffee-script (~> 2.2)
+      compass (>= 1.0.0, < 2.0.0)
+      compass-import-once (= 1.0.5)
+      execjs (~> 2.0)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-core (= 3.3.7)
+      middleman-sprockets (>= 3.1.2)
+      sass (>= 3.4.0, < 4.0)
+      uglifier (~> 2.5)
+    middleman-bootstrap-navbar (2.0.0)
+      bootstrap-navbar (~> 2.0)
+      middleman-core (>= 3.0)
+    middleman-core (3.3.7)
+      activesupport (~> 4.1.0)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.6.9)
+      listen (>= 2.7.9, < 3.0)
+      padrino-helpers (~> 0.12.3)
+      rack (>= 1.4.5, < 2.0)
+      rack-test (~> 0.6.2)
+      thor (>= 0.15.2, < 2.0)
+      tilt (~> 1.4.1, < 2.0)
+    middleman-deploy (0.3.0)
+      middleman-core (>= 3.2)
+      net-sftp
+      ptools
+    middleman-livereload (3.1.1)
+      em-websocket (>= 0.2.0)
+      middleman-core (>= 3.0.2)
+      multi_json (~> 1.0)
+      rack-livereload
+    middleman-sprockets (3.3.10)
+      middleman-core (~> 3.3)
+      sprockets (~> 2.12.1)
+      sprockets-helpers (~> 1.1.0)
+      sprockets-sass (~> 1.2.0)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.1)
+    padrino-helpers (0.12.4)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.4)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.4)
+      activesupport (>= 3.1)
+    ptools (1.2.6)
+    rack (1.5.2)
+    rack-livereload (0.3.15)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    sass (3.4.8)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-helpers (1.1.0)
+      sprockets (~> 2.0)
+    sprockets-sass (1.2.0)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uber (0.0.11)
+    uglifier (2.5.3)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bootstrap-sass
+  builder (~> 3.0)
+  jquery-middleman
+  middleman (~> 3.3.7)
+  middleman-bootstrap-navbar
+  middleman-deploy
+  middleman-livereload (~> 3.1.0)
+  middleman-meta-tags!
+  tzinfo-data
+  wdm (~> 0.1.0)

data/frontend/config.rb

@@ -0,0 +1,56 @@
+# For custom domains on github pages
+page "CNAME", layout: false
+
+set :build_dir, '../kiosk/public'
+set :css_dir, 'stylesheets'
+set :js_dir, 'javascripts'
+set :images_dir, 'images'
+
+# Better markdown support
+# set :markdown, :tables => true, :autolink => true, :gh_blockcode => true, :fenced_code_blocks => true
+# set :markdown_engine, :redcarpet
+
+activate :meta_tags
+
+# Turn this on if you want to make your url's prettier, without the .html
+# activate :directory_indexes
+
+# Automatic image dimensions on image_tag helper
+# activate :automatic_image_sizes
+
+# Easier bootstrap navbars
+activate :bootstrap_navbar
+
+configure :development do
+  activate :livereload
+end
+
+# Build-specific configuration
+configure :build do
+  # Any files you want to ignore:
+  ignore '/admin/*'
+  ignore '/stylesheets/admin/*'
+
+  # For example, change the Compass output style for deployment
+  activate :minify_css
+
+  # Minify Javascript on build
+  #activate :minify_javascript
+
+  # Enable cache buster
+  activate :asset_hash
+
+  # Use relative URLs
+  activate :relative_assets
+
+  # Or use a different image path
+  # set :http_prefix, "/blog/"
+end
+
+
+# This will push to the gh-pages branch of the repo, which will
+# host it on github pages (If this is a github repository)
+activate :deploy do |deploy|
+  deploy.method = :git
+  deploy.build_before = true
+end

data/frontend/data/site.yml

@@ -0,0 +1,4 @@
+title: "My Static Site"
+publisher_twitter: "@HappyFunCorp"
+twitter_id: "@wschenk"
+# google_analytics_id:

data/frontend/source/images/uploads/info.txt

@@ -0,0 +1 @@
+This is where uploads will be saved if you do not provide AWS creds in your .env file.

data/frontend/source/index.html.haml

@@ -0,0 +1,33 @@
+.container-fluid
+  .row
+    .left_column.col-md-5.sky
+      .row
+        .logo.text-center
+          = image_tag "/images/logo@1x.png"
+        .welcomes.text-center
+          = image_tag "/images/welcome@1x.png"
+        .newcomer.text-center.row
+          %h3
+        .newcomer_avatar.text-center.row
+          = image_tag "/images/visitor_art@1x.png", class: "img-circle img-responsive"
+        .sun.text-center
+          = image_tag "/images/sun@1x.png"
+        .town.text-center
+          = image_tag "/images/city@1x.png"
+        .wifi.col-md-6.col-md-offset-3
+          .row
+            %h3.register_url http://www.happyfuncorp.com/register
+          .row
+            %h3.pull-left.uname happyfuncorp3
+            %h3.pull-right.pword happiness4u
+    .right_column.col-md-7.board.med
+      .row
+        .worker.text-center.hidden
+          .pin_and_avatar_container
+            .pin_rope
+              = image_tag "/images/pin_rope@1x.png", class: "img-responsive"
+            .avatar_container.text-center
+              =# image_tag "/images/visitor_art@1x.png", class: "img-circle img-responsive"
+              = image_tag "/images/visitor_art@1x.png"
+          %h3.tape Ted 
+