sensorpush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de40da08a9b434e84bab3e6efcacf2a8fee90b433b24bca87256fd95573b0071
+  data.tar.gz: 84658a25be2fc440e1d1250b0a3a022d8a58e43e6767c05ccf83afa916226c02
+SHA512:
+  metadata.gz: 5aa3cdbc5340a70167b2255ef32e1ca14b0dd6cea00ee02a0c1dbc0ca007c769e7c46b47e97222a2339757c43550e20351a72946a6d5d7324da4579eb278528c
+  data.tar.gz: 253c8cb5666475a315f16682ca500f61d5ae3b2278cc2fd873ffa07da2f38fe236163d9f0573a6bd9b01fbcf156209b9b43ebedfa75dfdedd754f08923ef52e9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE related
+.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Layout/LineLength:
+  Max: 120
+
+Layout/DotPosition:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sensorpush.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    sensorpush (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (1.8.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  sensorpush!
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Garth Dubin
+
+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,64 @@
+# Sensorpush
+
+This gem will allow you to interface with the [SensorPush Cloud Gateway API](https://www.sensorpush.com/gateway-cloud-api).
+
+SensorPush is a small temperature/humidity sensor.  When paired with the SensorPush Gateway, it enables the gathering of
+environmental metrics which are stored and accessed via the SensorPush Cloud Gateway API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sensorpush'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sensorpush
+
+## Usage
+
+After purchasing a SensorPush Gateway and setting it up through the iOS/Android application, you will have a username
+and password to access the API.  These credentials are the same as what you would use to access the [SensorPush Dashboard](https://dashboard.sensorpush.com/).
+
+To begin using this gem to retrieve data, you must first authenticate with the service:
+
+```ruby
+require 'sensorpush'
+
+client = Sensorpush.new({ username: 'yourusername@example.com', password: 'yourpassword'} )
+success = client.authenticate
+```
+
+The authenticate method will return true if you've successfully connected to the SensorPush API.
+
+Once you've authenticated you can retrieve a list of sensors by running:
+
+```ruby
+sensors = client.sensors
+```
+
+This method will return an array of Sensorpush::Sensor objects.  Once you've determined which sensor
+you would like to download metrics/samples from, you can query those by using the id of the sensor
+and calling:
+
+```ruby
+sensor = sensors.first
+samples = client.samples(sensor.id)
+```
+
+This returns an array of Sensorpush::Sample objects.  The samples method has several options that can be
+passed to it to refine which set of samples you would like.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gdubin/sensorpush.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sensorpush"
+
+# 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(__FILE__)

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/sensorpush/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+require "pp"
+
+module Sensorpush
+  class Client
+    BASE_URL = "https://api.sensorpush.com/api/v1"
+    BASE_HEADERS = { 'accept': "application/json", 'Content-Type': "application/json" }.freeze
+
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :accesstoken
+
+    def initialize(options = {})
+      self.username = options[:username]
+      self.password = options[:password]
+      self.accesstoken = options[:accesstoken]
+    end
+
+    def authenticate
+      authorization = authorize
+      self.accesstoken = get_token(authorization) if authorization
+
+      !accesstoken.nil?
+    end
+
+    def sensors
+      uri = URI(BASE_URL + "/devices/sensors")
+      body = {}
+
+      response = Net::HTTP.post(uri, body.to_json, headers)
+      json_object = JSON.parse(response.body)
+
+      json_object.collect do |_key, hash|
+        Sensorpush::Sensor.new(hash)
+      end
+    end
+
+    def samples(id, options = {})
+      uri = URI(BASE_URL + "/samples")
+      body = { sensors: [id] }
+      body.merge!({ limit: options[:limit] }) unless options[:limit].nil?
+      body.merge!({ startTime: options[:start_time].to_s }) unless options[:start_time].nil?
+      body.merge!({ endTime: options[:end_time].to_s }) unless options[:end_time].nil?
+
+      response = Net::HTTP.post(uri, body.to_json, headers)
+      json_object = JSON.parse(response.body)
+
+      samples_json_array = json_object.dig("sensors", id)
+      samples = samples_json_array&.collect do |hash|
+        Sensorpush::Sample.new(hash)
+      end
+      samples || []
+    end
+
+    private
+
+    def headers
+      headers = BASE_HEADERS.dup
+      headers.merge!({ 'Authorization': accesstoken }) if accesstoken
+      headers
+    end
+
+    def authorize
+      uri = URI(BASE_URL + "/oauth/authorize")
+      body = { email: username, password: password }
+
+      response = Net::HTTP.post(uri, body.to_json, headers)
+      json_object = JSON.parse(response.body)
+      json_object["authorization"]
+    end
+
+    def get_token(authorization)
+      uri = URI(BASE_URL + "/oauth/accesstoken")
+      body = { authorization: authorization }
+
+      response = Net::HTTP.post(uri, body.to_json, headers)
+      json_object = JSON.parse(response.body)
+
+      json_object["accesstoken"]
+    end
+  end
+end

data/lib/sensorpush/sample.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Sensorpush
+  class Sample
+    attr_accessor :humidity
+    attr_accessor :temperature
+    attr_accessor :observed
+
+    def initialize(attributes = {})
+      self.humidity = attributes["humidity"]
+      self.temperature = attributes["temperature"]
+      self.observed = DateTime.parse(attributes["observed"])
+    end
+  end
+end

data/lib/sensorpush/sensor.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sensorpush
+  class Sensor
+    attr_accessor :active
+    attr_accessor :name
+    attr_accessor :address
+    attr_accessor :battery_voltage
+    attr_accessor :id
+    attr_accessor :device_id
+
+    def initialize(attributes = {})
+      self.active = attributes["active"]
+      self.name = attributes["name"]
+      self.address = attributes["address"]
+      self.battery_voltage = attributes["battery_voltage"]
+      self.id = attributes["id"]
+      self.device_id = attributes["deviceId"]
+    end
+  end
+end

data/lib/sensorpush/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sensorpush
+  VERSION = "0.1.0"
+end

data/lib/sensorpush.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "sensorpush/version"
+require_relative "sensorpush/client"
+require_relative "sensorpush/sensor"
+require_relative "sensorpush/sample"
+
+module Sensorpush
+  class Error < StandardError; end
+
+  class << self
+    def new(options = {})
+      Client.new(options)
+    end
+  end
+end

data/sensorpush.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/sensorpush/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensorpush"
+  spec.version       = Sensorpush::VERSION
+  spec.authors       = ["Garth Dubin"]
+  spec.email         = ["garth@dubin.dev"]
+
+  spec.summary       = "SensorPush API Client Library"
+  spec.description   = "Implements the SensorPush API to retrieve sensor and sample data."
+  spec.homepage      = "https://github.com/gdubin/sensorpush"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gdubin/sensorpush"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.18"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sensorpush
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garth Dubin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Implements the SensorPush API to retrieve sensor and sample data.
+email:
+- garth@dubin.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sensorpush.rb
+- lib/sensorpush/client.rb
+- lib/sensorpush/sample.rb
+- lib/sensorpush/sensor.rb
+- lib/sensorpush/version.rb
+- sensorpush.gemspec
+homepage: https://github.com/gdubin/sensorpush
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gdubin/sensorpush
+  source_code_uri: https://github.com/gdubin/sensorpush
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: SensorPush API Client Library
+test_files: []