airport_events 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47d41f6753ff18dd14d43e0fde4d204b792c5138
+  data.tar.gz: edd71ac189400ea7cd79bf1aa4318845d960bc74
+SHA512:
+  metadata.gz: 0de2ac852c75c2b4240c27c45c5fe3510afc4f8ca8ea6298b410bf0bea3da5b2d3bd1fc1e2b74f669ba197a7fd0df27f95c7ffda497ca1ce9b34f44d25706179
+  data.tar.gz: e6e7f6e5831f3408b197fb43d7e20af41256ffb0aa76e764597d4f7a4ebd87b7094fe975640d57410fefd88343825272064c18bdab7d81f6f580b61587ace2fb

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,91 @@
+airport_events
+==============
+
+airport-events is a MacOS specific library that receives WiFi related events. It currently supports:
+
+```
+event           parameters                    triggers when
+
+connected       String ssid, DateTime date    A WiFi networks has been successfully connected.
+disconnected    DateTime date                 Computer is going to sleep, airport has been disabled or system halts. 
+```
+
+The library is extremely fresh and currently has no tests and has only been tested on MacOS 10.7.5.
+
+I created it to log the amount of time I spend on different WiFi networks. Check out the airport-log utility below for an example implementation.
+
+Why?
+-------------
+
+* Detect when a machine has joined a specific network. 
+* Log the amount of time that's spent on different networks.
+
+Installation
+------------
+``
+gem install airport-events
+``
+
+The gem depends on an official Apple command line tool called "airport" which is disabled by default. To enable the "airport" command, symlink it into PATH by running the following command: 
+
+``
+sudo ln -s /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport /usr/sbin/airport
+``
+
+Usage
+-----
+
+```ruby
+require 'airport_events'
+
+# Create a new Watcher instance and set up some event listeners.
+watcher = AirportEvents::Watcher.new
+
+watcher.bind :connected do |ssid, date|
+  puts "Connected to #{ssid} on #{date}"
+end
+
+watcher.bind :disconnected do |date|
+  puts "Disconnected on #{date}"
+end
+
+# Start the watcher, which runs in a separate Thread.
+watcher.start
+
+# Keep program alive until interrupted (For instance: CTRL + C).
+interrupted = false
+trap("INT") { interrupted = true }
+
+while true do
+  exit if interrupted
+  sleep 0.1
+end
+
+```
+
+Binary: airport-log
+-----------
+
+The gem is shipped with a binary called 'airport-log' which logs wifi connect/disconnect events to a JSON file.
+
+For usage instructions run:
+``airport-log -h``
+
+Example JSON output:
+
+```json
+[
+  {
+    "ssid": "orca",
+    "connected_at": "2013-02-24T22:35:54+00:00",
+    "disconnected_at": "2013-02-24T22:47:38-05:00"
+  },
+  {
+    "ssid": "beluga",
+    "connected_at": "2013-02-24T22:48:23-05:00",
+    "disconnected_at": null
+  }
+]
+```
+
+When disconnected_at is null it means the network is still connected or a disconnect event was never sent.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/airport_events.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "airport_events/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'airport_events'
+  s.version     = AirportEvents::VERSION
+  s.date        = '2013-02-24'
+  s.summary     = "A MacOS specific library to receive WiFi related events"
+  s.description = "Detect and log changes in WiFi network associations on MacOS. Utilizing the official, but hidden 'airport' command."
+  s.authors     = ["Jonathan Pettersson"]
+  s.email       = 'jonathan@spacetofu.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage    = 'https://github.com/jpettersson/airport_events'
+  s.executables << 'airport-log'
+
+  s.add_development_dependency "rspec", "2.13.0"
+  s.add_runtime_dependency "thor", "0.17.0"
+  s.add_runtime_dependency "file-tail", "1.0.12"
+  s.add_runtime_dependency "json"
+end

data/bin/airport-log

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require_relative '../lib/airport_events'
+require "thor"
+
+class AirportLogThor < Thor
+  desc 'enable_airport', 'Print instructions on how to enable the airport command in MacOS.'
+  def enable_airport
+    puts <<-EOF
+
+The "airport" command is not enabled by default in MacOS. To enable it, run the following command:
+sudo ln -s /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport /usr/sbin/airport
+    
+    EOF
+  end
+
+  desc 'to_file --path PATH', "(Default) Log WiFi events to a JSON file. Default PATH is: ~/.airport-log.json"
+  method_option :path, :default => "#{Dir.home}/.airport-log.json", :aliases => '-p'
+  def to_file
+    puts "AirportLog: Logging WiFi events to '#{options[:path]}'"
+    AirportEvents::Logger.new options[:path]
+  end
+
+  default_task :to_file
+end
+
+AirportLogThor.start

data/lib/airport_events.rb

@@ -0,0 +1,41 @@
+require_relative 'airport_events/event_dispatcher'
+require_relative 'airport_events/airport'
+require_relative 'airport_events/kernel_log_parser'
+require_relative 'airport_events/logger'
+
+module AirportEvents
+  class Watcher
+    include EventDispatcher
+
+    def start
+      Airport.ensure_airport_command
+
+      if Airport.connected?
+        connected DateTime.now
+      else
+        disconnected DateTime.now
+      end
+
+      @kernel_log_parser = KernelLogParser.new
+
+      @kernel_log_parser.bind :connected do |date|
+        connected date
+      end
+
+      @kernel_log_parser.bind :disconnected do |date|
+        disconnected date
+      end
+    end
+
+    private 
+
+    def connected date
+      trigger :connected, Airport.ssid, date
+    end
+
+    def disconnected date
+      trigger :disconnected, date
+    end
+
+  end
+end

data/lib/airport_events/airport.rb

@@ -0,0 +1,32 @@
+module AirportEvents
+  class Airport
+    INFO_COMMAND = "airport -I 2>&1"
+
+    def self.ensure_airport_command
+      run_info_command
+      unless $?.exitstatus == 0
+        raise "Fatal: the 'airport' command is not in PATH. Run 'airport-log enable_airport' for instructions."
+      end
+    end
+
+    def self.ssid
+      parse_ssid(run_info_command)
+    end
+
+    def self.connected?
+      ssid.length > 0
+    end
+
+    def self.run_info_command
+      %x(#{INFO_COMMAND})
+    end
+
+    def self.parse_ssid result
+      if result.match /\sSSID: /
+        result[/\sSSID: (.*?)\n/, 1]
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/airport_events/event_dispatcher.rb

@@ -0,0 +1,36 @@
+module AirportEvents
+  module EventDispatcher
+
+    module InstanceMethods
+      def bind(event, &blk)
+        if observers[event].nil?
+          observers[event] = Array.new
+        end
+
+        observers[event].push blk
+      end
+
+      # TODO: unbind
+      #def unbind
+      #
+      #end
+
+      def trigger(event, *args)
+        unless observers[event].nil?
+          observers[event].each do |blk|
+            blk.call *args
+          end
+        end
+      end
+
+      def observers
+        @observers ||= Hash.new
+      end
+    end
+
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+
+  end
+end

data/lib/airport_events/kernel_log_parser.rb

@@ -0,0 +1,32 @@
+require 'file-tail'
+require 'date'
+
+module AirportEvents
+  class KernelLogParser
+    include EventDispatcher
+
+    def initialize
+      Thread.new do
+        File.open('/var/log/kernel.log') do |log|
+          log.extend(File::Tail)
+          log.interval = 10
+          log.backward(0)
+          log.tail do |line| 
+
+            if event = match_event(line)
+              trigger event, DateTime.strptime(line[0..15], '%b %d %H:%M:%S')
+            end
+          end
+        end
+      end
+    end
+
+    def match_event line
+      if line.match /AirPort: Link Up.*/
+        :connected
+      elsif line.match /AirPort: Link Down.*/
+        :disconnected
+      end
+    end
+  end
+end

data/lib/airport_events/logger.rb

@@ -0,0 +1,100 @@
+require 'json'
+require 'logger'
+
+OUT = Logger.new(STDOUT)
+
+module AirportEvents
+  class Logger
+
+    def initialize path
+      @log_path = path
+      read_log
+
+      watcher = AirportEvents::Watcher.new
+      
+      watcher.bind :connected do |ssid, date|
+        connected ssid, date
+      end
+
+      watcher.bind :disconnected do |date|
+        disconnected date
+      end
+
+      watcher.start
+
+      interrupted = false
+      trap("INT") { interrupted = true }
+
+      while true do
+        exit if interrupted
+        sleep 0.1
+      end
+
+    end
+
+    def connected ssid, date
+      if last_entry
+        unless last_entry[:ssid] == ssid
+          new_entry ssid, date
+        else
+          OUT.info "AirportLogger: Already connected to to \"#{ssid}\""
+        end
+      else
+        new_entry ssid, date
+      end
+    end
+
+    def disconnected date
+      end_last_entry date
+    end
+
+    def read_log
+      @log = read_file
+    end
+
+    def read_file 
+      if file = File.read(@log_path, mode: 'a+')
+        if file.length > 0
+          JSON.parse(file, :symbolize_names => true)
+        else
+          []
+        end
+      end
+    end
+
+    def rewrite
+      IO.write(@log_path, JSON.pretty_generate(@log))
+      read_log
+    end
+
+    def append entry
+      @log.push entry
+      rewrite
+    end
+
+    def last_entry
+      entry = @log.last
+      if entry and entry[:disconnected_at].nil?
+        return entry
+      end
+    end
+
+    def new_entry ssid, date
+      OUT.info "AirportLogger: Connected to \"#{ssid}\""
+      append({
+        :ssid => ssid,
+        :connected_at => date,
+        :disconnected_at => nil
+      })
+    end
+
+    def end_last_entry date
+      if last_entry and last_entry[:disconnected_at].nil?
+        OUT.info "AirportLogger: Disconnected"
+        last_entry[:disconnected_at] = date
+        rewrite
+      end
+    end
+
+  end
+end

data/lib/airport_events/version.rb

@@ -0,0 +1,3 @@
+module AirportEvents
+  VERSION = '0.0.2'
+end

data/spec/fixtures/airport.sample.txt

@@ -0,0 +1,15 @@
+     agrCtlRSSI: -48
+     agrExtRSSI: 0
+    agrCtlNoise: -89
+    agrExtNoise: 0
+          state: running
+        op mode: station 
+     lastTxRate: 216
+        maxRate: 300
+lastAssocStatus: 0
+    802.11 auth: open
+      link auth: wpa2-psk
+          BSSID: 2:18:1a:31:50:21
+           SSID: 3rd Ward Morgan
+            MCS: 13
+        channel: 44,1

data/spec/fixtures/kernel.log.sample

@@ -0,0 +1,9 @@
+Feb 23 13:44:05 minnow kernel[0]: AirPort: Link Down on en0. Reason 8 (Disassociated because station leaving).
+Feb 23 13:44:32 minnow kernel[0]: AirPort: Link Up on en0
+Feb 23 13:44:32 minnow kernel[0]: AirPort: Link Up on en0
+Feb 23 13:44:32 minnow kernel[0]: AirPort: Link Up on en0
+Feb 23 13:44:05 minnow kernel[0]: AirPort: Link Down on en0. Reason 8 (Disassociated because station leaving).
+Feb 23 13:44:05 minnow kernel[0]: AirPort: Link Down on en0. Reason 8 (Disassociated because station leaving).
+Feb 23 13:44:32 minnow kernel[0]: AirPort: Link Up on en0
+Feb 23 13:44:05 minnow kernel[0]: AirPort: Link Down on en0. Reason 8 (Disassociated because station leaving).
+Feb 23 13:44:32 minnow kernel[0]: AirPort: Link Up on en0

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require_relative '../lib/airport_events' 
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: airport_events
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonathan Pettersson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: file-tail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Detect and log changes in WiFi network associations on MacOS. Utilizing
+  the official, but hidden 'airport' command.
+email: jonathan@spacetofu.com
+executables:
+- airport-log
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- airport_events.gemspec
+- bin/airport-log
+- lib/airport_events.rb
+- lib/airport_events/airport.rb
+- lib/airport_events/event_dispatcher.rb
+- lib/airport_events/kernel_log_parser.rb
+- lib/airport_events/logger.rb
+- lib/airport_events/version.rb
+- spec/fixtures/airport.sample.txt
+- spec/fixtures/kernel.log.sample
+- spec/spec_helper.rb
+homepage: https://github.com/jpettersson/airport_events
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: A MacOS specific library to receive WiFi related events
+test_files:
+- spec/fixtures/airport.sample.txt
+- spec/fixtures/kernel.log.sample
+- spec/spec_helper.rb