cosm-rb 0.0.2 → 0.0.3

data/.travis.yml

@@ -8,3 +8,9 @@ rvm:
  - 1.8.7
  - 1.9.2
  - 1.9.3
+ - jruby-18mode
+ - jruby-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode

data/MIT-LICENSE

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

data/README.md

@@ -1,195 +1,18 @@
 [![Build Status](https://secure.travis-ci.org/cosm/cosm-rb.png)](http://travis-ci.org/cosm/cosm-rb)
 
-Cosm gem
-========================
+## Cosm gem
 
-WORK IN PROGRESS
+Use this gem if you would like to convert between Cosm data formats or represent Cosm objects in Ruby.
+You can also interact with the Cosm REST API using this gem.
 
-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.
+### Documentation
 
-  [1]: https://cosm.com/docs/v2/ "Cosm Api Docs"
+Documentation can be found on the [wiki](https://github.com/cosm/cosm-rb/wiki/Documentation).
 
-By default the gem expects your object to have the following fields:
+### Examples
 
-#### Feeds
+A working example using this gem can be found [here](https://github.com/levent/cosm_app-rb/)
 
- * 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>
+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.
 
-    

data/cosm-rb.gemspec

@@ -17,12 +17,16 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("yajl-ruby", ">=0.8.1")
+  if defined?(JRUBY_VERSION)
+    s.add_dependency("json_pure")
+  else
+    s.add_dependency("yajl-ruby", ">=0.8.1")
+  end
   s.add_dependency("nokogiri", ">=1.4.4")
   s.add_dependency("httparty", ">=0.8.3")
 
   begin
-    if RUBY_VERSION < "1.9"
+    if RUBY_VERSION < "1.9" && !defined?(JRUBY_VERSION)
       s.add_development_dependency("ruby-debug")
       s.add_development_dependency("rcov", ">=0.9.9")
     end

data/lib/cosm-rb.rb

@@ -1,5 +1,9 @@
 require 'nokogiri'
-require 'yajl/json_gem'
+if defined?(JRUBY_VERSION)
+  require 'json/pure'
+else
+  require 'yajl/json_gem'
+end
 require 'csv'
 
 $:.unshift(File.dirname(File.expand_path(__FILE__)))

data/lib/cosm-rb/version.rb

@@ -1,3 +1,3 @@
 module Cosm #:nodoc:
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cosm-rb
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Paul Bellamy
@@ -17,10 +17,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-21 00:00:00 +01:00
+date: 2012-06-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -32,11 +34,11 @@ dependencies:
         - 8
         - 1
         version: 0.8.1
-  prerelease: false
-  type: :runtime
   requirement: *id001
   name: yajl-ruby
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -48,11 +50,11 @@ dependencies:
         - 4
         - 4
         version: 1.4.4
-  prerelease: false
-  type: :runtime
   requirement: *id002
   name: nokogiri
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -64,11 +66,11 @@ dependencies:
         - 8
         - 3
         version: 0.8.3
-  prerelease: false
-  type: :runtime
   requirement: *id003
   name: httparty
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -78,11 +80,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
   requirement: *id004
   name: ruby-debug
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -94,11 +96,11 @@ dependencies:
         - 9
         - 9
         version: 0.9.9
-  prerelease: false
-  type: :development
   requirement: *id005
   name: rcov
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -110,11 +112,11 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  prerelease: false
-  type: :development
   requirement: *id006
   name: rake
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -126,8 +128,6 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
-  prerelease: false
-  type: :development
   requirement: *id007
   name: rspec
 description: A library for communicating with the Cosm REST API, parsing and rendering Cosm feed formats