wiot-sdk 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2eb71783d82d2813cf8909bf9f6ce4ac8f9591e
+  data.tar.gz: 6c9f22bcd220078cedd04bee1fa0ec2fef3a594f
+SHA512:
+  metadata.gz: e76ba9cd40b6272489993d3d4243fbf2003d08cd3a6b3c79c01cbe550355ccae900ef224bf2010c265cd7c9011482d1826ec08d367f965adffc7053263eb2464
+  data.tar.gz: 5ccb98d28134b8e1acd29fcbd2a12c7e232e262f97121d5accb9960053baa0f00ecdf23a3918559fba4b66f690749ecd8deb491505fd2b6d7f42bedb9c15370f

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.idea/*

data/.travis.yml

@@ -0,0 +1,7 @@
+  language: ruby
+  rvm:
+    - 2.2.2
+
+addons:
+    code_climate:
+        repo_token: 95713ead72c3f427ee9dd9ae87568ced889b4af00063d5e25d70183640f611d2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wiot_sdk_ruby-sdk-ruby.gemspec
+gemspec :name => 'wiot-sdk'
+
+gem 'rest-client', '~> 1.8'
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    wiot-sdk (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.20160310)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    mime-types (2.99.1)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  codeclimate-test-reporter
+  rake (~> 10.0)
+  rest-client (~> 1.8)
+  rspec (~> 3.0)
+  wiot-sdk!
+
+BUNDLED WITH
+   1.13.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 watchiot
+
+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,256 @@
+[![Stories in Ready](https://badge.waffle.io/watchiot/wiot-sdk-ruby.png?label=ready&title=Ready)](https://waffle.io/watchiot/wiot-sdk-ruby)
+[![Build Status](https://travis-ci.org/watchiot/wiot-sdk-ruby.svg?branch=master)](https://travis-ci.org/watchiot/wiot-sdk-ruby) [![Code Climate](https://codeclimate.com/github/watchiot/wiot-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/watchiot/wiot-sdk-ruby) [![Test Coverage](https://codeclimate.com/github/watchiot/wiot-sdk-ruby/badges/coverage.svg)](https://codeclimate.com/github/watchiot/wiot-sdk-ruby/coverage) [![Issue Count](https://codeclimate.com/github/watchiot/wiot-sdk-ruby/badges/issue_count.svg)](https://codeclimate.com/github/watchiot/wiot-sdk-ruby) [![Gem Version](https://badge.fury.io/rb/wiot_sdk.svg)](https://badge.fury.io/rb/wiot_sdk)
+
+# Watchiot SDK for Ruby
+
+If you want to create an monitor agent in **Ruby** we suggest use this **gem**, it contains easy way to interact with our api.
+
+## Install
+
+```bash
+$ gem install wiot-sdk
+```
+
+## Usage
+
+First you need to add the dependence in your *Gemfile* project 
+
+```ruby
+gem 'wiot-sdk', '~> 0.1'
+```
+
+Then you have to require the sdk where are you going to use it
+
+```ruby
+require 'wiot-sdk'
+```
+
+Now you have to initialice the **SDK** setting the mandatory configuration variables that always will be send in each request. This parameters are:
+
+**api key**, **name space** and **name project**
+ 
+```ruby
+def init_sdk
+  my_api_key = 'asd123asd-23asd-123sda-1231234saa'
+  my_namespace = 'my_space'
+  my_project = 'my_project'
+  
+  client = WiotSdk.init my_api_key, my_namespace, my_project
+end
+```
+
+The other way is put it into configuration file **yml** or **json** format and then set the path where this parameters are setting. 
+
+```ruby
+def init_sdk
+  my_config_json = '/home/myhome/my_agent/my_agent.json'
+ 
+  client = WiotSdk.init my_config_json
+end
+```
+
+```ruby
+def init_sdk
+  my_config_yml = '/home/myhome/my_agent/my_agent.yml'
+  
+  client = WiotSdk.init my_config_yml
+end
+```
+Example of config file
+
+* json
+```json
+{
+  api_key: "asd123asd-23asd-123sda-1231234saa",
+  space  : "my_space",
+  project: "my_project"
+}
+```
+
+* yml
+```yml
+api_key: "asd123asd-23asd-123sda-1231234saa"
+space  : "my_space"
+project: "my_project"
+```
+
+Now you are ready to send us a request with the metrics that you recollect.
+
+To fill the **metric** we provide you a *Metric class*
+
+```ruby
+require 'wiot_sdk/metric'
+
+def fill_metric
+ metric = Metric.new
+ 
+ metric.add('my_param1', 'my_malue1')
+ metric.add('my_param2', 'my_malue2')
+ metric.add('my_param3', 'my_malue3')
+ ...
+ metric.add('my_paramN', 'my_malueN')
+end
+```
+Whe you have the **metric** only you need send a **request** to us
+
+```ruby
+
+def request
+ client = init_sdk
+ metric = fill_metric
+ 
+ response = client.send metric
+end
+```
+
+* Response
+ 
+If all was fine you are going to recive
+
+```http
+HTTP/1.1 200 OK
+Server: nginx
+Date: Fri, 16 Nov 2016 21:03:12 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+Status: 200 OK
+Rate-Limit: 800
+Rate-Remaining: 745
+Rate-Reset: 2150085394
+Content-Length: 5 
+```
+```ruby
+
+def request
+ client = init_sdk
+ metric = fill_metric
+ 
+ response = client.send metric
+ puts response.code
+end
+```
+
+OUTPUT: 200
+
+* Rate limit
+
+ Rate-Limit: 60 The maximum number of requests per hour.
+ Rate-Remaining: 56 The number of requests remaining in the current rate limit window.
+ Rate-Reset: 1372700873 The time at which the current rate limit window reset in miliseconds.
+
+GET /rate_limit
+
+Status: 200 OK
+X-RateLimit-Limit: 5000
+X-RateLimit-Remaining: 4999
+X-RateLimit-Reset: 1372700873
+
+{
+  "resources": {
+    "core": {
+      "limit": 5000,
+      "remaining": 4999,
+      "reset": 1372700873
+    },
+    "search": {
+      "limit": 30,
+      "remaining": 18,
+      "reset": 1372697452
+    }
+  },
+  "rate": {
+    "limit": 5000,
+    "remaining": 4999,
+    "reset": 1372700873
+  }
+}
+
+
+* Errors
+
+Sending invalid JSON will result in a 400 Bad Request response.
+
+ HTTP/1.1 400 Bad Request
+ Content-Length: 35
+
+ {"message":"Problems parsing JSON"}
+ 
+ Sending the wrong type of JSON values will result in a 400 Bad Request response.
+
+ HTTP/1.1 400 Bad Request
+ Content-Length: 40
+
+ {"message":"Body should be a valid JSON"}
+
+ Sending invalid fields will result in a 422 Unprocessable Entity response.
+
+ HTTP/1.1 422 Unprocessable Entity
+ Content-Length: 149
+
+ {
+   "message": "Validation Failed",
+   "errors": [
+     {
+       "field": "title",
+       "code": "missing_field"
+     }
+   ]
+ }
+ 
+ HTTP/1.1 401 Unauthorized
+
+{
+  "message": "Bad credentials"
+}
+
+HTTP/1.1 403 Forbidden
+Content-Type: application/json; charset=utf-8
+Connection: close
+
+{
+  "message": "You have been temporarily blocked for have an abuse behavior. Please retry your request more later."
+}
+
+HTTP/1.1 403 Forbidden
+
+{
+  "message": "Maximum number of login attempts exceeded. Please try again later."
+}
+
+HTTP/1.1 403 Forbidden
+Date: Tue, 20 Aug 2013 14:50:41 GMT
+Status: 403 Forbidden
+Rate-Limit: 800
+Rate-Remaining: 0
+Rate-Reset: 1377013266
+
+{
+   "message": "API rate limit exceeded"
+}
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2016 WatchIoT
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wiot-sdk"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wiot-sdk/client.rb

@@ -0,0 +1,28 @@
+require 'wiot-sdk/request'
+require 'wiot-sdk/response'
+
+require 'wiot-sdk/config/parser_yml'
+require 'wiot-sdk/config/parser_json'
+
+module WiotSdk
+
+  class Client
+
+    def self.init_yaml(file_path)
+      api_key, space, project = WiotSdk::Config::ParserYml.parser file_path
+
+      Request.new api_key, space, project
+    end
+
+    def self.init_json(file_path)
+      api_key, space, project = WiotSdk::Config::ParserJson.parser file_path
+
+      Request.new api_key, space, project
+    end
+
+    def self.init(api_key, space, project)
+      Request.new api_key, space, project
+    end
+  end
+
+end

data/lib/wiot-sdk/config/parser_json.rb

@@ -0,0 +1,9 @@
+module WiotSdk
+  module Config
+    module ParserJson
+      def parser(path)
+        return '', '', ''
+      end
+    end
+  end
+end

data/lib/wiot-sdk/config/parser_yml.rb

@@ -0,0 +1,9 @@
+module WiotSdk
+  module Config
+    module ParserYml
+      def parser(path)
+        return '', '', ''
+      end
+    end
+  end
+end

data/lib/wiot-sdk/data/error.rb

@@ -0,0 +1,18 @@
+module WiotSdk
+  module Data
+    class Error
+      def initialize(field, msg)
+        @field = field
+        @msg = msg
+      end
+
+      def field
+        @field
+      end
+
+      def msg
+        @msg
+      end
+    end
+  end
+end

data/lib/wiot-sdk/data/errors.rb

@@ -0,0 +1,23 @@
+module WiotSdk
+  module Data
+    class Errors
+      def initialize(body)
+        @errors = parser_errors body
+      end
+
+      def errors
+        @errors
+      end
+
+      def has_errors?
+        !@errors.nil? && @errors.size > 0
+      end
+
+      private
+
+      def parser_errors(body)
+        []
+      end
+    end
+  end
+end

data/lib/wiot-sdk/data/rate.rb

@@ -0,0 +1,29 @@
+module WiotSdk
+  module Data
+    class Rate
+      def initialize(header)
+        parser_rate header
+      end
+
+      def rate_limit
+        @rate_limit
+      end
+
+      def rate_remaining
+        @rate_remaining
+      end
+
+      def rate_reset
+        @rate_reset
+      end
+
+      private
+
+      def parser_rate(header)
+        @rate_limit = ''
+        @rate_remaining = ''
+        @rate_reset = ''
+      end
+    end
+  end
+end

data/lib/wiot-sdk/metric.rb

@@ -0,0 +1,17 @@
+module WiotSdk
+
+  class Metric
+    def initialize
+      @metric = {}
+    end
+
+    def add(key, value)
+      @metric[key] = value
+    end
+
+    def values
+      @metric
+    end
+  end
+
+end

data/lib/wiot-sdk/request.rb

@@ -0,0 +1,37 @@
+require 'rest-client'
+require 'json'
+
+require_relative 'metric'
+require_relative 'response'
+
+module WiotSdk
+
+  class Request
+
+    BASE_URL = 'http://api.watchiot.org/'
+
+    def initialize(api_key, space, project)
+      @api_key = api_key
+      @space = space
+      @project = project
+    end
+
+    def send(metric)
+      uri = BASE_URL + @space + '/' + @project
+      payload = '{ api: ' + @api_key + ', data: { ' + JSON.generate(metric.values).to_s + '}'
+
+      req uri, payload
+    rescue => ex
+      Response.new nil, 500, ex.message
+    end
+
+    private
+
+    def req(url, payload)
+      response = RestClient.post url, payload, content_type: 'json', accept: 'json'
+
+      Response.new response
+    end
+  end
+
+end

data/lib/wiot-sdk/response.rb

@@ -0,0 +1,42 @@
+require 'wiot-sdk/data/errors'
+require 'wiot-sdk/data/rate'
+
+module WiotSdk
+
+  class Response
+    def initialize(response, code = nil, message = nil)
+      @code = code || response.code
+      @rate = Rate.new response.headers
+
+      @message = message || parser_message(response.body)
+      @errors = Errors.new response.body
+    end
+
+    def code
+      @code
+    end
+
+    def rate
+      @rate
+    end
+
+    def message
+      @message
+    end
+
+    def errors
+      @errors
+    end
+
+    def has_errors?
+      !@errors.nil? && @errors.has_errors?
+    end
+
+    private
+
+    def parser_message(body)
+      body
+    end
+  end
+
+end

data/lib/wiot-sdk/version.rb

@@ -0,0 +1,3 @@
+module WiotSdk
+  VERSION = '0.1.2'
+end

data/lib/wiot-sdk.rb

@@ -0,0 +1,18 @@
+require 'wiot-sdk/client'
+require 'wiot-sdk/metric'
+
+module WiotSdk
+
+  def self.init(api_key, space, project)
+    Client.init api_key, space, project
+  end
+
+  def self.init_yaml(file_path)
+    Client.init_yaml file_path
+  end
+
+  def self.init_json(file_path)
+    Client.init_json file_path
+  end
+
+end

data/wiot-sdk.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wiot-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wiot-sdk'
+  spec.version       = WiotSdk::VERSION
+  spec.authors       = ['watchiot']
+  spec.email         = ['dev@watchiot.com']
+
+  spec.summary       = %q{Watchiot SDK}
+  spec.description   = %q{Watchiot SDK is for agent}
+  spec.homepage      = 'http://www.watchiot.com'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: wiot-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- watchiot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Watchiot SDK is for agent
+email:
+- dev@watchiot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wiot-sdk.rb
+- lib/wiot-sdk/client.rb
+- lib/wiot-sdk/config/parser_json.rb
+- lib/wiot-sdk/config/parser_yml.rb
+- lib/wiot-sdk/data/error.rb
+- lib/wiot-sdk/data/errors.rb
+- lib/wiot-sdk/data/rate.rb
+- lib/wiot-sdk/metric.rb
+- lib/wiot-sdk/request.rb
+- lib/wiot-sdk/response.rb
+- lib/wiot-sdk/version.rb
+- wiot-sdk.gemspec
+homepage: http://www.watchiot.com
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Watchiot SDK
+test_files: []