whipped-cream 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.1
+
+* Validate GPIO pin numbers (@rringer)
+
 ## 0.1.0
 
 * Support deploying to a Pi with RVM installed (@shobhitic)

data/README.md

@@ -160,3 +160,7 @@ end
 Web UI designed by [Ashton Harris](http://ashtonharris.me).
 
 Logo designed by [Jeff Bloch](http://www.redbubble.com/people/jabbtees).
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/justincampbell/whipped-cream/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -9,7 +9,9 @@ task default: :ci
 desc "Run all test suites"
 task ci: [:spec, :cane]
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |rspec|
+  rspec.rspec_opts = '--tag ~acceptance'
+end
 
 Cane::RakeTask.new do |cane|
   cane.add_threshold 'coverage/.last_run.json', :>=, 90
@@ -17,7 +19,33 @@ end
 
 desc "Test deploying the demo plugin to a Vagrant box"
 task :vagrant do
-  system 'vagrant destroy -f'
-  system 'vagrant up'
-  system 'bin/whipped-cream deploy demo.rb 127.0.0.1:2222'
+  [
+    ['vagrant up',
+     'Bringing up Debian Wheezy Vagrant box'],
+    ['bin/whipped-cream deploy demo.rb 127.0.0.1:2222',
+     'Performing initial deploy'],
+    ['bin/whipped-cream deploy demo.rb 127.0.0.1:2222',
+     'Performing subsequent deploy'],
+    ['REMOTE_URL="http://127.0.0.1:8080" rspec --tag acceptance',
+     'Running acceptance tests against Vagrant box']
+  ].each do |command, description|
+    puts yellow(description)
+    puts cyan(?` + command + ?`)
+
+    unless system(command)
+      raise "Command failed: '#{command}'"
+    end
+  end
+end
+
+def yellow(text)
+  color(3, text)
+end
+
+def cyan(text)
+  color(6, text)
+end
+
+def color(number, text)
+  `tput setaf #{number}` + text + `tput sgr0`
 end

data/Vagrantfile

@@ -2,8 +2,10 @@ Vagrant.configure('2') do |config|
   config.vm.box = 'debian-wheezy'
   config.vm.box_url = 'https://dl.dropboxusercontent.com/u/86066173/debian-wheezy.box'
 
-  [80].each do |port|
-    config.vm.network "forwarded_port", guest: port, host: port
+  {
+    80 => 8080
+  }.each do |guest, host|
+    config.vm.network :forwarded_port, guest: guest, host: host
   end
 
   config.vm.provision :shell, inline: <<-SCRIPT

data/demo.rb

@@ -1,10 +1,10 @@
 name "Demo"
 
-button "Open/Close", pin: 1
+button "Open/Close", pin: 4
 
-sensor "Door", pin: 2, high: "Open", low: "Closed"
+sensor "Door", pin: 17, high: "Open", low: "Closed"
 
-switch "Light", pin: 3
+switch "Light", pin: 18
 
 sensor "Ruby Version" do
   RUBY_VERSION

data/lib/whipped-cream/button.rb

@@ -7,6 +7,10 @@ module WhippedCream
     attr_reader :name, :pin, :block
 
     def initialize(name, options = {})
+      raise "Invalid pin.  The pin must be one of "\
+            "the Raspberry Pi's valid GPIO pins: "\
+            "#{VALID_GPIO_PINS}" unless VALID_GPIO_PINS.include?(options[:pin])
+
       @name = name
       @pin = options[:pin]
       @block = options[:block]

data/lib/whipped-cream/control.rb

@@ -1,6 +1,8 @@
 module WhippedCream
   # An abstract class for controls to inherit from
   class Control
+    VALID_GPIO_PINS = [4, 17, 18, 22, 23, 24, 25, 27]
+
     def id
       name.downcase.gsub(/[^\w]+/, '_').gsub(/^_|_$/, '').to_sym
     end

data/lib/whipped-cream/sensor.rb

@@ -8,6 +8,13 @@ module WhippedCream
     attr_reader :name, :pin, :low, :high, :on_low, :on_high, :block
 
     def initialize(name, options = {}, &block)
+      # Pushing nil onto VALID_GPIO_PINS to allow a pinless sensor
+      raise "Invalid pin.  The pin must be one of "\
+            "the Raspberry Pi's valid GPIO pins: "\
+            "#{VALID_GPIO_PINS}" unless VALID_GPIO_PINS.dup
+                                                       .push(nil)
+                                                       .include?(options[:pin])
+
       @name = name
       @pin = options[:pin]
       @low = options[:low]

data/lib/whipped-cream/switch.rb

@@ -4,6 +4,10 @@ module WhippedCream
     attr_reader :name, :pin
 
     def initialize(name, options = {})
+      raise "Invalid pin.  The pin must be one of "\
+            "the Raspberry Pi's valid GPIO pins: "\
+            "#{VALID_GPIO_PINS}" unless VALID_GPIO_PINS.include?(options[:pin])
+
       @name = name
       @pin = options[:pin]
     end

data/lib/whipped-cream/version.rb

@@ -1,3 +1,3 @@
 module WhippedCream
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/acceptance_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'faraday'
+require 'timeout'
+
+describe 'Whipped Cream', :acceptance do
+  let(:http) { Faraday.new(url: url) }
+  let(:request_method) { :get }
+  let(:response) { http.send(request_method, path) }
+
+  let(:remote_url) { ENV['REMOTE_URL'] }
+  let(:url) { remote_url || 'http://127.0.0.1:8080' }
+  let(:path) { '' }
+
+  around do |example|
+    start_server unless remote_url
+    wait_for_server(1)
+    example.yield
+    kill_server unless remote_url
+  end
+
+  describe 'GET /' do
+    let(:path) { '/' }
+
+    it "succeeds" do
+      expect(response).to be_success
+    end
+  end
+end
+
+def start_server
+  `bin/whipped-cream start demo.rb --daemonize`
+end
+
+def kill_server
+  `pkill -9 -f whipped-cream`
+end
+
+def wait_for_server(duration)
+  Timeout.timeout(duration) do
+    begin
+      http.get
+    rescue Faraday::Error::ConnectionFailed
+      sleep 0.01
+      retry
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ describe WhippedCream::Builder do
     <<-PLUGIN
         name "Garage"
 
-        button "Open/Close", pin: 1
+        button "Open/Close", pin: 4
     PLUGIN
   }
 
@@ -89,7 +89,7 @@ describe WhippedCream::Builder do
     context "with a button" do
       let(:plugin) {
         described_class.build do
-          button "Open/Close", pin: 1 do
+          button "Open/Close", pin: 4 do
             :tap
           end
         end
@@ -101,7 +101,7 @@ describe WhippedCream::Builder do
         button = plugin.buttons.first
 
         expect(button.name).to eq("Open/Close")
-        expect(button.pin).to eq(1)
+        expect(button.pin).to eq(4)
       end
     end
   end
@@ -115,7 +115,7 @@ describe WhippedCream::Builder do
       let(:plugin) {
         described_class.build do
           sensor "Door",
-            pin: 2,
+            pin: 17,
             low: "Closed",
             high: "Open",
             on_high: :door_opened
@@ -128,7 +128,7 @@ describe WhippedCream::Builder do
         sensor = plugin.sensors.first
 
         expect(sensor.name).to eq("Door")
-        expect(sensor.pin).to eq(2)
+        expect(sensor.pin).to eq(17)
         expect(sensor.low).to eq("Closed")
         expect(sensor.high).to eq("Open")
         expect(sensor.on_high).to eq(:door_opened)
@@ -145,7 +145,7 @@ describe WhippedCream::Builder do
     context "with a switch" do
       let(:plugin) {
         described_class.build do
-          switch "Light", pin: 3
+          switch "Light", pin: 18
         end
       }
 
@@ -155,7 +155,7 @@ describe WhippedCream::Builder do
         switch = plugin.switches.first
 
         expect(switch.name).to eq("Light")
-        expect(switch.pin).to eq(3)
+        expect(switch.pin).to eq(18)
       end
     end
   end

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

@@ -1,13 +1,23 @@
 require 'spec_helper'
 
 describe WhippedCream::Button do
-  subject(:button) { described_class.new(name, pin: pin, block: block) }
+  context 'valid button' do
+    subject(:button) { described_class.new(name, pin: valid_pin, block: block) }
 
-  let(:name) { "Open/Close" }
-  let(:pin) { nil }
-  let(:block) { nil }
+    let(:name) { "Open/Close" }
+    let(:valid_pin) { 4 }
+    let(:block) { nil }
 
-  its(:name) { should eq(name) }
-  its(:id) { should eq(:open_close) }
-  its(:type) { should eq(:button) }
+    its(:name) { should eq(name) }
+    its(:id) { should eq(:open_close) }
+    its(:type) { should eq(:button) }
+  end
+
+  context 'invalid button' do
+    let(:invalid_pin) { 3 }
+
+    it 'should raise an error on initialization' do
+      expect { described_class.new(name, pin: invalid_pin) }.to raise_error
+    end
+  end
 end

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

@@ -12,7 +12,7 @@ describe WhippedCream::CLI do
     <<-PLUGIN
         name "Garage"
 
-        button "Open/Close", pin: 1
+        button "Open/Close", pin: 4
     PLUGIN
   }
   let(:pi_address) { "192.168.0.123" }

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

@@ -39,7 +39,7 @@ describe WhippedCream::Plugin do
 
   context "with a button" do
     before do
-      plugin.controls << WhippedCream::Button.new("Open/Close")
+      plugin.controls << WhippedCream::Button.new("Open/Close", pin: 4)
     end
 
     its(:controls) { should_not be_empty }

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

@@ -14,7 +14,7 @@ describe WhippedCream::Runner do
   context "with a button" do
     let(:plugin) {
       WhippedCream::Plugin.build do
-        button "Open/Close", pin: 1
+        button "Open/Close", pin: 4
       end
     }
 
@@ -22,7 +22,7 @@ describe WhippedCream::Runner do
       pin = runner.pins[:open_close]
 
       expect(pin).to be_a(PiPiper::Pin)
-      expect(pin.pin).to eq(1)
+      expect(pin.pin).to eq(4)
       expect(pin.direction).to eq(:out)
     end
 
@@ -40,7 +40,7 @@ describe WhippedCream::Runner do
   context "with a sensor" do
     let(:plugin) {
       WhippedCream::Plugin.build do
-        sensor "Door", pin: 2, low: "Open", high: "Closed"
+        sensor "Door", pin: 17, low: "Open", high: "Closed"
       end
     }
 
@@ -48,7 +48,7 @@ describe WhippedCream::Runner do
       pin = runner.pins[:door]
 
       expect(pin).to be_a(PiPiper::Pin)
-      expect(pin.pin).to eq(2)
+      expect(pin.pin).to eq(17)
       expect(pin.direction).to eq(:in)
     end
 
@@ -81,7 +81,7 @@ describe WhippedCream::Runner do
   context "with a switch" do
     let(:plugin) {
       WhippedCream::Plugin.build do
-        switch "Light", pin: 3
+        switch "Light", pin: 18
       end
     }
 
@@ -89,7 +89,7 @@ describe WhippedCream::Runner do
       pin = runner.pins[:light]
 
       expect(pin).to be_a(PiPiper::Pin)
-      expect(pin.pin).to eq(3)
+      expect(pin.pin).to eq(18)
       expect(pin.direction).to eq(:out)
     end
 

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

@@ -1,27 +1,48 @@
 require 'spec_helper'
 
 describe WhippedCream::Sensor do
-  subject(:sensor) { described_class.new(name, options, &block) }
-
-  let(:name) { "Door" }
-  let(:options) {
-    {
-      pin: 2,
-      high: "Open",
-      low: "Closed",
-      on_high: :door_opened
+  context 'valid sensor' do
+    subject(:sensor) { described_class.new(name, valid_options, &block) }
+
+    let(:name) { "Door" }
+    let(:valid_options) {
+      {
+        pin: 17,
+        high: "Open",
+        low: "Closed",
+        on_high: :door_opened
+      }
     }
-  }
-  let(:block) { nil }
+    let(:block) { nil }
+
+    its(:name) { should eq(name) }
+    its(:id) { should eq(:door) }
 
-  its(:name) { should eq(name) }
-  its(:id) { should eq(:door) }
+    its(:pin) { should eq(17) }
 
-  its(:pin) { should eq(2) }
+    its(:high) { should eq("Open") }
+    its(:low) { should eq("Closed") }
 
-  its(:high) { should eq("Open") }
-  its(:low) { should eq("Closed") }
+    its(:on_high) { should eq(:door_opened) }
+    its(:on_low) { should be_nil }
+  end
+
+  context 'invalid sensor' do
+    let(:name) { "Door" }
+    let(:invalid_options) {
+      {
+        pin: 3,
+        high: "Open",
+        low: "Closed",
+        on_high: :door_opened
+      }
+    }
+    let(:block) { nil }
 
-  its(:on_high) { should eq(:door_opened) }
-  its(:on_low) { should be_nil }
+    it 'should raise an error on initialization' do
+      expect {
+        described_class.new(name, invalid_options, &block)
+      }.to raise_error
+    end
+  end
 end

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

@@ -5,7 +5,7 @@ describe WhippedCream::Server do
 
   let(:plugin) {
     WhippedCream::Plugin.build do
-      button "Open/Close", pin: 1
+      button "Open/Close", pin: 4
     end
   }
 
@@ -28,7 +28,7 @@ describe WhippedCream::Server do
   context "with a button" do
     let(:plugin) {
       WhippedCream::Plugin.build do
-        button "Open/Close", pin: 1
+        button "Open/Close", pin: 4
       end
     }
 
@@ -44,7 +44,7 @@ describe WhippedCream::Server do
   context "with a switch" do
     let(:plugin) {
       WhippedCream::Plugin.build do
-        switch "Light", pin: 1
+        switch "Light", pin: 18
       end
     }
 

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

@@ -1,13 +1,23 @@
 require 'spec_helper'
 
 describe WhippedCream::Switch do
-  subject(:switch) { described_class.new(name, pin: pin) }
+  context 'valid switch' do
+    subject(:switch) { described_class.new(name, pin: valid_pin) }
 
-  let(:name) { "Light" }
-  let(:pin) { 3 }
+    let(:name) { "Light" }
+    let(:valid_pin) { 18 }
 
-  its(:name) { should eq(name) }
-  its(:id) { should eq(:light) }
-  its(:type) { should eq(:switch) }
-  its(:pin) { should eq(3) }
+    its(:name) { should eq(name) }
+    its(:id) { should eq(:light) }
+    its(:type) { should eq(:switch) }
+    its(:pin) { should eq(18) }
+  end
+
+  context 'invalid switch' do
+    let(:invalid_pin) { 3 }
+
+    it 'should raise an error upon initialization' do
+      expect { described_class.new(name, pin: invalid_pin) }.to raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -20,4 +20,5 @@ RSpec.configure do |config|
   end
 
   config.order = :random
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

data/whipped-cream.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'faraday'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whipped-cream
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-scp
@@ -123,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +237,7 @@ files:
 - lib/whipped-cream/views/switch.erb
 - lib/whipped-cream/web.rb
 - logo.png
+- spec/acceptance_spec.rb
 - spec/lib/whipped-cream/builder_spec.rb
 - spec/lib/whipped-cream/button_spec.rb
 - spec/lib/whipped-cream/cli_spec.rb
@@ -262,6 +279,7 @@ signing_key:
 specification_version: 3
 summary: HTTP topping for Raspberry Pi
 test_files:
+- spec/acceptance_spec.rb
 - spec/lib/whipped-cream/builder_spec.rb
 - spec/lib/whipped-cream/button_spec.rb
 - spec/lib/whipped-cream/cli_spec.rb
@@ -273,3 +291,4 @@ test_files:
 - spec/lib/whipped-cream/switch_spec.rb
 - spec/lib/whipped-cream_spec.rb
 - spec/spec_helper.rb
+has_rdoc: