eeml-simple 0.1.1

data/COPYING

@@ -0,0 +1,19 @@
+Copyright (c) 2008 James Smith (james@floppy.org.uk)
+
+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,39 @@
+== EEML-Ruby
+
+A Ruby wrapper around the Extended Environments Markup Language
+(http://www.eeml.org)
+
+Licensed under the MIT license (See COPYING file for details)
+
+Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)
+
+Homepage: http://github.com/Floppy/eeml-ruby
+
+Documentation: http://docs.github.com/Floppy/eeml-ruby
+
+== INSTALLATION
+
+1) Enable gems from gemcutter, if you haven't already done so:
+    > sudo gem install gemcutter
+    > sudo gem tumble
+
+2) Install gem
+    > sudo gem install eeml-simple
+
+== STATUS
+
+The code can current create EEML at a level equivalent to the
+"complete" EEML example at http://eeml.org/xml/005/complete.xml, and parse the
+"minimal" level at http://eeml.org/xml/005/minimal.xml
+
+To parse EEML: call EEML::Environment#from_eeml(your_eeml_string), and you will
+get back an EEML::Environment object containing a number of EEML::Data objects.
+
+To create EEML: create an EEML::Environment object, add one or more EEML::Data
+objects to it, and call EEML::Environment#to_eeml.
+
+== EXAMPLES
+
+The file examples/simple_server.rb contains a simple WEBrick server which serves
+an EEML document. This allows a site like Pachube (http://www.pachube.com) to
+fetch EEML data from your system.

data/examples/simple_server.rb

@@ -0,0 +1,30 @@
+#!/usr/local/bin/ruby
+
+dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+
+require 'webrick'
+require 'eeml'
+
+# Create an environment object
+$environment = EEML::Environment.new
+
+# Set dummy data in environment object
+$environment << EEML::Data.new(42, :id => "ABC123")
+
+# Create WEBrick server
+s = WEBrick::HTTPServer.new( :Port => 50000 )
+
+# Create a simple webrick servlet for index.eeml
+class EEMLServlet < WEBrick::HTTPServlet::AbstractServlet
+  def do_GET(request, response)
+    response.status = 200
+    response['Content-Type'] = "text/xml"
+    response.body = $environment.to_eeml
+  end
+end
+s.mount("/index.eeml", EEMLServlet)
+
+# Go
+trap("INT"){ s.shutdown }
+s.start

data/lib/eeml/data.rb

@@ -0,0 +1,44 @@
+module EEML
+
+  # An EEML data item. A valid EEML::Environment must contain at least one of
+  # these.
+  class Data
+
+    # Create a new EEML::Data item.
+    def initialize(value, options = {})
+      @value = value
+      @id = options[:id]
+      @tags = []
+    end
+
+    # Data value
+    attr_accessor :value
+
+    # Data value
+    attr_accessor :id
+
+    # Tag array
+    attr_accessor :tags
+
+    # Minimum value
+    attr_accessor :min_value
+
+    # Maximum value
+    attr_accessor :max_value
+
+    # Unit of measurement
+    def unit
+      @unit
+    end
+
+    # Unit of measurement - must be a EEML::Unit object
+    def unit=(unit_val)
+      unless unit_val.is_a?(EEML::Unit)
+        raise TypeError.new("unit must be an EEML::Unit") 
+      end
+      @unit = unit_val
+    end
+
+  end
+
+end

data/lib/eeml/environment.rb

@@ -0,0 +1,174 @@
+require 'rubygems'
+require 'builder'
+require 'rexml/document'
+require 'time'
+
+module EEML
+
+  # An EEML environment object. Can contain a number of EEML::Data objects, as
+  # well as having other attributes.
+  class Environment
+
+    # Create new Environment object
+    def initialize
+      @data_items = []
+    end
+
+    # Create from an EEML document
+    def self.from_eeml(eeml)
+      # Parse EEML
+      doc = REXML::Document.new(eeml)
+      # Create environment object
+      env = Environment.new
+      # Read data items
+      REXML::XPath.each(doc, "/eeml/environment/data") do |node|
+        env << EEML::Data.new(node.elements['value'].text.to_f)
+      end
+      # Done
+      return env
+    end
+
+    # Convert to EEML. Optional parameter describes the version of EEML to generate.
+    # Default (and currently only version implemented) is version 5.
+    def to_eeml(version = nil)
+      if version.nil? || version == 5
+        # Check that we have some data items
+        if size < 1
+          raise EEML::NoData.new('EEML requires at least one data item')
+        end
+        # Create EEML
+        eeml = Builder::XmlMarkup.new
+        eeml.instruct!
+        eeml_options = {:xmlns => "http://www.eeml.org/xsd/005",
+                        :'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+                        :'xsi:schemaLocation' => "http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd"}
+        eeml_options[:version] = version if version
+        eeml.eeml(eeml_options) do
+          env_options = {}
+          env_options[:updated] = @updated_at.xmlschema if @updated_at
+          env_options[:creator] = @creator if @creator
+          env_options[:id] = @id if @id
+          eeml.environment(env_options) do |env|
+            env.title @title if @title
+            env.feed @feed if @feed
+            env.status @status.to_s if @status
+            env.description @description if @description
+            env.icon @icon if @icon
+            env.website @website if @website
+            env.email @email if @email
+            if @location
+              loc_options = {}
+              loc_options[:domain] = @location.domain
+              loc_options[:exposure] = @location.exposure if @location.exposure
+              loc_options[:disposition] = @location.disposition if @location.disposition
+              env.location(loc_options) do |loc|
+                loc.name @location.name if @location.name
+                loc.lat @location.lat if @location.lat
+                loc.lon @location.lon if @location.lon
+                loc.ele @location.ele if @location.ele
+              end
+            end
+            @data_items.each_index do |i|
+              env.data(:id => @data_items[i].id || i) do |data|
+                @data_items[i].tags.each do |tag|
+                  data.tag tag
+                end
+                value_options = {}
+                value_options[:maxValue] = @data_items[i].max_value if @data_items[i].max_value
+                value_options[:minValue] = @data_items[i].min_value if @data_items[i].min_value
+                data.value @data_items[i].value, value_options
+                if @data_items[i].unit
+                  unit_options = {}
+                  unit_options[:symbol] = @data_items[i].unit.symbol if @data_items[i].unit.symbol
+                  unit_options[:type] = @data_items[i].unit.type if @data_items[i].unit.type
+                  data.unit @data_items[i].unit.name, unit_options
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # Add an EEML::Data object to the environment
+    def <<(value)
+      raise TypeError.new('Only EEML::Data objects can be added to EEML::Environment objects') unless value.is_a?(EEML::Data)
+      @data_items << value
+    end
+
+    # The number of EEML::Data objects in the environment
+    def size
+      @data_items.size
+    end
+
+    # Access contained EEML::Data objects
+    def [](index)
+      @data_items[index]
+    end
+
+    # The title for this EEML feed
+    attr_accessor :title
+
+    # The URL for this EEML feed
+    attr_accessor :feed
+
+    # The status of this EEML feed - can be :frozen or :live
+    def status
+      @status
+    end
+    # The status of this EEML feed - can be :frozen or :live
+    def status=(val)
+      unless [nil, :frozen, :live].include?(val)
+        raise ArgumentError.new("Status must be :frozen or :live") 
+      end
+      @status = val
+    end
+
+    # A description of this EEML feed
+    attr_accessor :description
+
+    # The URL of an icon for this feed
+    attr_accessor :icon
+    
+    # The URL of a website related to this feed
+    attr_accessor :website
+
+    # The email address of the feed creator
+    attr_accessor :email
+
+    # The location of the feed
+    attr_reader :location
+
+    # Set the location of the feed - loc must be an EEML::Location object
+    def location=(loc)
+      unless loc.is_a?(EEML::Location)
+        raise TypeError.new('loc must be an EEML::Location') 
+      end
+      @location = loc
+    end
+
+    # Last updated time
+    attr_reader :updated_at
+
+    # Set last updated time
+    def updated_at=(time)
+      unless time.is_a?(Time)
+        raise TypeError.new('updated_at must be a Time object')
+      end
+      @updated_at = time
+    end
+
+    # Set last updated time
+    def set_updated!
+      @updated_at = Time.now
+    end
+
+    # A string showing the creator of this environment object
+    attr_accessor :creator
+
+    # The ID of the environment object
+    attr_accessor :id
+
+  end
+
+end

data/lib/eeml/exceptions.rb

@@ -0,0 +1,7 @@
+module EEML
+
+  # Not enough data present. Raised by EEML::Environment#to_eeml.
+  class NoData < Exception
+  end
+
+end

data/lib/eeml/location.rb

@@ -0,0 +1,94 @@
+module EEML
+
+  # An class representing a location. Can be added to EEML::Data objects.
+  class Location
+
+    # Create a new EEML::Location item. Domain setting is required, and must be either :physical or :virtual.
+    def initialize(loc_domain, options = {})
+      set_domain(loc_domain)
+      set_exposure(options[:exposure])
+      set_disposition(options[:disposition])
+      @name = options[:name]
+      self.lat = options[:lat]
+      self.lon = options[:lon]
+      @ele = options[:ele]
+    end
+
+    # Domain (:physical or :virtual)
+    attr_reader :domain
+    
+    # Set the domain of the Location - must be either :physical or :virtual
+    def domain=(loc_domain)
+      set_domain(loc_domain)
+    end
+
+    # Exposure (:indoor or :outdoor)
+    attr_reader :exposure
+    
+    # Set the exposure of the Location - must be either :indoor or :outdoor
+    def exposure=(loc_exposure)
+      set_exposure(loc_exposure)
+    end
+
+    # Disposition (:fixed or :mobile)
+    attr_reader :disposition
+    
+    # Set the disposition of the Location - must be either :fixed or :mobile
+    def disposition=(loc_disposition)
+      set_disposition(loc_disposition)
+    end
+
+    # The name of the location
+    attr_accessor :name
+
+    # Latitude of location
+    attr_reader :lat
+    
+    # Set the latitude of the location
+    def lat=(latitude)
+      if latitude && (latitude < -90 || latitude > 90)
+        raise ArgumentError.new("Latitude must be between -90 and +90") 
+      end
+      @lat = latitude
+    end
+    
+    # Longitude of location
+    attr_reader :lon
+    
+    # Set the longitude of the location
+    def lon=(longitude)      
+      if longitude && (longitude < -180 || longitude > 180)
+        raise ArgumentError.new("Longitude must be between -180 and +180") 
+      end
+      @lon = longitude
+    end
+
+    # Elevation of location
+    attr_accessor :ele
+    
+    protected
+
+    def set_domain(loc_domain)
+      unless [:physical, :virtual].include?(loc_domain)
+        raise ArgumentError.new("Domain must be :physical or :virtual")
+      end
+      @domain = loc_domain
+    end
+
+    def set_exposure(loc_exposure)
+      unless [nil, :indoor, :outdoor].include?(loc_exposure)
+        raise ArgumentError.new("Exposure must be :indoor or :outdoor")
+      end
+      @exposure = loc_exposure
+    end
+
+    def set_disposition(loc_disposition)
+      unless [nil, :fixed, :mobile].include?(loc_disposition)
+        raise ArgumentError.new("Disposition must be :fixed or :mobile")
+      end
+      @disposition = loc_disposition
+    end
+
+  end
+
+end

data/lib/eeml/unit.rb

@@ -0,0 +1,41 @@
+module EEML
+
+  # An class representing a unit or measurement. Can be added to EEML::Data
+  # objects
+  class Unit
+
+    # Create a new EEML::Unit item.
+    def initialize(unit_name, options = {})
+      @name = unit_name
+      @symbol = options[:symbol]
+      set_type(options[:type])
+    end
+
+    # Name of the unit (e.g. "metre")
+    attr_accessor :name
+
+    # Symbol for the unit (e.g. "m")
+    attr_accessor :symbol
+
+    # Get the type of the unit
+    def type
+      @type
+    end
+    
+    # Set the type of the unit - must be one of :basicSI, :derivedSI, :conversionBasedUnits, :derivedUnits or :contextDependentUnits
+    def type=(unit_type)
+      set_type(unit_type)
+    end
+
+  protected
+
+    def set_type(unit_type)
+      unless [nil, :basicSI, :derivedSI, :conversionBasedUnits, :derivedUnits, :contextDependentUnits].include?(unit_type)
+        raise ArgumentError.new("Type must be one of :basicSI, :derivedSI, :conversionBasedUnits, :derivedUnits or :contextDependentUnits")
+      end
+      @type = unit_type
+    end
+
+  end
+
+end

data/lib/eeml.rb

@@ -0,0 +1,5 @@
+require 'eeml/exceptions'
+require 'eeml/location'
+require 'eeml/environment'
+require 'eeml/unit'
+require 'eeml/data'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: eeml-simple
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-15 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: 
+email: james@floppy.org.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- COPYING
+- lib/eeml.rb
+- lib/eeml/environment.rb
+- lib/eeml/data.rb
+- lib/eeml/exceptions.rb
+- lib/eeml/location.rb
+- lib/eeml/unit.rb
+- examples/simple_server.rb
+has_rdoc: true
+homepage: http://github.com/Floppy/eeml-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper around the Extended Environments Markup Language
+test_files: []
+