wattsense-api-client 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56bec849f1fe12cdcf3318bf1cb574ec5e2cdb28bdde7590153317793e111ba0
-  data.tar.gz: bff64a8e2a75b8435d888e577267583ec48923c58d68607f63dd83c6f88f42f9
+  metadata.gz: 0d0e958d259d4dfd6a296368e9c49867d396cb789e9a529952d05edb0cfcbe78
+  data.tar.gz: 2059813ffd4b5e059f0707256bfc33e86d9cb42d927cccab5338854d06934d48
 SHA512:
-  metadata.gz: f9e8bbf4d2ea927b6beb797edee9777900f683288b08224927ad52c1724480c289a935e5219e962f2dc73b48e91416527e89560f26b09c6ea8b54bfd972266f4
-  data.tar.gz: 8082c04e8a36570dc41d0be860102c6c911acee05adc62bb89162577855b6bc4c098a69326dcac76516ceda3e8b472faa65a15718925ff4309500dd784dd9c48
+  metadata.gz: 12a85c70878ebf6de8a047e2500fbe36825e886f1c1b513111a75c1fc56d8ac320fe016c690419638a13925a8cc55bd0b7b79df887ac3937dcb93422072a814f
+  data.tar.gz: 424cf11c91269389ca4e73c7f0e26507f55bfd30ff23ae0ffd043aa2f3262eeb0bd6ecd4c0bd543516fdfa8dc5c8d36cfd2f78bc6d5602577487604c3474845c

data/lib/http_requester.rb

@@ -21,8 +21,27 @@ class HttpRequester
   # HTTP GET method
   #
   # TODO: document
-  def get(path, &before_req_callback)
-    do_request(::Net::HTTP::Get.new(uri_from_path(path)), before_req_callback)
+  def get(path, query_parameters = nil, &before_req_callback)
+    uri = uri_from_path_and_query_parameters(path, query_parameters)
+    do_request(::Net::HTTP::Get.new(uri), before_req_callback)
+  end
+
+  # HTTP POST method
+  #
+  # TODO: document
+  def post(path, payload, &before_req_callback)
+    req = ::Net::HTTP::Post.new(uri_from_path_and_query_parameters(path))
+    req.body = payload
+    do_request(req, before_req_callback)
+  end
+
+  # HTTP POST method
+  #
+  # TODO: document
+  def put(path, payload, &before_req_callback)
+    req = ::Net::HTTP::Put.new(uri_from_path_and_query_parameters(path))
+    req.body = payload
+    do_request(req, before_req_callback)
   end
 
   private
@@ -37,7 +56,9 @@ class HttpRequester
     end
   end
 
-  def uri_from_path(path)
-    URI("#{@base_url}/#{path}")
+  def uri_from_path_and_query_parameters(path, query_parameters = nil)
+    uri = URI("#{@base_url}/#{path}")
+    uri.query = ::URI.encode_www_form(query_parameters) if query_parameters
+    uri
   end
 end

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

@@ -11,6 +11,8 @@ require 'http_requester'
 require 'watt_sense_api/v1/authentication'
 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'
 
 module WattSenseApi
   module V1
@@ -20,6 +22,8 @@ module WattSenseApi
       include ::WattSenseApi::V1::Authentication
       include ::WattSenseApi::V1::Organization
       include ::WattSenseApi::V1::UserManagement
+      include ::WattSenseApi::V1::DeviceInformation
+      include ::WattSenseApi::V1::PropertiesMeasurements
 
       # You can create a client V1 with both user's credentials or api creddentials.
       #
@@ -44,7 +48,16 @@ module WattSenseApi
             'Please give one of either couples: (api_key, api_secret) or (username, password)'
           )
         end
-        super(::WattSenseApi::V1::BASE_URL, auth_callback: @auth_block)
+        super(::WattSenseApi::V1::BASE_URL, auth_callback: @auth_block, headers_callback: headers_callback)
+      end
+
+      private
+
+      def headers_callback
+        lambda do |req|
+          req['Accept'] = 'application/json'
+          req['Content-Type'] = 'application/json'
+        end
       end
     end
   end

data/lib/watt_sense_api/v1/device_information.rb

@@ -0,0 +1,61 @@
+#--
+# 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 [Device Information](https://api.wattsense.com/#tag/Device-Information).
+    #
+    # In WattSense Api, the Wattsense Box is designated as device in all this API.
+    module DeviceInformation
+      # List all your devices
+      #
+      # @note: filters not implemented yet.
+      #
+      # @return [Array<Hash>] The devices information as a Hash in an Array.
+      # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPSuccess with a body)
+      def devices
+        response = get('devices')
+        raise(::WattSenseApi::HTTPError, response) unless response.is_a?(::Net::HTTPSuccess)
+
+        return [] if response.is_a?(::Net::HTTPNoContent)
+
+        ::JSON.parse(response.body)
+      end
+
+      # Get the information of the specified one
+      #
+      # @param deviceId [String] The ID of the device which you seek the informations
+      #
+      # @return [Hash] The device information as a Hash when id is not nil.
+      # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPSuccess with a body)
+      def device(id)
+        response = get("devices/#{id}")
+        raise(::WattSenseApi::HTTPError, response) unless response.is_a?(::Net::HTTPSuccess) && !response.body&.empty?
+
+        ::JSON.parse(response.body)
+      end
+
+      # Activate a device
+      #
+      # @note No check implemented nor tests.
+      #
+      # @param params [Hash] Parameters as expected by WattSense documentation.
+      #
+      # @return [Hash] The device information as a Hash
+      # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPSuccess with a body)
+      def device_activate(params)
+        response = post('devices', params)
+        raise(::WattSenseApi::HTTPError, response) unless response.is_a?(::Net::HTTPSuccess) && !response.body&.empty?
+
+        ::JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/watt_sense_api/v1/properties_measurements.rb

@@ -0,0 +1,69 @@
+#--
+# 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 [Properties Measurements](https://api.wattsense.com/#tag/Properties-Measurements)
+    module PropertiesMeasurements
+      # Get the specified device's properties list with values.
+      #
+      # @see https://api.wattsense.com/#operation/listDevicePropertiesValues API documentation
+      #
+      # @param device_id [String] The device id
+      #
+      # @return [Array<Hash>|NilClass] Array of the properties' values or nil if your device is not configured
+      #   and/or has no properties.
+      # @raise [::WattSenseApi::HTTPError] when server response is not as expected (HTTPSuccess with a body)
+      def device_properties(device_id)
+        response = get("devices/#{device_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
+
+      # Get a specified device's property to a given value.
+      #
+      # @see https://api.wattsense.com/#operation/getPropertyMeasurement API documentation
+      #
+      # @param device_id [String] The device id
+      # @param property_id [String] The property id or slug for which we ask the latest value
+      #
+      # @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_property(device_id, property_id)
+        response = get("devices/#{device_id}/properties/#{property_id}")
+        return ::JSON.parse(response.body) if response.is_a?(::Net::HTTPOK)
+
+        return if response.is_a?(::Net::HTTPNoContent)
+
+        raise(::WattSenseApi::HTTPError, response)
+      end
+
+      # Set a specified device's property to a given value.
+      #
+      # @see https://api.wattsense.com/#operation/setPropertyValue API documentation
+      #
+      # @param device_id [String] The device id
+      # @param property_id [String] The property id or slug for which we ask to set the value
+      # @param body [Hash] The body of the request. Hash that will be transformed to json.
+      #
+      # @return [Hash] Hash of the resulted action.
+      # @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)
+
+        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.1.0'
+  VERSION = '0.3.0'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wattsense-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -107,14 +107,20 @@ files:
 - lib/watt_sense_api/v1.rb
 - lib/watt_sense_api/v1/authentication.rb
 - lib/watt_sense_api/v1/client.rb
+- 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/user_management.rb
 - lib/watt_sense_api/version.rb
 - lib/wattsense-api-client.rb
 homepage: https://rubygems.org/gems/wattsense-api-client
 licenses:
 - GPL v3
-metadata: {}
+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.3.0
+  homepage_uri: https://gitlab.com/octopuslab-public/wattsense-api-client
 post_install_message: 
 rdoc_options: []
 require_paths: