xively-rb 0.2.09

data/lib/xively-rb/search_result.rb

@@ -0,0 +1,68 @@
+module Xively
+  class SearchResult
+    ALLOWED_KEYS = %w(totalResults startIndex itemsPerPage results)
+    ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
+
+    include Xively::Templates::JSON::SearchResultDefaults
+    include Xively::Templates::XML::SearchResultDefaults
+    include Xively::Parsers::JSON::SearchResultDefaults
+
+    @@feed_class = Xively::Feed
+
+    def initialize(input = {})
+      if input.is_a?(Hash)
+        self.attributes = input
+      else
+        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 results
+      return [] if @results.nil?
+      @results
+    end
+
+    def as_json(options = {})
+      options[:version] ||= "1.0.0"
+      generate_json(options[:version])
+    end
+
+    def to_json(options = {})
+      MultiJson.dump as_json(options)
+    end
+
+    def to_xml(options = {})
+      options[:version] ||= "0.5.1"
+      generate_xml(options[:version])
+    end
+
+  end
+end
+

data/lib/xively-rb/string_extensions.rb

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

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

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

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

@@ -0,0 +1,43 @@
+module Xively
+  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| Xively::CSV.generate_line(row).strip }.join("\n")
+        end
+
+        def csv_1
+          Xively::CSV.generate_line([current_value]).strip
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,47 @@
+module Xively
+  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 << Xively::CSV.generate_line([id, datastream.id, datapoint.at.iso8601(6), datapoint.value]).strip }
+              else
+                csv << Xively::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 << Xively::CSV.generate_line([datastream.id, datapoint.at.iso8601(6), datapoint.value]).strip }
+              else
+                csv << Xively::CSV.generate_line([datastream.id, datastream.updated.iso8601(6), datastream.current_value]).strip
+              end
+            end
+          end
+          csv.join("\n")
+        end
+
+        def csv_1
+          Xively::CSV.generate_line(datastreams.collect {|ds| ds.current_value }).strip
+        end
+      end
+    end
+  end
+end
+

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

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

data/lib/xively-rb/templates/json/datapoint_defaults.rb

@@ -0,0 +1,15 @@
+module Xively
+  module Templates
+    module JSON
+      module DatapointDefaults
+        def generate_json(version = nil)
+          {
+            :at => at.iso8601(6),
+            :value => value
+          }.delete_if_nil_value
+        end
+      end
+    end
+  end
+end
+

data/lib/xively-rb/templates/json/datastream_defaults.rb

@@ -0,0 +1,61 @@
+module Xively
+  module Templates
+    module JSON
+      module DatastreamDefaults
+
+        def generate_json(version, options={})
+          if version == "1.0.0"
+            output = json_100(options)
+          elsif version == "0.6-alpha"
+            output = json_06alpha(options)
+          end
+          output[:version] = version unless options[:hide_version]
+          !options[:include_blank] ? output.delete_if_nil_value : output
+        end
+
+        private
+
+        # As used by http://xively.com/api/v2/FEED_ID/datastreams/DATASTREAM_ID.json
+        def json_100(options = {})
+          datapoints = self.datapoints.map {|dp| {:value => dp.value, :at => dp.at.iso8601(6)}}
+          {
+            :id => self.id,
+            :current_value => self.current_value,
+            :at => self.updated.iso8601(6),
+            :max_value => self.max_value.to_s,
+            :min_value => self.min_value.to_s,
+            :tags => parse_tag_string(self.tags),
+            :unit => unit_hash(options),
+            :datapoints_function => datapoints_function,
+            :datapoints => datapoints
+          }
+        end
+
+        # As used by http://xively.com/api/v1/FEED_ID/datastreams/DATASTREAM_ID.json
+        def json_06alpha(options = {})
+          {
+            :id => self.id,
+            :values =>
+            [{
+              :recorded_at => updated.iso8601,
+              :value => current_value,
+              :max_value => max_value.to_s,
+              :min_value => min_value.to_s
+            }.delete_if_nil_value],
+            :tags => parse_tag_string(self.tags),
+            :unit => unit_hash(options),
+          }
+        end
+
+        def unit_hash(options={})
+          hash = { :type => unit_type,
+                   :symbol => unit_symbol,
+                   :label => unit_label }
+          !options[:include_blank] ? (hash.delete_if_nil_value if unit_type || unit_label || unit_symbol) : hash
+        end
+
+      end
+    end
+  end
+end
+

data/lib/xively-rb/templates/json/feed_defaults.rb

@@ -0,0 +1,90 @@
+module Xively
+  module Templates
+    module JSON
+      module FeedDefaults
+
+        include Xively::Helpers
+
+        def generate_json(version, options = {})
+          if version == "1.0.0"
+            output = json_100(options)
+          elsif version == "0.6-alpha"
+            output = json_06alpha(options)
+          end
+          !options[:include_blank] ? output.delete_if_nil_value : output
+        end
+
+        private
+
+        # As used by http://xively.com/api/v2/FEED_ID.json
+        def json_100(options = {})
+          {
+            :id => self.id,
+            :title => self.title,
+            :private => self.private.to_s,
+            :icon => icon,
+            :website => website,
+            :tags => parse_tag_string(tags),
+            :description => self.description,
+            :feed  => (feed.blank? ? "" : "#{feed}.json"),
+            :auto_feed_url => auto_feed_url,
+            :status => status,
+            :updated => updated.iso8601(6),
+            :created => created.iso8601(6),
+            :email => email,
+            :creator => creator,
+            :user => ({ :login => owner_login } if owner_login),
+            :version => "1.0.0",
+            :datastreams => datastreams.map {|ds| ds.generate_json("1.0.0", options.merge({:hide_version => true}))},
+            :location => location_hash(options),
+            :product_id => product_id,
+            :device_serial => device_serial
+          }
+        end
+
+
+        # As used by http://xively.com/api/v1/FEED_ID.json
+        def json_06alpha(options = {})
+          {
+            :id => self.id,
+            :title => self.title,
+            :icon => icon,
+            :website => website,
+            :description => self.description,
+            :feed  => (feed.blank? ? "" : "#{feed}.json"),
+            :status => status,
+            :updated => updated.iso8601(6),
+            :email => email,
+            :version => "0.6-alpha",
+            :datastreams => datastreams.map {|ds| ds.generate_json("0.6-alpha", options.merge({:hide_version => true}))},
+            :location => location_hash(options)
+          }
+        end
+
+        private
+
+        def location_hash(options={})
+          hash = { :disposition => location_disposition,
+            :name => location_name,
+            :exposure => location_exposure,
+            :domain => location_domain,
+            :ele => location_ele,
+            :lat => location_lat,
+            :lon => location_lon }
+          hash[:waypoints] = format_location_waypoints if location_waypoints
+          !options[:include_blank] ? (hash.delete_if_nil_value if location_disposition || location_name || location_exposure || location_domain || location_ele || location_lat || location_lon) : hash
+        end
+
+        def format_location_waypoints
+          output = []
+          location_waypoints.each{ |item|
+            output << item
+            output.last[:at] = output.last[:at].iso8601(6)
+          }
+          output
+        end
+      end
+    end
+  end
+end
+

data/lib/xively-rb/templates/json/key_defaults.rb

@@ -0,0 +1,39 @@
+module Xively
+  module Templates
+    module JSON
+      module KeyDefaults
+        def generate_json(options={})
+          if self.permissions
+            s = self.permissions.collect { |s|
+              if s.resources
+                res = s.resources.collect { |r| { :feed_id => r.feed_id, :datastream_id => r.datastream_id, :datastream_trigger_id => r.datastream_trigger_id }.delete_if_nil_value
+                }
+              end
+              {
+                :referer => s.referer,
+                :source_ip => s.source_ip,
+                :label => s.label,
+                :minimum_interval => s.minimum_interval,
+                :access_methods => s.access_methods.collect { |a| a.to_s.downcase },
+                :resources => res
+              }
+            }
+          end
+          output = {
+            :key => {
+              :id => id,
+              :expires_at => expires_at.respond_to?(:iso8601) ? expires_at.iso8601(6) : expires_at,
+              :api_key => key,
+              :user => user,
+              :label => label,
+              :private_access => private_access,
+              :permissions => s
+            }
+          }
+          !options[:include_blank] ? output.delete_if_nil_value : output
+        end
+      end
+    end
+  end
+end
+

data/lib/xively-rb/templates/json/search_result_defaults.rb

@@ -0,0 +1,42 @@
+module Xively
+  module Templates
+    module JSON
+      module SearchResultDefaults
+
+        include Helpers
+
+        def generate_json(version)
+          if version == "1.0.0"
+            json_100.delete_if_nil_value
+          elsif version == "0.6-alpha"
+            json_06alpha.delete_if_nil_value
+          end
+        end
+
+        private
+
+        # As used by http://xively.com/api/v2/feeds.json
+        def json_100
+          {
+            :totalResults => totalResults,
+            :startIndex => startIndex,
+            :itemsPerPage => itemsPerPage,
+            :results => results.collect{|f| f.generate_json("1.0.0")}
+          }
+        end
+
+        # As used by http://xively.com/api/v1/feeds.json
+        def json_06alpha
+          {
+            :totalResults => totalResults,
+            :startIndex => startIndex,
+            :itemsPerPage => itemsPerPage,
+            :results => results.collect{|f| f.generate_json("0.6-alpha")}
+          }
+        end
+
+      end
+    end
+  end
+end
+