aframe-switch 0.0.1

data/README.rdoc

@@ -0,0 +1,41 @@
+= Switch
+
+Set and retrieve an arbitrary switch flag via GET and POST. Requires Rack.
+
+== Use
+
+    Switch.new("light", { :url_namespace => "/switch", :file_location => "/tmp" })
+
+== Functionality
+
+    This will expose: 
+
+    A route to get the current state of the switch:
+    /switch/light
+
+    A route for flicking the switch to ON:
+    /switch/light/on
+
+    A route for flicking the switch to OFF:
+    /switch/light/off
+
+== Switch state possibilities
+
+    The switch state is stored in a file:
+    /tmp/light_switch
+
+    File doesn't exist
+        switch is on
+    File contains ON
+        switch is on
+    File contains OFF
+        server is off
+
+== An example config.ru file for mounting alongside Padrino:
+
+    require ::File.dirname(__FILE__) + '/config/boot.rb'
+    require 'switch'
+    run Rack::Cascade.new([
+        Switch.new("aframe_webapp_status"), 
+        Padrino.application,
+    ])

data/Rakefile

@@ -0,0 +1,18 @@
+require "rubygems"
+require "bundler"
+Bundler.require
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require "mg"
+  MG.new("aframe-switch.gemspec")
+rescue LoadError
+  "Couldn't load mg tasks"
+end

data/aframe-switch.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = "aframe-switch"
+  s.version  = "0.0.1"
+  s.date     = "2014-10-29"
+  s.summary  = "Set and retrieve an arbitrary Rack switch."
+  s.description  = "Set and retrieve an arbitrary switch flag via GET and POST."
+  s.homepage = "http://github.com/Allinthedata/switch"
+  s.email    = "hi@aframe.com"
+  s.authors  = ["mikesten"]
+  s.has_rdoc = false
+  s.files    = %w[
+README.rdoc
+Rakefile
+aframe-switch.gemspec
+lib/switch.rb
+test/switch_test.rb
+]
+  s.add_dependency("rack", [">= 1.2.0"])
+end

data/lib/switch.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+
+require "rack"
+
+class Switch
+  ON_MESSAGE  = "ON"
+  OFF_MESSAGE = "OFF"
+  
+  def initialize app_name, options
+    raise RuntimeError unless app_name
+    defaults  = { :file_location => "/tmp", :url_namespace => "/switch" }
+    @options  = defaults.merge(options)
+    @url_namespace = @options[:url_namespace]
+    @app_name = app_name
+    @file     = File.join(@options[:file_location], "#{@app_name}_switch")
+  end
+
+  def get_switch
+    result = unless File.exist? @file
+      ON_MESSAGE
+    else
+      File.open(@file, 'r').read
+    end
+  end
+
+  def set_switch message
+    File.open(@file, 'w') {|f| f.write(message) }
+  end
+
+  def call(env)
+    request = Rack::Request.new env
+    if request.get?
+      if request.path == "#{@url_namespace}/#{@app_name}"
+        case get_switch
+          when ON_MESSAGE
+            return [200, {}, ["#{@app_name} is #{ON_MESSAGE}"]]
+          when OFF_MESSAGE
+            return [503, {}, ["#{@app_name} is #{OFF_MESSAGE}"]]
+        end
+      end
+    elsif request.post?
+      case request.path
+        when "#{@url_namespace}/#{@app_name}/on"
+          set_switch ON_MESSAGE
+          return [200, {}, ["#{@app_name} set to #{ON_MESSAGE}"]]
+        when "#{@url_namespace}/#{@app_name}/off"
+          set_switch OFF_MESSAGE
+          return [200, {}, ["#{@app_name} set to #{OFF_MESSAGE}"]]
+      end
+    end
+    return [404, {}, "Not found"]
+  end
+end

data/test/switch_test.rb

@@ -0,0 +1,82 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:test)
+
+require File.dirname(__FILE__) + "/../lib/switch"
+
+class SwitchTest < Test::Unit::TestCase
+  def state_file
+    File.dirname(__FILE__) + "/light_switch"
+  end
+
+  def remove_state_file
+    File.delete(state_file) if File.exists?(state_file)
+  end
+
+  def setup
+    remove_state_file
+    @session = Rack::Test::Session.new(Switch.new("light", { :file_location => File.dirname(__FILE__) }))
+  end
+
+  def teardown
+    remove_state_file
+  end
+
+  def test_raises_unless_app_name_is_specified
+    assert_raise_kind_of(RuntimeError) do
+      Rack::Test::Session.new(Switch.new(nil, { :file_location => File.dirname(__FILE__) }))
+    end
+  end
+
+  def test_it_returns_not_found_for_other_urls
+    @session.get   "/another"
+    assert_equal   @session.last_response.status, 404
+    @session.get   "/another/url"
+    assert_equal   @session.last_response.status, 404
+  end
+
+  def test_it_returns_not_found_for_unknown_switch
+    @session.get   "/switch/power"
+    assert_equal   @session.last_response.status, 404
+  end
+
+  def test_it_defaults_to_on
+    @session.get   "/switch/light"
+    assert_equal   @session.last_response.status, 200
+    assert_include @session.last_response.body,   "light is ON"
+  end
+
+  def test_it_respects_passed_url_namespace
+    session = Rack::Test::Session.new(Switch.new("door", { :url_namespace => "/latch", :file_location => File.dirname(__FILE__) }))
+    session.get   "/latch/door"
+    assert_equal   session.last_response.status, 200
+
+    session = Rack::Test::Session.new(Switch.new("door", { :url_namespace => "", :file_location => File.dirname(__FILE__) }))
+    session.get   "/door"
+    assert_equal   session.last_response.status, 200
+  end
+
+  def test_it_writes_state_file_to_specified_location
+    @session.post  "/switch/light/off"
+    assert_equal File.exists?(state_file), true
+  end
+
+  def test_it_can_be_set_to_off
+    @session.post  "/switch/light/off"
+    assert_equal   @session.last_response.status, 200
+
+    @session.get   "/switch/light"
+    assert_equal   @session.last_response.status, 503
+    assert_include @session.last_response.body,   "light is OFF"
+  end
+
+  def test_it_can_be_set_to_on
+    @session.post  "/switch/light/off"
+    @session.post  "/switch/light/on"
+    assert_equal   @session.last_response.status, 200
+
+    @session.get   "/switch/light"
+    assert_equal   @session.last_response.status, 200
+    assert_include @session.last_response.body,   "light is ON"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: aframe-switch
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- mikesten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-10-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  requirement: *id001
+  name: rack
+  prerelease: false
+  type: :runtime
+description: Set and retrieve an arbitrary switch flag via GET and POST.
+email: hi@aframe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- aframe-switch.gemspec
+- lib/switch.rb
+- test/switch_test.rb
+homepage: http://github.com/Allinthedata/switch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Set and retrieve an arbitrary Rack switch.
+test_files: []
+