lifx_dash 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c90fc97d3bb2f4215218815b7697a8315026a03
-  data.tar.gz: 71bdddb56b295d00a7757be236caed3cc95a93d3
+SHA256:
+  metadata.gz: ca51794c2ebf07f04ff3f7f44f811fe32a0f1d559a315b1045055984165c7d9f
+  data.tar.gz: e1b3d10dff9420244c6d1fe2a02ac5c5476ea8a576a4511e01acd1fb870a6abe
 SHA512:
-  metadata.gz: ccf8e41e3db5e3bcf6a0e7f8e2449f0139f3de606a3260b066b49aa0cb44c5b0e2d3beaf41e5df839992d18f5bb535405bcd02480039e7c72ed66438cae03837
-  data.tar.gz: 1b0f089fcdabd020fbd60503bdff78b8651220555e056c426a55877aba86a033b68da10301a2d232f057fb4d4e39f90f7b5f2f4888f2cb41d85ed4eec216cac9
+  metadata.gz: bbbf9032c429cfa4201f41eae6b4562584e55024a95d719edb44f6eb42bcb46d0c2a6dc876ae68fae2cf1d393046f1180b229ec23b2d778357bfdc1ee798caf5
+  data.tar.gz: e4398d1c6f2b1bb3432c2393437bccc82cee0bd421e6ed111330c217f5f13fbb77a1a8246eda80c48c47f1b592ebb4308f0eb78e320d26116983c8e93c031727

data/.travis.yml

@@ -1,15 +1,16 @@
 sudo: required
 language: ruby
 before_install:
-- sudo apt-get install libpcap-dev -qq
-- gem update --system
-- gem --version
+  - sudo apt-get install libpcap-dev -qq
+  - gem update --system
+  - gem --version
 rvm:
-- 2.1.10
-- 2.2.7
-- 2.3.4
-- 2.4.1
-- ruby-head
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
 matrix:
   allow_failures:
   - rvm: ruby-head
@@ -24,3 +25,12 @@ deploy:
   on:
     tags: true
     repo: matthutchinson/lifx_dash
+env:
+  global:
+    - CC_TEST_REPORTER_ID=71107cb58f585bf7506e53f33238f4bd4e9aa87215ed916a5b466ecd9b493209
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build

data/README.md

@@ -2,9 +2,9 @@
 
 [![Gem Version](https://img.shields.io/gem/v/lifx_dash.svg?style=flat)](http://rubygems.org/gems/lifx_dash)
 [![Travis Build Status](https://travis-ci.org/matthutchinson/lifx_dash.svg?branch=master)](https://travis-ci.org/matthutchinson/lifx_dash)
-[![Coverage Status](https://coveralls.io/repos/github/matthutchinson/lifx_dash/badge.svg?branch=master)](https://coveralls.io/github/matthutchinson/lifx_dash?branch=master)
-[![Code Climate](https://codeclimate.com/github/matthutchinson/lifx_dash/badges/gpa.svg)](https://codeclimate.com/github/matthutchinson/lifx_dash)
-[![Gem Dependency Status](https://gemnasium.com/matthutchinson/lifx_dash.svg)](https://gemnasium.com/matthutchinson/lifx_dash)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/matthutchinson/lifx_dash.svg)](https://codeclimate.com/github/matthutchinson/lifx_dash/maintainability)
+[![Test Coverage](https://img.shields.io/codeclimate/c/matthutchinson/lifx_dash.svg)](https://codeclimate.com/github/matthutchinson/lifx_dash/test_coverage)
+[![Gem Dependency Status](https://gemnasium.com/badges/github.com/matthutchinson/lifx_dash.svg)](https://gemnasium.com/github.com/matthutchinson/lifx_dash)
 
 ![Amazon LIFX Dash Button](http://matthutchinson.github.io/lifx_dash/images/lifx_dash.png)
 
@@ -153,9 +153,9 @@ take a moment and check it hasn't already been raised (and possibly closed).
 This gem uses the [PacketFu](https://rubygems.org/gems/packetfu) gem (and
 [libpcap](https://sourceforge.net/projects/libpcap/) under the hood) to monitor
 data packets on your network. This packet stream filters for
-[DHCP](https://wiki.wireshark.org/DHCP) packets (sent from 0.0.0.0). Older dash
-buttons sent both DHCP and [ARP](https://wiki.wireshark.org/ARP) packets but
-detecting ARP reliably was problematic.
+[DHCP](https://wiki.wireshark.org/DHCP) packets (sent from 0.0.0.0). See
+[below](https://github.com/matthutchinson/lifx_dash#packet-detection)
+for more details on packet detection.
 
 When a valid packet is detected with a known source MAC address, the LIFX HTTP
 API [toggle-power](https://api.developer.lifx.com/docs/toggle-power) endpoint is
@@ -166,6 +166,26 @@ the commands and options.
 [MiniTest](https://rubygems.org/gems/minitest/versions/5.7.0) and
 [Aruba](https://rubygems.org/gems/aruba) are used for testing.
 
+## Packet detection
+
+Using [WireShark](https://www.wireshark.org) to monitor the network it appears
+that;
+
+* older buttons send an ARP packet followed by one or more DHCP packets
+* newer buttons send one or more DHCP packets
+
+To detect packets on both devices it should only be necessary to look for
+DHCP packets; this can be done with the following filter:
+
+```
+udp and src port 68 and dst port 67 and udp[247:4] == 0x63350103 and src host 0.0.0.0
+```
+
+However since DHCP packets appear to arrive in bursts of 2, the
+[Capturer](https://github.com/matthutchinson/lifx_dash/blob/master/lib/lifx_dash/capturer.rb)
+only acts on packets that have an even IP
+[ID](https://tools.ietf.org/html/rfc6864) field.
+
 ## Contributing
 
 Bug [reports](https://github.com/matthutchinson/lifx_dash/issues) and [pull
@@ -221,8 +241,8 @@ License](http://opensource.org/licenses/MIT).
 ## Links
 
 * [Travis CI](http://travis-ci.org/matthutchinson/lifx_dash)
-* [Test Coverage](https://coveralls.io/r/matthutchinson/lifx_dash?branch=master)
-* [Code Climate](https://codeclimate.com/github/matthutchinson/lifx_dash)
+* [Maintainability](https://codeclimate.com/github/matthutchinson/lifx_dash/maintainability)
+* [Test Coverage](https://codeclimate.com/github/matthutchinson/lifx_dash/test_coverage)
 * [RDoc](http://rdoc.info/projects/matthutchinson/lifx_dash)
 * [Wiki](http://wiki.github.com/matthutchinson/lifx_dash/)
 * [Issues](http://github.com/matthutchinson/lifx_dash/issues)

data/lib/lifx_dash/version.rb

@@ -1,3 +1,3 @@
 module LifxDash
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lifx_dash.gemspec

@@ -42,14 +42,14 @@ Gem::Specification.new do |spec|
   spec.rdoc_options << '--title' << 'lifx_dash' << '--main' << 'README.md' << '-ri'
 
   # non-gem dependecies
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.1"
   spec.requirements << 'libpcap'
   spec.requirements << 'an Amazon Dash button'
   spec.requirements << 'one or more LIFX bulbs'
   spec.requirements << 'root access'
 
   # external gems
-  spec.add_runtime_dependency "gli", "2.16.0"
+  spec.add_runtime_dependency "gli", "2.17.1"
   spec.add_runtime_dependency "packetfu", "1.1.13"
 
   # dev gems
@@ -63,5 +63,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "aruba"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "coveralls"
 end

data/test/test_helper.rb

@@ -1,10 +1,5 @@
 if ENV['COVERAGE']
-  if ENV['TRAVIS']
-    require 'coveralls'
-    Coveralls.wear!
-  else
-    require 'simplecov'
-  end
+  require 'simplecov'
 end
 
 require 'lifx_dash'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_dash
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 2.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 2.17.1
 - !ruby/object:Gem::Dependency
   name: packetfu
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |2
     A command line tool to listen for Amazon Dash button presses and toggle LIFX
     lights ON and OFF (via the LIFX HTTP API). With options to configure: the Dash
@@ -228,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -240,7 +226,7 @@ requirements:
 - one or more LIFX bulbs
 - root access
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Toggle LIFX lights with an Amazon Dash button