stsplatform 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a790360dbbb27d700ed672b733e5bddba655d1e8
-  data.tar.gz: c3b8fd632274ef52429f68d983510272c587c5eb
+  metadata.gz: 10ce676b5c9c86b013b9c5f311b95c5fca7ae912
+  data.tar.gz: 9527b81b6d60262c757aa0bc8e40415505114fd9
 SHA512:
-  metadata.gz: 8795c5ab4e6b944f0892415f54fa550e5f523d8a1f22d9e4414b40fa2c4420d5e3192af130d20c308659a6e94556f0386c21c659542c0c1518f7f2e671c449bc
-  data.tar.gz: b6a9ef01aa5c5d41b90dfee813690ea5ffe3fe698adb400dd0bb61a9fcd8de5f81ae9fd1a4e1f6ceaa811dd30e121dfbbcc403c28abb86d5c9db8cfd267c5b83
+  metadata.gz: d537eb5ac23328cba3a49392d2d3173c2ee43dab729706e837a364575e639699ead900438ce7e8839fe579a7d559b7c297b202741dbaaaa22e5834d3e49451a6
+  data.tar.gz: f56fedf746aa9b5c2c7502644d38d486c433492f0b3862353c389cf18124dae36ed86cbb3be906ff927529063fcbd0c09b3e4fa6364a0f055cfb53cbb2ed7490

data/README.md

@@ -1,8 +1,6 @@
 # Stsplatform
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stsplatform`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem allows you to use the STS Platform API, including the community version WoTKit.
 
 ## Dependencies
 

data/lib/stsplatform/client.rb

@@ -2,6 +2,21 @@ require "stsplatform/version"
 
 module STSPlatform
 
+
+  # The base class of this library.
+  # Params:
+  # +config+:: (optional) a configuration dictionary
+  # Returns:
+  # +STSPlatformResponse+:: object containing "data" and "code" parameters
+  # The configuration should be:
+  # {
+  #    "url": "http://wotkit.sensetecnic.com/api",
+  #    "auth": {}
+  # }
+  # Auth should contain either username and password or oauth key, for example:
+  # {"username":"john", "password":"smith"} or
+  # {"oauth_key":"2341lkj2f12341"}
+
   class Client < RequestHandler
     def initialize(config=nil)
       super(nil)

data/lib/stsplatform/data.rb

@@ -2,6 +2,13 @@ require "stsplatform/version"
 
 module STSPlatform
 
+  # The Data resource of the STS Platform API
+  # Params:
+  # +handler+:: a sensor object
+  # +id+:: (optional) the id (timestamp of the data), only used to delete
+  # Returns:
+  # +STSPlatformResponse+:: object containing "data" and "code" parameters
+  # Inherits from RequestHandler, with access to the get, post, put and delete methods.
   class Data < RequestHandler
     def initialize(handler, id="")
       super(handler,id)

data/lib/stsplatform/fields.rb

@@ -2,6 +2,13 @@ require "stsplatform/version"
 
 module STSPlatform
 
+  # The Fields resource of the STS Platform API
+  # Params:
+  # +handler+:: a client object
+  # +id+:: (optional) the numerical or string id of the field
+  # Returns:
+  # +STSPlatformResponse+:: object containing "data" and "code" parameters
+  # Inherits from RequestHandler, with access to the get, post, put and delete methods.
   class Fields < RequestHandler
     def initialize(handler, id="")
       super(handler,id)

data/lib/stsplatform/orgs.rb

@@ -2,6 +2,13 @@ require "stsplatform/version"
 
 module STSPlatform
 
+  # The Orgs resource of the STS Platform API
+  # Params:
+  # +handler+:: a client object
+  # +id+:: (optional) the numerical or string id of the organization
+  # Returns:
+  # +STSPlatformResponse+::  object containing "data" and "code" parameters
+  # Inherits from RequestHandler, with access to the get, post, put and delete methods.
   class Orgs < RequestHandler
     def initialize(handler, id="")
       super(handler,id)

data/lib/stsplatform/requesthandler.rb

@@ -4,7 +4,8 @@ require 'json'
 
 module STSPlatform
 
-  #TODO: move classes onto their own files
+  # Main handler of the library. Defines successors in the chain of responsibility
+  # and in our case handles the REST requests to the STS Platform.
   class RequestHandler
     attr_accessor :url, :_successor, :resource, :auth
 

data/lib/stsplatform/sensors.rb

@@ -2,6 +2,14 @@ require "stsplatform/version"
 
 module STSPlatform
 
+
+  # The Sensors resource of the STS Platform API
+  # Params:
+  # +handler+:: a client object
+  # +id+:: (optional) the numerical or string id of the sensor
+  # Returns:
+  # +STSPlatformResponse+:: object containing "data" and "code" parameters
+  # Inherits from RequestHandler, with access to the get, post, put and delete methods.
   class Sensors < RequestHandler
     def initialize(handler, id="")
       super(handler,id)

data/lib/stsplatform/stsplatformerror.rb

@@ -1,4 +1,6 @@
 module STSPlatform
+
+  # A custom error that makes it easier to track errors when debugging.  
   class STSPlatformError < StandardError
   end
 end

data/lib/stsplatform/stsplatformresponse.rb

@@ -1,6 +1,12 @@
 require 'json'
 
 module STSPlatform
+
+  # A custom response object from our library
+  # Params:
+  # +response+:: an Net::HTTP error response
+  # Returns:
+  # +STSPlatformResponse+:: object containing "data" and "code" parameters
   class STSPlatformResponse
     attr_accessor :data, :code
     def initialize(response)

data/lib/stsplatform/version.rb

@@ -1,3 +1,3 @@
 module Stsplatform
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stsplatform
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - SenseTecnic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json