Added cookie_datetime object to easly specify cookies expiration time&date

Author: JosephP91

include/cookie.h

@@ -29,25 +29,28 @@
 #include <string>
 
 #include "curl_exception.h"
+#include "cookie_datetime.h"
 
 namespace curl {
     /**
      * This class allows to specify every single field of an http-style cookie.
      */
     class cookie {
     public:
+        /*
+         * Default constructor.
+         */
         cookie() {}
         /**
          * The constructor allow a fast way to build a cookie.
          */
-        cookie(const std::string, const std::string, const std::string, const bool = false);
+        cookie(const std::string, const cookie_datetime &, const std::string = "/", const std::string = "", const bool = false);
         /**
          * This constructor overloades the previous one.
          */
-        cookie(const char *, const char *, const char *, bool = false);
+        cookie(const char *, const cookie_datetime &, const char * = "/", const char * = "", const bool = false);
         /**
-         * This method allows to specify the cookie name. It returns a pointer
-         * to this class to enable cascade calls.
+         * This method allows to specify the cookie name.
          */
         cookie *set_name(const std::string);
         /**
@@ -56,8 +59,7 @@ namespace curl {
          */
         cookie *set_name(const char *);
         /**
-         * This method allows to specify the cookie path. It returns a pointer
-         * to this class to enable cascade calls.
+         * This method allows to specify the cookie path.
          */
         cookie *set_path(const std::string) NOEXCEPT;
         /**
@@ -66,8 +68,7 @@ namespace curl {
          */
         cookie *set_path(const char *) NOEXCEPT;
         /**
-         * This method allows to specify the cookie domain. It returns a pointer
-         * to this class to enable cascade calls.
+         * This method allows to specify the cookie domain.
          */
         cookie *set_domain(const std::string) NOEXCEPT;
         /**
@@ -76,15 +77,18 @@ namespace curl {
          */
         cookie *set_domain(const char *) NOEXCEPT;
         /**
-         * This method allows to specify the cookie security. It returns a pointer
-         * to this class to enable cascade calls.
+         * This method allows to specify the cookie security.
          */
         cookie *set_secure(const bool) NOEXCEPT;
         /**
          * This method overloads the previous one allowing to specify an integer instead
          * of a bool.
          */
         cookie *set_secure(const unsigned int);
+        /**
+         * This method allows to specify a datetime expiration to this cookie.
+         */
+        cookie *set_datetime(const cookie_datetime &) NOEXCEPT;
         /**
          * This method returns the cookie name.
          */
@@ -97,6 +101,10 @@ namespace curl {
          * This method returns the cookie domain.
          */
         std::string get_domain() const NOEXCEPT;
+        /**
+         * This method returns the datetime expire object for this cookie.
+         */
+        cookie_datetime get_datetime() const NOEXCEPT;
         /**
          * This method returns the cookie security.
          */
@@ -105,7 +113,7 @@ namespace curl {
          * This method allows to get a string representing the entire cookie. Example:
          * 'Set-cookie: name=xxx; path=/; domain=/ expires=date'
          */
-        std::string get_formatted() const NOEXCEPT;
+        std::string get_formatted() NOEXCEPT;
     private:
         /**
          * The cookie name.
@@ -119,6 +127,10 @@ namespace curl {
          * The cookie domain.
          */
         std::string domain;
+        /**
+         * The cookie expire date and time.
+         */
+        cookie_datetime datetime;
         /**
          * The cookie security.
          */

include/cookie_date.h

@@ -28,6 +28,10 @@
 
 #include <string>
 #include <map>
+#include <iostream>
+#include <sstream>
+
+#include "curl_config.h"
 
 namespace curl {
     // Enumeration to better define months.
@@ -54,12 +58,12 @@ namespace curl {
         /**
          * Constructor with parameters, which gives a fast way to build a cookie_date object.
          */
-        cookie_date(const unsigned int, const unsigned int, const unsigned int);
+        cookie_date(const unsigned int, const unsigned int, const unsigned int) NOEXCEPT;
         /**
          * This method allows to specify a day for the date. If the day is less than zero or
          * greater than 31, 1 will be choosen.
          */
-        cookie_date *set_day(const unsigned int);
+        cookie_date *set_day(const unsigned int) NOEXCEPT;
         /**
          * This method allows to specify a month for the date. If the month is not supported,
          * January will be choosen.
@@ -69,19 +73,23 @@ namespace curl {
          * This method allows to specify a year for the date. If year is less than 1970, 1970 will
          * be choosen.
          */
-        cookie_date *set_year(const unsigned int);
+        cookie_date *set_year(const unsigned int) NOEXCEPT;
         /**
          * This method returns the day number.
          */
-        unsigned int get_day() const;
+        unsigned int get_day() const NOEXCEPT;
         /**
          * This method returns the month name.
          */
-        std::string get_month() const;
+        std::string get_month() const NOEXCEPT;
         /**
          * This method returns the year number.
          */
-        unsigned int get_year() const;
+        unsigned int get_year() const NOEXCEPT;
+        /**
+         * This method returns the date formatted as day-month-year
+         */
+        std::string get_formatted() NOEXCEPT;
     private:
         /**
          * The day for this date.

include/cookie_datetime.h

@@ -26,9 +26,52 @@
 #ifndef CURLCPP_COOKIE_DATETIME_H
 #define CURLCPP_COOKIE_DATETIME_H
 
+#include "cookie_date.h"
+#include "cookie_time.h"
+
 namespace curl {
+    /**
+     * This class provide an easy way to specify the date and the time of cooking expiration.
+     */
     class cookie_datetime {
-
+    public:
+        /**
+         * Default constructor.
+         */
+        cookie_datetime() {}
+        /**
+         * The constructor with parameters allows to specify a time and a date for cookie expiration.
+         */
+        cookie_datetime(const cookie_time &, const cookie_date &) NOEXCEPT;
+        /**
+         * This method allows to set the expiration time.
+         */
+        cookie_datetime *set_time(const cookie_time &) NOEXCEPT;
+        /**
+         * This method allows to set the expiration date.
+         */
+        cookie_datetime *set_date(const cookie_date &) NOEXCEPT;
+        /**
+         * This method returns the time object.
+         */
+        const cookie_time get_time() const NOEXCEPT;
+        /**
+         * This method returns the date object.
+         */
+        const cookie_date get_date() const NOEXCEPT;
+        /**
+         * This method returns the cookie_datetime as a string.
+         */
+        std::string get_formatted() NOEXCEPT;
+    private:
+        /**
+         * Time object.
+         */
+        cookie_time time;
+        /**
+         * Date object.
+         */
+        cookie_date date;
     };
 }
 

include/cookie_time.h

@@ -1,14 +1,93 @@
-//
-// Created by Giuseppe Persico on 25/03/16.
-//
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014 - Giuseppe Persico
+ * File - cookie_date.h
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 
 #ifndef CURLCPP_COOKIE_TIME_H
 #define CURLCPP_COOKIE_TIME_H
 
+#include "curl_config.h"
+
+#include <string>
+#include <iostream>
+#include <sstream>
+
 namespace curl {
+    /**
+     * This class provides a fast way to build a time object formed by hour, minutes and seconds.
+     */
     class cookie_time {
-
+    public:
+        /**
+         * The default constructor will initialize every attribute with zero.
+         */
+        cookie_time() : hour(0), minutes(0), seconds(0) {};
+        /**
+         * The constructor with parameters allows to initialize attributes with custom values.
+         */
+        cookie_time(const unsigned int, const unsigned int, const unsigned int);
+        /**
+         * This method allows to specify the hours.
+         */
+        cookie_time *set_hour(const unsigned int) NOEXCEPT;
+        /**
+         * This method allows to specify the minutes.
+         */
+        cookie_time *set_minutes(const unsigned int) NOEXCEPT;
+        /**
+         * This method allows to specify the seconds.
+         */
+        cookie_time *set_seconds(const unsigned int) NOEXCEPT;
+        /**
+         * This method returns the hours.
+         */
+        const unsigned int get_hour() const NOEXCEPT;
+        /**
+         * This method returns the minutes.
+         */
+        const unsigned int get_minutes() const NOEXCEPT;
+        /**
+         * This method returns the seconds.
+         */
+        const unsigned int get_seconds() const NOEXCEPT;
+        /**
+         * This method returns the time formatted as h:m:s
+         */
+        std::string get_formatted() NOEXCEPT;
+    private:
+        /**
+         * The hours.
+         */
+        unsigned int hour;
+        /**
+         * The minutes.
+         */
+        unsigned int minutes;
+        /**
+         * The seconds.
+         */
+        unsigned int seconds;
     };
 }
 
-#endif //CURLCPP_COOKIE_TIME_H
+#endif //CURLCPP_COOKIE_TIME_H

include/curl_cookie.h

@@ -59,11 +59,11 @@ namespace curl {
          * header (Set-Cookie: ...) format. This will also enable the cookie engine. This adds
          * that single cookie to the internal cookie store.
          */
-        void set(const curl::cookie &);
+        void set(curl::cookie &);
         /**
          * This method overloads the one previously declared allowing to specify a vector of cookies.
          */
-        void set(const std::vector<const curl::cookie> &);
+        void set(const std::vector<curl::cookie> &);
         /**
          * This method allow you to specify a file where libcurl will write every internal
          * known-stored cookie when the curl_easy destructor will be called. If no cookies

src/cookie.cpp

@@ -8,13 +8,13 @@
 using std::string;
 
 // Implementation of constructor.
-curl::cookie::cookie(const string name, const string path, const string domain, const bool secure) {
-    this->set_name(name)->set_path(path)->set_domain(domain)->set_secure(secure);
+curl::cookie::cookie(const string name, const cookie_datetime &datetime, const string path, const string domain, const bool secure) {
+    this->set_name(name)->set_path(path)->set_domain(domain)->set_secure(secure)->set_datetime(datetime);
 }
 
 // Implementation of overloaded constructor.
-curl::cookie::cookie(const char *name, const char *path, const char *domain, const bool secure) {
-    this->set_name(name)->set_path(path)->set_domain(domain)->set_secure(secure);
+curl::cookie::cookie(const char *name, const cookie_datetime &datetime, const char *path, const char *domain, const bool secure) {
+    this->set_name(name)->set_path(path)->set_domain(domain)->set_secure(secure)->set_datetime(datetime);
 }
 
 // Implementation of set_name method.
@@ -73,7 +73,7 @@ curl::cookie *curl::cookie::set_secure(const bool secure) NOEXCEPT {
     return this;
 }
 
-//
+// Implementation of set_secure method.
 curl::cookie *curl::cookie::set_secure(const unsigned int secure) {
     if (secure == 0) {
         this->secure = false;
@@ -85,6 +85,12 @@ curl::cookie *curl::cookie::set_secure(const unsigned int secure) {
     return this;
 }
 
+// Implementation of set_datetime method.
+curl::cookie *curl::cookie::set_datetime(const cookie_datetime &datetime) NOEXCEPT {
+    this->datetime = datetime;
+    return this;
+}
+
 // Implementation of get_name method.
 string curl::cookie::get_name() const NOEXCEPT {
     return this->name;
@@ -105,9 +111,14 @@ bool curl::cookie::is_secure() const NOEXCEPT {
     return this->secure;
 }
 
+// Implementation of get_datetime method.
+curl::cookie_datetime curl::cookie::get_datetime() const NOEXCEPT {
+    return this->datetime;
+}
+
 // Implementation of get_formatted method.
-string curl::cookie::get_formatted() const NOEXCEPT {
-    return "Set-cookie: name="+this->name+"; path="+this->path+"; domain="+this->domain;
+string curl::cookie::get_formatted() NOEXCEPT {
+    return "Set-cookie: name="+this->name+"; expires="+this->datetime.get_formatted()+"path="+this->path+"; domain="+this->domain;
 }
 
 /*