cosm-rb 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.bundle/*
+*.swp
+*.swo
+Gemfile.lock
+.gem/*
+build_artefacts/*
+coverage/*
+debug.log
+test.sqlite3.db
+*.gem
+*.orig

data/.rbenv-version

@@ -0,0 +1 @@
+1.8.7-p249

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.8.7-p249@pachube_data_formats

data/.travis.yml

@@ -0,0 +1,10 @@
+branches:
+  only:
+    - cosm-rb
+    - master
+    - version_0.3.xx_branch
+language: ruby
+rvm:
+ - 1.8.7
+ - 1.9.2
+ - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+## 0.1.11
+ * Keys always have a root node of 'keys'
+
+## 0.1.10
+ * Adding label field to Keys
+ * should pass options through to Key#as_json
+ * Clearing up some confusion with trigger/key parsers
+ * Improving the Key.to_json error handling
+
+## 0.1.09
+ * Adding Key model for api keys, XML/JSON parsers, and JSON template
+
+## 0.1.08
+ * Rewrote tag string parser
+
+## 0.1.07
+ * Adding some validations on feed_id for datastreams and datapoints
+
+## 0.1.06
+ * Feeds should invalidate with duplicate datastream ids or invalid datastreams
+ * Fixed a bug in Template#method_missing
+
+## 0.1.05
+ * Added CSV feed parsing with autodetection of version
+
+## 0.1.04
+ * Added user node parsers to Feed eeml 0.5.1 and json 1.0.0
+
+## 0.1.03
+ * Added owner_login and owner_user_level to Feed
+ * user node added to json 1.0.0 and eeml 0.5.1 templates for Feed
+
+## 0.1.02
+ * Bug fix release
+ * Handling empty (nil) datastreams in json 1.0.0 (feeds and search results)
+
+## 0.1.01
+ * Major release that 
+ * Eliminates requirement for ActiveSupport / ActiveModel
+ * PachubeDataFormat objects have basic validation
+
+## 0.0.3
+ * Ignore nil tags with json parsers
+ * Added templates for datastream level eeml 005 and 0.5.1
+ * Added templates for EEML 005 and 0.5.1 (v1 / v2)
+ * Eeml 0.5.1 and 5 datastream parser
+ * Eeml 0.5.1 and 5 feed parser
+ * Providing as_pachube_xml on AR records
+ * Adding creator to default xml parsers
+ * encode xml in utf-8
+ * Adding feed_id and feed_creator onto datastream (used by xml)
+ * Creator is always http://www.haque.co.uk in v1 xml
+ * Creator always http://www.haque.co.uk in v1 templates
+ * First pass at a Datapoint model w/ parsers and templates
+ * Added datapoints to json parser
+ * Creating datapoint templates
+ * Templates append format onto feed url
+ * order of xml attributes
+ * Hash#delete_if_nil_value
+ * Completely ignore unit nodes in xml if no unit attributes present
+ * iso8601 shouldn't be to precision of v2 api     ignore nil.iso8601 calls
+ * Allow excluding datastreams
+ * Hooking up datapoints into ActiveRecord
+ * Bug fix: Datapoint json template wasn't formatting time to iso8601(6)
+ * datapoint templates need no version as there is only one
+ * moving private node
+ * Hide min/max value nodes on eeml 0.5.1 templates
+ * Simplifying ActiveRecord hooks     Updated documentation
+ * Datapoint templates should iso8601 at     Feed json template datapoints in iso8601(6)
+ * Added json template for search results
+ * XML and JSON templates for search results
+ * Adding opensearch namespace and nodes
+ * Merge branch 'hotfix-0.0.2' into develop
+ * Incorporating hotfix changes into search results
+ * Restructure of lib
+ * Basic csv for datapoints (full and minimal)
+ * Basic csv for datastreams and feeds      * V1      * V2      * V2 full
+ * Allows options to be passed to to_csv
+ * KICK: Keep it consistent knucklehead
+ * Datastream#to_csv shows datapoints      * options[:both] will include datastream as first element      * Will only show datastream if no datapoints      * Will only show all datapoints if any
+ * Escaping csv cells properly
+ * Handling datapoints in feed#to_csv
+ * Adding depth option to datapoint#to_csv
+ * Adding depth option to datastream#to_csv
+ * Ignoring units in eeml if no attributes present
+ * Refactoring specs
+ * Handle empty tags in xml
+ * Ignore primary nodes in xml feed templates
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Gem dependencies specified in pachube_data_formats.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Connected Enviroments Ltd.
+
+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
+
+

data/README.md

@@ -0,0 +1,195 @@
+[![Build Status](https://secure.travis-ci.org/pachube/pachube_data_formats.png)](http://travis-ci.org/pachube/pachube_data_formats)
+
+Cosm gem
+========================
+
+WORK IN PROGRESS
+
+This gem will convert between Cosm Data Formats.
+You can use it to prepare data for sending to Cosm or for parsing data received from Cosm.
+
+Allowed inputs
+--------------
+
+ * XML (EEML)
+ * JSON
+ * CSV
+
+Outputs
+-------
+
+ * XML (EEML)
+ * JSON
+ * CSV
+
+Cosm Interface
+----------------------------
+
+If you have your own model that maps to a Cosm Feed (such as an ActiveRecord model), this plugin will provide many convenience methods to convert your objects into Cosm objects.
+
+### Example with ActiveRecord
+
+    class Datastream < ActiveRecord::Base
+      belongs_to :feed
+    end
+
+    class Feed < ActiveRecord::Base
+      has_many :datastreams
+      extend Cosm::Base
+      is_cosm :feed
+    end
+
+### Provided methods
+  
+    @cosm_feed = feed.to_cosm # returns an instance of Cosm::Feed
+    @cosm_feed.to_json(:version => "1.0.0") # converts your feed and associated datastreams into Cosm V2 JSON
+    @cosm_feed.as_json(:version => "0.6-alpha") # provides a json hash for 0.6-alpha
+    @cosm_feed.to_xml(:version => "0.5.1") # converts your feed and associated datastreams into Cosm V2 XML (EEML)
+
+### Supported formats
+
+ * JSON "1.0.0" - used by Cosm API v2
+ * JSON "0.6-alpha" - used by Cosm API v1
+ * XML "0.5.1" - used by Cosm API v2
+ * XML "5" - used by Cosm API v1
+ * CSV v1 - used by Cosm API v1
+ * CSV v2 - used by Cosm API v2
+
+### Mapped fields
+
+See [the Cosm Api docs] [1] for a description of each field.
+
+  [1]: https://cosm.com/docs/v2/ "Cosm Api Docs"
+
+By default the gem expects your object to have the following fields:
+
+#### Feeds
+
+ * creator
+ * datastreams
+ * description
+ * email
+ * feed
+ * icon
+ * id
+ * location_disposition
+ * location_domain
+ * location_ele
+ * location_exposure
+ * location_lat
+ * location_lon
+ * location_name
+ * private
+ * status
+ * tags
+ * title
+ * updated
+ * website
+
+
+#### Datastreams
+
+ * current_value
+ * datapoints
+ * feed_creator
+ * feed_id
+ * id
+ * max_value
+ * min_value
+ * tags
+ * unit_label
+ * unit_symbol
+ * unit_type
+ * updated
+
+#### Datapoints
+
+ * at
+ * value
+ * feed_id
+ * datastream_id
+
+If you use different field names, want to map custom fields or want to map fields onto instance methods you can:
+
+    class Feed < ActiveRecord::Base
+      extend Cosm::Base
+
+      has_one :geo_location
+      is_cosm :feed, {:location_lat => :geo_lat, :location_lon => :geo_lon}
+
+      def geo_lat
+        geo_location.try(:latitude)
+      end
+
+      def geo_lon
+        geo_location.try(:longitude)
+      end
+    end
+
+Examples using the Cosm objects
+--------------------------------------------
+
+    feed = Cosm::Feed.new('{"title":"Cosm Office Environment"}')
+    feed.as_json # {"title" => "Cosm Office Environment"}
+    feed.to_json # {"title":"Cosm Office Environment"}
+    feed.to_xml
+      #  <?xml version="1.0" encoding="UTF-8"?
+      #  <eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd"> 
+      #    <environment updated="2010-11-11T15:57:17.637887Z" id="12567" creator="https://cosm.com"> 
+      #      <title>Cosm Office Environment</title>
+      #    </environment>
+      #  </eeml>
+    feed.attributes # {:title => "Cosm Office Environment"}
+
+### Parsing a Datastream using json
+
+    json = '
+      {
+          "max_value": "658.0",
+          "current_value": "14",
+          "datapoints": [{
+              "value": "1",
+              "at": "2011-03-02T15:59:56.895922Z"
+          },
+          {
+              "value": "1",
+              "at": "2011-03-02T16:00:07.188648Z"
+          },
+          {
+              "value": "2",
+              "at": "2011-03-02T16:00:18.416500Z"
+          }],
+          "min_value": "0.0",
+          "id": "0",
+          "tags": ["humidity", "Temperature", "freakin lasers"],
+          "version": "1.0.0",
+          "unit": {
+              "label": "percentage",
+              "symbol": "%",
+              "type": "derived SI"
+          },
+          "at": "2011-02-16T16:21:01.834174Z"
+      }'
+    datastream = Cosm::Datastream.new(json)
+    datastream.to_xml # =>
+    # <?xml version="1.0" encoding="UTF-8"?>
+    # <eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+    #   <environment creator="" updated="2011-02-16T16:21:01.834174Z" id="">
+    #     <data id="0">
+    #       <tag>freakin lasers</tag>
+    #       <tag>humidity</tag>
+    #       <tag>Temperature</tag>
+    #       <current_value at="2011-02-16T16:21:01.834174Z">14</current_value>
+    #       <max_value>658.0</max_value>
+    #       <min_value>0.0</min_value>
+    #       <unit type="derived SI" symbol="%">percentage</unit>
+    #       <datapoints>
+    #         <value at="2011-03-02T15:59:56.895922Z">1</value>
+    #         <value at="2011-03-02T16:00:07.188648Z">1</value>
+    #         <value at="2011-03-02T16:00:18.416500Z">2</value>
+    #       </datapoints>
+    #     </data>
+    #   </environment>
+    # </eeml>
+
+    

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+
+#require 'rake/testtask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require "rspec/core/rake_task"
+
+CLEAN.include('pkg')
+CLEAN.include('coverage')
+CLOBBER.include('html')
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+# run tests before building
+task :build => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new do |t|
+end
+
+desc "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov => :clean) do |t|
+  t.rcov = true
+  t.rcov_opts = '--exclude .gem/*,spec/*,.bundle/*,config/*,.rvm/*'
+end
+
+namespace :spec do
+  desc "Run all specs tagged with :focus => true"
+  RSpec::Core::RakeTask.new(:focus) do |t|
+    t.rspec_opts = "--tag focus"
+    t.verbose = true
+  end
+end

data/ci/build_hudson.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+set -e
+set -u
+set -x
+#TODO: script the installation of the pre-reqs: sqlite3
+#sudo apt-get install sqlite3 libsqlite3-dev libsqlite3-ruby
+
+outdir='build_artefacts'
+rm -rf $outdir
+mkdir -p $outdir
+
+echo "started build script $0 in `$outdir` at `date`"
+
+show_platform.sh > $outdir/platform.txt 2>&1 || true
+
+echo "Running custom build.sh - install bundle, rake"
+bundle --path=.gem/
+set +e
+bundle exec rake rcov > $outdir/testtask.log
+spec_rc=$?
+set -e
+
+exit $spec_rc

data/cosm-rb.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cosm-rb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cosm-rb"
+  s.version     = Cosm::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Bellamy", "Levent Ali", "Sam Mulube"]
+  s.email       = ["paul.a.bellamy@gmail.com", "lebreeze@gmail.com", "sam@pachube.com"]
+  s.homepage    = "http://github.com/pachube/pachube_data_formats"
+  s.summary     = "A library for communicating with the Cosm REST API, parsing and rendering Cosm feed formats"
+  s.description = "A library for communicating with the Cosm REST API, parsing and rendering Cosm feed formats"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_rubygems_version = ">=1.6.2"
+
+  s.add_dependency("yajl-ruby", ">=0.8.1")
+  s.add_dependency("nokogiri", ">=1.4.4")
+  s.add_dependency("httparty", ">=0.8.3")
+
+  begin
+    if RUBY_VERSION < "1.9"
+      s.add_development_dependency("ruby-debug")
+      s.add_development_dependency("rcov", ">=0.9.9")
+    end
+  rescue
+    p "Could not detect ruby version"
+  end
+  s.add_development_dependency("rake", "=0.8.7")
+  s.add_development_dependency("rspec", "=2.6.0")
+
+  s.extra_rdoc_files = ["README.md", "CHANGELOG.md", "MIT-LICENSE"]
+  s.rdoc_options << '--main' << 'README'
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+require 'lib/cosm-rb'
+

data/lib/cosm-rb/array_extensions.rb

@@ -0,0 +1,6 @@
+class Array
+  def split(pattern = nil, limit = nil)
+    self
+  end
+end
+

data/lib/cosm-rb/base/instance_methods.rb

@@ -0,0 +1,28 @@
+module Cosm
+  module Base
+    module InstanceMethods
+      
+      # Converts a model that extends Cosm::Base into it's equivalent Cosm object
+      #  this can then be used to convert into xml, json or csv
+      def to_cosm
+        attributes = {}
+        self.class.cosm_class::ALLOWED_KEYS.each do |key|
+          attributes[key] = self.send(key) if self.respond_to?(key)
+        end
+        self.class.cosm_class.new(attributes.merge(custom_cosm_attributes))
+      end
+
+      protected
+
+      def custom_cosm_attributes(options = {})
+        hash = {}
+        self.class.cosm_mappings.each do |key, value|
+          hash[key.to_s] = self.send(value)
+        end
+        hash
+      end
+
+    end
+  end
+end
+

data/lib/cosm-rb/base.rb

@@ -0,0 +1,52 @@
+require 'cosm-rb/base/instance_methods'
+
+module Cosm
+  # Provide an interface for your model objects by extending this module:
+  # extend Cosm::Base
+  #
+  # This provides the following configuration class method:
+  # is_cosm:
+  #   - specifies that this model represents all or part of a Cosm feed
+  module Base
+
+      # Provides methods for converting between the different Cosm API data formats
+      # An example for a model representing a Cosm feed:
+      #
+      #   is_cosm :feed
+      #
+      # A datastream
+      #
+      #   is_cosm :datastream
+      #
+      # To specify custom field mappings or map methods onto a field
+      #
+      #   is_cosm :feed, {:title => :my_custom_instance_method, :status => :determine_feed_state}
+      #
+      def is_cosm(klass, options = {})
+        @options = options
+        case klass
+        when :feed
+          @cosm_class = Cosm::Feed
+        when :datastream
+          @cosm_class = Cosm::Datastream
+        when :datapoint
+          @cosm_class = Cosm::Datapoint
+        else
+          @cosm_class = nil
+        end
+
+        class << self
+          def cosm_mappings
+            @options
+          end
+
+          def cosm_class
+            @cosm_class
+          end
+        end
+
+        send :include, Cosm::Base::InstanceMethods
+      end
+  end
+end
+

data/lib/cosm-rb/client.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+module Cosm
+  class Client
+    include HTTParty
+    base_uri 'https://api.cosm.com'
+  end
+end

data/lib/cosm-rb/datapoint.rb

@@ -0,0 +1,71 @@
+module Cosm
+  class Datapoint
+    ALLOWED_KEYS = %w(feed_id datastream_id at value)
+    ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
+
+    include Cosm::Templates::JSON::DatapointDefaults
+    include Cosm::Templates::XML::DatapointDefaults
+    include Cosm::Templates::CSV::DatapointDefaults
+    include Cosm::Parsers::JSON::DatapointDefaults
+    include Cosm::Parsers::XML::DatapointDefaults
+
+    # validates_presence_of :datastream_id
+    # validates_presence_of :value
+
+    include Validations
+
+    def valid?
+      pass = true
+      [:datastream_id, :value, :feed_id].each do |attr|
+        if self.send(attr).blank?
+          errors[attr] = ["can't be blank"]
+          pass = false
+        end
+      end
+      return pass
+    end
+
+    def initialize(input = {})
+      if input.is_a? Hash
+        self.attributes = input
+      elsif input.strip[0...1].to_s == "{"
+        self.attributes = from_json(input)
+      else
+        self.attributes = from_xml(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?
+      input.deep_stringify_keys!
+      ALLOWED_KEYS.each { |key| self.send("#{key}=", input[key]) }
+      return attributes
+    end
+
+    def as_json(options = {})
+      generate_json(options[:version])
+    end
+
+    def to_json(options = {})
+      ::JSON.generate as_json(options)
+    end
+
+    def to_xml(options = {})
+      generate_xml(options[:version])
+    end
+
+    def to_csv(options = {})
+      generate_csv(options.delete(:version), options)
+    end
+  end
+end
+