stsplatform 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a790360dbbb27d700ed672b733e5bddba655d1e8
+  data.tar.gz: c3b8fd632274ef52429f68d983510272c587c5eb
+SHA512:
+  metadata.gz: 8795c5ab4e6b944f0892415f54fa550e5f523d8a1f22d9e4414b40fa2c4420d5e3192af130d20c308659a6e94556f0386c21c659542c0c1518f7f2e671c449bc
+  data.tar.gz: b6a9ef01aa5c5d41b90dfee813690ea5ffe3fe698adb400dd0bb61a9fcd8de5f81ae9fd1a4e1f6ceaa811dd30e121dfbbcc403c28abb86d5c9db8cfd267c5b83

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stsplatform.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roberto
+
+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
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,191 @@
+# 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
+
+## Dependencies
+
+* Ruby > 2.2.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stsplatform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stsplatform
+
+## Getting Started
+
+Require the stsplatform gem. Make sure to install it
+To install from source run: "bundle exec rake install"
+to install from RubyGems run : "gem install stsplatform"
+
+```
+require 'stsplatform'
+```
+
+Create an STS Platform client:
+
+```
+c = STSPlatform::Client.new()
+```
+
+
+Print a sensor hosted in the platform:
+
+```
+s = STSPlatform::Sensors.new(c, 'calderonroberto.demo')
+res = s.get()
+puts res.data
+```
+
+Print some data (last data point):
+
+To acccess data from a sensor create a data object that uses the sensor object
+
+```
+d = STSPlatform::Data.new(s)
+res = d.get({beforeE:1})
+puts res.data
+```
+
+## Using the Library
+
+All methods rely on the Client Class. The parameter CONF is not required, but allows you to configure your client to specify your credentials and url of the STS Platform instance you want to access. By default the client will use the community edition of the STS Platform (WoTKit):
+
+A common configuration object is:
+
+```
+CONF = {
+  url:"http://wotkit.sensetecnic.com/api",
+  auth:{key_id:YOURKEYID,key_password:YOURKEYPASSWORD}
+  }
+```
+
+You can then instantiate your client like this:
+
+```
+c = STSPlatform::Client.new(CONF)
+```
+
+To access resources you build them hierarchically. A sensor lives in an STS Platform Server:
+
+
+```
+c = STSPlatform::Client.new(CONF)
+s = STSPlatform::Sensors.new(c, 'SENSORNAME')
+```
+
+Sensor data lives in a Sensor:
+
+```
+c = STSPlatform::Client.new(CONF)
+s = STSPlatform::Sensors.new(c, 'SENSORNAME')
+d = STSPlatform::Data .new(s)
+```
+
+And so on. Each element that uses the Client class can access GET, POST, PUT and DELETE methods. These methods take parameters and return a STSPlatformResponse object containing "data" and "code". Data is the parsed response from the STS Platform server. Code is a string response code from the STS Platform server:
+
+```
+c = STSPlatform::Client.new(CONF)
+s = STSPlatform::Sensors.new(c, 'SENSORNAME')
+d = STSPlatform::Data .new(s)
+response = d.get({parameter:parametervalue})
+
+puts response.code
+puts response.data
+```
+
+For more information on the API, support and examples visit [http://developers.sensetecnic.com](http://developers.sensetecnic.com)
+
+## Supported Resources
+
+To get started first require the library
+
+```
+require 'stsplatform'
+```
+
+### Configuring the Client
+
+By default the library does not need a configuration to access public sensors. You can configure the client to use a different STS Platform URL (in this case the free version 'WoTKit'). You can also configure it to use a username and password or a valid key_id and key_password:
+
+```
+conf = {
+  url:"http://wotkit.sensetecnic.com/api",
+  #auth:{key_id:YOURKEYID,key_password:YOURKEYPASSWORD}
+  #auth:{username:USERNAME,password:PASSWORD}
+  }
+client = STSPlatform::Client.new(conf)
+```
+
+### Get Sensors
+
+```
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+puts s.get().data
+```
+
+### Get Data
+
+```
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+d = STSPlatform::Data.new(s)
+puts d.get({beforeE:1}).data
+```
+
+### Publish Data
+
+```
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+d = STSPlatform::Data.new(s)
+puts d.post({value:100}).code #print response code
+puts d.get({beforeE:1}).data
+```
+
+### Get Sensor Fields
+
+```
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+fs = STSPlatform::Fields.new(s)
+puts fs.get().data
+f = STSPlatform::Fields.new(s, "value")
+puts f.get().data
+```
+
+### Organizations
+
+```
+c = STSPlatform::Client.new(config)
+o = STSPlatform::Orgs.new(c, 'sensetecnic')
+puts o.get().data
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+* To install this gem onto your local machine, run `bundle exec rake install`.
+* To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SenseTecnic/stsplatform-lib-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stsplatform"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/advanced_example.rb

@@ -0,0 +1,49 @@
+require 'stsplatform'
+
+#TODO: Configure your credentials and sensor
+SENSOR_NAME = ''
+KEY_ID = ''
+KEY_PASSWORD = ''
+
+config = {auth:{key_id:KEY_ID,key_password:KEY_PASSWORD}}
+
+### Get Sensors
+
+puts "\nGet Sensors"
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+puts s.get().data
+
+### Get Data
+
+puts "\nGet Data"
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+d = STSPlatform::Data.new(s)
+puts d.get({beforeE:1}).data
+
+### Publish Data
+
+puts "\nPublish Data"
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+d = STSPlatform::Data.new(s)
+puts d.post({value:100}).code #print response code
+puts d.get({beforeE:1}).data
+
+### Get Sensor Fields
+
+puts "\nSensor Fields"
+c = STSPlatform::Client.new(config)
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+fs = STSPlatform::Fields.new(s)
+puts fs.get().data
+f = STSPlatform::Fields.new(s, "value")
+puts f.get().data
+
+### Organizations
+
+puts "\nGet Organization"
+c = STSPlatform::Client.new(config)
+o = STSPlatform::Orgs.new(c, 'sensetecnic')
+puts o.get().data

data/examples/simple_example.rb

@@ -0,0 +1,28 @@
+# Require the stsplatform gem. Make sure to install it
+# To install from source run: "bundle exec rake install"
+# to install from RubyGems run : "gem install stsplatform"
+require 'stsplatform'
+
+# A sensor to use for this example. We will use
+SENSOR_NAME = 'calderonroberto.demo'
+
+# First, create a client that will handle all the REST calls
+c = STSPlatform::Client.new()
+
+# Create a sensor object, that uses the client:
+s = STSPlatform::Sensors.new(c, SENSOR_NAME)
+
+# Print the sensor object:
+res = s.get()
+puts res.data
+puts res.code
+
+# To acccess data from a sensor create a data object that uses the sensor object
+d = STSPlatform::Data.new(s)
+
+# Print the last data point. Do a get request on the data resource, passing
+# a parameter: "beforeE", according to:
+# http://wotkit.readthedocs.org/en/latest/api_v1/api_sensor_data.html#raw-data-retrieval
+res = d.get({beforeE:1})
+puts res.data
+puts res.code

data/lib/stsplatform/client.rb

@@ -0,0 +1,14 @@
+require "stsplatform/version"
+
+module STSPlatform
+
+  class Client < RequestHandler
+    def initialize(config=nil)
+      super(nil)
+      unless config.nil?
+        self.set_config(config)
+      end
+    end
+  end
+
+end

data/lib/stsplatform/data.rb

@@ -0,0 +1,11 @@
+require "stsplatform/version"
+
+module STSPlatform
+
+  class Data < RequestHandler
+    def initialize(handler, id="")
+      super(handler,id)
+    end
+  end
+
+end

data/lib/stsplatform/fields.rb

@@ -0,0 +1,11 @@
+require "stsplatform/version"
+
+module STSPlatform
+
+  class Fields < RequestHandler
+    def initialize(handler, id="")
+      super(handler,id)
+    end
+  end
+
+end

data/lib/stsplatform/orgs.rb

@@ -0,0 +1,11 @@
+require "stsplatform/version"
+
+module STSPlatform
+
+  class Orgs < RequestHandler
+    def initialize(handler, id="")
+      super(handler,id)
+    end
+  end
+
+end

data/lib/stsplatform/requesthandler.rb

@@ -0,0 +1,142 @@
+require "stsplatform/version"
+require 'net/http'
+require 'json'
+
+module STSPlatform
+
+  #TODO: move classes onto their own files
+  class RequestHandler
+    attr_accessor :url, :_successor, :resource, :auth
+
+    def initialize(successor=nil,id="")
+      @url = "http://wotkit.sensetecnic.com/api"
+      @_successor = successor
+      resource =  self.class.name.downcase.split('::').last || ''
+      @resource = "/#{resource}/#{id.to_s}"
+      @auth = nil
+    end
+
+    def set_config(config)
+      if config.has_key?(:url)
+        unless /http:\/\//.match(config[:url]).nil?
+          @url = config[:url]
+        else
+          raise STSPlatform::STSPlatformError.new("Malformed URL string")
+        end
+      end
+      if config.has_key?(:auth)
+        unless config[:auth].has_key?(:username) || config[:auth].has_key?(:key_id)
+            raise STSPlatform::STSPlatformError.new("Malformed Auth Hash. Must contain username or key_id")
+        end
+        if config[:auth].has_key?(:username)
+          @auth = {key_id:config[:auth][:username],key_password:config[:auth][:password]}
+        elsif config[:auth].has_key?(:key_id)
+          @auth = config[:auth]
+        end
+      end
+
+    end
+
+    def set_handler(handler)
+      @_successor = handler
+    end
+
+    def get(params=nil,resource="")
+      unless @_successor.nil?
+        return @_successor.get(params,@resource + resource)
+      else
+        uri = URI.parse(@url+resource)
+        uri.query = URI.encode_www_form(handle_params(params))
+        req = Net::HTTP::Get.new(uri)
+        unless handle_authentication().nil?
+          req.basic_auth auth[:key_id].to_s, auth[:key_password].to_s
+        end
+        res = Net::HTTP.start(uri.hostname, uri.port) {|http|
+          http.request(req)
+        }
+        return handle_response(res)
+      end
+    end
+
+    def post(payload=nil,resource="")
+      unless @_successor.nil?
+        return @_successor.post(payload,@resource + resource)
+      else
+        uri = URI.parse(@url+resource)
+        req = Net::HTTP::Post.new(uri, initheader={'Content-Type'=>'application/json'})
+        req.body = handle_payload(payload)
+        unless handle_authentication().nil?
+          req.basic_auth auth[:key_id].to_s, auth[:key_password].to_s
+        end
+        res = Net::HTTP.start(uri.hostname, uri.port) {|http|
+          http.request(req)
+        }
+        return handle_response(res)
+      end
+    end
+
+    def put(payload=nil,resource="")
+      unless @_successor.nil?
+        return @_successor.put(payload,@resource + resource)
+      else
+        uri = URI.parse(@url+resource)
+        req = Net::HTTP::Put.new(uri, initheader={'Content-Type'=>'application/json'})
+        req.body = handle_payload(payload)
+        unless handle_authentication().nil?
+          req.basic_auth auth[:key_id].to_s, auth[:key_password].to_s
+        end
+        res = Net::HTTP.start(uri.hostname, uri.port) {|http|
+          http.request(req)
+        }
+        return handle_response(res)
+      end
+    end
+
+    def delete(payload=nil,resource="")
+      unless @_successor.nil?
+        return @_successor.delete(payload,@resource + resource)
+      else
+        uri = URI.parse(@url+resource)
+        req = Net::HTTP::Delete.new(uri, initheader={'Content-Type'=>'application/json'})
+        req.body = handle_payload(payload)
+        unless handle_authentication().nil?
+          req.basic_auth auth[:key_id].to_s, auth[:key_password].to_s
+        end
+        res = Net::HTTP.start(uri.hostname, uri.port) {|http|
+          http.request(req)
+        }
+        return handle_response(res)
+      end
+    end
+
+    private
+
+      def handle_response(response)
+        return STSPlatform::STSPlatformResponse.new(response)
+      end
+
+      def handle_authentication()
+        #if need handle authentication do it here
+        return @auth
+      end
+
+      def handle_params(params)
+        if params.nil?
+          return {}
+        else
+          return params
+        end
+      end
+
+      def handle_payload(payload)
+        pay = handle_params(payload)
+        begin
+          return JSON.generate(pay)
+        rescue
+          raise STSPlatform::STSPlatformError.new("Malformed payload")
+        end
+      end
+
+  end
+
+end

data/lib/stsplatform/sensors.rb

@@ -0,0 +1,11 @@
+require "stsplatform/version"
+
+module STSPlatform
+
+  class Sensors < RequestHandler
+    def initialize(handler, id="")
+      super(handler,id)
+    end
+  end
+
+end

data/lib/stsplatform/stsplatformerror.rb

@@ -0,0 +1,4 @@
+module STSPlatform
+  class STSPlatformError < StandardError
+  end
+end

data/lib/stsplatform/stsplatformresponse.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+module STSPlatform
+  class STSPlatformResponse
+    attr_accessor :data, :code
+    def initialize(response)
+      begin
+        @data = JSON.parse(response.body)
+      rescue
+        @data = nil
+      ensure
+        @code = response.code
+      end
+    end
+  end
+end

data/lib/stsplatform/version.rb

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

data/lib/stsplatform.rb

@@ -0,0 +1,9 @@
+require 'stsplatform/requesthandler'
+require 'stsplatform/client'
+require 'stsplatform/stsplatformerror'
+require 'stsplatform/stsplatformresponse'
+#resources:
+require 'stsplatform/sensors'
+require 'stsplatform/data'
+require 'stsplatform/fields'
+require 'stsplatform/orgs'

data/stsplatform.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stsplatform/version'
+#Bundler.require(:default, :development)
+
+Gem::Specification.new do |spec|
+  spec.name          = "stsplatform"
+  spec.version       = Stsplatform::VERSION
+  spec.authors       = ["SenseTecnic"]
+  spec.email         = ["rcalderon@sensetecnic.com"]
+
+  spec.summary       = "Allows developers to use the STS Platform API"
+  spec.description   = "This gem allows you to access the STS Platform API. For more information visit http://developers.sensetecnic.com"
+  spec.homepage      = "http://developers.sensetecnic.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.8.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: stsplatform
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SenseTecnic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This gem allows you to access the STS Platform API. For more information
+  visit http://developers.sensetecnic.com
+email:
+- rcalderon@sensetecnic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/advanced_example.rb
+- examples/simple_example.rb
+- lib/stsplatform.rb
+- lib/stsplatform/client.rb
+- lib/stsplatform/data.rb
+- lib/stsplatform/fields.rb
+- lib/stsplatform/orgs.rb
+- lib/stsplatform/requesthandler.rb
+- lib/stsplatform/sensors.rb
+- lib/stsplatform/stsplatformerror.rb
+- lib/stsplatform/stsplatformresponse.rb
+- lib/stsplatform/version.rb
+- stsplatform.gemspec
+homepage: http://developers.sensetecnic.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Allows developers to use the STS Platform API
+test_files: []