lifx_dash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b9be5bbdb38e32487767ecec9f7c7d6e05ed06d
+  data.tar.gz: 47311732c4e4ee713439d41d5aeb72621d9a1863
+SHA512:
+  metadata.gz: 922a24cce44a9403a77e1a56270f09983894a42b610009656a6d4632aa0810829153f905cf3849226e4e25ad67b874a8802c21e6e66c9ec4f6b75b23d088c99a
+  data.tar.gz: 6d12425fb407bb079373b3dfcba59fcd359d83676b0f80aa9dbea2d1a5e9e94b91df43e410d129b08289720ecbfc62e8f1f5fd64db77b95097474725f4c4c9e3

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/html/

data/.simplecov

@@ -0,0 +1,10 @@
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/features/'
+  add_filter '/vendor/'
+end
+
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
+end

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: required
+language: ruby
+before_install:
+  - sudo apt-get install libpcap-dev -qq
+  - gem update --system
+  - gem --version
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  except:
+    - gh-pages

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+### LifxDash Change Log
+
+All notable changes to this project will be documented in this file. This
+project adheres to [Semantic Versioning][Semver].
+
+## [Unreleased]
+
+  * Validation of all command line flag values, iface/mac/token etc.
+
+## [0.1.0][] (30 Jun 2016)
+  * Initial gem release, config/help/snoop/monitor commands working
+  * Includes 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.1.0...HEAD
+[0.1.0]: https://github.com/matthutchinson/lifx_dash/releases/tag/v0.1.0
+[Semver]: http://semver.org

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer via [GitHub][maintainer]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[maintainer]: https://github.com/matthutchinson
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+### Contributing
+
+Pull Requests are welcome! To start helping out on this project:
+
+Fork then clone the repository:
+
+    git clone git@github.com:your-username/lifx_dash.git
+
+Create your feature branch:
+
+    git checkout -b my-new-feature
+
+Commit your changes, push and submit a new [Pull
+Request](https://github.com/matthutchinson/lifx_dash/compare/):
+
+    git commit -am 'Added some feature'
+    git push origin my-new-feature
+
+At this point you'll be waiting for me to review it. I try to reply to new Pull
+Requests within 5 days. I may suggest some changes, improvements or
+alternatives. To increase the chance that your pull request gets accepted:
+
+* Explain what your are doing (and why) in your Pull Request description.
+* If you are fixing an
+  [issue](https://github.com/matthutchinson/lifx_dash/issues), link to
+  it in your description and [mention
+  it](https://help.github.com/articles/closing-issues-via-commit-messages/) in
+  the commit message.
+* Write a good [commit
+  message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* Write tests.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matthew Hutchinson
+
+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,235 @@
+# LifxDash
+
+[![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)
+
+![Amazon LIFX Dash Button](http://matthutchinson.github.io/lifx_dash/images/lifx_dash.png)
+
+`lifx_dash` is a simple command-line tool to monitor your network for [Amazon
+Dash button](https://www.amazon.com/Dash-Buttons/b?ie=UTF8&node=10667898011)
+presses and toggle [LIFX](http://www.lifx.com) lights ON and OFF. The tool
+provides two commands, `monitor` and `snoop`.
+
+Use `snoop` to listen for Dash presses on your network, and identify the
+button's MAC address.
+
+Use `monitor` (with a MAC address and LIFX HTTP API token) to respond to
+presses, and toggle your lights ON and OFF. You can optionally pass a bulb
+selector, or choose to daemonize the `monitor` process.
+
+A `config` command also exists, allowing you to set default options for
+`monitor` and `snoop`.
+
+## Requirements
+
+`lifx_dash` requires at least one LIFX bulb, and any Amazon Dash button. You
+will also need a wifi network and root access to sniff packets on your network
+adaptor.
+
+`lifx_dash` is distributed via [RubyGems](https://rubygems.org) and requires
+[Ruby](https://www.ruby-lang.org) >= 2.0.0.
+
+## Installation
+
+    gem install lifx_dash
+
+The `lifx_dash` command will now be available in your PATH.
+
+### Dash Button Setup
+
+Follow Amazon's Dash button setup steps, but **stop** before choosing any
+particular product to purchase. If necessary, you can [factory
+reset](https://www.amazon.com/gp/help/customer/display.html?nodeId=201746400)
+your button and start the setup from scratch.
+
+Next use the `snoop` command to determine the button's MAC address:
+
+    $ sudo lifx_dash snoop -i en0
+
+This will listen on network interface 'en0' for ARP packets from any Dash
+button. Take a note of the MAC address that's logged when you press. To list
+network interfaces on your machine use:
+
+    $ ifconfig
+    # or
+    $ ifconfig -l
+
+#### Snooping Tips
+
+Wait for the network to quiet down, before pressing the button, since other
+devices may respond with ARP packets of their own when you press. Take care to
+choose the MAC address from the ARP packet that occurs only once from a single
+MAC address.
+
+### LIFX Bulb Setup
+
+Create a [personal token](https://cloud.lifx.com/settings) for the LIFX HTTP
+API.
+
+By default `lifx_dash` will toggle _ALL_ bulbs. To toggle a specific light you
+will need to find the LIFX Bulb ID.
+
+Visit the LIFX API [list
+lights](https://api.developer.lifx.com/docs/list-lights) doc and use the 'Try It
+Out' form with your token. Details for all bulbs on your network will be shown
+along with their IDs (in JSON format).
+
+Or call the API directly with this curl command:
+
+    $ curl "https://api.lifx.com/v1/lights/all" -H "Authorization: Bearer LIFX_API_TOKEN"
+
+## Usage
+
+To start the `lifx_dash` monitor:
+
+    $ sudo lifx_dash monitor --token=LIFX_API_TOKEN --mac-address=DASH_MAC_ADDRESS --selector='all' --iface=en0
+    Starting lifx_dash monitor ...
+
+This starts a long-running process listening on 'en0', for button presses (from
+the given MAC address). When a press occurs, the monitor will toggle all LIFX
+bulbs.
+
+Only the `--mac-address` and `--token` options are required, by default
+`--selector=all` and `--iface=en0`. You can also use short-form flag options
+like so:
+
+    $ sudo lifx_dash monitor -t LIFX_API_TOKEN -m DASH_MAC_ADDRESS -s 'all' -i en0
+
+### Running as a Daemon
+
+Use the `-d` switch (or `--daemonize`) to run `monitor` as a daemon:
+
+    $ sudo lifx_dash monitor -t LIFX_API_TOKEN -m DASH_MAC_ADDRESS -s 'all' -i en0 -d
+    [17099] Starting lifx_dash ... (daemon logging to /tmp/lifx_dash.log)
+
+The command will log to `/tmp/lifx_dash.log` by default (creating the file and
+folder if it does not exist). Use `-l` or `--log-file` to override this
+location.
+
+## Configuration
+
+You can save option defaults using the `config` command:
+
+    $ lifx_dash config
+    Configuring lifx_dash ...
+
+You will be prompted for values for each option and your choices will be stored
+at `~/.lifx_dash.rc.yml`.
+
+An empty answer will mean no value is set, and the option reverts to it's
+default. Passing options on the command-line always takes precedence over
+your saved configuration.
+
+You can inspect the current configuration file options with:
+
+    $ lifx_dash config --show
+
+## Help
+
+You can get help in number of ways, for example:
+
+    $ lifx_dash help
+    $ lifx_dash help monitor
+    $ lifx_dash snoop -h
+    $ lifx_dash config --help
+
+The gem also comes packaged with its own [man
+page](http://htmlpreview.github.io/?https://raw.githubusercontent.com/matthutchinson/lifx_dash/master/man/lifx_dash.1.html).
+You'll need [gem-man](https://github.com/defunkt/gem-man) to view this from your
+command line.
+
+## Troubles?
+
+If you think something is broken or missing, do raise a new
+[issue](https://github.com/matthutchinson/lifx_dash/issues). Please remember to
+take a moment and check it hasn't already been raised (and possibly closed).
+
+## What does the code do?
+
+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 is filtered by
+[ARP](https://en.wikipedia.org/wiki/Address_Resolution_Protocol) packets (sent
+when a device attempts to identify itself). Amazon Dash buttons do this on every
+press.
+
+When an ARP 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
+requested, with a selector and authorization header.
+
+The [GLI](http://naildrivin5.com/gli/) command line framework is used to define
+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.
+
+## Contributing
+
+Bug [reports](https://github.com/matthutchinson/lifx_dash/issues) and [pull
+requests](https://github.com/matthutchinson/lifx_dash/pulls) are welcome on
+GitHub.
+
+When submitting pull requests, please remember to add tests covering the new
+behaviour, and ensure all tests are passing on [Travis
+CI](https://travis-ci.org/matthutchinson/lifx_dash). Read the [contributing
+guidelines](https://github.com/matthutchinson/lifx_dash/blob/master/CONTRIBUTING.md)
+for more details.
+
+This project is intended to be a safe, welcoming space for
+collaboration, and contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct. See
+[here](https://github.com/mroth/lolcommits/blob/master/CODE_OF_CONDUCT.md) for
+more details.
+
+## Development
+
+After checking out the repo, run `bin/setup`, this will install dependencies,
+and re-generate the man page and docs. Then, run `bundle exec rake` to run all
+tests (and generate a coverage report). You can run unit or feature tests
+separately with:
+
+    bundle exec rake test
+    bundle exec rake features
+
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
+
+## Future Work
+
+Work in progress is usually mentioned at the top of the
+[CHANGELOG](https://github.com/matthutchinson/lifx_dash/blob/master/CHANGELOG.md).
+If you'd like to get involved in contributing, here are some ideas:
+
+* Validation of all command line flag values, iface/mac/token etc.
+* More unit test coverage
+* Aruba features covering the happy paths for all commands
+* Smarter config, auto-snoop, list bulbs with names and choose id
+* Show existing values in config, when configuring, allowing edits (with readline)
+* More Rdoc documentation on command classes
+* New optional flag for the configuration file location
+* Handle CTRL-C and kill signals with better exit/cleanup messages
+* Use LIFX LAN API (with a command switch to choose LAN/HTTP)
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+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)
+* [RDoc](http://rdoc.info/projects/matthutchinson/lifx_dash)
+* [Wiki](http://wiki.github.com/matthutchinson/lifx_dash/)
+* [Issues](http://github.com/matthutchinson/lifx_dash/issues)
+* [Report a bug](http://github.com/matthutchinson/lifx_dash/issues/new)
+* [Gem](http://rubygems.org/gems/lifx_dash)
+* [GitHub](http://github.com/matthutchinson/lifx_dash)
+
+## Who's Who?
+
+* [LifxDash](http://github.com/matthutchinson/lifx_dash) by [Matthew Hutchinson](http://matthewhutchinson.net)
+* Inspired by this [hack](http://tinyurl.com/zba3da2) from [Ted Benson](https://twitter.com/edwardbenson)

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "cucumber"
+require "cucumber/rake/task"
+require 'rdoc/task'
+
+task :default => ['test:coverage']
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+# test with code coverage (default)
+namespace :test do
+  desc "Run all tests and features and generate a code coverage report"
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].execute
+    Rake::Task['features'].execute
+  end
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty -x"
+  t.fork = false
+end
+
+# generate docs
+RDoc::Task.new do |rd|
+  rd.main     = "README.md"
+  rd.title    = 'lifx_dash'
+  rd.rdoc_dir = 'doc'
+  rd.options  << "--all"
+  rd.rdoc_files.include("README.md", "LICENSE.txt", "lib/**/*.rb", "bin/**/*")
+end
+