cosm-rb 0.0.1

data/lib/cosm-rb/parsers/json/search_result_defaults.rb

@@ -0,0 +1,18 @@
+module Cosm
+  module Parsers
+    module JSON
+      module SearchResultDefaults
+        include FeedDefaults
+
+        def from_json(json)
+          hash = ::JSON.parse(json)
+          hash['results'] = hash['results'].collect do |feed|
+            transform_1_0_0(feed)
+          end
+          hash
+        end
+
+      end
+    end
+  end
+end

data/lib/cosm-rb/parsers/json/trigger_defaults.rb

@@ -0,0 +1,12 @@
+module Cosm
+  module Parsers
+    module JSON
+      module TriggerDefaults
+        def from_json(json)
+          ::JSON.parse(json)
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/parsers/xml/datapoint_defaults.rb

@@ -0,0 +1,20 @@
+module Cosm
+  module Parsers
+    module XML
+      module DatapointDefaults
+        def from_xml(xml)
+          xml = Nokogiri.parse(xml)
+          hash = {}
+          environment = xml.at_xpath("//xmlns:environment")
+          data = environment.at_xpath("xmlns:data")
+          datapoint = data.at_xpath("xmlns:datapoints")
+          value = datapoint.at_xpath("xmlns:value")
+          hash["value"] = value.content
+          hash["at"] = value.attributes["at"].value
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/parsers/xml/datastream_defaults.rb

@@ -0,0 +1,77 @@
+module Cosm
+  module Parsers
+    module XML
+      module DatastreamDefaults
+        def from_xml(xml)
+          xml = Nokogiri.parse(xml)
+          case xml.root.attributes["version"].value
+          when "0.5.1"
+            transform_0_5_1(xml)
+          else # "5"
+            transform_5(xml)
+          end
+        end
+
+        private
+
+        # As produced by http://cosm.com/api/v2/FEED_ID/datastreams/DATASTREAM_ID.xml
+        def transform_0_5_1(xml)
+          hash = {}
+          environment = xml.at_xpath("//xmlns:environment")
+          data = environment.at_xpath("xmlns:data")
+          hash["feed_id"] = environment.attributes["id"].value
+          hash["feed_creator"] = environment.attributes["creator"].value
+          hash["id"] = data.attributes["id"].value
+          if (tags = data.xpath("xmlns:tag").collect(&:content)).any?
+            hash["tags"] = tags.sort{|a,b| a.downcase <=> b.downcase}.join(',')
+          end
+          current_value = data.at_xpath("xmlns:current_value")
+          hash["current_value"] = current_value.content
+          hash["updated"] = current_value.attributes["at"].value
+          hash["min_value"] = data.at_xpath("xmlns:min_value").content
+          hash["max_value"] = data.at_xpath("xmlns:max_value").content
+          unit = data.at_xpath("xmlns:unit")
+          if unit
+            hash["unit_label"] = unit.content
+            hash["unit_symbol"] = unit.attributes["symbol"].value
+            hash["unit_type"] = unit.attributes["type"].value
+          end
+          hash["datapoints"] = data.xpath("xmlns:datapoints").collect do |datapoint|
+            value = datapoint.at_xpath("xmlns:value")
+            {
+              "value" => value.content,
+              "at" => value.attributes["at"].content
+            }
+          end
+          hash
+        end
+
+        # As produced by http://cosm.com/api/v1/FEED_ID/datastreams/DATASTREAM_ID.xml
+        def transform_5(xml)
+          hash = {}
+          environment = xml.at_xpath("//xmlns:environment")
+          data = environment.at_xpath("xmlns:data")
+          hash["feed_id"] = environment.attributes["id"].value
+          hash["feed_creator"] = "http://www.haque.co.uk"
+          hash["updated"] = environment.attributes["updated"].value
+          hash["id"] = data.attributes["id"].value
+          if (tags = data.xpath("xmlns:tag").collect(&:content)).any?
+            hash["tags"] = tags.sort{|a,b| a.downcase <=> b.downcase}.join(',')
+          end
+          current_value = data.at_xpath("xmlns:value")
+          hash["current_value"] = current_value.content
+          hash["min_value"] = current_value.attributes["minValue"].value
+          hash["max_value"] = current_value.attributes["maxValue"].value
+          unit = data.at_xpath("xmlns:unit")
+          if unit
+            hash["unit_label"] = unit.content
+            hash["unit_symbol"] = unit.attributes["symbol"].value
+            hash["unit_type"] = unit.attributes["type"].value
+          end
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/parsers/xml/feed_defaults.rb

@@ -0,0 +1,127 @@
+module Cosm
+  module Parsers
+    module XML
+      module FeedDefaults
+        def from_xml(xml)
+          xml = Nokogiri.parse(xml)
+          case xml.root.attributes["version"].value
+          when "0.5.1"
+            transform_0_5_1(xml)
+          else # "5"
+            transform_5(xml)
+          end
+        end
+
+        # As produced by http://cosm.com/api/v2/FEED_ID.xml
+        def transform_0_5_1(xml)
+          hash = {}
+          environment = xml.at_xpath("//xmlns:environment")
+          hash["updated"] = environment.attributes["updated"].value
+          hash["created"] = environment.attributes["created"].value
+          hash["creator"] = environment.attributes["creator"].value
+          hash["title"] = environment.at_xpath("xmlns:title").content
+          hash["feed"] = environment.at_xpath("xmlns:feed").content
+          hash["auto_feed_url"] = environment.at_xpath("xmlns:auto_feed_url").content
+          hash["status"] = environment.at_xpath("xmlns:status").content
+          hash["description"] = environment.at_xpath("xmlns:description").content
+          hash["icon"] = environment.at_xpath("xmlns:icon").content
+          hash["website"] = environment.at_xpath("xmlns:website").content
+          hash["email"] = environment.at_xpath("xmlns:email").content
+          hash["private"] = environment.at_xpath("xmlns:private").content
+          hash["tags"] = environment.xpath("xmlns:tag").collect(&:content).sort{|a,b| a.downcase <=> b.downcase}.join(',')
+          location = environment.at_xpath("xmlns:location")
+          if location
+            hash["location_name"] = location.at_xpath("xmlns:name").content
+            hash["location_lat"] = location.at_xpath("xmlns:lat").content
+            hash["location_lon"] = location.at_xpath("xmlns:lon").content
+            hash["location_ele"] = location.at_xpath("xmlns:ele").content
+            hash["location_domain"] = location.attributes["domain"].value
+            hash["location_exposure"] = location.attributes["exposure"].value
+            hash["location_disposition"] = location.attributes["disposition"].value
+          end
+          owner = environment.at_xpath("xmlns:user")
+          if owner
+            hash["owner_login"] = owner.at_xpath("xmlns:login").content
+          end
+          hash["datastreams"] = environment.xpath("xmlns:data").collect do |datastream|
+            current_value = datastream.at_xpath("xmlns:current_value")
+            unit = datastream.at_xpath("xmlns:unit")
+            if unit
+              unit_hash = {
+                "unit_label" => unit.content,
+                "unit_type" => unit.attributes["type"].value,
+                "unit_symbol" => unit.attributes["symbol"].value,
+              }
+            else
+              unit_hash = {}
+            end
+            {
+              "id" => datastream.attributes["id"].value,
+              "tags" => datastream.xpath("xmlns:tag").collect(&:content).sort{|a,b| a.downcase <=> b.downcase}.join(','),
+              "current_value" => current_value.content,
+              "updated" => current_value.attributes["at"].value,
+              "min_value" => datastream.at_xpath("xmlns:min_value").content,
+              "max_value" => datastream.at_xpath("xmlns:max_value").content,
+              "datapoints" => datastream.xpath("xmlns:datapoints").collect do |datapoint|
+              value = datapoint.at_xpath("xmlns:value")
+              {
+                "at" => value.attributes["at"].value,
+                "value" => value.content,
+              }
+              end
+            }.merge(unit_hash)
+          end
+          hash
+        end
+
+        # As produced by http://cosm.com/api/v1/FEED_ID.xml
+        def transform_5(xml)
+          hash = {}
+          environment = xml.at_xpath("//xmlns:environment")
+          hash["updated"] = environment.attributes["updated"].value
+          hash["creator"] = "http://www.haque.co.uk"
+          hash["title"] = environment.at_xpath("xmlns:title").content
+          hash["feed"] = environment.at_xpath("xmlns:feed").content
+          hash["status"] = environment.at_xpath("xmlns:status").content
+          hash["description"] = environment.at_xpath("xmlns:description").content
+          hash["icon"] = environment.at_xpath("xmlns:icon").content
+          hash["website"] = environment.at_xpath("xmlns:website").content
+          hash["email"] = environment.at_xpath("xmlns:email").content
+          location = environment.at_xpath("xmlns:location")
+          if location
+            hash["location_name"] = location.at_xpath("xmlns:name").content
+            hash["location_lat"] = location.at_xpath("xmlns:lat").content
+            hash["location_lon"] = location.at_xpath("xmlns:lon").content
+            hash["location_ele"] = location.at_xpath("xmlns:ele").content
+            hash["location_domain"] = location.attributes["domain"].value
+            hash["location_exposure"] = location.attributes["exposure"].value
+            hash["location_disposition"] = location.attributes["disposition"].value
+          end
+          hash["datastreams"] = environment.xpath("xmlns:data").collect do |datastream|
+            current_value = datastream.at_xpath("xmlns:value")
+            unit = datastream.at_xpath("xmlns:unit")
+            if unit
+              unit_hash = {
+                "unit_label" => unit.content,
+                "unit_type" => unit.attributes["type"].value,
+                "unit_symbol" => unit.attributes["symbol"].value,
+              }
+            else
+              unit_hash = {}
+            end
+            {
+              "id" => datastream.attributes["id"].value,
+              "tags" => datastream.xpath("xmlns:tag").collect(&:content).sort{|a,b| a.downcase <=> b.downcase}.join(','),
+              "current_value" => current_value.content,
+              "updated" => environment.attributes["updated"].value,
+              "min_value" => current_value.attributes["minValue"].value,
+              "max_value" => current_value.attributes["maxValue"].value,
+            }.merge(unit_hash)
+          end
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/parsers/xml/key_defaults.rb

@@ -0,0 +1,40 @@
+module Cosm
+  module Parsers
+    module XML
+      module KeyDefaults
+        def from_xml(xml)
+          xml = Nokogiri.parse(xml)
+          hash = {}
+          hash["id"] = xml.at_xpath("//id").content if xml.at_xpath("//id")
+          hash["expires_at"] = xml.at_xpath("//expires-at").content if xml.at_xpath("//expires-at")
+          hash["key"] = xml.at_xpath("//api-key").content if xml.at_xpath("//api-key")
+          hash["label"] = xml.at_xpath("//label").content if xml.at_xpath("//label")
+          hash["user"] = xml.at_xpath("//user").content if xml.at_xpath("//user")
+          hash["private_access"] = xml.at_xpath("//private-access").content if xml.at_xpath("//private-access")
+
+          hash["permissions"] = xml.xpath("//key/permissions/permission").collect { |permission|
+            access_methods = permission.xpath("access-methods/access-method").collect { |method|
+              method.content.to_s.downcase
+            }
+            resources = permission.xpath("resources/resource").collect { |resource|
+              { "feed_id" => resource.at_xpath("feed-id").content,
+                "datastream_id" => resource.at_xpath("datastream-id").content,
+                "datastream_trigger_id" => resource.at_xpath("datastream-trigger-id").content
+              }.delete_if_nil_value
+            }
+            {
+              "referer" => permission.at_xpath("referer").content,
+              "source_ip" => permission.at_xpath("source-ip").content,
+              "private_access" => permission.at_xpath("private-access").content,
+              "access_methods" => access_methods,
+              "resources" => resources
+            }.delete_if_nil_value
+          }
+
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/parsers/xml/trigger_defaults.rb

@@ -0,0 +1,22 @@
+module Cosm
+  module Parsers
+    module XML
+      module TriggerDefaults
+        def from_xml(xml)
+          xml = Nokogiri.parse(xml)
+          hash = {}
+          hash["id"] = xml.at_xpath("//id").content if xml.at_xpath("//id")
+          hash["url"] = xml.at_xpath("//url").content if xml.at_xpath("//url")
+          hash["trigger_type"] = xml.at_xpath("//trigger-type").content if xml.at_xpath("//trigger-type")
+          hash["threshold_value"] = xml.at_xpath("//threshold-value").content if xml.at_xpath("//threshold-value")
+          hash["notified_at"] = xml.at_xpath("//notified-at").content if xml.at_xpath("//notified-at")
+          hash["user"] = xml.at_xpath("//user").content if xml.at_xpath("//user")
+          hash["environment_id"] = xml.at_xpath("//environment-id").content if xml.at_xpath("//environment-id")
+          hash["stream_id"] = xml.at_xpath("//stream-id").content if xml.at_xpath("//stream-id")
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/permission.rb

@@ -0,0 +1,67 @@
+module Cosm
+  class Permission
+    ALLOWED_KEYS = %w(label access_methods referer source_ip minimum_interval resources)
+    ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
+    NESTED_KEYS = %w(resources)
+
+    include Validations
+
+    def valid?
+      pass = true
+      if access_methods.nil? || access_methods.empty?
+        errors[:access_methods] = ["can't be blank"]
+        pass = false
+      end
+
+      resources.each do |resource|
+        unless resource.valid?
+          resource.errors.each do |attr, resource_errors|
+            errors["resources_#{attr}".to_sym] = ([*errors["resources_#{attr}".to_sym]] | [*resource_errors]).compact
+          end
+          pass = false
+        end
+      end
+
+      return pass
+    end
+
+    # Build an instance from a Hash only
+    def initialize(input = {})
+      self.attributes = input
+    end
+
+    def resources
+      return [] if @resources.nil?
+      @resources
+    end
+
+    def resources=(array)
+      return unless array.is_a?(Array)
+      @resources = []
+      array.each do |resource|
+        if resource.is_a?(Resource)
+          @resources << resource
+        elsif resource.is_a?(Hash)
+          @resources << Resource.new(resource)
+        end
+      end
+    end
+
+    def attributes
+      h = {}
+      ALLOWED_KEYS.each do |key|
+        value = self.send(key)
+        h[key] = value unless value.nil?
+      end
+      return h
+    end
+
+    def attributes=(input)
+      return if input.nil?
+      input.deep_stringify_keys!
+      ALLOWED_KEYS.each { |key| self.send("#{key}=", input[key]) }
+      NESTED_KEYS.each { |key| self.send("#{key}=", input["#{key}_attributes"]) unless input["#{key}_attributes"].nil? }
+      return attributes
+    end
+  end
+end

data/lib/cosm-rb/resource.rb

@@ -0,0 +1,43 @@
+module Cosm
+  class Resource
+    ALLOWED_KEYS = %w(feed_id datastream_id datastream_trigger_id)
+    ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
+
+    include Validations
+
+    def valid?
+      pass = true
+      if feed_id.blank? && datastream_id.blank? && datastream_trigger_id.blank?
+        errors[:feed_id] = "Must supply at least one of feed_id (optionally with a datastream_id) or datastream_trigger_id"
+        pass = false
+      end
+
+      if feed_id.blank? && !datastream_id.blank?
+        errors[:feed_id] = ["can't be blank if we have supplied a datastream_id"]
+        pass = false
+      end
+
+      return pass
+    end
+
+    def initialize(input = {})
+      self.attributes = input
+    end
+
+    def attributes
+      h = {}
+      ALLOWED_KEYS.each do |key|
+        value = self.send(key)
+        h[key] = value unless value.nil?
+      end
+      return h
+    end
+
+    def attributes=(input)
+      return if input.nil?
+      input.deep_stringify_keys!
+      ALLOWED_KEYS.each { |key| self.send("#{key}=", input[key]) }
+      return attributes
+    end
+  end
+end

data/lib/cosm-rb/search_result.rb

@@ -0,0 +1,63 @@
+module Cosm
+  class SearchResult
+    ALLOWED_KEYS = %w(totalResults startIndex itemsPerPage results)
+    ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
+
+    include Cosm::Templates::JSON::SearchResultDefaults
+    include Cosm::Templates::XML::SearchResultDefaults
+    include Cosm::Parsers::JSON::SearchResultDefaults
+
+    @@feed_class = Cosm::Feed
+
+    def initialize(input = {})
+      if input.is_a?(Hash)
+        self.attributes = input
+      elsif input.strip[0...1].to_s == "{"
+        self.attributes = from_json(input)
+      end
+    end
+
+    def attributes
+      h = {}
+      ALLOWED_KEYS.each do |key|
+        value = self.send(key)
+        h[key] = value unless value.nil?
+      end
+      return h
+    end
+
+    def attributes=(input)
+      return if input.nil?
+      ALLOWED_KEYS.each { |key| self.send("#{key}=", input[key]) }
+      return attributes
+    end
+
+    def results=(array)
+      return unless array.is_a?(Array)
+      @results = []
+      array.each do |feed|
+        if feed.is_a?(@@feed_class)
+          @results << feed
+        elsif feed.is_a?(Hash)
+          @results << @@feed_class.new(feed)
+        end
+      end
+    end
+
+    def as_json(options = {})
+      options[:version] ||= "1.0.0"
+      generate_json(options[:version])
+    end
+
+    def to_json(options = {})
+      ::JSON.generate as_json(options)
+    end
+
+    def to_xml(options = {})
+      options[:version] ||= "0.5.1"
+      generate_xml(options[:version])
+    end
+
+  end
+end
+

data/lib/cosm-rb/string_extensions.rb

@@ -0,0 +1,6 @@
+class String
+  def iso8601(precision = nil)
+    self
+  end
+end
+

data/lib/cosm-rb/template.rb

@@ -0,0 +1,32 @@
+module Cosm
+  class Template
+    attr_accessor :subject
+    attr_accessor :presentation
+    attr_accessor :output
+
+    def initialize(subject, presentation, &block)
+      @subject = subject
+      @presentation = presentation
+      @output = {}
+    end
+
+    def method_missing(sym, *args, &block)
+      if block_given?
+        @output[sym] = @subject.instance_eval &block
+      else
+        @output[sym] = @subject.send(sym)
+      end
+    rescue NameError, NoMethodError => e
+      @output[sym] = nil
+    end
+
+    def id
+      method_missing(:id)
+    end
+
+    def output!(options = {})
+      !options[:include_blank] ? @output.reject {|k,v| v.nil? || v.blank?} : @output
+    end
+  end
+end
+

data/lib/cosm-rb/templates/csv/datapoint_defaults.rb

@@ -0,0 +1,22 @@
+module Cosm
+  module Templates
+    module CSV
+      module DatapointDefaults
+        def generate_csv(version, options = {})
+          options[:depth] = 4 if options[:full]
+          case options[:depth].to_i
+          when 4
+            ::CSV.generate_line([feed_id, datastream_id, at.iso8601(6), value]).strip
+          when 3
+            ::CSV.generate_line([datastream_id, at.iso8601(6), value]).strip
+          when 2
+            ::CSV.generate_line([at.iso8601(6), value]).strip
+          else
+            ::CSV.generate_line([value]).strip
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/templates/csv/datastream_defaults.rb

@@ -0,0 +1,43 @@
+module Cosm
+  module Templates
+    module CSV
+      module DatastreamDefaults
+        def generate_csv(version, options = {})
+          case version
+          when "2"
+            csv_2(options)
+          when "1"
+            csv_1
+          end
+        end
+
+        private
+
+        def csv_2(options)
+          csv = []
+          options[:depth] = 4 if options[:full]
+          case options[:depth].to_i
+          when 4
+            datapoints.collect {|datapoint| csv << [feed_id, id, datapoint.at.iso8601(6), datapoint.value] }
+            csv << [feed_id, id, updated.iso8601(6), current_value] if csv.empty?
+          when 3
+            datapoints.collect {|datapoint| csv << [id, datapoint.at.iso8601(6), datapoint.value] }
+            csv << [id, updated.iso8601(6), current_value] if csv.empty?
+          when 1
+            datapoints.collect {|datapoint| csv << [datapoint.value] }
+            csv << [current_value] if csv.empty?
+          else
+            datapoints.collect {|datapoint| csv << [datapoint.at.iso8601(6), datapoint.value] }
+            csv << [updated.iso8601(6), current_value] if csv.empty?
+          end
+          csv.collect {|row| ::CSV.generate_line(row).strip }.join("\n")
+        end
+
+        def csv_1
+          ::CSV.generate_line([current_value]).strip
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/templates/csv/feed_defaults.rb

@@ -0,0 +1,47 @@
+module Cosm
+  module Templates
+    module CSV
+      module FeedDefaults
+        def generate_csv(version, options = {})
+          case version
+          when "2"
+            csv_2(options)
+          when "1"
+            csv_1
+          end
+        end
+
+        private
+
+        def csv_2(options)
+          csv = []
+          if options[:full]
+            datastreams.collect do |datastream|
+              if datastream.datapoints.any?
+                datastream.datapoints.collect { |datapoint| csv << ::CSV.generate_line([id, datastream.id, datapoint.at.iso8601(6), datapoint.value]).strip }
+              else
+                csv << ::CSV.generate_line([id, datastream.id, datastream.updated.iso8601(6), datastream.current_value]).strip
+              end
+ 
+
+            end
+          else
+            datastreams.collect do |datastream|
+              if datastream.datapoints.any?
+                datastream.datapoints.collect { |datapoint| csv << ::CSV.generate_line([datastream.id, datapoint.at.iso8601(6), datapoint.value]).strip }
+              else
+                csv << ::CSV.generate_line([datastream.id, datastream.updated.iso8601(6), datastream.current_value]).strip
+              end
+            end
+          end
+          csv.join("\n")
+        end
+
+        def csv_1
+          ::CSV.generate_line(datastreams.collect {|ds| ds.current_value }).strip
+        end
+      end
+    end
+  end
+end
+

data/lib/cosm-rb/templates/defaults.rb

@@ -0,0 +1,14 @@
+require 'cosm-rb/templates/xml_headers'
+require 'cosm-rb/templates/json/feed_defaults'
+require 'cosm-rb/templates/json/datastream_defaults'
+require 'cosm-rb/templates/json/datapoint_defaults'
+require 'cosm-rb/templates/json/trigger_defaults'
+require 'cosm-rb/templates/json/search_result_defaults'
+require 'cosm-rb/templates/json/key_defaults'
+require 'cosm-rb/templates/xml/feed_defaults'
+require 'cosm-rb/templates/xml/datastream_defaults'
+require 'cosm-rb/templates/xml/datapoint_defaults'
+require 'cosm-rb/templates/xml/search_result_defaults'
+require 'cosm-rb/templates/csv/datapoint_defaults'
+require 'cosm-rb/templates/csv/datastream_defaults'
+require 'cosm-rb/templates/csv/feed_defaults'