wattsense-api-client 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4916afb23e887ae08589fdaaad78580ae15af7e5ac95979cb0aafbef169bd859
-  data.tar.gz: ab72b48cf7d8704d5ceae305106c66c16e64d3672e8b76c174675bcb76e8489e
+  metadata.gz: b1faff348377c3626f858fe12fa996a4f37401fdd818ed1167d713a65188d2fe
+  data.tar.gz: 34cedf857f72be6be95f5ec633f59b9d356cafd3ee02bfde93dd7515cc2c3ab3
 SHA512:
-  metadata.gz: 79bf2c3af476a9305a6eeb93a20bb24c17fe85925152990e41be38d82a6225c4f4d2103257b342855c55dfaf9090daa96b36bf70648456832ad26e466d01291f
-  data.tar.gz: eabff64a18caf34439921ff2017748cd5592337f37793b66ed2f08df38c9435051847fcf0c48247df421c5defcb35f4d7611c644299869c37da4f98c73624bf4
+  metadata.gz: 5eee4d1a875ac73f8bd067846a4d1b35dfdf3331931d58251bfca1daea1aea230d9382ed3bedeae435e5c65e44f9a24de2c8a1f6e37bae5e5b7e1bf0571a29a0
+  data.tar.gz: f44cd1e4be3980e2f43783cba0a95c5fc8f74c9d1a8e2779a5ce558ffc0bd5f6a06c969dbb67c45067d84aaf86512c9e6f56fe383237142456058edadd73e586

data/lib/watt_sense_api/v1/authentication.rb

@@ -5,6 +5,9 @@
 #++
 # frozen_string_literal: true
 
+require 'openssl'
+require 'base64'
+
 module WattSenseApi
   module V1
     # This module gather all the necessary elements for ClientV1 ability to authenticate to the
@@ -19,8 +22,15 @@ module WattSenseApi
       #
       # @param api_key [String] The api's credential key
       # @param api_secret [String] The api's credential secret
-      def api_key_authentication(_api_key, _api_secret)
-        raise(::WattSenseApi::NotImplementedError, 'Please use (username, password) couple for now.')
+      def api_key_authentication(api_key, api_secret)
+        @auth_block =
+          lambda do |request|
+            time = now_in_ms
+            to_sign = to_sign_from_request(request, time)
+            signed = ::OpenSSL::HMAC.digest('SHA512', api_secret, to_sign.join("\n"))
+            request['X-API-Auth'] = "#{api_key}:#{::Base64.strict_encode64(signed)}"
+            request['X-API-Timestamp'] = time.to_s
+          end
       end
 
       # This method allows to use username/password credentials with HTTP Basic user authentication
@@ -31,6 +41,21 @@ module WattSenseApi
       def basic_user_authentication(username, password)
         @auth_block = ->(request) { request.basic_auth(username, password) }
       end
+
+      # @return [Integer] Time now in ms since Epoch
+      def now_in_ms
+        now = ::Time.now
+        now.tv_sec * 1000 + now.tv_usec / 1_000
+      end
+
+      # @return [String] Message to sign
+      def to_sign_from_request(request, time)
+        to_sign = [request.method, request.uri.path]
+        to_sign.push(request.uri.query) if request.uri.query
+        to_sign.push(request.body) if request.body
+        to_sign << time.to_s
+        to_sign
+      end
     end
   end
 end

data/lib/watt_sense_api/v1/client.rb

@@ -13,6 +13,7 @@ require 'watt_sense_api/v1/organization'
 require 'watt_sense_api/v1/user_management'
 require 'watt_sense_api/v1/device_information'
 require 'watt_sense_api/v1/properties_measurements'
+require 'watt_sense_api/v1/property_configuration'
 
 module WattSenseApi
   module V1
@@ -24,6 +25,7 @@ module WattSenseApi
       include ::WattSenseApi::V1::UserManagement
       include ::WattSenseApi::V1::DeviceInformation
       include ::WattSenseApi::V1::PropertiesMeasurements
+      include ::WattSenseApi::V1::PropertyConfiguration
 
       # You can create a client V1 with both user's credentials or api creddentials.
       #

data/lib/watt_sense_api/v1/properties_measurements.rb

@@ -60,7 +60,7 @@ module WattSenseApi
       # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPAccepted with a body)
       def device_property_set(device_id, property_id, body)
         response = put("devices/#{device_id}/properties/#{property_id}", body.to_json)
-        return ::JSON.parse(response.body) if response.is_a?(::Net::HTTPAccepted)
+        return ::JSON.parse(response.body) if response.is_a?(::Net::HTTPOK)
 
         raise(::WattSenseApi::HTTPError, response)
       end

data/lib/watt_sense_api/v1/property_configuration.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright (C) 2021 - Octopus Lab SAS
+# All rights are described by the GPLv3 license present in the file /LICENSE available in the
+# original repository of this file or [here](https://www.gnu.org/licenses/gpl-3.0.fr.html).
+#++
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module WattSenseApi
+  module V1
+    # This module gather all the methods to deal with [Property Configuration](https://api.wattsense.com/#tag/Property-Configuration)
+    module PropertyConfiguration
+      # List all properties present in a specific config revision.
+      #
+      # @see https://api.wattsense.com/#operation/listPropertyConfiguration API documentation
+      #
+      # @param device_id [String] The device id
+      # @param revision_id [String] The revision id of the configuration to get. Default: "current"
+      # Two special cases:
+      # - "current" will return the currently published config revision, i.e. status equal to CURRENT
+      # - "draft" will return the current draft i.e. status equal to DRAFT or SENT
+      #
+      # @return [Hash|NilClass] Hash of the property's latest value (nil if property is unreachable)
+      # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPAccepted with a body)
+      def device_config_properties(device_id, revision_id = 'current')
+        response = get("devices/#{device_id}/configs/#{revision_id}/properties")
+        return ::JSON.parse(response.body) if response.is_a?(::Net::HTTPOK)
+
+        return if response.is_a?(::Net::HTTPNoContent)
+
+        raise(::WattSenseApi::HTTPError, response)
+      end
+    end
+  end
+end

data/lib/watt_sense_api/version.rb

@@ -6,6 +6,6 @@
 # frozen_string_literal: true
 
 module WattSenseApi
-  VERSION = '0.2.0'
+  VERSION = '0.4.1'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wattsense-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.20.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -73,7 +73,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.21.2
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -87,7 +87,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -110,6 +110,7 @@ files:
 - lib/watt_sense_api/v1/device_information.rb
 - lib/watt_sense_api/v1/organization.rb
 - lib/watt_sense_api/v1/properties_measurements.rb
+- lib/watt_sense_api/v1/property_configuration.rb
 - lib/watt_sense_api/v1/user_management.rb
 - lib/watt_sense_api/version.rb
 - lib/wattsense-api-client.rb
@@ -117,10 +118,10 @@ homepage: https://rubygems.org/gems/wattsense-api-client
 licenses:
 - GPL v3
 metadata:
-  bug_tracker_uri: https://gitlab.com/octopuslab-public/wattsense-api-client/-/issues
-  changelog_uri: https://gitlab.com/octopuslab-public/wattsense-api-client/-/blob/main/CHANGELOG.md
-  documentation_uri: https://octopuslab-public.gitlab.io/wattsense-api-client/0.2.0
-  homepage_uri: https://gitlab.com/octopuslab-public/wattsense-api-client
+  bug_tracker_uri: https://gitlab.com/fr-octopuslab/wattsense-api-client/-/issues
+  changelog_uri: https://gitlab.com/octopuslab/wattsense-api-client/-/blob/main/CHANGELOG.md
+  documentation_uri: https://fr-octopuslab.gitlab.io/wattsense-api-client/0.4.1
+  homepage_uri: https://gitlab.com/octopuslab/wattsense-api-client
 post_install_message: 
 rdoc_options: []
 require_paths: