whipped-cream 0.1.1 → 0.2.0.beta1

data/.travis.yml

@@ -6,3 +6,6 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq avahi-daemon libavahi-compat-libdnssd-dev

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+## 0.2.0
+
+* Broadcast and discover Whipped Cream servers using mDNS (@rringler)
+* Improve button functionality (@rringler)
+* Support starting plugins with or without an `.rb` extension (@rringler)
+
 ## 0.1.1
 
-* Validate GPIO pin numbers (@rringer)
+* Validate GPIO pin numbers (@rringler)
 
 ## 0.1.0
 

data/lib/whipped-cream/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'dnssd'
 
 module WhippedCream
   # The CLI gets invoked from the binary, and encapsulates all user interaction
@@ -47,9 +48,58 @@ module WhippedCream
       server.start
     end
 
+    desc "discover", "Discovers any whipped-cream servers on the local network"
+    def discover
+      services = browse_services('_whipped-cream._tcp.')
+
+      services.select { |_, service| service.flags.add? }.each do |_, service|
+        host = resolve_service(service)
+
+        puts "#{host[:address]}:#{host[:port]}\t#{host[:name]}"
+      end
+    end
+
     no_tasks do
       def resolve_plugin(name)
-        name # TODO: resolve name to filename
+        name += '.rb' unless name.split('.').last == 'rb'
+        name
+      end
+
+      def browse_services(service_type)
+        services = {}
+
+        DNSSD::Service.new.browse(service_type) do |reply|
+          services[reply.fullname] = reply
+          break unless reply.flags.more_coming?
+        end
+
+        services
+      end
+
+      def resolve_service(service)
+        host = {}
+
+        DNSSD::Service.new.resolve(service) do |reply|
+          address = get_ipv4_address(reply)
+
+          host[:name]    = "#{reply.name}"
+          host[:address] = "#{address}"
+          host[:port]    = "#{reply.port}"
+          break unless reply.flags.more_coming?
+        end
+
+        host
+      end
+
+      def get_ipv4_address(reply)
+        address = nil
+
+        DNSSD::Service.new.getaddrinfo(reply.target, 1) do |addrinfo|
+          address = addrinfo.address
+          break unless addrinfo.flags.more_coming?
+        end
+
+        address
       end
     end
   end

data/lib/whipped-cream/deployer.rb

@@ -55,6 +55,12 @@ module WhippedCream
              time sudo apt-get install ruby1.9.3 -y)
         fi
 
+        dpkg --status avahi-daemon > /dev/null ||
+          (time sudo apt-get update &&
+           time sudo apt-get install avahi-daemon &&
+           time sudo apt-get install libavahi-compat-libdnssd-dev &&
+           time sudo insserv avahi-daemon)
+
         which whipped-cream ||
           time sudo gem install whipped-cream --no-ri --no-rdoc --pre
 

data/lib/whipped-cream/runner.rb

@@ -31,6 +31,10 @@ module WhippedCream
       @pins ||= {}
     end
 
+    def read_pin(pin)
+      pin.read.zero? ? :off : :on
+    end
+
     private
 
     def configure
@@ -65,7 +69,7 @@ module WhippedCream
       define_singleton_method sensor.id do
         pin = pins[sensor.id]
 
-        pin.read == 1 ? sensor.high : sensor.low
+        read_pin(pin) == :on ? sensor.high : sensor.low
       end
     end
 
@@ -79,8 +83,8 @@ module WhippedCream
       plugin.switches.each do |switch|
         create_pin switch, direction: :out
 
-        define_singleton_method switch.id do
-          toggle_pin(pins[switch.id])
+        define_singleton_method switch.id do |state|
+          set_pin(pins[switch.id], state)
         end
       end
     end
@@ -94,20 +98,18 @@ module WhippedCream
     end
 
     def tap_pin(pin)
-      pin.on
+      set_pin(pin, :on)
 
       Thread.new {
         sleep 0.25
-        pin.off
+        set_pin(pin, :off)
       }
     end
 
-    def toggle_pin(pin)
-      if pin.read.nonzero?
-        pin.off
-      else
-        pin.on
-      end
+    def set_pin(pin, state)
+      return if read_pin(pin) == state
+
+      pin.send(state)
     end
   end
 end

data/lib/whipped-cream/server.rb

@@ -1,4 +1,5 @@
 require 'rack'
+require 'dnssd'
 
 module WhippedCream
   # A server handles building a plugin/runner and starting a web server
@@ -14,6 +15,7 @@ module WhippedCream
       ensure_routes_built
       ensure_runner_started
 
+      register_server
       start_web
     end
 
@@ -47,6 +49,17 @@ module WhippedCream
       Rack::Server.start rack_options
     end
 
+    def register_server
+      name = runner.name || "<none>"
+      service = "_whipped-cream._tcp"
+      domain = nil
+      port = rack_options[:Port]
+
+      DNSSD.register(name, service, domain, port) do |reply|
+        raise "Unable to register web server" unless reply.flags.add?
+      end
+    end
+
     def build_routes
       build_button_routes
       build_switch_routes
@@ -63,8 +76,8 @@ module WhippedCream
 
     def build_switch_routes
       plugin.switches.each do |switch|
-        web.get "/#{switch.id}" do
-          runner.send switch.id
+        web.post "/#{switch.id}" do
+          runner.send switch.id, params[:state]
           redirect to('/')
         end
       end

data/lib/whipped-cream/version.rb

@@ -1,3 +1,3 @@
 module WhippedCream
-  VERSION = "0.1.1"
+  VERSION = "0.2.0.beta1"
 end

data/lib/whipped-cream/views/switch.erb

@@ -1,7 +1,17 @@
 <div class="item">
   <h2><%= control.name %></h2>
-  <p><%= runner.pins[control.id].read.nonzero? ? "On" : "Off" %></p>
-  <form action="/<%= control.id %>" method="get">
-    <input type="submit" value="<%= runner.pins[control.id].read.nonzero? ? "Off" : "On" %>">
+  <% pin = runner.pins[control.id] %>
+  <% pin_state = runner.read_pin(pin) %>
+  <p><%= pin_state.to_s.capitalize %></p>
+  <form action="/<%= control.id %>" method="post">
+    <input type="radio"
+           name="state"
+           value="on"
+           <%= "checked" if pin_state == :on %>> On <br />
+    <input type="radio"
+           name="state"
+           value="off"
+           <%= "checked" if pin_state == :off %>> Off <br />
+    <input type="submit" value="Submit">
   </form>
 </div>

data/spec/lib/whipped-cream/cli_spec.rb

@@ -7,7 +7,7 @@ describe WhippedCream::CLI do
   subject { cli }
   let(:cli) { described_class.new }
 
-  let(:plugin_filename) { File.join(tmpdir, "garage.rb") }
+  let(:plugin_filename) { File.join(tmpdir, "garage") }
   let(:plugin_string) {
     <<-PLUGIN
         name "Garage"
@@ -19,7 +19,7 @@ describe WhippedCream::CLI do
   let(:tmpdir) { Dir.mktmpdir }
 
   before do
-    File.open(plugin_filename, 'w') { |file| file.write plugin_string }
+    File.open("#{plugin_filename}.rb", 'w') { |file| file.write plugin_string }
   end
 
   after do
@@ -48,11 +48,22 @@ describe WhippedCream::CLI do
   describe "#start" do
     let(:server_double) { double(WhippedCream::Server) }
 
-    it "starts a server for the plugin" do
-      expect(WhippedCream::Server).to receive(:new) { server_double }
-      expect(server_double).to receive(:start)
+    context "with a filename and extension" do
+      it "starts a server for the plugin" do
+        expect(WhippedCream::Server).to receive(:new) { server_double }
+        expect(server_double).to receive(:start)
+
+        cli.start("#{plugin_filename}.rb")
+      end
+    end
 
-      cli.start(plugin_filename)
+    context "with just a filename and no extension" do
+      it "starts a server for the plugin" do
+        expect(WhippedCream::Server).to receive(:new) { server_double }
+        expect(server_double).to receive(:start)
+
+        cli.start(plugin_filename)
+      end
     end
 
     context "with --daemonize" do
@@ -83,6 +94,36 @@ describe WhippedCream::CLI do
     end
   end
 
+  describe "#discover" do
+    let(:service_type) { "_whipped-cream._tcp." }
+    let(:services_double) {
+      { "Test._whipped-cream._tcp.local." => double("reply") }
+    }
+    let(:host_double) {
+      { name: "Test",
+        address: "192.168.0.100",
+        port: "8080" }
+    }
+    let(:output_string) {
+      "#{host_double[:address]}:#{host_double[:port]}\t#{host_double[:name]}"
+    }
+
+    it "displays the host information for any running servers" do
+      cli.should_receive(:browse_services)
+         .with(service_type)
+         .and_return(services_double)
+
+      cli.should_receive(:resolve_service)
+         .and_return(host_double)
+
+      services_double.should_receive(:select).and_return(services_double)
+
+      expect(cli).to receive(:puts).with(output_string)
+
+      cli.discover
+    end
+  end
+
   describe "#usage" do
     it "displays a banner and help" do
       expect(cli).to receive(:puts).exactly(2).times
@@ -91,4 +132,42 @@ describe WhippedCream::CLI do
       cli.usage
     end
   end
+
+  describe "#browse_services" do
+    let(:service_type) { '_whipped-cream._tcp.' }
+
+    it "should call DNSSD::Services#browse" do
+      DNSSD::Service.any_instance
+                    .should_receive(:browse)
+                    .with(service_type)
+
+      cli.browse_services(service_type)
+    end
+  end
+
+  describe "#resolve_service" do
+    let(:service_double) { double("service") }
+
+    it "should call DNSSD::Services#resolve" do
+      DNSSD::Service.any_instance
+                    .should_receive(:resolve)
+                    .with(service_double)
+
+      cli.resolve_service(service_double)
+    end
+  end
+
+  describe "#get_ipv4_address" do
+    let(:reply_double) { double("dnssd_reply") }
+
+    it "should call DNSSD::Services#getaddrinfo" do
+      reply_double.stub(:target).and_return("test_host")
+
+      DNSSD::Service.any_instance
+                    .should_receive(:getaddrinfo)
+                    .with(reply_double.target, 1)
+
+      cli.get_ipv4_address(reply_double)
+    end
+  end
 end

data/spec/lib/whipped-cream/runner_spec.rb

@@ -29,9 +29,7 @@ describe WhippedCream::Runner do
     it "defines an open_close method that taps the pin" do
       pin = runner.pins[:open_close]
 
-      expect(pin).to receive(:on)
-      expect(runner).to receive(:sleep).with(0.25)
-      expect(pin).to receive(:off)
+      expect(runner).to receive(:tap_pin).with(pin).and_call_original
 
       runner.open_close.join
     end
@@ -96,13 +94,59 @@ describe WhippedCream::Runner do
     it "defines a light method that switches the pin on and off" do
       pin = runner.pins[:light]
 
-      expect(pin.read).to eq(0)
-      runner.light
-      expect(pin.read).to eq(1)
-      runner.light
-      expect(pin.read).to eq(0)
-      runner.light
-      expect(pin.read).to eq(1)
+      expect(runner.read_pin(pin)).to eq(:off)
+      runner.light(:on)
+      expect(runner.read_pin(pin)).to eq(:on)
+      runner.light(:off)
+      expect(runner.read_pin(pin)).to eq(:off)
+      runner.light(:on)
+      expect(runner.read_pin(pin)).to eq(:on)
+    end
+  end
+
+  describe "#tap_pin" do
+    let(:plugin) {
+      WhippedCream::Plugin.build do
+        button "Open/Close", pin: 4
+      end
+    }
+
+    it "turns the pin on momentarily and then turns it off" do
+      pin = runner.pins[:garage]
+
+      expect(runner).to receive(:set_pin).with(pin, :on)
+      expect(runner).to receive(:sleep).with(0.25)
+      expect(runner).to receive(:set_pin).with(pin, :off)
+
+      runner.send(:tap_pin, pin).join
+    end
+  end
+
+  describe "#set_pin" do
+    let(:plugin) {
+      WhippedCream::Plugin.build do
+        switch "Light", pin: 18
+      end
+    }
+    let(:pin) { runner.pins[:light] }
+    before(:each) { runner.send(:set_pin, pin, :off) }
+
+    it "orders the desired pin state when different from the current state" do
+      expect(pin).to receive(:on).and_call_original
+      runner.send(:set_pin, pin, :on)
+
+      expect(pin).to receive(:off)
+      runner.send(:set_pin, pin, :off)
+    end
+
+    it "does nothing when the ordered pin state matches the current state" do
+      expect(pin).not_to receive(:off)
+      runner.send(:set_pin, pin, :off)
+
+      runner.send(:set_pin, pin, :on)
+
+      expect(pin).not_to receive(:on)
+      runner.send(:set_pin, pin, :on)
     end
   end
 end

data/spec/lib/whipped-cream/server_spec.rb

@@ -51,7 +51,7 @@ describe WhippedCream::Server do
     before { server.start }
 
     it "creates a switch route" do
-      expect(server.web.routes['GET'].find { |route|
+      expect(server.web.routes['POST'].find { |route|
         route.first.match('/light')
       }).to be_true
     end
@@ -66,6 +66,17 @@ describe WhippedCream::Server do
       server.start
     end
 
+    it "registers the server via mDNS" do
+      expect(DNSSD).to receive(:register).with(
+        server.runner.name || "<none>",
+        '_whipped-cream._tcp',
+        nil,
+        server.options.fetch(:port, 8080)
+      )
+
+      server.start
+    end
+
     context "with daemonize: true" do
       let(:options) {
         { daemonize: true }

data/whipped-cream.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'pi_piper'
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'dnssd'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'cane'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: whipped-cream
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Justin Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-scp
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dnssd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -269,9 +285,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23