Added cargo deny coverage.

Factored out common send code to trait.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "se_monitoring_server_api"
-version = "0.1.0"
+version = "0.1.0-alpha.1"
 edition = "2021"
 description = "Library for accessing the SolarEdge Monitoring Server API"
 license = "MIT"

deny.toml

@@ -0,0 +1,206 @@
+# This template contains all of the possible sections and their default values
+
+# Note that all fields that take a lint level have these possible values:
+# * deny - An error will be produced and the check will fail
+# * warn - A warning will be produced, but the check will not fail
+# * allow - No warning or error will be produced, though in some cases a note
+# will be
+
+# The values provided in this template are the default values that will be used
+# when any section or field is not specified in your own configuration
+
+# If 1 or more target triples (and optionally, target_features) are specified,
+# only the specified targets will be checked when running `cargo deny check`.
+# This means, if a particular package is only ever used as a target specific
+# dependency, such as, for example, the `nix` crate only being used via the
+# `target_family = "unix"` configuration, that only having windows targets in
+# this list would mean the nix crate, as well as any of its exclusive
+# dependencies not shared by any other crates, would be ignored, as the target
+# list here is effectively saying which targets you are building for.
+targets = [
+    # The triple can be any string, but only the target triples built in to
+    # rustc (as of 1.40) can be checked against actual config expressions
+    #{ triple = "x86_64-unknown-linux-musl" },
+    # You can also specify which target_features you promise are enabled for a
+    # particular target. target_features are currently not validated against
+    # the actual valid features supported by the target architecture.
+    #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
+]
+
+# This section is considered when running `cargo deny check advisories`
+# More documentation for the advisories section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
+[advisories]
+# The path where the advisory database is cloned/fetched into
+db-path = "~/.cargo/advisory-db"
+# The url(s) of the advisory databases to use
+db-urls = ["https://github.com/rustsec/advisory-db"]
+# The lint level for security vulnerabilities
+vulnerability = "deny"
+# The lint level for unmaintained crates
+unmaintained = "warn"
+# The lint level for crates that have been yanked from their source registry
+yanked = "warn"
+# The lint level for crates with security notices. Note that as of
+# 2019-12-17 there are no security notice advisories in
+# https://github.com/rustsec/advisory-db
+notice = "warn"
+# A list of advisory IDs to ignore. Note that ignored advisories will still
+# output a note when they are encountered.
+ignore = [
+    #"RUSTSEC-0000-0000",
+]
+# Threshold for security vulnerabilities, any vulnerability with a CVSS score
+# lower than the range specified will be ignored. Note that ignored advisories
+# will still output a note when they are encountered.
+# * None - CVSS Score 0.0
+# * Low - CVSS Score 0.1 - 3.9
+# * Medium - CVSS Score 4.0 - 6.9
+# * High - CVSS Score 7.0 - 8.9
+# * Critical - CVSS Score 9.0 - 10.0
+#severity-threshold =
+
+# This section is considered when running `cargo deny check licenses`
+# More documentation for the licenses section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
+[licenses]
+# The lint level for crates which do not have a detectable license
+unlicensed = "deny"
+# List of explicitly allowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
+allow = [
+    "MIT",
+    "Apache-2.0",
+    "BSD-3-Clause",
+    #"Apache-2.0 WITH LLVM-exception",
+]
+# List of explicitly disallowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
+deny = [
+    #"Nokia",
+]
+# Lint level for licenses considered copyleft
+copyleft = "warn"
+# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
+# * both - The license will be approved if it is both OSI-approved *AND* FSF
+# * either - The license will be approved if it is either OSI-approved *OR* FSF
+# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
+# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
+# * neither - This predicate is ignored and the default lint level is used
+allow-osi-fsf-free = "neither"
+# Lint level used when no other predicates are matched
+# 1. License isn't in the allow or deny lists
+# 2. License isn't copyleft
+# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
+default = "deny"
+# The confidence threshold for detecting a license from license text.
+# The higher the value, the more closely the license text must be to the
+# canonical license text of a valid SPDX license file.
+# [possible values: any between 0.0 and 1.0].
+confidence-threshold = 0.8
+# Allow 1 or more licenses on a per-crate basis, so that particular licenses
+# aren't accepted for every possible crate as with the normal allow list
+exceptions = [
+    # Each entry is the crate and version constraint, and its specific allow
+    # list
+    #{ allow = ["Zlib"], name = "adler32", version = "*" },
+]
+
+# Some crates don't have (easily) machine readable licensing information,
+# adding a clarification entry for it allows you to manually specify the
+# licensing information
+#[[licenses.clarify]]
+# The name of the crate the clarification applies to
+#name = "ring"
+# The optional version constraint for the crate
+#version = "*"
+# The SPDX expression for the license requirements of the crate
+#expression = "MIT AND ISC AND OpenSSL"
+# One or more files in the crate's source used as the "source of truth" for
+# the license expression. If the contents match, the clarification will be used
+# when running the license check, otherwise the clarification will be ignored
+# and the crate will be checked normally, which may produce warnings or errors
+# depending on the rest of your configuration
+#license-files = [
+    # Each entry is a crate relative path, and the (opaque) hash of its contents
+    #{ path = "LICENSE", hash = 0xbd0eed23 }
+#]
+
+[licenses.private]
+# If true, ignores workspace crates that aren't published, or are only
+# published to private registries.
+# To see how to mark a crate as unpublished (to the official registry),
+# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
+ignore = false
+# One or more private registries that you might publish crates to, if a crate
+# is only published to private registries, and ignore is true, the crate will
+# not have its license(s) checked
+registries = [
+    #"https://sekretz.com/registry
+]
+
+# This section is considered when running `cargo deny check bans`.
+# More documentation about the 'bans' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
+[bans]
+# Lint level for when multiple versions of the same crate are detected
+multiple-versions = "warn"
+# Lint level for when a crate version requirement is `*`
+wildcards = "allow"
+# The graph highlighting used when creating dotgraphs for crates
+# with multiple versions
+# * lowest-version - The path to the lowest versioned duplicate is highlighted
+# * simplest-path - The path to the version with the fewest edges is highlighted
+# * all - Both lowest-version and simplest-path are used
+highlight = "all"
+# List of crates that are allowed. Use with care!
+allow = [
+    #{ name = "ansi_term", version = "=0.11.0" },
+]
+# List of crates to deny
+deny = [
+    # Each entry the name of a crate and a version range. If version is
+    # not specified, all versions will be matched.
+    #{ name = "ansi_term", version = "=0.11.0" },
+    #
+    # Wrapper crates can optionally be specified to allow the crate when it
+    # is a direct dependency of the otherwise banned crate
+    #{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
+]
+# Certain crates/versions that will be skipped when doing duplicate detection.
+skip = [
+    #{ name = "ansi_term", version = "=0.11.0" },
+]
+# Similarly to `skip` allows you to skip certain crates during duplicate
+# detection. Unlike skip, it also includes the entire tree of transitive
+# dependencies starting at the specified crate, up to a certain depth, which is
+# by default infinite
+skip-tree = [
+    #{ name = "ansi_term", version = "=0.11.0", depth = 20 },
+]
+
+# This section is considered when running `cargo deny check sources`.
+# More documentation about the 'sources' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
+[sources]
+# Lint level for what to happen when a crate from a crate registry that is not
+# in the allow list is encountered
+unknown-registry = "warn"
+# Lint level for what to happen when a crate from a git repository that is not
+# in the allow list is encountered
+unknown-git = "warn"
+# List of URLs for allowed crate registries. Defaults to the crates.io index
+# if not specified. If it is specified but empty, no registries are allowed.
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+# List of URLs for allowed Git repositories
+allow-git = []
+
+[sources.allow-org]
+# 1 or more github.com organizations to allow git sources for
+github = [""]
+# 1 or more gitlab.com organizations to allow git sources for
+gitlab = [""]
+# 1 or more bitbucket.org organizations to allow git sources for
+bitbucket = [""]

src/current_version.rs

@@ -1,7 +1,6 @@
 //! Module for querying the current API version of the SolarEdge monitoring server.
 
-use crate::error::Error;
-use crate::{SolaredgeCredentials, REQWEST_CLIENT};
+use crate::{SendReq, SolaredgeCredentials, MONITORING_API_URL};
 use serde::{Deserialize, Serialize};
 
 /// Current version request
@@ -27,27 +26,14 @@ impl CurrentVersionReq {
     pub fn new() -> Self {
         CurrentVersionReq {}
     }
+}
 
-    /// Send the current version request to Solaredge and return the response.
-    ///
-    /// # Arguments
-    ///
-    /// * `solaredge` - SolarEdge credentials to use for sending
-    ///
-    /// # Returns
-    /// The SolarEdge response or an error string.
-    /// Errors can occur on the request send or when parsing the response.
-    pub fn send(&self, solaredge: &SolaredgeCredentials) -> Result<CurrentVersionResp, Error> {
-        let url = format!(
+impl SendReq<CurrentVersionResp> for CurrentVersionReq {
+    fn build_url(&self, solaredge: &SolaredgeCredentials) -> String {
+        format!(
             "{}version/current?{}",
-            solaredge.url_start, solaredge.url_end
-        );
-
-        let res = REQWEST_CLIENT.get(&url).send()?;
-
-        let parsed = res.json::<CurrentVersionResp>()?;
-
-        Ok(parsed)
+            *MONITORING_API_URL, solaredge.api_key,
+        )
     }
 }
 

src/se_ms_api.rs

@@ -14,16 +14,16 @@
 //!
 //! ```no_run
 //! extern crate se_ms_api;
-//! use se_ms_api::{SiteDetailsReq, SolaredgeCredentials};
+//! use se_ms_api::{SendReq, SiteDetailsReq, SolaredgeCredentials};
 //!
 //! let site_id = "my_site_id";
 //! let api_key = "my_api_key";
 //!
-//! let cred = SolaredgeCredentials::create(&site_id, &api_key); // (1)
-//! let req = SiteDetailsReq::new();                             // (2)
-//! let resp = req.send(&cred);                                  // (3)
+//! let cred = SolaredgeCredentials::new(&site_id, &api_key); // (1)
+//! let req = SiteDetailsReq::new();                          // (2)
+//! let resp = req.send(&cred);                               // (3)
 //!
-//! match resp {                                                 // (4)
+//! match resp {                                              // (4)
 //!    Ok(r) => {
 //!        println!("My site's status is {}.", r.details.status);
 //!    }
@@ -71,10 +71,12 @@
 #![warn(unused_crate_dependencies)]
 #![deny(unused_extern_crates)]
 #![warn(missing_docs)]
+#![warn(missing_debug_implementations)]
 
 pub use current_version::{CurrentVersionReq, CurrentVersionResp};
 pub use error::{Error, ErrorKind};
 pub use meter_type::MeterType;
+use serde::Deserialize;
 pub use site_details::{SiteDetailsReq, SiteDetailsResp};
 pub use site_energy_detailed::{SiteEnergyDetailedReq, SiteEnergyDetailedResp};
 pub use supported_versions::{SupportedVersionsReq, SupportedVersionsResp};
@@ -95,43 +97,64 @@ mod time_unit;
 #[macro_use]
 extern crate lazy_static;
 
+lazy_static! {
+    static ref REQWEST_CLIENT: reqwest::blocking::Client = reqwest::blocking::Client::new();
+    static ref MONITORING_API_URL: String = "https://monitoringapi.solaredge.com/".to_string();
+}
+
 const URL_TIME_FORMAT: &str = "%Y-%m-%d %H:%M:%S";
 
 /// Struct for accessing SolarEdge's monitoring server for a given site and api key.
 ///
 /// Used as the parameter for the send() function of all of the possible requests.
 #[derive(Clone, Debug, Default, PartialEq)]
 pub struct SolaredgeCredentials {
-    url_start: String,
     site_id: String,
-    url_end: String,
+    api_key: String,
 }
 
 impl SolaredgeCredentials {
-    const MONITORING_API_URL: &'static str = "https://monitoringapi.solaredge.com/";
-
     /// Create a Solaredge destination for the requests from the given site id and api_key.
-    pub fn create(site_id: &str, api_key: &str) -> Self {
-        let url_start = SolaredgeCredentials::MONITORING_API_URL.to_string();
+    pub fn new(site_id: &str, api_key: &str) -> Self {
         let site_id = site_id.to_string();
-        let url_end = format!("api_key={}", api_key);
+        let api_key = format!("api_key={}", api_key);
 
-        SolaredgeCredentials {
-            url_start,
-            site_id,
-            url_end,
-        }
+        SolaredgeCredentials { site_id, api_key }
     }
 
-    /// See the site ID bing used in the credentials.
+    /// See the site ID being used in the credentials.
     pub fn site_id(&self) -> &str {
         &self.site_id
     }
 }
 
-lazy_static! {
-    pub(crate) static ref REQWEST_CLIENT: reqwest::blocking::Client =
-        reqwest::blocking::Client::new();
+/// All Solaredge requests implement this trait since sending the request
+/// and getting the response is the same for all requests.
+pub trait SendReq<Resp> {
+    #[doc(hidden)]
+    fn build_url(&self, solaredge: &SolaredgeCredentials) -> String;
+
+    /// Send the request to Solaredge and return the response.
+    ///
+    /// # Arguments
+    ///
+    /// * `solaredge` - SolarEdge credentials to use for sending
+    ///
+    /// # Returns
+    /// The SolarEdge response or an error string.
+    /// Errors can occur on the request send or when parsing the response.
+    fn send(&self, solaredge: &SolaredgeCredentials) -> Result<Resp, Error>
+    where
+        for<'de> Resp: Deserialize<'de>,
+    {
+        let url = self.build_url(solaredge);
+
+        let res = REQWEST_CLIENT.get(&url).send()?;
+
+        let parsed = res.json::<Resp>()?;
+
+        Ok(parsed)
+    }
 }
 
 #[cfg(test)]
@@ -143,11 +166,10 @@ mod tests {
 
     #[test]
     fn solaredge_credentials_unit_test() {
-        let se = SolaredgeCredentials::create("id", "key");
-        assert_eq!(se.url_start, SolaredgeCredentials::MONITORING_API_URL);
+        let se = SolaredgeCredentials::new("id", "key");
         assert_eq!(se.site_id, "id");
         assert_eq!(se.site_id(), "id");
-        assert_eq!(se.url_end, "api_key=key");
+        assert_eq!(se.api_key, "api_key=key");
     }
 
     #[test]