ambient 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2005 Tom Fakes
+
+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

@@ -0,0 +1,69 @@
+== Ambient: Control your Ambient Orb or Beacon
+
+Ambient version 0.1.0
+
+This package contains Ambient, a package that allows a Ruby program to
+control an Ambient Orb using the Ambient Devices web based API.
+
+== Download
+
+The latest version of Ambient can be found at
+
+* http://rubyforge.org/project/showfiles.php?group_id=753
+
+== Installation
+
+=== GEM Installation
+
+Download and install Ambient with the following.
+
+   gem install --remote ambient
+
+== Online Resources
+
+* http://www.ambientdevices.com/
+* http://www.ambientdevices.com/developer/OrbWDK.pdf
+
+== Prerequisites
+
+* You must own an Ambient Orb or Beacon
+* You must be in the Ambient coverage area
+* You must register your device with Ambient
+* You must have a Premium account
+* You must have your device 'tuned' to the developer channel (which involves 
+  registering *again* to get access)
+
+== Simple Example
+
+  Ambient::Orb.new(:id => 'ABC-DEF-GHI', :color => :red).update
+
+
+== License
+
+Ambient is available under an MIT-style license.
+
+:include: MIT-LICENSE
+
+== Support
+
+The ambient homepage is http://ambient.rubyforge.org.  You can find the Ambient
+RubyForge page at http://rubyforge.org/projects/ambient.
+
+Feel free to submit commits or feature requests.
+
+For other information, feel free to contact me
+mailto:tom@craz8.com.
+
+= Other stuff
+
+Author::   Tom Fakes <tom@craz8.com>
+License::  Copyright 2005 by Tom Fakes.
+           Released under an MIT-style license.  See the MIT-LICENSE file
+           included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/lib/ambient.rb

@@ -0,0 +1,171 @@
+
+require 'net/http'
+require 'rexml/document'
+require 'date'
+
+module Ambient
+
+  #
+  # All Ambient::Orb methods will raise an exception of type AmbientError
+  # if they detect some badness.
+  #
+  class AmbientError < StandardError; end
+
+#
+# = Ambient::Orb
+#
+# The Ambient::Orb methods will check their parameters to avoid making expensive
+# net calls that will fail due to values out of range.  Any error cases will
+# raise an AmbientError exception
+#
+# Example:
+#   Ambient::Orb.new(:id => 'ABC-DEF-GHI', :color => :red).update
+#
+# or:
+#   @my_orb = Ambient::Orb.new(:id => my_id)
+#   @my_orb.color = :blue
+#   @my_orb.update
+#   @my_orb.color = :green
+#   @my_orb.update
+#
+# The second example isn't as useful, since it can take up to 30 minutes for
+# an Orb to actually be updated over the ether.
+
+  class Orb
+
+    @@animations = { 
+            :none => 0, 
+            :very_slow => 1, 
+            :slow => 2, 
+            :medium_slow => 3,
+            :medium => 4, 
+            :medium_fast => 5, 
+            :fast => 6, 
+            :very_fast => 7,
+            :cresendo => 8, 
+            :heartbeat => 9
+    }
+
+    # Colors available for the 'color' property
+    @@colors = {
+			:red => 0,
+			:light_red => 1,
+			:dark_orange => 2,
+			:orange => 3,
+			:light_orange => 4,
+			:dark_yellow => 5,
+			:yellow => 6,
+			:lime_green => 7,
+			:pale_green => 8,
+			:green => 12,
+			:pale_aqua => 15,
+			:aqua => 16,
+			:dark_aqua => 17,
+			:cyan => 18,
+			:dark_cyan => 19,
+			:light_blue => 20,
+			:sky_blue => 21,
+			:blue => 24,
+			:deep_blue => 25,
+			:very_deep_blue => 26,
+			:violet => 27,
+			:purple => 28,
+			:light_purple => 29,
+			:magenta => 30,
+			:deep_magenta => 33,
+			:very_deep_magenta => 35,
+			:white => 36
+    }
+
+    # Orb ID from the bottom of your Orb or Beacon    
+    attr_accessor :id
+    
+    # Color to set the Orb to display
+    attr_accessor :color
+    
+    # Animation to set the Orb to perform
+    attr_accessor :animation
+    
+    # The time and date at which the orb should be updated, set after the update() call
+    attr :update_at
+  
+    AMBIENT_HOST = "myambient.com" #:nodoc: 
+    AMBIENT_PORT = 8080 #:nodoc: 
+    AMBIENT_URL = '/java/my_devices/submitdata.jsp' #:nodoc: 
+      
+    # Sets the color value for the Orb to be set to.  This can either be 
+    # a numeric value between zero and 36, or one of the color symbols,
+    # such as :red, :yellow, :blue
+    def color=(var)
+      if var.kind_of?(Symbol)
+        var = @@colors[var]
+        raise AmbientError, "Color not recognized" unless var
+      end        
+      raise AmbientError, "Color out of range: #{var}" if (var < 0 || var > 36)
+      @color = var
+    end
+    
+    # Sets the animation value for the Orb to be set to.  This value can either
+    # be a numeric value between zero and 9, or one of the animation symbols,
+    # such as :none, :fast, :heartbeat
+    def animation=(var)
+      if var.kind_of?(Symbol)
+        var = @@animations[var]
+        raise AmbientError, "Animation not recognized" unless var
+      end        
+      raise AmbientError, "Animation out of range: #{var}" if (var < 0 || var > 9)
+      @animation = var
+    end
+
+    # The Orb ID is always 11 letters and digits of the form XXX-XXX-XXX.  The
+    # Orb ID is on the bottom of the Ambient Orb and must be registered for
+    # development access on the http://ambientdevices.com web site for the
+    # update to be successful. 
+    def id=(var)
+      if ((var !~ /[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}/) &&
+               (var != nil))
+        raise AmbientError, "ID must be of the form ABC-DEF-GHI:  #{var}" 
+      end
+      @id = var
+    end
+      
+    # Takes a hash of up to three values:
+    #    :id => Orb ID
+    #    :color => Color value
+    #    :animation => Animation value
+    def initialize(options = {})
+      self.color = options[:color] || 0
+      self.animation = options[:animation] || 0
+      self.id = options[:id] || nil
+    end
+    
+    # Make the HTTP call to the Ambient Devices web site to cause your
+    # orb to be updated.  The Orb ID supplied must be registered with Ambient
+    # Devices as using the developer channel for this call to succeed.
+    # 
+    # Returns self, to allow this to work
+    # 
+    # * Ambient::Orb.new(:id => 'ABC-DEF-GHI', :color => :red).update.update_at
+    def update
+      raise AmbientError, "No ID set for Ambient Orb" if id == nil
+      Net::HTTP.start(AMBIENT_HOST, AMBIENT_PORT) do |http|
+        begin
+          response = http.get("#{AMBIENT_URL}?devID=#{id}&anim=#{animation}&color=#{color}")
+        rescue Exception
+          raise AmbientError, "HTTP Get Failed"
+        end
+  
+        xml = REXML::Document.new(response.body)
+        xml.elements.each("//response") do |resp|
+          raise AmbientError, resp.text unless resp.attributes["type"] == "OK"
+        end
+        xml.elements.each("//maxNextUpdate") do |update|
+          @update_at = DateTime::parse(update.text).new_offset(5.0/24.0)
+        end
+      end
+      self
+    end
+    
+  end
+
+end

data/rakefile

@@ -0,0 +1,74 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_NAME        = 'ambient'
+PKG_VERSION     = '0.1.0'
+PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_DESTINATION = ENV["AMBIENT_PKG_DESTINATION"] || "../#{PKG_NAME}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "ambient"
+RUBY_FORGE_USER    = "tomfakes"
+
+PKG_FILES = FileList[
+	'lib/**/*',
+	'test/**/*',
+	'rakefile',
+	'README',
+	'MIT-LICENSE'
+]
+
+$VERBOSE = nil
+TEST_CHANGES_SINCE = Time.now - 600
+
+desc "Run all the tests"
+task :default => [ :test ]
+
+desc "Generate API documentation"
+task :doc => [ :apidoc ]
+
+desc "Run the unit tests in test"
+Rake::TestTask.new("test") { |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+}
+
+desc "Generate documentation for Ambient Library"
+Rake::RDocTask.new("apidoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Ambient Library Documentation"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/*.rb')
+}
+
+# Generate GEM ----------------------------------------------------------------------------
+
+spec = Gem::Specification.new do |s|
+  s.name = 'ambient'
+  s.version = PKG_VERSION
+  s.summary = "Control an Ambient Orb or Beacon from a Ruby app."
+  s.description = <<-EOF
+  	Allow the color and animation settings to be changed on an Ambient Ord or Beacon - 
+  	http://www.ambientdevices.com/developer/OrbWDK.pdf.  This code uses the Ambient HTTP developer interface.
+  EOF
+
+  s.rdoc_options << '--exclude' << '.'
+  s.has_rdoc = false
+
+  s.files = PKG_FILES.to_a.delete_if {|f| f.include?('.svn')}
+  s.require_path = 'lib'
+
+  s.author = "Tom Fakes"
+  s.email = "tom@craz8.com"
+  s.homepage = "http://ambient.rubyforge.org"
+  s.rubyforge_project = "ambient"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end

data/test/ambient_test.rb

@@ -0,0 +1,66 @@
+
+require 'lib/ambient'
+require 'test/unit'
+
+class AmbientTest < Test::Unit::TestCase
+
+  def setup
+    @orb = Ambient::Orb.new
+    @good_id = ENV["AMBIENT_ORB_ID"]   # Put your Orb ID !
+    flunk("No AMBIENT_ORB_ID in environment, needed to run tests") if @good_id == nil
+    @bad_id = "ABC-DEF-HIJ"            # Invalid ID, but valid format
+  end
+
+  def test_raise_if_invalid_id
+    assert_raise(Ambient::AmbientError) { @orb.update }
+    assert_raise(Ambient::AmbientError) { @orb.id = "12345" }
+    assert_raise(Ambient::AmbientError) { @orb.id = "abc-def-ghi" }
+  end
+
+  def test_raise_if_bad_id
+    @orb.id = @bad_id
+    assert_raise(Ambient::AmbientError) { @orb.update }
+  end
+    
+  def test_default_attributes_ok
+    @orb.id = @good_id
+    @orb.update
+    assert_kind_of(DateTime, @orb.update_at, "Update date should be returned from @orb.update")
+  end
+  
+  def test_init_types
+    Ambient::Orb.new(:id => @good_id).update
+    Ambient::Orb.new(:id => @good_id, :color => :green, :animation => :heartbeat).update
+  end
+  
+  def test_set_color_in_range
+    @orb.id = @good_id
+    @orb.color = 26
+    
+    @orb.color = :white
+    @orb.color = :red
+    @orb.color = :blue
+  end
+
+  def test_set_color_out_of_range
+    assert_raise(Ambient::AmbientError) { @orb.color = 57 }
+    assert_raise(Ambient::AmbientError) { @orb.color = :pink }
+  end
+  
+  def test_set_animation_in_range
+    @orb.id = @good_id
+    @orb.animation = 0
+    @orb.animation = 9
+    
+    @orb.animation = :slow
+    @orb.animation = :heartbeat
+  end
+
+  def test_set_animation_out_of_range
+    @orb.id = @good_id
+    assert_raise(Ambient::AmbientError) { @orb.animation = 42 }
+    assert_raise(Ambient::AmbientError) { @orb.animation = -1 }
+    assert_raise(Ambient::AmbientError) { @orb.animation = :cool }
+  end
+
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.3
+specification_version: 1
+name: ambient
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-10-23
+summary: Control an Ambient Orb or Beacon from a Ruby app.
+require_paths: 
+  - lib
+email: tom@craz8.com
+homepage: http://ambient.rubyforge.org
+rubyforge_project: ambient
+description: "Allow the color and animation settings to be changed on an Ambient Ord or Beacon
+  -  http://www.ambientdevices.com/developer/OrbWDK.pdf.  This code uses the
+  Ambient HTTP developer interface."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Tom Fakes
+files: 
+  - lib/ambient.rb
+  - test/ambient_test.rb
+  - rakefile
+  - README
+  - MIT-LICENSE
+test_files: []
+rdoc_options: 
+  - "--exclude"
+  - "."
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []