yourkarma 0.0.1

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

@@ -0,0 +1,45 @@
+---
+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/features/cli_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+describe "CLI", :vcr do
+  let(:io)   { StringIO.new }
+  let(:args) { ['--timeout', '10', '--verbose'] }
+  let(:cli)  { YourKarma::CLI.run(io, args) }
+
+  describe "output" do
+    subject do
+      cli
+      io.string
+    end
+
+    context "connected to a hotspot" do
+      it { should match /connected/i }
+    end
+
+    context "connected to the internet" do
+      it { should match "online" }
+      it { should_not match /slow/i }
+    end
+
+    context "connected to the internet with a slow connection" do
+      before do
+        stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
+      end
+      it { should match /slow/i }
+    end
+
+    context "connected to a hotspot without an assigned WAN IP address" 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" }
+    end
+
+    context "not connected to a hotspot" 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" }
+    end
+  end
+
+  describe "status code" do
+    subject { cli }
+
+    context "connected to the internet" do
+      it { should be 0 }
+    end
+
+    context "connected to the internet with a slow connection" do
+      before do
+        stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
+      end
+      it { should be 1 }
+    end
+
+    context "connected to a hotspot without an assigned WAN IP address" do
+      before do
+        stub_request(:any, /.*yourkarma.com\/dashboard.*/).to_raise(Timeout::Error.new "Fail")
+      end
+      it { should be 1 }
+    end
+
+    context "not connected to a hotspot" do
+      before do
+        stub_request(:any, /.*yourkarma.com.*/).to_raise(Timeout::Error.new "Fail")
+      end
+      it { should be 1 }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "../lib/yourkarma.rb")
+
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), "support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/have_line_matching_matcher.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_line_matching do |expected|
+  match do |actual|
+    actual.readlines.any? {|line| Regexp.new(expected) =~ line }
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,12 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.hook_into :webmock
+  c.cassette_library_dir = 'spec/cassettes'
+
+  c.default_cassette_options = {
+    record: :new_episodes
+  }
+
+  c.configure_rspec_metadata!
+end

data/spec/units/benchmarker_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe YourKarma::Benchmarker do
+
+  describe "#options" do
+    subject { YourKarma::Benchmarker.new.options }
+    its([:timeout])   { should eq 10 }
+    its([:benchmark]) { should match "yourkarma.com" }
+  end
+
+  describe "#benchmark" do
+    let(:benchmarker) { YourKarma::Benchmarker.new(benchmark: "example.com") }
+    let(:response)    { double :response }
+    subject           { benchmarker.benchmark }
+    before do
+      Net::HTTP.stub(:get_response) { response }
+    end
+
+    it "makes request to url" do
+      subject
+      uri = URI('example.com')
+      expect(Net::HTTP).to have_received(:get_response).with(uri)
+    end
+
+    it "returns execution time" do
+      Benchmark.stub(:realtime) { 123.45 }
+      subject.should eq 123.45
+    end
+
+    context "timing out" do
+      before do
+        Timeout.stub(:timeout) { raise Timeout::Error }
+      end
+
+      it "raises ConnectionError" do
+        expect(-> { subject }).to raise_error YourKarma::Benchmarker::ConnectionError
+      end
+    end
+
+    context "with an HTTP error" do
+      before do
+        Net::HTTP.stub(:get_response) { raise SocketError }
+      end
+
+      it "raises ConnectionError" do
+        expect(-> { subject }).to raise_error YourKarma::Benchmarker::ConnectionError
+      end
+    end
+  end
+end

data/spec/units/cli_argument_parser_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe "YourKarma::CLI::ArgumentParser" do
+  subject(:cli) { YourKarma::CLI::ArgumentParser.new }
+
+  describe "#parse" do
+    let(:arguments) { ["--url", "http://example.com"] }
+    subject { cli.parse(arguments) }
+    its([:verbose]) { should be_false }
+    its([:url])     { should eq "http://example.com"}
+
+    context "help argument" do
+      let(:arguments) { ["--help"] }
+      it "should raise InvalidOption exception" do
+        expect(-> { subject }).to raise_error YourKarma::CLI::ArgumentParser::InvalidOption
+      end
+    end
+
+    context "invalid arguments" do
+      let(:arguments) { ["--WRONG"] }
+      it "should raise InvalidOption exception" do
+        expect(-> { subject }).to raise_error YourKarma::CLI::ArgumentParser::InvalidOption
+      end
+    end
+  end
+end

data/spec/units/cli_reporter_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe "CLI::Reporter" do
+  let(:arguments) { { verbose: true } }
+  let(:reporter)  { YourKarma::CLI::Reporter.new arguments }
+
+  describe "#options" do
+    subject { reporter.options }
+
+    its([:io]) { should eq STDOUT }
+    its([:verbose]) { should be true }
+  end
+end
+
+describe "CLI::Reporter", "#report_on" do
+  let(:io)        { StringIO.new }
+  let(:device)    { YourKarma::Device.new ssid: "My Karma" }
+  let(:benchmark) { 123.45 }
+  let(:reporter)  { YourKarma::CLI::Reporter.new({ io: io, verbose: true }) }
+  let!(:status)   { reporter.report_on(device, benchmark) }
+  subject { status }
+
+  it { should be 0 }
+
+  describe "io" do
+    subject { io.string }
+    it { should match "My Karma" }
+    it { should match /123.5/ }
+  end
+end
+
+describe "CLI::Reporter", "#report_connectivity_failure" 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 }
+
+  it { should be 1 }
+
+  describe "io" do
+    subject { io.string }
+    it { should match "Not connected" }
+  end
+end
+
+describe "CLI::Reporter", "#report_benchmark_failure_on" 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) }
+  subject { status }
+
+  it { should be 1 }
+
+  describe "io" do
+    subject { io.string }
+    it { should match "My Karma" }
+    it { should match "slow" }
+  end
+end

data/spec/units/cli_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe "CLI", ".new" do
+  let(:options) { { verbose: true } }
+  subject { YourKarma::CLI.new options }
+  its(:options) { should eq options }
+end
+
+describe "CLI", ".run" do
+  it "should parse command line arguments, instantiate CLI instance and run it" do
+    io              = double(:io)
+    arguments       = double(:arguments)
+    options         = {}
+    argument_parser = double(:argument_parser, parse: options )
+    exit_code       = double(:exit_code)
+    cli             = double(:cli, run: exit_code)
+    YourKarma::CLI::ArgumentParser.stub(:new) { argument_parser }
+    YourKarma::CLI.stub(:new) { cli }
+    YourKarma::CLI.run io, arguments
+    expect(cli).to have_received(:run).with { { io: io } }
+  end
+end
+
+describe "CLI", "#run" do
+  it "should fetch status from device, benchmark speed and report" do
+    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)
+    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
+    response = cli.run
+    expect(reporter).to have_received(:report_on).with(device, benchmark)
+    expect(response).to eq(exit_code)
+  end
+end

data/spec/units/client_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe YourKarma::Client do
+  describe "#options" do
+    let(:client)  { YourKarma::Client.new }
+    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 }
+    before do
+      Net::HTTP.stub(:get_response) { response }
+    end
+
+    its(['foo']) { should eq 'bar' }
+
+    it "makes request to url" do
+      subject
+      uri = URI('example.com')
+      expect(Net::HTTP).to have_received(:get_response).with(uri)
+    end
+
+    context "timing out" do
+      before do
+        Net::HTTP.stub(:get_response) { raise Timeout::Error }
+      end
+
+      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 }
+      end
+
+      it "raises ConnectionError" do
+        expect(-> { subject }).to raise_error YourKarma::Client::ConnectionError
+      end
+    end
+
+    context "with bad JSON" do
+      let(:response)  { double :response, body: '{ WRONG }' }
+
+      it "raises BadResponseError" do
+        expect(-> { subject }).to raise_error YourKarma::Client::BadResponseError
+      end
+    end
+  end
+end

data/spec/units/device_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe YourKarma::Device do
+  let(:attrs) { { 'ssid' => "My Karma", 'ipaddress' => "127.0.0.1" } }
+  subject { YourKarma::Device.new attrs }
+
+  its(:ssid) { should eq "My Karma" }
+  its(:ipaddress) { should eq "127.0.0.1" }
+
+end
+
+describe YourKarma::Device, "#valid_ipaddress?" do
+  context "with a real IP address" do
+    subject { YourKarma::Device.new 'ipaddress' => "127.0.0.1" }
+    its(:valid_ipaddress?) { should be_true }
+  end
+  context "with a real IP address" do
+    subject { YourKarma::Device.new 'ipaddress' => "N/A" }
+    its(:valid_ipaddress?) { should be_false }
+  end
+end

data/what_karma.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yourkarma/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yourkarma"
+  spec.version       = YourKarma::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Greg Sterndale"]
+  spec.email         = ["gsterndale@gmail.com"]
+  spec.summary       = %q{Karma hotspot status client & CLI}
+  spec.description   = %q{Determine connectivity, battery and connection speed for your device.}
+  spec.homepage      = "http://github.com/gsterndale/yourkarma"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  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"
+
+  # Release every merge to master as a prerelease
+  spec.version = "#{spec.version}.pre#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+end