yourkarma 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a01341231ba782a9acafe01f78d90cdc20c2a4d
+  data.tar.gz: 1edbb26ae1729447750964fb557ae781ba2718d6
+SHA512:
+  metadata.gz: 58a1e7efb614a6b5b617e1982b2dba09c3dbaf0988b1cb690272de2119a5274bae2fb45ec3d4c682ef67a462330cb96e14db1fa85e009bcf49facd27a976475d
+  data.tar.gz: c9ca35b5db6487a8c4516a8622bdd13d0de695f09d01707fca6ed7c27f8c8cdd8443b2fda0cc19e9ed8f8961b97814691bc0a277dd895b56bd0f3b2814969c9f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Greg Sterndale
+
+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,28 @@
+# yourkarma
+## Karma hotspot status client & CLI
+
+Determine connectivity, battery and connection speed for your device.
+
+## Installation
+
+    $ gem install yourkarma
+
+## Usage
+
+    $ yourkarma
+
+## TODO
+
+  - Bar charts for connection speed and battery
+  - Option to poll until connected
+  - Display available data from yourkarma.com/dashboard
+  - Display updates/news from yourkarma.com/dashboard
+  - Display connected user count
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yourkarma/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/yourkarma

@@ -0,0 +1,8 @@
+#! /usr/bin/ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'yourkarma'
+
+exit YourKarma::CLI.run(STDOUT, ARGV)

data/lib/yourkarma.rb

@@ -0,0 +1,5 @@
+require "yourkarma/version"
+require "yourkarma/cli"
+
+module YourKarma
+end

data/lib/yourkarma/benchmarker.rb

@@ -0,0 +1,36 @@
+require 'uri'
+require 'timeout'
+require 'net/http'
+require 'benchmark'
+
+module YourKarma
+  class Benchmarker
+    class ConnectionError < StandardError; end
+
+    HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+                   Errno::ETIMEDOUT, EOFError, Net::HTTPBadResponse,
+                   Net::HTTPHeaderSyntaxError, Net::ProtocolError, SocketError]
+
+    DEFAULT_OPTIONS = {
+      timeout:   10,
+      benchmark: 'http://yourkarma.com/dashboard'
+    }
+
+    attr_accessor :options
+
+    def initialize(options = {})
+      self.options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def benchmark
+      uri = URI(options[:benchmark])
+      Timeout::timeout(options[:timeout]) do
+        return Benchmark.realtime do
+          Net::HTTP.get_response(uri)
+        end
+      end
+    rescue *HTTP_ERRORS => e
+      raise ConnectionError
+    end
+  end
+end

data/lib/yourkarma/cli.rb

@@ -0,0 +1,195 @@
+require 'optparse'
+require_relative 'client'
+require_relative 'device'
+require_relative 'benchmarker'
+
+module YourKarma
+  class CLI
+    attr_accessor :options
+
+    def self.run(io, arguments)
+      options = { io: io }
+      options.merge! ArgumentParser.new.parse(arguments)
+      self.new(options).run
+    rescue ArgumentParser::InvalidOption => e
+      options[:io].puts e
+      1
+    end
+
+    def initialize(options = {})
+      self.options = options
+    end
+
+    def run
+      reporter  = Reporter.new(options)
+      attrs     = Client.new(options).get
+      device    = Device.new(attrs)
+      benchmark = Benchmarker.new(options).benchmark
+      reporter.report_on(device, benchmark)
+    rescue Client::ConnectionError => e
+      reporter.report_connectivity_failure e.message
+    rescue Benchmarker::ConnectionError 
+      reporter.report_benchmark_failure_on(device)
+    end
+
+    class Reporter
+      DEFAULT_OPTIONS = {
+        io: STDOUT
+      }
+      attr_accessor :options
+
+      def initialize(options = {})
+        self.options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def report_on(device, benchmark)
+        write "Connected to '#{device.ssid}' and online!"
+        if options[:verbose]
+          ceil = (benchmark * 10).ceil / 10.0
+          write "Benchmark took less than #{ceil} seconds."
+        end
+        0
+      end
+
+      def report_connectivity_failure(message)
+        write "Not connected to a Karma hotspot."
+        write message if options[:verbose]
+        1
+      end
+
+      def report_benchmark_failure_on(device)
+        if device.valid_ipaddress?
+          write "Connected to '#{device.ssid}' and online, but the tubes are slow!"
+        else
+          write "Connected to '#{device.ssid}' and acquiring IP address."
+        end
+        1
+      end
+
+      private
+
+      def write(string)
+        options[:io].puts string
+      end
+    end
+
+    class ArgumentParser
+      class InvalidOption < StandardError
+      end
+
+      DEFAULT_OPTIONS = {
+        verbose: false
+      }
+
+      def parse(arguments)
+        options = DEFAULT_OPTIONS.dup
+        optparse = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^\s{4}/, '')
+            Karma hotspot status
+            Usage: yourkarma [options]
+            Example: yourkarma --verbose
+          BANNER
+
+          opts.on('-u', '--url=URL', "Karma hotspot URL") do |url|
+            options[:url] = url
+          end
+          opts.on('-t', '--timeout=TIMEOUT', "Time to wait for HTTP response", Float) do |timeout|
+            options[:timeout] = timeout
+          end
+          opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+            options[:verbose] = true
+          end
+          opts.on('-h', '--help', 'Display this screen') do
+            raise InvalidOption, opts
+          end
+        end
+
+        optparse.parse!(arguments)
+
+        options
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        raise InvalidOption, optparse
+      end
+    end
+  end
+end
+
+# require 'json'
+# require 'uri'
+# require 'net/http'
+# require 'timeout'
+# require 'benchmark'
+# require 'pp'
+# 
+# uri = URI('http://hotspot.yourkarma.com/api/status.json')
+# 
+# VERBOSE      = true
+# VERY_VERBOSE = false
+# TIMEOUT      = 10
+# 
+# def failure(message, exception, context = nil)
+#   if VERBOSE
+#     puts exception.class if VERY_VERBOSE
+#     puts exception
+#     puts context if context && VERY_VERBOSE
+#   end
+#   puts message
+#   exit 1
+# end
+# 
+# HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+#   Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+#   SocketError]
+# 
+# begin
+#   response = nil
+#   Timeout::timeout(TIMEOUT) do
+#     response = Net::HTTP.get_response(uri)
+#   end
+#   parsed = JSON::load(response.body)
+# rescue Timeout::Error => e
+#   failure "Request to Karma hotspot timed out.", e
+# rescue *HTTP_ERRORS => e
+#   failure "Not connected to a Karma hotspot.", e
+# rescue JSON::ParserError
+#   failure "Unexpected response from #{uri}.", e, parsed
+# end
+# 
+# begin
+#   message = "Network not connected."
+# 
+#   device = parsed.fetch "device"
+#   wifi   = device.fetch "wifiinterface"
+#   ssid   = wifi.fetch "ssid"
+# 
+#   message = "Unable to determine battery status."
+# 
+#   charging  = device.fetch "charging"
+#   battery   = device.fetch "batterypower"
+#   print "Battery #{battery}%. "
+#   puts charging ? "Charging." : "Not charging."
+# 
+#   message = "Connected to '#{ssid}', but WAN IP address is not assigned."
+# 
+#   wan        = device.fetch "waninterface"
+#   ip_address = wan.fetch "ipaddress"
+# rescue KeyError => e
+#   failure message, e, parsed
+# end
+# 
+# begin
+#   benchmark = nil
+#   Timeout::timeout(TIMEOUT) do
+#     benchmark = Benchmark.realtime do
+#       Net::HTTP.get_response(URI('https://www.google.com'))
+#     end
+#   end
+#   benchmark = (benchmark * 10).ceil / 10.0
+# rescue TimeoutError => e
+#   failure "Connected to '#{ssid}' and online, but the tubes are slow!", e, parsed
+# rescue *HTTP_ERRORS => e
+#   failure "Connected to '#{ssid}' and WAN IP address has be assigned, but request to Google failed.", e, parsed
+# end
+# 
+# puts "Connected to '#{ssid}' and online!"
+# puts "Request to Google took less than #{benchmark} seconds." if VERBOSE

data/lib/yourkarma/client.rb

@@ -0,0 +1,61 @@
+require 'uri'
+require 'timeout'
+require 'net/http'
+
+module YourKarma
+  class Client
+    class ConnectionError < StandardError; end
+    class BadResponseError < StandardError; end
+
+    HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+                   Errno::ETIMEDOUT, EOFError, Net::HTTPBadResponse,
+                   Net::HTTPHeaderSyntaxError, Net::ProtocolError, SocketError]
+
+    DEFAULT_OPTIONS = {
+      timeout: 10,
+      url: "http://hotspot.yourkarma.com/api/status.json",
+    }
+
+    attr_accessor :options
+
+    def initialize(options = DEFAULT_OPTIONS)
+      self.options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def get
+      uri      = URI(options[:url])
+      response = nil
+      Timeout::timeout(options[:timeout]) do
+        response = Net::HTTP.get_response(uri)
+      end
+      JSON::load(response.body).fetch("device")
+    rescue *HTTP_ERRORS => e
+      raise ConnectionError, e.message
+    rescue JSON::ParserError => e
+      raise BadResponseError, e.message
+    end
+  end
+end
+
+# {
+#   "device"=>{
+#     "name"=>"IMW-C918W",
+#     "swversion"=>"R4855",
+#     "hwversion"=>"R06",
+#     "uptime"=>"P0Y0M0DT0H14M41S",
+#     "batterypower"=>100,
+#     "charging"=>false,
+#     "waninterface"=>{
+#       "macaddress"=>"001E312C42D0",
+#       "ipaddress"=>"74.60.178.162",
+#       "bsid"=>"00:00:02:06:04:30",
+#       "rssi"=>-59,
+#       "cinr"=>20,
+#       "connectionduration"=>"P0Y0M0DT0H9M54S"
+#     },
+#     "wifiinterface"=>{
+#       "ssid"=>"Karma Wi-Fi",
+#       "users"=>2
+#     }
+#   }
+# }

data/lib/yourkarma/device.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module YourKarma
+  class Device
+    IPADDRESS_PATTERN = /^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}$/
+
+    attr_accessor *%i(name swversion hwversion uptime batterypower charging
+                     macaddress ipaddress bsid rssi cinr connectionduration
+                     ssid users)
+
+    def initialize(attrs = {})
+      self.attributes = attrs
+    end
+
+    def waninterface=(attrs)
+      self.attributes = attrs
+    end
+
+    def wifiinterface=(attrs)
+      self.attributes = attrs
+    end
+
+    def valid_ipaddress?
+      self.ipaddress && self.ipaddress.match(IPADDRESS_PATTERN)
+    end
+
+    private
+
+    def attributes=(attrs)
+      attrs.each_pair do |name, value|
+        self.public_send("#{name}=", value)
+      end
+    end
+  end
+end