RubyGems - helium-ruby - Versions diffs - 0.2.0 → 0.3.0 - Mend

helium-ruby 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (49) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +31 -0
data/.csslintrc +2 -0
data/.eslintignore +1 -0
data/.eslintrc +213 -0
data/.gitignore +0 -1
data/.rubocop.yml +1156 -0
data/CONTRIBUTING.md +33 -0
data/LICENSE.txt +23 -17
data/README.md +58 -47
data/Rakefile +14 -0
data/bin/console +8 -0
data/docs/Helium.html +131 -0
data/docs/Helium/Client.html +493 -0
data/docs/Helium/Client/Http.html +428 -0
data/docs/Helium/Client/Organizations.html +251 -0
data/docs/Helium/Client/Sensors.html +543 -0
data/docs/Helium/Client/Users.html +185 -0
data/docs/Helium/Cursor.html +305 -0
data/docs/Helium/DataPoint.html +707 -0
data/docs/Helium/Organization.html +632 -0
data/docs/Helium/Sensor.html +820 -0
data/docs/Helium/User.html +563 -0
data/docs/Helium/Utils.html +183 -0
data/docs/_index.html +226 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +474 -0
data/docs/file.README.html +266 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +266 -0
data/docs/js/app.js +243 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +475 -0
data/docs/top-level-namespace.html +112 -0
data/helium-ruby.gemspec +2 -0
data/lib/helium.rb +1 -1
data/lib/helium/client.rb +0 -16
data/lib/helium/client/http.rb +50 -9
data/lib/helium/client/sensors.rb +51 -28
data/lib/helium/cursor.rb +54 -0
data/lib/helium/data_point.rb +3 -3
data/lib/helium/sensor.rb +9 -0
data/lib/helium/version.rb +1 -1
metadata +63 -3
data/lib/helium/timeseries.rb +0 -35

data/docs/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.3
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <iframe id="search_frame" src="class_list.html"></iframe>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Helium.html" title="Helium (module)">Helium</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Thu Aug 18 10:50:33 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.3 (ruby-2.3.1).
+</div>
+    </div>
+  </body>
+</html>

data/helium-ruby.gemspec CHANGED

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency "typhoeus", "~> 1.1.0"
+  spec.add_dependency "ruby_dig", "~> 0.0.2"
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -41,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "terminal-notifier-guard", "~> 1.7.0"
   spec.add_development_dependency "simplecov", "~> 0.12.0"
   spec.add_development_dependency "human_time", "~> 0.2.0"
+  spec.add_development_dependency "yard", "~> 0.9.3"
 end

data/lib/helium.rb CHANGED

@@ -5,10 +5,10 @@ require 'date'
 require "helium/version"
 require "helium/utils"
 require "helium/client"
+require "helium/cursor"
 require "helium/user"
 require "helium/organization"
 require "helium/sensor"
-require "helium/timeseries"
 require "helium/data_point"
 module Helium

data/lib/helium/client.rb CHANGED

@@ -11,16 +11,6 @@ module Helium
     include Helium::Client::Organizations
     include Helium::Client::Sensors
-    API_VERSION = 1
-    HOST        = 'api.helium.com'
-    PROTOCOL    = 'https'
-    BASE_HTTP_HEADERS = {
-      'Accept'        => 'application/json',
-      'Content-Type'  => 'application/json',
-      'User-Agent'    => 'helium-ruby'
-    }
     attr_accessor :api_key
     def initialize(api_key:, debug: false)
@@ -35,11 +25,5 @@ module Helium
     def debug?
       @debug == true
     end
-    def http_headers
-      BASE_HTTP_HEADERS.merge({
-        'Authorization' => api_key
-      })
-    end
   end
 end

data/lib/helium/client/http.rb CHANGED

@@ -1,26 +1,67 @@
 module Helium
   class Client
     module Http
-      def get(path = nil, url: nil, options: {})
-        path = path.gsub(/^\//, '') if path
-        url ||= "#{PROTOCOL}://#{HOST}/v#{API_VERSION}/#{path}"
+      API_VERSION = 1
+      HOST        = 'api.helium.com'
+      PROTOCOL    = 'https'
-        request = Typhoeus::Request.new(url, {
-          params: options,
-          headers: http_headers
-        })
+      BASE_HTTP_HEADERS = {
+        'Accept'        => 'application/json',
+        'Content-Type'  => 'application/json',
+        'User-Agent'    => 'helium-ruby'
+      }
+      def get(path = nil, url: nil, params: {})
+        request = generate_request(path, url: url, method: :get, params: params)
+        run(request)
+      end
+      def paginated_get(path, klass:, params: {})
+        Cursor.new(client: self, path: path, klass: klass, params: params)
+      end
+      def post(path, body: {})
+        request = generate_request(path, method: :post, body: body)
+        run(request)
+      end
+      def patch(path, body: {})
+        request = generate_request(path, method: :patch, body: body)
         run(request)
       end
+      def delete(path)
+        request = generate_request(path, method: :delete)
+        response = run(request)
+        response.code == 204
+      end
       private
+      def http_headers
+        BASE_HTTP_HEADERS.merge({
+          'Authorization' => api_key
+        })
+      end
+      def generate_request(path = nil, url: nil, method:, params: {}, body: {})
+        path = path.gsub(/^\//, '') if path
+        url ||= "#{PROTOCOL}://#{HOST}/v#{API_VERSION}/#{path}"
+        Typhoeus::Request.new(url, {
+          method:   method,
+          params:   params,
+          headers:  http_headers,
+          body:     JSON.generate(body)
+        })
+      end
       def run(request)
         request.run()
         if debug?
-          # TODO print request method dynamically, won't always be GET
-          puts "GET #{request.url} #{request.response.code} #{request.response.total_time}"
+          method = request.options[:method]
+          puts "#{method.upcase} #{request.url} #{request.response.code} #{request.response.total_time}"
           # puts request.response.body
         end

data/lib/helium/client/sensors.rb CHANGED

@@ -19,40 +19,63 @@ module Helium
         return Sensor.new(client: self, params: sensor_data)
       end
-      def sensor_timeseries(sensor, size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil)
-        options = {
-          "page[size]"    => size,
-          "filter[port]"  => port,
-          "filter[start]" => datetime_to_iso(start_time),
-          "filter[end]"   => datetime_to_iso(end_time),
-          "agg[type]"     => aggtype,
-          "agg[size]"     => aggsize
+      def sensor_timeseries(sensor, opts = {})
+        path = "/sensor/#{sensor.id}/timeseries"
+        params = {
+          "page[size]"    => opts.fetch(:size, nil),
+          "filter[port]"  => opts.fetch(:port, nil),
+          "filter[start]" => datetime_to_iso(opts.fetch(:start_time, nil)),
+          "filter[end]"   => datetime_to_iso(opts.fetch(:end_time, nil)),
+          "agg[type]"     => opts.fetch(:aggtype),
+          "agg[size]"     => opts.fetch(:aggsize)
         }.delete_if { |key, value| value.to_s.empty? }
-        response = get("/sensor/#{sensor.id}/timeseries", options: options)
-        json_results = JSON.parse(response.body)
-        timeseries_data = json_results["data"]
-        timeseries_links = json_results["links"]
+        paginated_get(path, klass: Helium::DataPoint, params: params)
+      end
+      def new_sensor(name:)
+        path = "/sensor"
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            type: "sensor"
+          }
+        }
-        return Timeseries.new(
-          client: self,
-          params: timeseries_data,
-          links: timeseries_links
-        )
+        response = post(path, body: body)
+        sensor_data = JSON.parse(response.body)["data"]
+        return Sensor.new(client: self, params: sensor_data)
       end
-      def sensor_timeseries_by_link(url)
-        response = get(url: url)
-        json_results = JSON.parse(response.body)
-        timeseries_data = json_results["data"]
-        timeseries_links = json_results["links"]
-        return Timeseries.new(
-          client: self,
-          params: timeseries_data,
-          links: timeseries_links
-        )
+      def update_sensor(sensor, name:)
+        path = "/sensor/#{sensor.id}"
+        body = {
+          data: {
+            attributes: {
+              name: name
+            },
+            id: sensor.id,
+            type: "sensor"
+          }
+        }
+        response = patch(path, body: body)
+        sensor_data = JSON.parse(response.body)["data"]
+        return Sensor.new(client: self, params: sensor_data)
       end
+      def delete_sensor(sensor)
+        path = "/sensor/#{sensor.id}"
+        delete(path)
+      end
     end
   end
 end

data/lib/helium/cursor.rb ADDED

@@ -0,0 +1,54 @@
+module Helium
+  class Cursor
+    include Enumerable
+    def initialize(client:, path:, klass:, params: {})
+      @client = client
+      @path   = path
+      @klass  = klass
+      @params = params
+      @collection = []
+      @next_link  = nil
+      @is_last    = false
+    end
+    def each(start = 0)
+      return to_enum(:each, start) unless block_given?
+      Array(@collection[start..-1]).each do |element|
+        yield(element)
+      end
+      unless last?
+        start = [@collection.size, start].max
+        fetch_next_page
+        each(start, &Proc.new)
+      end
+    end
+    private
+    def fetch_next_page
+      if @next_link
+        response = @client.get(url: @next_link)
+      else
+        response = @client.get(@path, params: @params)
+      end
+      json_results  = JSON.parse(response.body)
+      data          = json_results["data"]
+      links         = json_results["links"]
+      @next_link    = links["prev"]
+      @is_last      = @next_link.nil?
+      @collection  += data.map{ |el| @klass.new(client: @client, params: el) }
+    end
+    def last?
+      @is_last
+    end
+  end
+end

data/lib/helium/data_point.rb CHANGED

@@ -5,9 +5,9 @@ module Helium
     def initialize(client:, params:)
       @client     = client
       @id         = params["id"]
-      @timestamp  = params["attributes"]["timestamp"]
-      @value      = params["attributes"]["value"]
-      @port       = params["attributes"]["port"]
+      @timestamp  = params.dig("attributes", "timestamp")
+      @value      = params.dig("attributes", "value")
+      @port       = params.dig("attributes", "port")
     end
     def timestamp

data/lib/helium/sensor.rb CHANGED

@@ -30,5 +30,14 @@ module Helium
         aggsize:    aggsize
       )
     end
+    # TODO these kinds of methods should be generalized into a Resource object
+    def update(name:)
+      @client.update_sensor(self, name: name)
+    end
+    def destroy
+      @client.delete_sensor(self)
+    end
   end
 end

data/lib/helium/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Helium
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helium-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Allen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby_dig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 description: A Ruby gem for building applications with the Helium API
 email:
 - allenan@helium.com
@@ -199,10 +227,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".csslintrc"
+- ".eslintignore"
+- ".eslintrc"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -210,6 +244,32 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/Helium.html
+- docs/Helium/Client.html
+- docs/Helium/Client/Http.html
+- docs/Helium/Client/Organizations.html
+- docs/Helium/Client/Sensors.html
+- docs/Helium/Client/Users.html
+- docs/Helium/Cursor.html
+- docs/Helium/DataPoint.html
+- docs/Helium/Organization.html
+- docs/Helium/Sensor.html
+- docs/Helium/User.html
+- docs/Helium/Utils.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
 - helium-ruby.gemspec
 - lib/helium.rb
 - lib/helium/client.rb
@@ -217,10 +277,10 @@ files:
 - lib/helium/client/organizations.rb
 - lib/helium/client/sensors.rb
 - lib/helium/client/users.rb
+- lib/helium/cursor.rb
 - lib/helium/data_point.rb
 - lib/helium/organization.rb
 - lib/helium/sensor.rb
-- lib/helium/timeseries.rb
 - lib/helium/user.rb
 - lib/helium/utils.rb
 - lib/helium/version.rb