biscuit-monitor 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.log
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.bin
+/vendor/bundle

data/.noexec.yml

@@ -0,0 +1 @@
+exclude: [mux, tmuxinator]

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194-perf@biscuit-monitor"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.7 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in biscuit-monitor.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael D. Hall
+
+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,57 @@
+# Biscuit::Monitor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'biscuit-monitor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install biscuit-monitor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Notes
+
+- cinr
+
+  Carrier to Interference-plus-Noise Ratio (CINR)
+
+- rssi
+
+  Received signal strength indication
+
+## Reference
+
+http://www.clear.com/support/faq/connection-issues/connectionsignal/how-do-i-find-my-cinr-score-from-my-clear-spot-device
+
+From the CLEAR Spot 4G+ Personal Hotspot website
+
+CINR
+
+CINR stands for Carrier to Interference-plus-Noise Ratio (CINR), expressed in decibels (dBs). CINR is a measurement of signal effectiveness. We use the CINR score to tell us the signal quality received by the modem.
+
+The higher the number the better signal quality you are receiving. You need at minimum a CINR of 8 or greater to receive consistent service. A CINR score of 18 or higher is considered excellent signal quality.
+
+RSSI
+
+RSSI stands for Received signal strength indicator RSSI is a measurement of the power present in a received radio signal. We use RSSI score to tell us the strength of signal your CLEAR Spot is receiving.
+
+A RSSI score of -100dBm reflects poor signal strength, a score of -50dBm is an excellent RSSI score and reflects a strong signal.

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+# encoding: utf-8
+
+require "bundler/gem_tasks"

data/bin/biscuit-monitor

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby -w
+# encoding: utf-8
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'biscuit-monitor'
+
+Biscuit::Monitor::CLI.start

data/bin/biscuit-monitor-gui.rb

@@ -0,0 +1,11 @@
+#!/Applications/Shoes.app/Contents/MacOS/shoes
+Shoes.app :title => "Biscuit Monitor", :width => 400, :height => 300 do
+  para "What's your login name?"
+  @name = edit_line
+  para "What's your password?"
+  @password = edit_line(:secret => true)
+  para "What's the device's IP address?"
+  @device_ip = edit_line(:default => "192.168.1.1")
+
+  button("click me") { alert "#{@username} #{@device_ip}" }
+end

data/biscuit-monitor.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/biscuit-monitor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael D. Hall"]
+  gem.email         = ["mdh@just3ws.com"]
+  gem.description   = %q{Monitors your Clear Hotspot biscuit.}
+  gem.summary       = %q{Console app that will poll your attached Clear Hotspot biscuit.}
+  gem.homepage      = "https://github.com/just3ws/biscuit-monitor"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "biscuit-monitor"
+  gem.require_paths = ["lib"]
+  gem.version       = Biscuit::Monitor::VERSION
+
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'multi_json'
+  gem.add_runtime_dependency 'oj'
+  gem.add_runtime_dependency 'colorize'
+end

data/lib/biscuit-monitor/version.rb

@@ -0,0 +1,5 @@
+module Biscuit
+  module Monitor
+    VERSION = "0.0.1"
+  end
+end

data/lib/biscuit-monitor.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+
+require 'biscuit-monitor/version'
+require 'colorize'
+require 'logger'
+require 'multi_json'
+require 'net/http'
+require 'thor'
+require 'uri'
+
+module Biscuit
+  module Monitor
+    trap("SIGINT") { throw :ctrl_c }
+
+    class Monitor
+      def initialize(device_ip)
+        @logger = Logger.new('biscuit-monitor.log', 10, 1024000)
+        @device_ip = device_ip
+        @seconds = 3
+      end
+
+      def device_uri
+        URI.parse("http://#{@device_ip}/cgi-bin/webmain.cgi?act=act_wimax_status&param=WIMAX_LINK_STATUS,WIMAX_DEVICE_STATUS")
+        # TODO get the battery status
+        # URI.parse("http://#{@device_ip}/cgi-bin/webmain.cgi?act_battery_status&TYPE=BISCUIT&param=BATTERY_STATUS")
+      end
+
+      def clear_last_message
+        (@last_message || "").length.times { print "\b" }
+      end
+
+      def cinr_foreground_color(cinr)
+        case
+        when cinr > 24
+          :green
+        when (13..24).include?(cinr)
+          :light_green
+        when (8..12).include?(cinr)
+          :yellow
+        when (3..7).include?(cinr)
+          :light_red
+        when cinr < 3
+          :red
+        end
+      end
+
+      def rssi_foreground_color (rssi)
+        case
+        when rssi > -50
+          :green
+        when rssi < -100
+          :red
+        else
+          :yellow
+        end
+      end
+
+      def poll
+        catch :ctrl_c do
+          begin
+            response = parse(scrub_response(Net::HTTP.get(device_uri)))
+
+            cinr = Integer(response[:data][:cinr])
+            rssi = Integer(response[:data][:rssi])
+
+            message = "CINR: #{cinr}dBs".colorize(cinr_foreground_color(cinr))
+            message << " ".uncolorize
+            message << "RSSI: #{rssi}dBs".colorize(rssi_foreground_color(rssi))
+
+            write message
+            @logger.debug(response)
+
+          rescue Errno::EHOSTUNREACH => err
+
+            write "Cannot find the biscuit. Check your connection."
+            @logger.error(err.inspect)
+
+          rescue StandardError => err
+
+            write "There was an error checking your biscuit. See the logfile for details."
+            @logger.error(err.inspect)
+
+          ensure
+
+            sleep @seconds  # TODO when error increase length of time until next check to avoid spamming error log
+          end until false
+
+        end
+      end
+
+      def write(message)
+        clear_last_message
+        print message
+        @last_message = message
+      end
+
+
+
+      def parse(document)
+        data = {}
+        hash = MultiJson.decode(document, symbolize_keys: true)
+        hash.delete(:list)
+        hash.each do |k,v|
+          data[k] = if v.class == String && /^-?\d+$/ =~ v
+                      Integer(v)
+                    elsif v.class == Hash
+                      idata = {}
+                      v.each do |ik, iv|
+                        idata[ik] = if iv.class == String && /^-?\d+$/ =~ iv
+                                      Integer(iv)
+                                    else
+                                      iv
+                                    end
+                      end
+                      idata
+                    else
+                      v
+                    end
+        end
+        data
+      end
+
+
+      def scrub_response(document)
+        document = document.split.join
+        document.gsub!(/'/, '"')
+        document.gsub!(/:(\d*),/, ':"\1",')
+        document.gsub!(/(\w*):"/, '"\1":"')
+        document.gsub!(/(\w*):{/, '"\1": {')
+        document.gsub!(/(\w*):\[/, '"\1": [')
+        document.gsub!(/":"/, '": "')
+        document.gsub!(/,/, ', ')
+      end
+
+    end
+
+    class CLI < Thor
+      default_task :start
+
+      desc "start", "Start monitoring your biscuit."
+      method_option :device_ip, :default => "192.168.1.1", :aliases => "-d"
+      def start
+        Biscuit::Monitor::Monitor.new(options[:device_ip]).poll
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: biscuit-monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael D. Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Monitors your Clear Hotspot biscuit.
+email:
+- mdh@just3ws.com
+executables:
+- biscuit-monitor
+- biscuit-monitor-gui.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .noexec.yml
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/biscuit-monitor
+- bin/biscuit-monitor-gui.rb
+- biscuit-monitor.gemspec
+- lib/biscuit-monitor.rb
+- lib/biscuit-monitor/version.rb
+homepage: https://github.com/just3ws/biscuit-monitor
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Console app that will poll your attached Clear Hotspot biscuit.
+test_files: []