lifx_dash 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0e67bbe784dc06c3c111d6933809d2404529d88047ee55dbbd816379a03ee06
-  data.tar.gz: 2ae77cef8817730f5ba6a15f60f0f4136763ffc80823910111ba6152de485e34
+  metadata.gz: 251f4790426026ae467c0365fc5bcf80ced642efeb6d4735b0114c90bfd69253
+  data.tar.gz: dd7221baf7af6d9aa8a05b8a3775a32da9d6f204238733021bb4af6bc255ee18
 SHA512:
-  metadata.gz: 1b6033ff970855599b43eb9752fafc2bc0f970773c9bbaa0cee7770c572ef596f57fe67cdf61a71c68e4badb2d3ca086ae8a06dd9686db98e0a523a7a6065a36
-  data.tar.gz: 597ef41ec1d531d32f9bf6a0d0ed5da1624f4455b401bdb45545b1ceff397654a3a996a61da86373fa2d3991ae4926d8de87beae23e21d759e2dcda9f6a5627a
+  metadata.gz: 48ec583e80fb92bb429e2ce8f0d6492d7ca912de6e2c32219d6203cc1e8293942e2338f51d983e326a1af0012a5ce0b1f7c7a72209ec364908a1618f410bade3
+  data.tar.gz: af4d47c2a80703954cffce9b15713159608d16a500705826890200be6f9eda384dcdba324cfd63ab060f37730c57face82379ed08030c2d335a405a94255d7c4

data/.travis.yml

@@ -1,17 +1,14 @@
 sudo: required
 language: ruby
 rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.1
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
   - ruby-head
 
 before_install:
   - sudo apt-get install libpcap-dev -qq
-  - gem update --system
-  - gem install bundler
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -2,13 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](KeepAChangelog) and this project
-adheres to [Semantic Versioning](Semver).
+The format is based on [Keep a Changelog][KeepAChangelog] and this project
+adheres to [Semantic Versioning][Semver].
 
 ## [Unreleased]
 
 - Your contribution here!
 
+## [0.4.0] - 2019-04-23
+### Added
+- `frozen_string_literal: true` to all Ruby files
+
+### Removed
+- Support for Ruby < 2.3 (earlier versions no longer supported)
+
 ## [0.3.1] - 2018-05-23
 ### Changed
 - Adding links to gemspec
@@ -28,7 +35,8 @@ adheres to [Semantic Versioning](Semver).
 - Dameonizing option for monitor command (writing to a log file)
 - Built with gli command-suite gem
 
-[Unreleased]: https://github.com/matthutchinson/lifx_dash/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/matthutchinson/lifx_dash/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/matthutchinson/lifx_dash/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/matthutchinson/lifx_dash/compare/v0.1.3...v0.3.1
 [0.1.3]: https://github.com/matthutchinson/lifx_dash/compare/v0.1.1...v0.1.3
 [0.1.1]: https://github.com/matthutchinson/lifx_dash/compare/v0.1.0...v0.1.1

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at via [Github][maintainer]. All
+reported by contacting the project team at matt@hiddenloop.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -71,4 +71,3 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
 [homepage]: https://www.contributor-covenant.org
-[maintainer]: https://github.com/matthutchinson

data/features/lifx_dash.feature

@@ -0,0 +1,17 @@
+Feature: Show help information
+  In order to show command line help
+
+  Scenario: Show general command line help
+    When I get help for "lifx_dash"
+    Then the output should contain "    lifx_dash - Toggle LIFX lights with an Amazon Dash button"
+    Then the output should match /   config  - (.*)/
+    Then the output should match /   help    - (.*)/
+    Then the output should match /   monitor - (.*)/
+    Then the output should match /   snoop   - (.*)/
+    And the exit status should be 0
+
+  Scenario: Show config help
+    When I run `lifx_dash help config`
+    Then the output should contain "    config - Set (and persist) default options for commands"
+    Then the output should contain "   -s, --[no-]show - Show the config file"
+    And the exit status should be 0

data/features/step_definitions/lifx_dash_steps.rb

@@ -0,0 +1,4 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/lifx_dash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # stdlib
 require "logger"
 

data/lib/lifx_dash/capturer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "packetfu"
 
 module LifxDash

data/lib/lifx_dash/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "yaml"
 
 module LifxDash

data/lib/lifx_dash/daemonizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LifxDash
   class Daemonizer
 

data/lib/lifx_dash/lifx_http_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "net/https"
 require "json"
 

data/lib/lifx_dash/monitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LifxDash
   class Monitor
 

data/lib/lifx_dash/snoop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LifxDash
   class Snoop
 

data/lib/lifx_dash/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LifxDash
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lifx_dash.gemspec

@@ -22,21 +22,13 @@ Gem::Specification.new do |spec|
   EOF
 
   spec.metadata = {
-    "homepage_uri"    => "https://github.com/matthutchinson/lifx_dash",
-    "changelog_uri"   => "https://github.com/matthutchinson/lifx_dash/blob/master/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/matthutchinson/lifx_dash",
-    "bug_tracker_uri" => "https://github.com/matthutchinson/lifx_dash/issues",
+    "homepage_uri"      => "https://github.com/matthutchinson/lifx_dash",
+    "changelog_uri"     => "https://github.com/matthutchinson/lifx_dash/blob/master/CHANGELOG.md",
+    "source_code_uri"   => "https://github.com/matthutchinson/lifx_dash",
+    "bug_tracker_uri"   => "https://github.com/matthutchinson/lifx_dash/issues",
+    "allowed_push_host" => "https://rubygems.org"
   }
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
-  # 'allowed_push_host' to allow pushing to a single host or delete this section
-  # to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
   spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
   spec.bindir        = "bin"
@@ -44,12 +36,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # documentation
-  spec.has_rdoc         = true
   spec.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   spec.rdoc_options << '--title' << 'lifx_dash' << '--main' << 'README.md' << '-ri'
 
   # non-gem dependecies
-  spec.required_ruby_version = ">= 2.1"
+  spec.required_ruby_version = ">= 2.3"
   spec.requirements << 'libpcap'
   spec.requirements << 'an Amazon Dash button'
   spec.requirements << 'one or more LIFX bulbs'

data/test/lifx_dash/lifx_http_api_test.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require File.expand_path(File.dirname(__FILE__)+'/../test_helper')
+
+class TestLifxHTTPApi <  Minitest::Test
+
+  def setup
+    @logger     = MiniTest::Mock.new
+    @api_client = LifxDash::LifxHTTPApi.new('my-token', @logger)
+  end
+
+  def test_toggles_lights_logging_successful
+    selector = "d073d500ec8e"
+    body = { results: [{ id: "d073d500ec8e", label: "Golden Boy", status: "ok" } ]}.to_json
+    stub_request(:post, lifx_url(selector)).to_return(body: body, status: 207)
+
+    @logger.expect(:info, nil, ["Toggling lights! (via #{LifxDash::LifxHTTPApi::BASE_URI})"])
+    @logger.expect(:info, nil, ["Lights toggled successfully!"])
+    @logger.expect(:info, nil, ["API reply (207): #{body}"])
+    @api_client.toggle(selector)
+
+    assert @logger.verify
+  end
+
+  def test_toggles_lights_logging_warnings
+    selector = "all"
+    http_responses = {
+      401 => { error: "Invalid token" }, # invalid token in header
+      500 => nil, # server issue
+      207 => "{}" # server OK, but results not present
+    }
+
+    http_responses.each do |code, api_response_body|
+      stub_request(:post, lifx_url(selector)).
+        to_return(body: api_response_body.to_json, status: code)
+
+      @logger.expect(:info, nil, ["Toggling lights! (via #{LifxDash::LifxHTTPApi::BASE_URI})"])
+      @logger.expect(:warn, nil, ["Warning: Possible issue with LIFX lights or HTTP API response"])
+      @logger.expect(:warn, nil, ["API reply (#{code}): #{api_response_body.to_json}"])
+      @api_client.toggle(selector)
+
+      assert @logger.verify
+    end
+  end
+
+  def test_raises_error_on_toggle_when_http_errors
+    assert_raises(Errno::ECONNRESET) do
+      @logger.expect(:info, nil, ["Toggling lights! (via #{LifxDash::LifxHTTPApi::BASE_URI})"])
+      @logger.expect(:error, nil, ["Error: POST request to #{LifxDash::LifxHTTPApi::BASE_URI} failed: Connection reset by peer"])
+
+      net_error = -> (uri) { raise Errno::ECONNRESET.new }
+      Net::HTTP::Post.stub :new, net_error do
+        @api_client.toggle('all')
+      end
+
+      assert @logger.verify
+    end
+  end
+
+  def test_raises_error_on_toggle_with_bad_selector
+    assert_raises do
+      bad_selector = "im a bad bulb selector"
+      @logger.expect(:error, nil, [
+        "Error: POST request to #{LifxDash::LifxHTTPApi::BASE_URI} failed: bad URI(is not URI?): #{lifx_url(bad_selector)}"
+      ])
+      @api_client.toggle(bad_selector)
+
+      assert @logger.verify
+    end
+  end
+
+  private
+
+  def lifx_url(selector)
+    "https://#{LifxDash::LifxHTTPApi::BASE_URI}/lights/#{selector}/toggle"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
+  end
+end
+
+require 'lifx_dash'
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+# set a quiet logger to /dev/null
+LOGGER = Logger.new("/dev/null")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_dash
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -179,6 +179,9 @@ files:
 - bin/console
 - bin/lifx_dash
 - bin/setup
+- features/lifx_dash.feature
+- features/step_definitions/lifx_dash_steps.rb
+- features/support/env.rb
 - lib/lifx_dash.rb
 - lib/lifx_dash/capturer.rb
 - lib/lifx_dash/configuration.rb
@@ -191,6 +194,8 @@ files:
 - man/lifx_dash.1
 - man/lifx_dash.1.html
 - man/lifx_dash.1.ronn
+- test/lifx_dash/lifx_http_api_test.rb
+- test/test_helper.rb
 homepage: http://github.com/matthutchinson/lifx_dash
 licenses:
 - MIT
@@ -213,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -224,9 +229,13 @@ requirements:
 - an Amazon Dash button
 - one or more LIFX bulbs
 - root access
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Toggle LIFX lights with an Amazon Dash button
-test_files: []
+test_files:
+- features/lifx_dash.feature
+- features/step_definitions/lifx_dash_steps.rb
+- features/support/env.rb
+- test/lifx_dash/lifx_http_api_test.rb
+- test/test_helper.rb