lifx_dash 0.1.1 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjBlMWRjMmRmOWZlZDY1NjJiODA1NDNmZTIyZWVlZDYxNTkyOWFhMw==
+    M2Q0MTdjYWZlZmM1MzQ0ZGE5MWY3YTJmMjM3NmVhNzdmNzZiZmZlMg==
   data.tar.gz: !binary |-
-    MTQyZDA5Yjc1ZDM4NGFjODU2ZWM3NmQzODQ5YTM2MWI3MzUxZWZkMw==
+    OWVhMDk4N2JhNGIwYmNmODg0YTlhYzU2NjczNWYzZmYzOWMxMzVlMg==
 SHA512:
   metadata.gz: !binary |-
-    YzIzY2FjNmYyYzRkODc1YjRmZjIzMDc0MGZjN2ZiOWJhYjQxOGJjNWRkNWYy
-    MTEwMmNjY2QzN2QwYzIzODUyNzQ2NTg4OTE1Y2E5MGVkMzdhOGM0ODBjNWY1
-    MjhjMmQ1MmFiYzhlZjUyMjJmNzQ2OGE5NDg4Y2RlMWM1NmY0MTQ=
+    ZDc3ZjhlYzhjNmExYmU5ZGEyNGM4OTE4MGZkMTMzYTBhMTZmMzEwMTE4ZjNj
+    MmY5MTFkNzBjN2Y3YjE4NzcyODEyMjdiMjUxY2I5ZDcxMzdmNjljNDA2Mjk4
+    MzY5ZDlkNTFkZDRjZDMxOGVhYTgyMDJkMDJlZDE3MGNhYjdlYjY=
   data.tar.gz: !binary |-
-    NWZmYjlmZDMzOTlhNGUwNGZiYjlkYzBkYzAxNjU4OGM3NzA0YTE1ZDdkZDhk
-    YWMwZTdkZDc0ZGZiODU2NDcyNGFmMmM0ZjNkYzJkMGEzZjNkMDQwMWNkN2Q4
-    YjE0ODRlMWMxZDQzNzZjZmFmNjM1MGEyNTFjN2ZiZDcwMzQ3NmQ=
+    ZmZlZmQ5MDAwYjgwN2Q1MGU0MWFmODY5YTdiNTIxYmE1ODFjNTlhODlmMzM1
+    Y2Y2OGFiZWQ3MDEzNmE2YzBlYjQ4ZTE2ZDFlZGJiM2E1ZWM4YWM5ZDBhMjIw
+    MDdmMDhkYzU0ZDZjNTcxNDk3MjAyNzljZTBjZWYxYzc4ZmI2ZDc=

data/CHANGELOG.md

@@ -7,6 +7,13 @@ project adheres to [Semantic Versioning][Semver].
 
   * Validation of all command line flag values, iface/mac/token etc.
 
+## [0.1.3][] (2 Jul 2016)
+  * Mentioning libpcap dependency
+  * Refactoring Configuration - added CONFIG const and fixed sudo home dir issue
+
+## [0.1.2][] (2 Jul 2016)
+  * YANKED!
+
 ## [0.1.1][] (30 Jun 2016)
   * Testing auto-releasing gem from Travis CI
 
@@ -15,7 +22,8 @@ project adheres to [Semantic Versioning][Semver].
   * 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.1...HEAD
+[Unreleased]: https://github.com/matthutchinson/lifx_dash/compare/v0.1.3...HEAD
+[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
 [0.1.0]: https://github.com/matthutchinson/lifx_dash/releases/tag/v0.1.0
 [Semver]: http://semver.org

data/README.md

@@ -29,6 +29,15 @@ A `config` command also exists, allowing you to set default options for
 will also need a wifi network and root access to sniff packets on your network
 adaptor.
 
+This gem uses [packet_fu](https://rubygems.org/gems/packetfu) which in turn
+requires the [libpcap](http://www.tcpdump.org) library. This is probably already
+available on your machine, if not download the [latest
+release](http://www.tcpdump.org/#latest-release) or install with your package
+manager e.g.:
+
+    sudo apt-get install libpcap0.8-dev  # UNIX
+    brew install libpcap                 # homebrew on OSX
+
 `lifx_dash` is distributed via [RubyGems](https://rubygems.org) and requires
 [Ruby](https://www.ruby-lang.org) >= 2.0.0.
 

data/bin/lifx_dash

@@ -6,7 +6,7 @@ require "lifx_dash"
 include GLI::App
 
 LOGGER = Logger.new(STDOUT)
-config_options = LifxDash::Configuration.load
+CONFIG = LifxDash::Configuration.new
 
 program_desc "Toggle LIFX lights with an Amazon Dash button"
 
@@ -25,7 +25,11 @@ command :config do |c|
   c.switch [:s, :show]
 
   c.action do |_global_options, options, _args|
-    LifxDash::Configuration.new.run(show_config: options["show"])
+    if options["show"]
+      CONFIG.show
+    else
+      CONFIG.configure
+    end
   end
 end
 
@@ -38,7 +42,7 @@ 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."
 command :snoop do |c|
   c.desc "Network Interface"
-  c.default_value config_options["iface"] || "en0"
+  c.default_value CONFIG["iface"] || "en0"
   c.flag [:i, :iface]
 
   c.action do |_global_options, options, _args|
@@ -61,30 +65,30 @@ overrride this location."
 command :monitor do |c|
 
   c.desc "Dash button MAC address"
-  c.default_value config_options["mac-address"]
+  c.default_value CONFIG["mac-address"]
   c.flag [:m, :"mac-address"]
 
   c.desc "LIFX HTTP API Token"
-  c.default_value config_options["token"]
+  c.default_value CONFIG["token"]
   c.flag [:t, :token]
 
   c.desc "LIFX Bulb Selector"
-  c.default_value config_options["selector"] || "all"
+  c.default_value CONFIG["selector"] || "all"
   c.flag [:s, :selector]
 
   c.desc "Network Interface"
-  c.default_value config_options["iface"] || "en0"
+  c.default_value CONFIG["iface"] || "en0"
   c.flag [:i, :iface]
 
   c.desc "Log file location (when running as a daemon)"
-  c.default_value config_options["log-file"] || LifxDash::Daemonizer::LOG_FILE
+  c.default_value CONFIG["log-file"] || LifxDash::Daemonizer::LOG_FILE
   c.flag [:l, :"log-file"]
 
   c.desc "Dameonize the monitor process"
   c.switch [:d, :daemonize]
 
   c.action do |_global_options, options, _args|
-    help_now!("a valid Dash button MAC address option (-m) is required: use `lifx_dash snoop #{options["iface"]}` to find it") unless options["mac-address"]
+    help_now!("a valid Dash button MAC address option (-m) is required: use `lifx_dash snoop -i #{options["iface"]}` to find it") unless options["mac-address"]
     help_now!("a valid LIFX API Token option (-t) is required: get one from https://cloud.lifx.com/settings") unless options["token"]
 
     if options["daemonize"]

data/lib/lifx_dash/configuration.rb

@@ -3,8 +3,8 @@ require "yaml"
 module LifxDash
   class Configuration
 
-    CONFIG_FILE    = File.join(ENV["HOME"], ".lifx_dash.rc.yml")
-    OPTION_PROMPTS = {
+    CONFIG_FILE_NAME = ".lifx_dash.rc.yml"
+    OPTION_PROMPTS   = {
       "iface"       => "Network interface identifier e.g. en0 (choose from ifconfig -l)",
       "token"       => "LIFX API token (get a free personal token at cloud.lifx.com)",
       "mac-address" => "Dash button MAC address (use lifx_dash snoop to find it)",
@@ -12,26 +12,17 @@ module LifxDash
       "log-file"    => "Log file location (when running as a daemon)"
     }
 
-    def self.load
-      if File.exist?(CONFIG_FILE)
-        YAML.load_file(CONFIG_FILE)
-      else
-        {}
-      end
-    end
-
-    def run(show_config: false)
-      # decide to show config or start configuring
-      show_config ? show : configure
+    def [](key)
+      config_options[key]
     end
 
     def show
-      if File.exist?(CONFIG_FILE)
-        puts "Configuration file at #{CONFIG_FILE} ...\n\n"
-        puts File.read(CONFIG_FILE)
+      if File.exist?(config_file)
+        puts "Configuration file at #{config_file} ...\n\n"
+        puts File.read(config_file)
         puts "\nChange these options with `lifx_dash config`"
       else
-        puts "No configuration file exists at #{CONFIG_FILE}"
+        puts "No configuration file exists at #{config_file}"
       end
     end
 
@@ -42,10 +33,37 @@ module LifxDash
       if user_options.values.all?(&:nil?)
         puts "\nNo options set, configuration is unchanged"
       else
-        File.open(CONFIG_FILE, "w") do |file|
+        File.open(config_file, "w") do |file|
           YAML::dump(user_options, file)
         end
-        puts "\nConfiguration saved to #{CONFIG_FILE}"
+        puts "\nConfiguration saved to #{config_file}"
+      end
+    end
+
+    private
+
+    def config_file
+      @config_file ||= begin
+        home_dir = ENV["HOME"]
+
+        # when running as sudo on linux, use the sudo users' home dir
+        if platform == :linux &&
+             ENV["SUDO_USER"] &&
+             File.exist?("/home/#{ENV["SUDO_USER"]}")
+          home_dir = "/home/#{ENV["SUDO_USER"]}"
+        end
+
+        File.join(home_dir, CONFIG_FILE_NAME)
+      end
+    end
+
+    def config_options
+      @config_options ||= begin
+        if File.exist?(config_file)
+          YAML.load_file(config_file)
+        else
+          {}
+        end
       end
     end
 
@@ -56,6 +74,19 @@ module LifxDash
       end
     end
 
+    def platform
+      case RbConfig::CONFIG['host_os']
+      when /linux/
+        :linux
+      when /darwin/
+        :mac
+      when /(win|w)32/
+        :windows
+      else
+        :unknown
+      end
+    end
+
     def parse_user_input(str)
       # handle empty strings
       if str.empty?

data/lib/lifx_dash/version.rb

@@ -1,3 +1,3 @@
 module LifxDash
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lifx_dash.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
 
   # non-gem dependecies
   spec.required_ruby_version = ">= 2.0.0"
+  spec.requirements << 'libpcap'
   spec.requirements << 'an Amazon Dash button'
   spec.requirements << 'one or more LIFX bulbs'
   spec.requirements << 'root access'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_dash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -229,6 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
+- libpcap
 - an Amazon Dash button
 - one or more LIFX bulbs
 - root access