walkon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e98fa4a3f793072e126e54bb7885cc9ad4a11509
+  data.tar.gz: a613f716836c62e95d919db026bd3101395ffe62
+SHA512:
+  metadata.gz: 94c888a21f894d3ec03066389834954bd53dc9da3bcff4b280e7d192b78a707a5a0066bbeb8d08adce83bd7305c4dfdb0b327c2a0c7fab3c121886767c1c00c5
+  data.tar.gz: 5b840b4c8e37048f83b8589ce8fc8d746737d182df1f05a6f866276bfba8a85dfdf446b8485359d35eece2b803eea504bda23009ad3ad4bd2e610ff76caa9bf5

data/README.md

@@ -0,0 +1,37 @@
+# Walkon
+
+Walkon plays your entrance music. It's a daemon process that
+periodically checks `hcitool scan` for new Bluetooth devices, then uses
+their ESSIDs to find tracks to play as they leave or exit the network.
+
+## Installation
+
+Walkon is best used on a **Raspberry Pi** with **Ubuntu**.
+
+Install it yourself:
+
+    $ gem install walkon
+
+Then, run:
+
+    $ walkon setup
+
+## Usage
+
+Place an MP3 in `/music` that corresponds with your device's ESSID.
+So, if your device's name is "iPhone5", you would upload a track like
+so:
+
+    $ scp your-track.mp3 walkon:/music/iPhone5.mp3
+
+To find out more about how it works, read the [Documentation][docs].
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[docs]: http://rdoc.info/github/tubbo/walkon

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :test
+
+desc "Provision a local development VM"
+task :vm do
+  if `which vagrant` == ""
+    puts "Error: You must install Vagrant to use this feature."
+    exit 1
+  end
+
+  sh 'vagrant up'
+end
+
+task :default => %w(test build)

data/bin/walkon

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'walkon'
+
+unless Walkon.found_hcitool?
+  puts "Error: You need BlueZ to use this software. Exiting.."
+  exit 1
+end
+
+Walkon.start

data/lib/walkon.rb

@@ -0,0 +1,18 @@
+require "walkon/version"
+require "walkon/daemon"
+
+module Walkon
+  def self.start
+    Walkon::Daemon.start
+  end
+
+  def self.found_hcitool?
+    !!`hcitool -h`
+  rescue Errno::ENOENT
+    false
+  end
+
+  def self.env
+    ENV['WALKON_ENV'] || 'development'
+  end
+end

data/lib/walkon/daemon.rb

@@ -0,0 +1,46 @@
+require 'walkon/device'
+require 'walkon/hci_tool'
+
+# The process which listens for new Devices to come on the network, then
+# immediately plays their entrance music and adds them to the collection
+# so they won't be triggered again.
+#
+# A cron job restarts the daemon every night at 3:00am so the devices
+# collection is reset and people are triggered again once they walk in
+# the building.
+
+module Walkon
+  class Daemon
+    attr_accessor :devices
+
+    def initialize
+      @devices = []
+    end
+
+    def self.start
+      new.run
+    end
+
+    def run
+      loop { check_for_devices }
+    end
+
+    def check_for_devices
+      scanned_devices.each do |mac_address|
+        unless self.devices.include? mac_address
+          device = Device.new mac_address
+          play_entrance_music_for device
+          self.devices << Device.new(mac_address)
+        end
+      end
+    end
+
+    def scanned_devices
+      HciTool.scan
+    end
+
+    def play_entrance_music_for device
+      device.entrance_music.play if device.has_entrance_music?
+    end
+  end
+end

data/lib/walkon/device.rb

@@ -0,0 +1,18 @@
+require 'walkon/entrance_music'
+
+# Represents a single Bluetooth device in the building.
+
+module Walkon
+  class Device
+    attr_reader :mac_address, :entrance_music
+
+    def initialize with_mac_address
+      @mac_address = with_mac_address
+      @entrance_music = EntranceMusic.new self
+    end
+
+    def has_entrance_music?
+      entrance_music.exists?
+    end
+  end
+end

data/lib/walkon/entrance_music.rb

@@ -0,0 +1,34 @@
+require 'walkon/device'
+
+# Finds and plays the entrance music for a given device.
+
+module Walkon
+  class EntranceMusic
+    attr_reader :device, :filename
+
+    def initialize from_device
+      @device = from_device
+      @filename = "#{prefix}/#{@device.mac_address}.mp3"
+    end
+
+    def exists?
+      File.exists? filename
+    end
+
+    alias present? exists?
+
+    def play
+      return false unless exists?
+      `xmms #{filename}`
+    end
+
+    private
+    def prefix
+      if Walkon.env == 'test'
+        File.expand_path "../../../spec/fixtures/music", __FILE__
+      else
+        "/music"
+      end
+    end
+  end
+end

data/lib/walkon/hci_tool.rb

@@ -0,0 +1,31 @@
+# A collection of device names gathered from HciTool.
+
+module Walkon
+  class HciTool
+    attr_accessor :results
+
+    def initialize
+      @results = []
+    end
+
+    def self.scan
+      new.scan
+    end
+
+    def scan
+      @results = scan_results.reduce([]) do |collection, line|
+        line.scan FOR_MAC_ADDRESS do |mac_address|
+          collection << mac_address.first
+        end
+
+        collection
+      end
+    end
+
+    private
+    FOR_MAC_ADDRESS = /(..:..:..:..:..:..)/
+    def scan_results
+      `hcitool scan`.split "\n"
+    end
+  end
+end

data/lib/walkon/version.rb

@@ -0,0 +1,3 @@
+module Walkon
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'rspec'
+require 'pry'
+
+ENV['WALKON_ENV'] ||= "test"
+
+require 'walkon'

data/spec/walkon/daemon_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'walkon/daemon'
+
+module Walkon
+  describe Daemon do
+    context "when a new device is detected" do
+      let(:mac_address) { "00:A1:5D:AB:B2:E9" }
+
+      before do
+        subject.stub(:scanned_devices) { [mac_address] }
+        subject.stub(:play_entrance_music_for) { |device| true }
+        subject.check_for_devices
+      end
+
+      it "adds the sample mac address to devices" do
+        expect(subject.devices.map(&:mac_address)).to include(mac_address)
+      end
+
+      it "plays device's entrance music" do
+        expect(subject.devices).to_not be_empty
+        device = subject.devices.select { |dev| dev.mac_address == mac_address }.first
+        expect(device).to_not be_nil
+        expect(device).to have_entrance_music
+      end
+    end
+  end
+end

data/spec/walkon/device_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'walkon/device'
+
+module Walkon
+  describe Device do
+    subject { Device.new '00:A1:5D:AB:B2:E9' }
+
+    it "requires a mac address for identification" do
+      expect(subject.mac_address).to_not be_nil
+    end
+
+    it "uses mac address to find entrance music in configured dir" do
+      expect(subject).to have_entrance_music
+    end
+  end
+end

data/spec/walkon/entrance_music_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'walkon/entrance_music'
+
+module Walkon
+  describe EntranceMusic do
+    let(:mac_address) { "00:A1:5D:AB:B2:E9" }
+    let(:device) do
+      dev = double :device
+      dev.stub(:mac_address) { mac_address }
+      dev
+    end
+    subject { EntranceMusic.new device }
+
+    before do
+      subject.stub(:play) { "" }
+    end
+
+    it "finds an mp3 file to play" do
+      expect(subject).to be_present
+    end
+
+    it "plays the mp3 file if found" do
+      expect(subject.play).to be_true
+    end
+  end
+end

data/spec/walkon/hci_tool_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Walkon
+  describe HciTool do
+    let(:mac_address) { "00:A1:5D:AB:B2:E9" }
+    let(:sample_output) do
+      %(
+        Scanning....
+           #{mac_address}  Nokia 6600
+       ).split("\n")
+    end
+
+    before do
+      subject.stub(:scan_results) { sample_output }
+    end
+
+    it "starts with no results" do
+      expect(subject.results).to be_empty
+    end
+
+    it "finds mac addresses with a scan" do
+      expect(subject.scan).to_not be_empty
+      expect(subject.results.first).to eq(mac_address)
+    end
+  end
+end

data/spec/walkon_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Walkon do
+  it "runs a daemon for playing entrance music" do
+    expect(Walkon).to respond_to :start
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: walkon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Play your entrance music
+email:
+- tubbo@psychedeli.ca
+executables:
+- walkon
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/walkon
+- lib/walkon/daemon.rb
+- lib/walkon/device.rb
+- lib/walkon/entrance_music.rb
+- lib/walkon/hci_tool.rb
+- lib/walkon/version.rb
+- lib/walkon.rb
+- spec/fixtures/music/00:A1:5D:AB:B2:E9.mp3
+- spec/spec_helper.rb
+- spec/walkon/daemon_spec.rb
+- spec/walkon/device_spec.rb
+- spec/walkon/entrance_music_spec.rb
+- spec/walkon/hci_tool_spec.rb
+- spec/walkon_spec.rb
+- README.md
+- Rakefile
+homepage: http://github.com/tubbo/walkon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Play your entrance music
+test_files:
+- spec/fixtures/music/00:A1:5D:AB:B2:E9.mp3
+- spec/spec_helper.rb
+- spec/walkon/daemon_spec.rb
+- spec/walkon/device_spec.rb
+- spec/walkon/entrance_music_spec.rb
+- spec/walkon/hci_tool_spec.rb
+- spec/walkon_spec.rb