yourkarma 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efebe6dd64ed479530537b7eae43cfdfbee14d29
-  data.tar.gz: e65c0cd273366bfeed6310346d07586ca66008d0
+  metadata.gz: c4fd1140147e2153167f9d50d43bd133628d1e7f
+  data.tar.gz: bf4950dbd9c676d8a536aa14e595f455b78b6de1
 SHA512:
-  metadata.gz: e77919d76e388ff2b72a3cc3728f242ff0addffc3e532d3d8228a5e7e9a48c5ebc0fcfe1d113910c616eef0be35b0ef835dbe0aa6ef0121b7a6e82c0a3ae1e97
-  data.tar.gz: 65a8347b3033de673bac4ea35e9b3020820744a2ffd49637e14d57a174c1b7df11ff5208d346e6801b8d4751512074463e6d21b2f166911615a2d635dbeddfe6
+  metadata.gz: e8b2c5c5854c76d2e0edc77596bb58ef1f181cf21390ee9b69b3184df2bc5cb9927ee6e86c31a219e543409bf6b7f85cc3841bd991728374a0d5f6837318eb84
+  data.tar.gz: 3587886adcaaa2b23da14db1a396cc79a811c733447d71d09ca04ac52b602460a59e11a5aa7d447bbfeb2c1a7a4d215179dca1a2b6ca8755ecbe216834de1681

data/README.md

@@ -13,11 +13,7 @@ Determine connectivity, battery and connection speed for your device.
 
 ## 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
+See [GitHub issues](https://github.com/gsterndale/yourkarma/issues) for a list of desired features and bug fixes.
 
 ## Contributing
 

data/lib/yourkarma/benchmarker.rb

@@ -8,8 +8,9 @@ module YourKarma
     class ConnectionError < StandardError; end
 
     HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
-                   Errno::ETIMEDOUT, EOFError, Net::HTTPBadResponse,
-                   Net::HTTPHeaderSyntaxError, Net::ProtocolError, SocketError]
+                   Errno::ENETUNREACH, Errno::ETIMEDOUT, EOFError,
+                   Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+                   Net::ProtocolError, SocketError]
 
     DEFAULT_OPTIONS = {
       timeout:   10,
@@ -25,9 +26,10 @@ module YourKarma
     def benchmark
       uri = URI(options[:benchmark])
       Timeout::timeout(options[:timeout]) do
-        return Benchmark.realtime do
+        duration = Benchmark.realtime do
           Net::HTTP.get_response(uri)
         end
+        return duration / options[:timeout].to_f
       end
     rescue *HTTP_ERRORS => e
       raise ConnectionError

data/lib/yourkarma/cli.rb

@@ -21,15 +21,34 @@ module YourKarma
     end
 
     def run
-      reporter  = Reporter.new(options)
-      attrs     = Client.new(options).get
-      device    = Device.new(attrs)
-      benchmark = Benchmarker.new(options).benchmark
+      client      = Client.new(options)
+      benchmarker = Benchmarker.new(options)
+      reporter    = Reporter.new(options)
+      reporter.report_header
+      iterations = options[:iterations] || Float::INFINITY
+      code = 1
+      (1..iterations).each do
+        begin
+          code = run_once(client, benchmarker, reporter)
+        rescue Interrupt
+          break
+        end
+      end
+      reporter.report_quit(code)
+    end
+
+    private
+
+    def run_once(client, benchmarker, reporter)
+      begin
+        attrs     = client.get
+        reporter.report_progress
+        device    = Device.new(attrs)
+        benchmark = benchmarker.benchmark
+      rescue Client::ConnectionError, Benchmarker::ConnectionError
+        reporter.report_error
+      end
       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
@@ -42,34 +61,108 @@ module YourKarma
         self.options = DEFAULT_OPTIONS.merge(options)
       end
 
+      def report_header
+        write "| Connect | Speed | Battery | Charging | Bandwidth |\n"
+        write "+---------+-------+---------+----------+-----------+\n"
+      end
+
+      def report_progress
+        write '.' if reported?
+      end
+
+      def report_error
+        write '*' if reported?
+      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
+        write options[:tail] ? "\n" : "\r" if reported?
+        @reported = true
+        write [
+          '',
+          pad( 9,   connect(device, benchmark)),
+          pad( 7,     speed(device, benchmark)),
+          pad( 9,   battery(device, benchmark)),
+          pad(10,  charging(device, benchmark)),
+          pad(11, bandwidth(device, benchmark)),
+          " "
+        ].join "|"
+        status_code(device, benchmark)
       end
 
-      def report_connectivity_failure(message)
-        write "Not connected to a Karma hotspot."
-        write message if options[:verbose]
-        1
+      def report_quit(code)
+        write "\n"
+        code || 1
       end
 
-      def report_benchmark_failure_on(device)
-        if device.valid_ipaddress?
-          write "Connected to '#{device.ssid}' and online, but the tubes are slow!"
+      private
+
+      def reported?
+        !!@reported
+      end
+
+      def connect(device, benchmark)
+        return '' unless device
+        case
+        when benchmark
+          "-=≡"
+        when device.valid_ipaddress?
+          "-="
         else
-          write "Connected to '#{device.ssid}' and acquiring IP address."
+          "-"
         end
-        1
       end
 
-      private
+      def speed(device, benchmark)
+        unless benchmark
+          return device && device.valid_ipaddress? ? ":(" : ":X"
+        end
+        case benchmark * 100
+        when 0..20
+          "(⌐■_■)" # ":0"
+        when 20..40
+          ":)"
+        when 40..70
+          ":|"
+        else
+          "(ಠ_ಠ)" # ":["
+        end
+      end
+
+      def battery(device, benchmark)
+        return '[?????}' unless device && device.batterypower
+        percent = device.batterypower.to_f / 100.0
+        length = 5
+        tics = (length * percent).floor
+        "[#{ '#' * tics}#{ ' ' * (length - tics)}}"
+      end
+
+      def charging(device, benchmark)
+        return '?' unless device
+        device.charging ? "=D----" : "X"
+      end
+
+      def bandwidth(device, benchmark)
+        "1.3 GB"
+      end
+
+      def status_code(device, benchmark)
+        device && benchmark ? 0 : 3
+      end
+
+      def pad(size, meat)
+        meat ||= ''
+        space = size - meat.size
+        left  = (space.to_f / 2).ceil
+        right = (space.to_f / 2).floor
+        [
+          ' ' * left,
+          meat,
+          ' ' * right
+        ].join
+      end
 
       def write(string)
-        options[:io].puts string
+        options[:io].print string
       end
     end
 
@@ -78,7 +171,9 @@ module YourKarma
       end
 
       DEFAULT_OPTIONS = {
-        verbose: false
+        verbose: false,
+        poll:    true,
+        tail:    false
       }
 
       def parse(arguments)
@@ -99,6 +194,16 @@ module YourKarma
           opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
             options[:verbose] = true
           end
+          opts.on('-c', '--count=COUNT', 'Poll COUNT times', Integer) do |c|
+            options[:iterations] = c
+          end
+          opts.on('-p', '--[no-]poll', 'Continually poll') do |p|
+            options[:poll] = p
+            options[:iterations] = 1 unless p
+          end
+          opts.on('--[no-]tail', 'Tail log') do |t|
+            options[:tail] = t
+          end
           opts.on('-h', '--help', 'Display this screen') do
             raise InvalidOption, opts
           end
@@ -113,83 +218,3 @@ module YourKarma
     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

@@ -8,8 +8,9 @@ module YourKarma
     class BadResponseError < StandardError; end
 
     HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
-                   Errno::ETIMEDOUT, EOFError, Net::HTTPBadResponse,
-                   Net::HTTPHeaderSyntaxError, Net::ProtocolError, SocketError]
+                   Errno::ENETUNREACH, Errno::ETIMEDOUT, EOFError,
+                   Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+                   Net::ProtocolError, SocketError]
 
     DEFAULT_OPTIONS = {
       timeout: 10,
@@ -28,6 +29,7 @@ module YourKarma
       Timeout::timeout(options[:timeout]) do
         response = Net::HTTP.get_response(uri)
       end
+      raise ConnectionError unless response.code == '200'
       JSON::load(response.body).fetch("device")
     rescue *HTTP_ERRORS => e
       raise ConnectionError, e.message

data/lib/yourkarma/version.rb

@@ -1,3 +1,3 @@
 module YourKarma
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/cassettes/{CLI/status_code/connected_to_a_hotspot/.yml → charging.yml}

@@ -33,15 +33,15 @@ http_interactions:
       Transfer-Encoding:
       - chunked
       Date:
-      - Wed, 30 Apr 2014 22:02:23 GMT
+      - Wed, 30 Apr 2014 22:02:24 GMT
       Server:
       - lighttpd/1.4.30-devel-4855
     body:
       encoding: UTF-8
-      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M36S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":20,\"connectionduration\":\"P0Y0M0DT0H0M17S\"},\"wifiinterface\":{\"ssid\":\"Karma
+      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M37S\",\"batterypower\":30,\"charging\":true,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":21,\"connectionduration\":\"P0Y0M0DT0H0M18S\"},\"wifiinterface\":{\"ssid\":\"Karma
         Wi-Fi\",\"users\":1}}}\r\n"
-    http_version: 
-  recorded_at: Thu, 01 May 2014 12:49:45 GMT
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:46 GMT
 - request:
     method: get
     uri: http://yourkarma.com/dashboard
@@ -65,7 +65,7 @@ http_interactions:
       Content-Type:
       - text/html
       Date:
-      - Thu, 01 May 2014 12:49:45 GMT
+      - Thu, 01 May 2014 12:49:46 GMT
       Location:
       - https://yourkarma.com/dashboard
       Server:
@@ -81,6 +81,6 @@ http_interactions:
     body:
       encoding: UTF-8
       string: ''
-    http_version: 
-  recorded_at: Thu, 01 May 2014 12:49:46 GMT
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:47 GMT
 recorded_with: VCR 2.9.0

data/spec/cassettes/low_battery.yml

@@ -0,0 +1,86 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://hotspot.yourkarma.com/api/status.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - hotspot.yourkarma.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - "-1"
+      - "-1"
+      Content-Type:
+      - application/json; charset=utf-8
+      Access-Control-Allow-Origin:
+      - "*"
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 30 Apr 2014 22:02:24 GMT
+      Server:
+      - lighttpd/1.4.30-devel-4855
+    body:
+      encoding: UTF-8
+      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M37S\",\"batterypower\":30,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":21,\"connectionduration\":\"P0Y0M0DT0H0M18S\"},\"wifiinterface\":{\"ssid\":\"Karma
+        Wi-Fi\",\"users\":1}}}\r\n"
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:46 GMT
+- request:
+    method: get
+    uri: http://yourkarma.com/dashboard
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - yourkarma.com
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Content-Type:
+      - text/html
+      Date:
+      - Thu, 01 May 2014 12:49:46 GMT
+      Location:
+      - https://yourkarma.com/dashboard
+      Server:
+      - nginx
+      Status:
+      - 301 Moved Permanently
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:47 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/{CLI/output/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml → no_wan.yml}

@@ -42,4 +42,46 @@ http_interactions:
         Wi-Fi\",\"users\":1}}}\r\n"
     http_version: 
   recorded_at: Thu, 01 May 2014 12:46:25 GMT
+- request:
+    method: get
+    uri: http://hotspot.yourkarma.com/api/status.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - hotspot.yourkarma.com
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - text/html
+      Cache-Control:
+      - public
+      Pragma:
+      - cache
+      Expires:
+      - Sat, 28 Jun 2014 00:07:42 GMT
+      Date:
+      - Fri, 27 Jun 2014 23:37:42 GMT
+      Last-Modified:
+      - Fri, 27 Jun 2014 23:37:42 GMT
+      Accept-Ranges:
+      - bytes
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: "<html>\n<head>\n  <title>404 Not Found</title>\n</head>\n<body bgcolor=\"ffffff\">\n
+        \ <h2>404 Not Found<h2>\n  <p>\n  \n</body>\n</html>\n"
+    http_version: 
+  recorded_at: Fri, 27 Jun 2014 23:37:43 GMT
 recorded_with: VCR 2.9.0

data/spec/cassettes/{CLI/output/connected_to_a_hotspot/.yml → online.yml}

@@ -33,15 +33,15 @@ http_interactions:
       Transfer-Encoding:
       - chunked
       Date:
-      - Wed, 30 Apr 2014 22:02:23 GMT
+      - Wed, 30 Apr 2014 22:02:24 GMT
       Server:
       - lighttpd/1.4.30-devel-4855
     body:
       encoding: UTF-8
-      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M36S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":20,\"connectionduration\":\"P0Y0M0DT0H0M17S\"},\"wifiinterface\":{\"ssid\":\"Karma
+      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M37S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":21,\"connectionduration\":\"P0Y0M0DT0H0M18S\"},\"wifiinterface\":{\"ssid\":\"Karma
         Wi-Fi\",\"users\":1}}}\r\n"
-    http_version: 
-  recorded_at: Thu, 01 May 2014 12:49:45 GMT
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:46 GMT
 - request:
     method: get
     uri: http://yourkarma.com/dashboard
@@ -65,7 +65,7 @@ http_interactions:
       Content-Type:
       - text/html
       Date:
-      - Thu, 01 May 2014 12:49:45 GMT
+      - Thu, 01 May 2014 12:49:46 GMT
       Location:
       - https://yourkarma.com/dashboard
       Server:
@@ -81,6 +81,6 @@ http_interactions:
     body:
       encoding: UTF-8
       string: ''
-    http_version: 
-  recorded_at: Thu, 01 May 2014 12:49:46 GMT
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:47 GMT
 recorded_with: VCR 2.9.0

data/spec/cassettes/{CLI/status_code/connected_to_the_internet_with_a_slow_connection/.yml → online_timeout.yml}

@@ -33,13 +33,13 @@ http_interactions:
       Transfer-Encoding:
       - chunked
       Date:
-      - Wed, 30 Apr 2014 21:49:57 GMT
+      - Wed, 30 Apr 2014 22:02:24 GMT
       Server:
       - lighttpd/1.4.30-devel-4855
     body:
       encoding: UTF-8
       string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M37S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":21,\"connectionduration\":\"P0Y0M0DT0H0M18S\"},\"wifiinterface\":{\"ssid\":\"Karma
         Wi-Fi\",\"users\":1}}}\r\n"
-    http_version: 
-  recorded_at: Wed, 30 Apr 2014 21:49:58 GMT
+    http_version:
+  recorded_at: Thu, 01 May 2014 12:49:46 GMT
 recorded_with: VCR 2.9.0

data/spec/features/cli_spec.rb

@@ -3,75 +3,141 @@ require 'webmock/rspec'
 
 describe "CLI", :vcr do
   let(:io)   { StringIO.new }
-  let(:args) { ['--timeout', '10', '--verbose'] }
+  let(:timeout) { 0.01 }
+  let(:args) { ['--timeout', timeout.to_s, '--verbose', '--no-poll'] }
   let(:cli)  { YourKarma::CLI.run(io, args) }
 
   describe "output" do
-    subject do
+    # | Connect | Speed | Battery | Charging | Bandwidth |
+    # +---------+-------+---------+----------+-----------+
+    # |   -=≡   | ==>-- | [###  } |  =D----  |    1.3 GB |
+    let(:string) do
       cli
       io.string
     end
-
-    context "connected to a hotspot" do
-      it { should match /connected/i }
+    let(:header) do
+      string.split("\n")
+        .first
+        .split(/\s*\|\s*/)[1..-1]
+    end
+    let(:rows) do
+      string.split("\n")[2..-1].map do |row|
+        Hash[
+          row
+          .split(/\s*\|\s*/)[1..-1]
+          .each_with_index
+          .map{|cell, i| [header[i], cell.strip] }
+        ]
+      end
     end
+    subject { rows.first }
+
+    context "connected to a hotspot and the internet", vcr: {cassette_name: "online"} do
+      its(["Connect"]) { should eq "-=≡" }
+
+      context "with a slow connection" do
+        before do
+          Benchmark.stub(:realtime) { timeout }
+        end
+        its(["Speed"]) { should eq "(ಠ_ಠ)" }
+      end
+
+      context "with a fast connection" do
+        before do
+          Benchmark.stub(:realtime) { timeout / 100.0 }
+        end
+        its(["Speed"]) { should eq "(⌐■_■)" }
+      end
+
+      context "full battery power", vcr: {cassette_name: "full_battery"} do
+        its(["Battery"]) { should eq "[#####}" }
+      end
+
+      context "low battery power", vcr: {cassette_name: "low_battery"} do
+        its(["Battery"]) { should eq "[#    }" }
+      end
 
-    context "connected to the internet" do
-      it { should match "online" }
-      it { should_not match /slow/i }
+      context "charging", vcr: {cassette_name: "charging"} do
+        its(["Charging"])  { should eq "=D----" }
+      end
+
+      context "not charging", vcr: {cassette_name: "not_charging"} do
+        its(["Charging"])  { should eq "X" }
+      end
     end
 
-    context "connected to the internet with a slow connection" do
+    context "connected to a hotspot and the internet, but requests timeout", vcr: {cassette_name: "online_timeout"} do
       before do
         stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should match /slow/i }
+      its(["Connect"]) { should eq "-=" }
+      its(["Speed"])   { should eq ":(" }
     end
 
-    context "connected to a hotspot without an assigned WAN IP address" do
+    context "connected to a hotspot, but not to the internet", vcr: {cassette_name: "no_wan"} do
       before do
         stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should match /acquiring IP address/i }
-      it { should_not match "Fail" }
+
+      its(["Connect"])   { should eq "-" }
+      its(["Speed"])     { should eq ":X" }
     end
 
-    context "not connected to a hotspot" do
+    context "not connected to a hotspot", vcr: {cassette_name: "offline"} do
       before do
         stub_request(:any, /.*yourkarma.com.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should match /Not connected/i }
-      it { should match "Fail" }
+      its(["Connect"])   { should eq "" }
+      its(["Speed"])     { should eq ":X" }
+      its(["Battery"])   { should eq "[?????}" }
+      its(["Charging"])  { should eq "?" }
+    end
+
+    context "polling", vcr: { allow_playback_repeats: true, cassette_name: "online"} do
+      subject { rows }
+      let(:args) { ['--timeout', timeout.to_s, '--verbose', '--count', '2', '--no-tail'] }
+      it { should have(1).elements }
+
+      context "tailing" do
+        let(:args) { ['--timeout', timeout.to_s, '--verbose', '--count', '2', '--tail'] }
+        it { should have(2).elements }
+      end
     end
   end
 
   describe "status code" do
     subject { cli }
 
-    context "connected to the internet" do
+    context "connected to a hotspot and the internet", vcr: {cassette_name: "online"} do
       it { should be 0 }
+
+      context "with a slow connection" do
+        before do
+          Benchmark.stub(:realtime) { timeout }
+        end
+        it { should be 0 }
+      end
     end
 
-    context "connected to the internet with a slow connection" do
+    context "connected to a hotspot and the internet, but requests timeout", vcr: {cassette_name: "online_timeout"} do
       before do
         stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should be 1 }
+      it { should be 3 }
     end
 
-    context "connected to a hotspot without an assigned WAN IP address" do
+    context "connected to a hotspot, but not to the internet", vcr: {cassette_name: "no_wan"} do
       before do
         stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should be 1 }
+      it { should be 3 }
     end
 
-    context "not connected to a hotspot" do
+    context "not connected to a hotspot", vcr: {cassette_name: "offline"} do
       before do
         stub_request(:any, /.*yourkarma.com.*/).to_raise(Timeout::Error.new "Fail")
       end
-      it { should be 1 }
+      it { should be 3 }
     end
   end
 end
-

data/spec/support/vcr.rb

@@ -5,7 +5,8 @@ VCR.configure do |c|
   c.cassette_library_dir = 'spec/cassettes'
 
   c.default_cassette_options = {
-    record: :new_episodes
+    record: :none,
+    allow_playback_repeats: true
   }
 
   c.configure_rspec_metadata!

data/spec/units/benchmarker_spec.rb

@@ -23,8 +23,8 @@ describe YourKarma::Benchmarker do
     end
 
     it "returns execution time" do
-      Benchmark.stub(:realtime) { 123.45 }
-      subject.should eq 123.45
+      Benchmark.stub(:realtime) { 1.2345 }
+      subject.should eq 1.2345 / 10.0
     end
 
     context "timing out" do

data/spec/units/cli_reporter_spec.rb

@@ -14,48 +14,84 @@ end
 
 describe "CLI::Reporter", "#report_on" do
   let(:io)        { StringIO.new }
-  let(:device)    { YourKarma::Device.new ssid: "My Karma" }
-  let(:benchmark) { 123.45 }
+  let(:device)    { YourKarma::Device.new batterypower: 30 }
+  let(:benchmark) { 0.123 }
   let(:reporter)  { YourKarma::CLI::Reporter.new({ io: io, verbose: true }) }
-  let!(:status)   { reporter.report_on(device, benchmark) }
-  subject { status }
+  let(:status)    { reporter.report_on(device, benchmark) }
+  before do
+    status
+  end
 
-  it { should be 0 }
+  describe "status" do
+    subject { status }
+    it { should be 0 }
+
+    context "without benchmark" do
+      let(:benchmark) { nil }
+      it { should be 3 }
+    end
+  end
 
   describe "io" do
     subject { io.string }
-    it { should match "My Karma" }
-    it { should match /123.5/ }
+    it { should include "-=≡" }
+    it { should include "(⌐■_■)" }
+    it { should include "[#    }" }
+    it { should include "X" }
   end
 end
 
-describe "CLI::Reporter", "#report_connectivity_failure" do
+describe "CLI::Reporter", "#report_progress" do
   let(:io)        { StringIO.new }
   let(:reporter)  { YourKarma::CLI::Reporter.new({ io: io }) }
-  let(:message)   { "Whoops" }
-  let!(:status)   { reporter.report_connectivity_failure(message) }
-  subject { status }
+  subject { io.string }
 
-  it { should be 1 }
+  before do
+    reporter.report_progress
+  end
 
-  describe "io" do
-    subject { io.string }
-    it { should match "Not connected" }
+  it { should_not include "." }
+
+  context "after reporting on" do
+    before do
+      reporter.report_on(nil, nil)
+      reporter.report_progress
+    end
+    it { should include "." }
+  end
+end
+
+describe "CLI::Reporter", "#report_error" do
+  let(:io)        { StringIO.new }
+  let(:reporter)  { YourKarma::CLI::Reporter.new({ io: io }) }
+  subject { io.string }
+
+  before do
+    reporter.report_error
+  end
+
+  it { should_not include "*" }
+
+  context "after reporting on" do
+    before do
+      reporter.report_on(nil, nil)
+      reporter.report_error
+    end
+    it { should include "*" }
   end
 end
 
-describe "CLI::Reporter", "#report_benchmark_failure_on" do
+describe "CLI::Reporter", "#report_quit" do
   let(:io)        { StringIO.new }
-  let(:device)    { YourKarma::Device.new ssid: "My Karma", ipaddress: "192.168.1.1" }
   let(:reporter)  { YourKarma::CLI::Reporter.new({ io: io }) }
-  let!(:status)   { reporter.report_benchmark_failure_on(device) }
+  let(:code)      { 123 }
+  let(:status)    { reporter.report_quit code }
   subject { status }
 
-  it { should be 1 }
+  it { should eq code }
 
-  describe "io" do
-    subject { io.string }
-    it { should match "My Karma" }
-    it { should match "slow" }
+  context "nil code" do
+    let(:code) { nil }
+    it { should eq 1 }
   end
 end

data/spec/units/cli_spec.rb

@@ -23,19 +23,27 @@ end
 
 describe "CLI", "#run" do
   it "should fetch status from device, benchmark speed and report" do
+    iterations  = 3
     client      = double(:client, get: {})
     device      = double(:device)
     benchmark   = double(:benchmark)
     benchmarker = double(:benchmarker, benchmark: benchmark)
     exit_code   = double(:exit_code)
-    reporter    = double(:reporter, report_on: exit_code)
+    reporter    = double(:reporter,
+                         report_header:   nil,
+                         report_progress: nil,
+                         report_on:       exit_code,
+                         report_quit:     exit_code)
     YourKarma::Client.stub(:new)        { client }
     YourKarma::Device.stub(:new)        { device }
     YourKarma::Benchmarker.stub(:new)   { benchmarker }
     YourKarma::CLI::Reporter.stub(:new) { reporter }
-    cli = YourKarma::CLI.new
+    cli = YourKarma::CLI.new iterations: iterations
     response = cli.run
-    expect(reporter).to have_received(:report_on).with(device, benchmark)
+    expect(reporter).to have_received(:report_header).once
+    expect(reporter).to have_received(:report_progress).exactly(iterations).times
+    expect(reporter).to have_received(:report_on).with(device, benchmark).exactly(iterations).times
+    expect(reporter).to have_received(:report_quit).with(exit_code).once
     expect(response).to eq(exit_code)
   end
 end

data/spec/units/client_spec.rb

@@ -3,14 +3,16 @@ require 'spec_helper'
 describe YourKarma::Client do
   describe "#options" do
     let(:client)  { YourKarma::Client.new }
-    subject       { client.options } 
+    subject       { client.options }
     its([:url])  { should match "yourkarma.com" }
   end
 
   describe "#get" do
-    let(:client)    { YourKarma::Client.new(url: "example.com") }
-    let(:response)  { double :response, body: '{"device": {"foo": "bar"}}' }
-    subject         { client.get }
+    let(:client)      { YourKarma::Client.new(url: "example.com") }
+    let(:status_code) { '200' }
+    let(:body)        { '{"device": {"foo": "bar"}}' }
+    let(:response)    { double :response, body: body, code: status_code }
+    subject           { client.get }
     before do
       Net::HTTP.stub(:get_response) { response }
     end
@@ -33,6 +35,13 @@ describe YourKarma::Client do
       end
     end
 
+    context "with an unsuccessfull HTTP status code" do
+      let(:status_code) { '500' }
+      it "raises ConnectionError" do
+        expect(-> { subject }).to raise_error YourKarma::Client::ConnectionError
+      end
+    end
+
     context "with an HTTP error" do
       before do
         Net::HTTP.stub(:get_response) { raise SocketError }
@@ -44,8 +53,7 @@ describe YourKarma::Client do
     end
 
     context "with bad JSON" do
-      let(:response)  { double :response, body: '{ WRONG }' }
-
+      let(:body) { '{ WRONG }' }
       it "raises BadResponseError" do
         expect(-> { subject }).to raise_error YourKarma::Client::BadResponseError
       end

data/yourkarma.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec",    "~> 2.1"
   spec.add_development_dependency "webmock",  "~> 1.15"
-  spec.add_development_dependency "vcr",      "~> 2.6"
+  spec.add_development_dependency "vcr",      "~> 2.9"
 
   # Release every merge to master as a prerelease
   spec.version = "#{spec.version}.pre#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yourkarma
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Greg Sterndale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.9'
 description: Determine connectivity, battery and connection speed for your device.
 email:
 - gsterndale@gmail.com
@@ -102,14 +102,13 @@ files:
 - lib/yourkarma/device.rb
 - lib/yourkarma/version.rb
 - spec/cassettes/.keep
-- spec/cassettes/CLI/output/connected_to_a_hotspot/.yml
-- spec/cassettes/CLI/output/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml
-- spec/cassettes/CLI/output/connected_to_the_internet/.yml
-- spec/cassettes/CLI/output/connected_to_the_internet_with_a_slow_connection/.yml
-- spec/cassettes/CLI/status_code/connected_to_a_hotspot/.yml
-- spec/cassettes/CLI/status_code/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml
-- spec/cassettes/CLI/status_code/connected_to_the_internet/.yml
-- spec/cassettes/CLI/status_code/connected_to_the_internet_with_a_slow_connection/.yml
+- spec/cassettes/charging.yml
+- spec/cassettes/full_battery.yml
+- spec/cassettes/low_battery.yml
+- spec/cassettes/no_wan.yml
+- spec/cassettes/not_charging.yml
+- spec/cassettes/online.yml
+- spec/cassettes/online_timeout.yml
 - spec/features/cli_spec.rb
 - spec/spec_helper.rb
 - spec/support/have_line_matching_matcher.rb
@@ -147,14 +146,13 @@ specification_version: 4
 summary: Karma hotspot status client & CLI
 test_files:
 - spec/cassettes/.keep
-- spec/cassettes/CLI/output/connected_to_a_hotspot/.yml
-- spec/cassettes/CLI/output/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml
-- spec/cassettes/CLI/output/connected_to_the_internet/.yml
-- spec/cassettes/CLI/output/connected_to_the_internet_with_a_slow_connection/.yml
-- spec/cassettes/CLI/status_code/connected_to_a_hotspot/.yml
-- spec/cassettes/CLI/status_code/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml
-- spec/cassettes/CLI/status_code/connected_to_the_internet/.yml
-- spec/cassettes/CLI/status_code/connected_to_the_internet_with_a_slow_connection/.yml
+- spec/cassettes/charging.yml
+- spec/cassettes/full_battery.yml
+- spec/cassettes/low_battery.yml
+- spec/cassettes/no_wan.yml
+- spec/cassettes/not_charging.yml
+- spec/cassettes/online.yml
+- spec/cassettes/online_timeout.yml
 - spec/features/cli_spec.rb
 - spec/spec_helper.rb
 - spec/support/have_line_matching_matcher.rb
@@ -165,3 +163,4 @@ test_files:
 - spec/units/cli_spec.rb
 - spec/units/client_spec.rb
 - spec/units/device_spec.rb
+has_rdoc: 

data/spec/cassettes/CLI/output/connected_to_the_internet_with_a_slow_connection/.yml

@@ -1,45 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: http://hotspot.yourkarma.com/api/status.json
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-      Host:
-      - hotspot.yourkarma.com
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - no-cache
-      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
-      Expires:
-      - "-1"
-      - "-1"
-      Content-Type:
-      - application/json; charset=utf-8
-      Access-Control-Allow-Origin:
-      - "*"
-      Transfer-Encoding:
-      - chunked
-      Date:
-      - Wed, 30 Apr 2014 21:49:57 GMT
-      Server:
-      - lighttpd/1.4.30-devel-4855
-    body:
-      encoding: UTF-8
-      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H4M37S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"74.60.178.162\",\"bsid\":\"00:00:02:07:44:E9\",\"rssi\":-75,\"cinr\":21,\"connectionduration\":\"P0Y0M0DT0H0M18S\"},\"wifiinterface\":{\"ssid\":\"Karma
-        Wi-Fi\",\"users\":1}}}\r\n"
-    http_version: 
-  recorded_at: Wed, 30 Apr 2014 21:49:58 GMT
-recorded_with: VCR 2.9.0

data/spec/cassettes/CLI/status_code/connected_to_a_hotspot_without_an_assigned_WAN_IP_address/.yml

@@ -1,45 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: http://hotspot.yourkarma.com/api/status.json
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-      Host:
-      - hotspot.yourkarma.com
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - no-cache
-      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
-      Expires:
-      - "-1"
-      - "-1"
-      Content-Type:
-      - application/json; charset=utf-8
-      Access-Control-Allow-Origin:
-      - "*"
-      Transfer-Encoding:
-      - chunked
-      Date:
-      - Wed, 30 Apr 2014 21:59:03 GMT
-      Server:
-      - lighttpd/1.4.30-devel-4855
-    body:
-      encoding: UTF-8
-      string: "{\"device\":{\"name\":\"IMW-C918W\",\"swversion\":\"R4855\",\"hwversion\":\"R06\",\"uptime\":\"P0Y0M0DT0H25M15S\",\"batterypower\":100,\"charging\":false,\"waninterface\":{\"macaddress\":\"001E312C42D0\",\"ipaddress\":\"N/A\",\"bsid\":\"N/A\",\"rssi\":\"N/A\",\"cinr\":\"N/A\",\"connectionduration\":\"P0Y0M0DT0H0M0S\"},\"wifiinterface\":{\"ssid\":\"Karma
-        Wi-Fi\",\"users\":1}}}\r\n"
-    http_version: 
-  recorded_at: Thu, 01 May 2014 12:46:25 GMT
-recorded_with: VCR 2.9.0