eeml 0.0.14 → 0.0.17

data/CHANGELOG

@@ -1,3 +1,21 @@
+commit 245dae9ae8e246d3f933106e70df4eadb33823fe
+Author: Levent Ali <lebreeze@gmail.com>
+Date:   Fri Jul 2 16:03:27 2010 +0100
+
+  Version 0.0.17
+
+    JSON version 0.6rc1 bumped to 1.0.0 (as not tied to eeml directly)
+    JSON 1.0.0 takes at instead of recorded_at
+
+commit b2829c7df6eea4fb5be3c6834d56d70f472aba9b
+Author: Levent Ali <lebreeze@gmail.com>
+Date:   Thu Jul 1 17:41:23 2010 +0100
+
+  Version 0.0.15
+
+    Added functionality to parse json v0.6-rc1
+    Updating readme on building gem / gemspec
+
 commit 926ef3400b50ee441f2c48951ad1e5d1fd4f0549
 Author: Sam Mulube <sam.mulube@gmail.com>
 Date:   Wed Jun 24 23:47:25 2009 +0100

data/README

@@ -8,3 +8,5 @@ Library for simplifying the creation and manipulation of EEML documents, primari
 ruby objects that can be used programmatically. Also provides parsing and output of the JSON format used by pachube.com.
 
 == USAGE
+
+rake build - will create gemspec and gem file in pkg/

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.summary = "Simple little library for programmatically manipulating EEML documents."
     gem.description = "Simple little library for programmatically manipulating EEML documents, in particular this library is designed to work with the Pachube web service."
     gem.email = "sam.mulube@gmail.com"
-    gem.authors = ["Neill Bogie", "Sam Mulube"]
+    gem.authors = ["Neill Bogie", "Sam Mulube", "Levent Ali"]
     gem.version = Eeml::VERSION
     gem.add_dependency("libxml-ruby", ">=1.1.3")
     gem.add_dependency("json", ">=1.4.3")

data/lib/eeml/constants.rb

@@ -9,6 +9,10 @@ module Eeml
     XSI_NAMESPACE = "http://www.w3.org/2001/XMLSchema-instance"
 
     EEML6_VERSION = "0.6-alpha1"
+
+    # Not calling this EEML as json is not part of the eeml spec
+    JSON_1_0_0_VERSION = "1.0.0"
+    # EEML6_RC1_VERSION = "0.6-rc1"
   end
 end
 

data/lib/eeml/environment_builder.rb

@@ -1,6 +1,7 @@
 require 'eeml/libxml_eeml_parser_v005'
 require 'eeml/json_environment_parser_v005'
 require 'eeml/json_environment_parser_v006'
+require 'eeml/json_environment_parser_v100'
 
 module Eeml
   class EnvironmentBuilder # :nodoc:
@@ -19,10 +20,12 @@ module Eeml
       json = JSON.parse(json_str)
       if json["version"].to_i == Constants::EEML5_VERSION.to_i
         parser = JsonEnvironmentParserV005.new
+      elsif json["version"] == Constants::JSON_1_0_0_VERSION
+	parser = JsonEnvironmentParserV100.new
       elsif json["version"].to_f == Constants::EEML6_VERSION.to_f
         parser = JsonEnvironmentParserV006.new
       else
-        raise "Invalid version specification. Permitted versions are #{Constants::EEML5_VERSION} and #{Constants::EEML6_VERSION}"
+        raise "Invalid version specification. Permitted versions are #{Constants::EEML5_VERSION}, #{Constants::EEML6_VERSION} and #{Constants::JSON_1_0_0_VERSION}"
       end
       return parser.make_environment_from_hash(json)
     end

data/lib/eeml/json_environment_parser_v100.rb

@@ -0,0 +1,82 @@
+module Eeml
+  # A parser for json environments based on the EEML 5 specification.
+  class JsonEnvironmentParserV100 # :nodoc:
+    include Exceptions
+
+    def make_environment_from_hash(env_hash)
+      env = Environment.new(:title => env_hash["title"],
+                            :description => env_hash["description"],
+                            :feed_url => env_hash["feed"],
+                            :website => env_hash["website"],
+                            :email => env_hash["email"],
+                            :icon => env_hash["icon"],
+                            :status => env_hash["status"],
+                            :identifier => env_hash["id"],
+                            :private => env_hash["private"])
+
+      env.updated = Time.gm(*ParseDate.parsedate(env_hash['updated'])) unless env_hash['updated'].nil?
+
+      env.location = buildLocation(env_hash)
+
+      env.datastreams = buildDatastreams(env_hash)
+  
+      return env
+    end
+
+    def make_environment_from_json(json_str)
+      env_hash = JSON.parse(json_str)
+      return make_environment_from_hash(env_hash)
+    end
+
+    private
+
+    def buildLocation(env_hash)
+      location_hash = env_hash["location"]
+      return if location_hash.nil?
+      Location.new(:name => location_hash["name"],
+                   :latitude => location_hash["lat"],
+                   :longitude => location_hash["lon"],
+                   :elevation => location_hash["ele"],
+                   :domain => location_hash["domain"],
+                   :disposition => location_hash["disposition"],
+                   :exposure => location_hash["exposure"])
+    end
+
+    def buildDatastreams(env_hash)
+      datastreams_hash = env_hash["datastreams"]
+      return if datastreams_hash.nil?
+      datastreams = []
+      datastreams_hash.each do |datastream_hash|  
+	datastream = DataStream.new
+        raise MissingAttribute.new('id', "data") if datastream_hash['id'].nil?
+        datastream.identifier = datastream_hash['id']
+        datastream.tags = datastream_hash['tags'] unless datastream_hash['tags'].nil?
+        
+        values_arr = datastream_hash["values"]
+
+        raise DataMissingValue if values_arr.nil?
+
+        values_arr.each do |v|
+          value = Value.new(:value => v["value"],
+                            :min_value => datastream_hash["min_value"],
+                            :max_value => datastream_hash["max_value"],
+                            :recorded_at => v["at"])
+
+          datastream.add_value(value)
+        end
+
+        unit_hash = datastream_hash["unit"]
+        unless unit_hash.nil?
+          datastream.unit_symbol = unit_hash["symbol"]
+          datastream.unit_type = unit_hash["type"]
+          datastream.unit_value = unit_hash["label"]
+        end
+
+        datastreams << datastream
+      end
+      return datastreams
+    end
+  end
+end
+
+

data/lib/eeml.rb

@@ -15,7 +15,7 @@ require 'time'
 module Eeml
 
   # library version number
-  VERSION = '0.0.14'
+  VERSION = '0.0.17'
 
   # TODO: put in some configuration file, not here
   LOCAL_EEML_SCHEMA_LOCATION = 'schemas/eeml/005.xsd'

data/test/data/doc_1_v1-0-0.json

@@ -0,0 +1,34 @@
+{"datastreams":[
+  {"tags":["tagD0"],
+  "values":[{"value":"0","at":"2009-02-11T10:56:56Z"}],
+  "min_value":"-9999.0",
+  "max_value":"1022.0",
+  "unit":{"type":"basicSI","label":"Celsius","symbol":"C"},
+  "id":"0"},
+  {"values":[{"value":"33","at":"2009-02-11T10:56:55Z"}],
+  "min_value":"0.0","max_value":"1023.0",
+  "id":"1"},
+  {"tags":["tagD2a","tagD2b","tagD2c"],
+  "values":[{"value":"42.1","at":"2009-02-11T10:55:10Z"}],
+  "min_value":"23.4","max_value":"1021.0",
+  "id":"2"}
+],
+"description":"description here",
+"updated":"2010-02-11T10:56:56Z",
+"status":"frozen",
+"website":"http:\/\/example.com\/studio\/",
+"email":"someone@example.com",
+"feed":"http:\/\/example.com\/api\/1247.xml",
+"location":{
+  "lat":"50.1",
+  "lon":"48.7",
+  "ele":"1.34",
+  "name":"Up on the roof (somewhere)",
+  "domain":"physical",
+  "exposure":"outdoor",
+  "disposition":"mobile"
+},
+"icon":"http:\/\/example.com\/some\/icon.gif",
+"id":"1247",
+"title":"title here",
+"version":"1.0.0"}

data/test/test_environment.rb

@@ -365,6 +365,70 @@ class TestEnvironment < Test::Unit::TestCase
     end
   end
 
+  test "parses a v1.0.0 input file ok" do
+    env = create_env_from_json_v100_file_one
+    assert_not_nil env
+    assert_instance_of Environment, env
+    assert_equal('title here', env.title)
+    assert_equal('description here', env.description)
+    assert_equal('http://example.com/api/1247.xml', env.feed_url)
+    assert_equal('http://example.com/studio/', env.website)
+    assert_equal('frozen', env.status)
+    assert_equal('someone@example.com', env.email)
+    assert_equal('http://example.com/some/icon.gif', env.icon)
+    
+    #env attrs
+    assert_equal('1247', env.identifier)
+    assert_equal('2010-02-11T10:56:56Z', env.updated.utc.iso8601)
+  end
+
+  test "location parses ok from json when parsing a v1.0.0 file" do
+    env = create_env_from_json_v100_file_one
+    assert_not_nil env.location
+    location = env.location
+    assert_equal "Up on the roof (somewhere)", location.name
+    assert_equal "50.1", location.latitude
+    assert_equal "48.7", location.longitude
+    assert_equal "1.34", location.elevation
+    assert_equal "physical", location.domain
+    assert_equal "outdoor", location.exposure
+    assert_equal "mobile", location.disposition
+  end
+
+  test "datastreams parse ok from v1.0.0 json" do
+    env = create_env_from_json_v100_file_one
+    assert_equal 3, env.datastreams.size
+
+    #the expected values for the datastreams in the test doc
+    expectations_list = [
+      #id, tag array, min, max, value, unit_symbol, unit_type, unit_value
+      ['0', ['tagD0'], '-9999.0', '1022.0', '0', 'C', 'basicSI', 'Celsius', '2009-02-11T10:56:56Z'], 
+      ['1', [], '0.0', '1023.0', '33', nil, nil, nil, '2009-02-11T10:56:55Z'], 
+      ['2', ['tagD2a', 'tagD2b', 'tagD2c'], '23.4', '1021.0', '42.1', nil, nil, nil, '2009-02-11T10:55:10Z']
+    ]
+    env.datastreams.each_with_index do |ds, i|
+
+      e_identifier, e_tags, e_min_value, e_max_value, e_value, e_unit_symbol, e_unit_type, e_unit_value, e_value_recorded_at = expectations_list[i]
+
+      assert_equal e_identifier, ds.identifier
+
+      assert_equal e_tags.size, ds.tags.size, "should have right num of tags"
+      
+      e_tags.each do |expected_tag|
+        ds.tags.member? expected_tag
+
+      end
+
+      assert_equal e_value_recorded_at, ds.values.last.recorded_at
+      assert_equal e_min_value, ds.min_value
+      assert_equal e_max_value, ds.max_value
+      assert_equal e_value, ds.value
+      assert_equal e_unit_symbol, ds.unit_symbol
+      assert_equal e_unit_type, ds.unit_type
+      assert_equal e_unit_value, ds.unit_value
+    end
+  end
+
   test "parses a v6 input file ok" do
     env = create_env_from_json_v6_file_one
     assert_not_nil env
@@ -599,6 +663,10 @@ class TestEnvironment < Test::Unit::TestCase
     return create_env_from_json_file('test/data/doc_1_v6.json')
   end
 
+  def create_env_from_json_v100_file_one
+    return create_env_from_json_file('test/data/doc_1_v1-0-0.json')
+  end
+
   def create_env_from_json_file(filename)
     json = File.read(filename)
     return Environment.new_from_json(json)

metadata

@@ -5,17 +5,18 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 17
+  version: 0.0.17
 platform: ruby
 authors: 
 - Neill Bogie
 - Sam Mulube
+- Levent Ali
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 +01:00
+date: 2010-07-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +73,7 @@ files:
 - lib/eeml/exceptions.rb
 - lib/eeml/json_environment_parser_v005.rb
 - lib/eeml/json_environment_parser_v006.rb
+- lib/eeml/json_environment_parser_v100.rb
 - lib/eeml/json_output.rb
 - lib/eeml/libxml_eeml_output_v005.rb
 - lib/eeml/libxml_eeml_parser_v005.rb
@@ -84,6 +86,7 @@ files:
 - test/data/doc_1.xml
 - test/data/doc_1_private.json
 - test/data/doc_1_private.xml
+- test/data/doc_1_v1-0-0.json
 - test/data/doc_1_v6.json
 - test/data/doc_1_v6_private.json
 - test/data/doc_2.xml
@@ -128,8 +131,8 @@ signing_key:
 specification_version: 3
 summary: Simple little library for programmatically manipulating EEML documents.
 test_files: 
-- test/test_environment.rb
+- test/test_helper.rb
+- test/test_libxml_eeml_parser_v005.rb
 - test/test_libxml_test_helper.rb
+- test/test_environment.rb
 - test/libxml_test_helper.rb
-- test/test_libxml_eeml_parser_v005.rb
-- test/test_helper.rb