DEL: Remove deprecated packaging option

threecgreen · threecgreen · commit c635b158ef14 · 2024-12-12T17:17:05.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.26.0 - TBD
+
+### Breaking changes
+- Removed deprecated `Packaging` enum and `packaging` field that's no longer supported
+  by the API
+
 ## 0.25.0 - 2024-11-12
 
 ### Enhancements
diff --git a/include/databento/batch.hpp b/include/databento/batch.hpp
@@ -5,7 +5,7 @@
 #include <string>
 #include <vector>
 
-#include "databento/enums.hpp"  // JobState, Delivery, Packaging, Schema, SType
+#include "databento/enums.hpp"  // JobState, Delivery, Schema, SType
 
 namespace databento {
 // Description of a batch job.
@@ -31,8 +31,6 @@ struct BatchJob {
   SplitDuration split_duration;
   std::uint64_t split_size;
   bool split_symbols;
-  // NOTE: deprecated and will be removed in a future version
-  Packaging packaging;
   Delivery delivery;
   std::uint64_t record_count;
   // Size in bytes.
diff --git a/include/databento/enums.hpp b/include/databento/enums.hpp
@@ -85,15 +85,6 @@ enum class SplitDuration : std::uint8_t {
   None,
 };
 
-// Represents how a batch job will be packaged.
-//
-// NOTE: Deprecated now that all batch jobs can be downloaded as a ZIP file.
-enum class Packaging : std::uint8_t {
-  None = 0,
-  Zip,
-  TarDeprecated,
-};
-
 // Represents how a batch job will be delivered.
 enum class Delivery : std::uint8_t {
   Download,
@@ -462,7 +453,6 @@ const char* ToString(FeedMode mode);
 const char* ToString(Compression compression);
 const char* ToString(SType stype);
 const char* ToString(SplitDuration duration_interval);
-const char* ToString(Packaging packaging);
 const char* ToString(Delivery delivery);
 const char* ToString(JobState state);
 const char* ToString(DatasetCondition condition);
@@ -487,7 +477,6 @@ std::ostream& operator<<(std::ostream& out, FeedMode mode);
 std::ostream& operator<<(std::ostream& out, Compression compression);
 std::ostream& operator<<(std::ostream& out, SType stype);
 std::ostream& operator<<(std::ostream& out, SplitDuration duration_interval);
-std::ostream& operator<<(std::ostream& out, Packaging packaging);
 std::ostream& operator<<(std::ostream& out, Delivery delivery);
 std::ostream& operator<<(std::ostream& out, JobState state);
 std::ostream& operator<<(std::ostream& out, DatasetCondition condition);
@@ -522,8 +511,6 @@ SType FromString(const std::string& str);
 template <>
 SplitDuration FromString(const std::string& str);
 template <>
-Packaging FromString(const std::string& str);
-template <>
 Delivery FromString(const std::string& str);
 template <>
 JobState FromString(const std::string& str);
diff --git a/include/databento/historical.hpp b/include/databento/historical.hpp
@@ -9,7 +9,7 @@
 #include "databento/datetime.hpp"  // DateRange, DateTimeRange, UnixNanos
 #include "databento/dbn_file_store.hpp"
 #include "databento/detail/http_client.hpp"  // HttpClient
-#include "databento/enums.hpp"  // BatchState, Delivery, DurationInterval, Packaging, Schema, SType
+#include "databento/enums.hpp"  // BatchState, Delivery, DurationInterval, Schema, SType
 #include "databento/metadata.hpp"  // DatasetConditionDetail, DatasetRange, FieldDetail, PublisherDetail, UnitPricesForMode
 #include "databento/symbology.hpp"  // SymbologyResolution
 #include "databento/timeseries.hpp"  // KeepGoing, MetadataCallback, RecordCallback
@@ -52,19 +52,17 @@ class Historical {
                           Encoding encoding, Compression compression,
                           bool pretty_px, bool pretty_ts, bool map_symbols,
                           bool split_symbols, SplitDuration split_duration,
-                          std::uint64_t split_size, Packaging packaging,
-                          Delivery delivery, SType stype_in, SType stype_out,
-                          std::uint64_t limit);
+                          std::uint64_t split_size, Delivery delivery,
+                          SType stype_in, SType stype_out, std::uint64_t limit);
   BatchJob BatchSubmitJob(const std::string& dataset,
                           const std::vector<std::string>& symbols,
                           Schema schema,
                           const DateTimeRange<std::string>& datetime_range,
                           Encoding encoding, Compression compression,
                           bool pretty_px, bool pretty_ts, bool map_symbols,
                           bool split_symbols, SplitDuration split_duration,
-                          std::uint64_t split_size, Packaging packaging,
-                          Delivery delivery, SType stype_in, SType stype_out,
-                          std::uint64_t limit);
+                          std::uint64_t split_size, Delivery delivery,
+                          SType stype_in, SType stype_out, std::uint64_t limit);
   std::vector<BatchJob> BatchListJobs();
   std::vector<BatchJob> BatchListJobs(const std::vector<JobState>& states,
                                       UnixNanos since);
diff --git a/src/batch.cpp b/src/batch.cpp
@@ -40,7 +40,6 @@ std::ostream& operator<<(std::ostream& stream, const BatchJob& batch_job) {
       .AddField("split_duration", batch_job.split_duration)
       .AddField("split_size", batch_job.split_size)
       .AddField("split_symbols", batch_job.split_symbols)
-      .AddField("packaging", batch_job.packaging)
       .AddField("delivery", batch_job.delivery)
       .AddField("record_count", batch_job.record_count)
       .AddField("billed_size", batch_job.billed_size)
diff --git a/src/enums.cpp b/src/enums.cpp
@@ -180,23 +180,6 @@ const char* ToString(SplitDuration duration_interval) {
   }
 }
 
-const char* ToString(Packaging packaging) {
-  switch (packaging) {
-    case Packaging::None: {
-      return "none";
-    }
-    case Packaging::Zip: {
-      return "zip";
-    }
-    case Packaging::TarDeprecated: {
-      return "tar";
-    }
-    default: {
-      return "unknown";
-    }
-  }
-}
-
 const char* ToString(Delivery delivery) {
   switch (delivery) {
     case Delivery::Download: {
@@ -804,11 +787,6 @@ std::ostream& operator<<(std::ostream& out, SplitDuration duration_interval) {
   return out;
 }
 
-std::ostream& operator<<(std::ostream& out, Packaging packaging) {
-  out << ToString(packaging);
-  return out;
-}
-
 std::ostream& operator<<(std::ostream& out, Delivery delivery) {
   out << ToString(delivery);
   return out;
@@ -1042,21 +1020,6 @@ SplitDuration FromString(const std::string& str) {
                              "unknown value '" + str + '\''};
 }
 
-template <>
-Packaging FromString(const std::string& str) {
-  if (str == "none") {
-    return Packaging::None;
-  }
-  if (str == "zip") {
-    return Packaging::Zip;
-  }
-  if (str == "tar") {
-    return Packaging::TarDeprecated;
-  }
-  throw InvalidArgumentError{"FromString<Packaging>", "str",
-                             "unknown value '" + str + '\''};
-}
-
 template <>
 Delivery FromString(const std::string& str) {
   if (str == "download") {
diff --git a/src/historical.cpp b/src/historical.cpp
@@ -65,7 +65,6 @@ databento::BatchJob Parse(const std::string& endpoint,
   using databento::Encoding;
   using databento::JobState;
   using databento::JsonResponseError;
-  using databento::Packaging;
   using databento::Schema;
   using databento::SplitDuration;
   using databento::SType;
@@ -100,8 +99,6 @@ databento::BatchJob Parse(const std::string& endpoint,
       endpoint, json, "split_duration", SplitDuration::None);
   res.split_size = ParseAt<std::uint64_t>(endpoint, json, "split_size");
   res.split_symbols = ParseAt<bool>(endpoint, json, "split_symbols");
-  res.packaging = FromCheckedAtStringOrNull<Packaging>(
-      endpoint, json, "packaging", Packaging::None);
   res.delivery = FromCheckedAtString<Delivery>(endpoint, json, "delivery");
   res.record_count = ParseAt<std::uint64_t>(endpoint, json, "record_count");
   res.billed_size = ParseAt<std::uint64_t>(endpoint, json, "billed_size");
@@ -170,26 +167,24 @@ databento::BatchJob Historical::BatchSubmitJob(
     Schema schema, const DateTimeRange<UnixNanos>& datetime_range) {
   return this->BatchSubmitJob(dataset, symbols, schema, datetime_range,
                               kDefaultEncoding, kDefaultCompression, {}, {}, {},
-                              {}, SplitDuration::Day, {}, Packaging::None,
-                              Delivery::Download, kDefaultSTypeIn,
-                              kDefaultSTypeOut, {});
+                              {}, SplitDuration::Day, {}, Delivery::Download,
+                              kDefaultSTypeIn, kDefaultSTypeOut, {});
 }
 databento::BatchJob Historical::BatchSubmitJob(
     const std::string& dataset, const std::vector<std::string>& symbols,
     Schema schema, const DateTimeRange<std::string>& datetime_range) {
   return this->BatchSubmitJob(dataset, symbols, schema, datetime_range,
                               kDefaultEncoding, kDefaultCompression, {}, {}, {},
-                              {}, SplitDuration::Day, {}, Packaging::None,
-                              Delivery::Download, kDefaultSTypeIn,
-                              kDefaultSTypeOut, {});
+                              {}, SplitDuration::Day, {}, Delivery::Download,
+                              kDefaultSTypeIn, kDefaultSTypeOut, {});
 }
 databento::BatchJob Historical::BatchSubmitJob(
     const std::string& dataset, const std::vector<std::string>& symbols,
     Schema schema, const DateTimeRange<UnixNanos>& datetime_range,
     Encoding encoding, Compression compression, bool pretty_px, bool pretty_ts,
     bool map_symbols, bool split_symbols, SplitDuration split_duration,
-    std::uint64_t split_size, Packaging packaging, Delivery delivery,
-    SType stype_in, SType stype_out, std::uint64_t limit) {
+    std::uint64_t split_size, Delivery delivery, SType stype_in,
+    SType stype_out, std::uint64_t limit) {
   httplib::Params params{
       {"dataset", dataset},
       {"start", ToString(datetime_range.start)},
@@ -202,7 +197,6 @@ databento::BatchJob Historical::BatchSubmitJob(
       {"map_symbols", std::to_string(map_symbols)},
       {"split_symbols", std::to_string(split_symbols)},
       {"split_duration", ToString(split_duration)},
-      {"packaging", ToString(packaging)},
       {"delivery", ToString(delivery)},
       {"stype_in", ToString(stype_in)},
       {"stype_out", ToString(stype_out)}};
@@ -216,8 +210,8 @@ databento::BatchJob Historical::BatchSubmitJob(
     Schema schema, const DateTimeRange<std::string>& datetime_range,
     Encoding encoding, Compression compression, bool pretty_px, bool pretty_ts,
     bool map_symbols, bool split_symbols, SplitDuration split_duration,
-    std::uint64_t split_size, Packaging packaging, Delivery delivery,
-    SType stype_in, SType stype_out, std::uint64_t limit) {
+    std::uint64_t split_size, Delivery delivery, SType stype_in,
+    SType stype_out, std::uint64_t limit) {
   httplib::Params params{
       {"dataset", dataset},
       {"start", datetime_range.start},
@@ -230,7 +224,6 @@ databento::BatchJob Historical::BatchSubmitJob(
       {"map_symbols", std::to_string(map_symbols)},
       {"split_symbols", std::to_string(split_symbols)},
       {"split_duration", ToString(split_duration)},
-      {"packaging", ToString(packaging)},
       {"delivery", ToString(delivery)},
       {"stype_in", ToString(stype_in)},
       {"stype_out", ToString(stype_out)}};
diff --git a/tests/src/batch_tests.cpp b/tests/src/batch_tests.cpp
@@ -27,7 +27,6 @@ TEST(BatchTests, TestBatchJobToString) {
                         SplitDuration::Week,
                         {},
                         false,
-                        Packaging::Zip,
                         Delivery::Download,
                         10250,
                         35000000,
@@ -61,7 +60,6 @@ TEST(BatchTests, TestBatchJobToString) {
     split_duration = week,
     split_size = 0,
     split_symbols = false,
-    packaging = zip,
     delivery = download,
     record_count = 10250,
     billed_size = 35000000,
