Remove Timestamp::Now (#66)

* Remove Timestamp::Now

Author: Empty2k12

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,6 +5,6 @@
 ### Checklist
 - [ ] Formatted code using `cargo fmt --all`
 - [ ] Linted code using clippy `cargo clippy --all-targets --all-features -- -D warnings`
-- [ ] Updated README.md using `cargo readme > README.md`
+- [ ] Updated README.md using `cargo readme -r influxdb -t ../README.tpl > README.md`
 - [ ] Reviewed the diff. Did you leave any print statements or unnecessary comments?
 - [ ] Any unfinished work that warrants a separate issue captured in an issue with a TODO code comment

.github/workflows/rust.yml

@@ -1,8 +1,24 @@
 name: Rust
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
+    readmecheck:
+        name: README Format Check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v1
+            - uses: actions-rs/toolchain@v1
+              with:
+                toolchain: nightly
+                override: true
+            - run: bash ./auxiliary/update_cargo-readme.sh
+            - run: bash ./auxiliary/check_readme_consistency.sh
+
     style:
         name: Style Checks (stable/ubuntu-latest)
         runs-on: ubuntu-latest
@@ -37,7 +53,6 @@ jobs:
     integration_test:
         name: Integration Tests (stable/ubuntu-latest)
         runs-on: ubuntu-latest
-        needs: [style, compile]
         services:
             influxdb:
                 image: influxdb

CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+-  Due to InfluxDb inconsistencies between versions and ambiguities, `Timestamp::Now` has been removed. Please calculate the current timestamp since the epoch yourself and use the other available `Timestamp` values like so:
+
+    ```
+    use influxdb::{Timestamp};
+    use std::time::{SystemTime, UNIX_EPOCH};
+    let start = SystemTime::now();
+    let since_the_epoch = start
+      .duration_since(UNIX_EPOCH)
+      .expect("Time went backwards")
+      .as_millis();
+    let query = Timestamp::Milliseconds(since_the_epoch)
+        .into_query("weather")
+        .add_field("temperature", 82);
+    ```
+
+- `WriteQuery` and `ReadQuery` now derive `Debug` and `Clone` ([@jaredwolff](https://github.com/jaredwolff) in [#63](https://github.com/Empty2k12/influxdb-rust/pull/63))
+
 ## [0.1.0] - 2020-03-17
 
 This adds `#[derive(InfluxDbWriteable)]` for Structs, fixes escaping for the line-protocol and improves timestamp handling.

README.md

@@ -27,8 +27,7 @@
     </a>
 </p>
 
-This library is a work in progress. Although we've been using it in production at [OpenVelo](https://openvelo.org/),
-we've prioritized features that fit our use cases. This means a feature you might need is not implemented
+This library is a work in progress. This means a feature you might need is not implemented
 yet or could be handled better.
 
 Pull requests are always welcome. See [Contributing](https://github.com/Empty2k12/influxdb-rust/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/Empty2k12/influxdb-rust/blob/master/CODE_OF_CONDUCT.md).
@@ -100,5 +99,4 @@ in the repository.
 ## License
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
 @ 2019 Gero Gerke, All rights reserved.

influxdb/src/client/mod.rs

@@ -163,14 +163,22 @@ impl Client {
     /// ```rust,no_run
     /// use influxdb::{Client, Query, Timestamp};
     /// use influxdb::InfluxDbWriteable;
+    /// use std::time::{SystemTime, UNIX_EPOCH};
     ///
     /// # #[tokio::main]
     /// # async fn main() -> Result<(), failure::Error> {
+    /// let start = SystemTime::now();
+    /// let since_the_epoch = start
+    ///   .duration_since(UNIX_EPOCH)
+    ///   .expect("Time went backwards")
+    ///   .as_millis();
+    ///
     /// let client = Client::new("http://localhost:8086", "test");
-    /// let query = Timestamp::Now
+    /// let query = Timestamp::Milliseconds(since_the_epoch)
     ///     .into_query("weather")
     ///     .add_field("temperature", 82);
     /// let results = client.query(&query).await?;
+    ///
     /// # Ok(())
     /// # }
     /// ```

influxdb/src/lib.rs

@@ -1,5 +1,4 @@
-//! This library is a work in progress. Although we've been using it in production at [OpenVelo](https://openvelo.org/),
-//! we've prioritized features that fit our use cases. This means a feature you might need is not implemented
+//! This library is a work in progress. This means a feature you might need is not implemented
 //! yet or could be handled better.
 //!
 //! Pull requests are always welcome. See [Contributing](https://github.com/Empty2k12/influxdb-rust/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/Empty2k12/influxdb-rust/blob/master/CODE_OF_CONDUCT.md).
@@ -71,7 +70,6 @@
 //! # License
 //!
 //! [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-//!
 
 #![allow(clippy::needless_doctest_main)]
 

influxdb/src/query/mod.rs

@@ -7,7 +7,7 @@
 //! use influxdb::{Query, Timestamp};
 //! use influxdb::InfluxDbWriteable;
 //!
-//! let write_query = Timestamp::Now.into_query("measurement")
+//! let write_query = Timestamp::Nanoseconds(0).into_query("measurement")
 //!     .add_field("field1", 5)
 //!     .add_tag("author", "Gero")
 //!     .build();
@@ -37,7 +37,6 @@ pub use influxdb_derive::InfluxDbWriteable;
 
 #[derive(PartialEq, Debug, Copy, Clone)]
 pub enum Timestamp {
-    Now,
     Nanoseconds(u128),
     Microseconds(u128),
     Milliseconds(u128),
@@ -50,7 +49,6 @@ impl fmt::Display for Timestamp {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         use Timestamp::*;
         match self {
-            Now => write!(f, ""),
             Nanoseconds(ts) | Microseconds(ts) | Milliseconds(ts) | Seconds(ts) | Minutes(ts)
             | Hours(ts) => write!(f, "{}", ts),
         }
@@ -60,7 +58,6 @@ impl fmt::Display for Timestamp {
 impl Into<DateTime<Utc>> for Timestamp {
     fn into(self) -> DateTime<Utc> {
         match self {
-            Timestamp::Now => Utc::now(),
             Timestamp::Hours(h) => {
                 let nanos =
                     h * MINUTES_PER_HOUR * SECONDS_PER_MINUTE * MILLIS_PER_SECOND * NANOS_PER_MILLI;
@@ -125,10 +122,10 @@ pub trait Query {
     /// use influxdb::{Query, Timestamp};
     /// use influxdb::InfluxDbWriteable;
     ///
-    /// let invalid_query = Timestamp::Now.into_query("measurement").build();
+    /// let invalid_query = Timestamp::Nanoseconds(0).into_query("measurement").build();
     /// assert!(invalid_query.is_err());
     ///
-    /// let valid_query = Timestamp::Now.into_query("measurement").add_field("myfield1", 11).build();
+    /// let valid_query = Timestamp::Nanoseconds(0).into_query("measurement").add_field("myfield1", 11).build();
     /// assert!(valid_query.is_ok());
     /// ```
     fn build(&self) -> Result<ValidQuery, Error>;
@@ -218,19 +215,10 @@ mod tests {
         );
     }
     #[test]
-    fn test_format_for_timestamp_now() {
-        assert!(format!("{}", Timestamp::Now) == "");
-    }
-    #[test]
     fn test_format_for_timestamp_else() {
         assert!(format!("{}", Timestamp::Nanoseconds(100)) == "100");
     }
     #[test]
-    fn test_chrono_datetime_from_timestamp_now() {
-        let datetime_from_timestamp: DateTime<Utc> = Timestamp::Now.into();
-        assert_eq!(Utc::now().date(), datetime_from_timestamp.date())
-    }
-    #[test]
     fn test_chrono_datetime_from_timestamp_hours() {
         let datetime_from_timestamp: DateTime<Utc> = Timestamp::Hours(2).into();
         assert_eq!(

influxdb/src/query/write_query.rs

@@ -57,7 +57,7 @@ impl WriteQuery {
     /// use influxdb::{Query, Timestamp};
     /// use influxdb::InfluxDbWriteable;
     ///
-    /// Timestamp::Now.into_query("measurement").add_field("field1", 5).build();
+    /// Timestamp::Nanoseconds(0).into_query("measurement").add_field("field1", 5).build();
     /// ```
     pub fn add_field<S, F>(mut self, field: S, value: F) -> Self
     where
@@ -79,7 +79,7 @@ impl WriteQuery {
     /// use influxdb::{Query, Timestamp};
     /// use influxdb::InfluxDbWriteable;
     ///
-    /// Timestamp::Now
+    /// Timestamp::Nanoseconds(0)
     ///     .into_query("measurement")
     ///     .add_tag("field1", 5); // calling `.build()` now would result in a `Err(Error::InvalidQueryError)`
     /// ```
@@ -94,7 +94,6 @@ impl WriteQuery {
 
     pub fn get_precision(&self) -> String {
         let modifier = match self.timestamp {
-            Timestamp::Now => "rfc3339",
             Timestamp::Nanoseconds(_) => "ns",
             Timestamp::Microseconds(_) => "u",
             Timestamp::Milliseconds(_) => "ms",
@@ -201,10 +200,7 @@ impl Query for WriteQuery {
             measurement = LineProtoTerm::Measurement(&self.measurement).escape(),
             tags = tags,
             fields = fields,
-            time = match self.timestamp {
-                Timestamp::Now => String::from(""),
-                _ => format!(" {}", self.timestamp),
-            }
+            time = format!(" {}", self.timestamp)
         )))
     }
 

influxdb/tests/derive_integration_tests.rs

@@ -52,7 +52,7 @@ async fn test_derive_simple_write() {
             create_db(TEST_NAME).await.expect("could not setup db");
             let client = create_client(TEST_NAME);
             let weather_reading = WeatherReading {
-                time: Timestamp::Now.into(),
+                time: Timestamp::Nanoseconds(0).into(),
                 humidity: 30,
                 wind_strength: Some(5),
             };