wattsense-api-client 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdbe56bc224c52dabf5ec031b0c2cacf722500deb3dc11e7eccf886475b0a2a8
-  data.tar.gz: 77dfcb5d92512aec9f5db55410e1d3dca5c756e7a35fc34a4875eca828f945f2
+  metadata.gz: b1faff348377c3626f858fe12fa996a4f37401fdd818ed1167d713a65188d2fe
+  data.tar.gz: 34cedf857f72be6be95f5ec633f59b9d356cafd3ee02bfde93dd7515cc2c3ab3
 SHA512:
-  metadata.gz: e7cc5f941d05d3630ec4ff0562eb1d5a1f2cf4bb69f76d22b60c9dcf4df2eb3f623966ae92440810e024fcea6fde8536ac8d76e871f7a44e84f6e0ab0e1260f6
-  data.tar.gz: 910ec81176e4600489a3f4704aa7cc480161b7191dcb6d3631cc4662d487f6357f1a11b6321e8d90ba2f27a4e41c58f0f15c2f1ae0713e7f42c5cec874dcea10
+  metadata.gz: 5eee4d1a875ac73f8bd067846a4d1b35dfdf3331931d58251bfca1daea1aea230d9382ed3bedeae435e5c65e44f9a24de2c8a1f6e37bae5e5b7e1bf0571a29a0
+  data.tar.gz: f44cd1e4be3980e2f43783cba0a95c5fc8f74c9d1a8e2779a5ce558ffc0bd5f6a06c969dbb67c45067d84aaf86512c9e6f56fe383237142456058edadd73e586

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.3.2'
+  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.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -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
@@ -119,7 +120,7 @@ licenses:
 metadata:
   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.3.2
+  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: []