working delete_rows

Author: Vsevolod

module/move/gspread/Cargo.toml

@@ -17,6 +17,11 @@ default-run = "main"
 name = "main"
 path = "src/bin/main.rs"
 
+[[bin]]
+name = "test"
+path = "src/bin/test.rs"
+
+
 [features]
 with_online = []
 default = [ "enabled" ]

module/move/gspread/src/actions/gspread.rs

@@ -11,7 +11,34 @@ mod private
   use once_cell::sync::Lazy;
   use std::collections::HashMap;
 
-  use crate::{gcore::{methods::values::{BatchClearValuesRequest, BatchClearValuesResponse, BatchUpdateValuesRequest, BatchUpdateValuesResponse, UpdateValuesResponse, ValuesClearResponse}, types::{DimensionRange, InsertDataOption, SheetProperties, ValueInputOption, ValueRenderOption}, Client, DeleteDimensionRequest, Dimension, Error, Result, ValueRange}, *};
+  use crate::*;
+  use gcore::methods::batch_update::BatchUpdateResponse;
+  use gcore::methods::values::
+  {
+    BatchClearValuesRequest, 
+    BatchClearValuesResponse, 
+    BatchUpdateValuesRequest, 
+    BatchUpdateValuesResponse, 
+    UpdateValuesResponse, 
+    ValuesClearResponse
+  }; 
+  use gcore::types::
+  {
+    DimensionRange, 
+    InsertDataOption, 
+    SheetProperties, 
+    ValueInputOption, 
+    ValueRenderOption
+  };
+  use gcore::
+  {
+    Client, 
+    DeleteDimensionRequest, 
+    Dimension, 
+    Error, 
+    Result, 
+    ValueRange
+  };
   use gcore::Secret;
 
   static REGEX_ROW_INDEX : Lazy< Regex > = Lazy::new( || {
@@ -641,17 +668,30 @@ mod private
 
   }
 
+  /// # delete_rows
+  /// 
+  /// Deletes selected range of rows. It starts from the first one.
+  /// 
+  /// ## Returns:
+  /// - `Result< Response >`  
+  ///   On success, returns a list of rows, where each row is a `Vec< serde_json::Value >`.
+  ///
+  /// ## Errors:
+  /// - `Error::ApiError`:  
+  ///   Occurs if the Google Sheets API returns an error, 
+  ///   such as an invalid spreadsheet ID, insufficient permissions, 
+  ///   or any issues during the request/response cycle.
   pub async fn delete_rows< S : Secret >
   (
     client : &Client< '_, S >,
     spreadsheet_id : &str,
     sheet_id : &str,
     range : RowRange
-  ) -> Result<()>
+  ) -> Result< BatchUpdateResponse >
   {
-    let (start_index, end_index) = match range
+    let ( start_index, end_index ) = match range
     {
-      RowRange::All => ( None, None ),
+      RowRange::All => ( Some( 1 ), None ),
       RowRange::Range { row_start, row_end } => ( Some( row_start ), Some( row_end ) )
     };
 
@@ -669,12 +709,12 @@ mod private
     };
 
     match client
-    .sheet()
-    .delete_dimension( spreadsheet_id, request )
+    .batch_update( spreadsheet_id )
+    .delete_dimension( request )
     .doit()
     .await
     {
-      Ok( _ ) => Ok( () ),
+      Ok( response ) => Ok( response ),
       Err( error ) => Err( Error::ApiError( error.to_string() ) )
     }
   }
@@ -1177,6 +1217,7 @@ crate::mod_interface!
     clear,
     clear_by_custom_row_key,
     copy_to,
-    RowRange
+    RowRange,
+    delete_rows
   };
 }

module/move/gspread/src/bin/test.rs

@@ -1,5 +1,5 @@
-use std::error::Error;
 use dotenv::dotenv;
+use gspread::actions::gspread::{delete_rows, RowRange};
 use gspread::*;
 use gcore::ApplicationSecret;
 use gcore::client::
@@ -8,14 +8,8 @@ use gcore::client::
   Client
 };
 
-use std::collections::HashMap;
-use serde_json::json;
-use rand::Rng;
-use rand::rngs::OsRng;
-
-
 #[ tokio::main ]
-async fn main() -> Result< (), Box< dyn Error > >
+async fn main()
 {
   dotenv().ok();
 
@@ -27,76 +21,13 @@ async fn main() -> Result< (), Box< dyn Error > >
   .auth( auth )
   .form();
 
-  let spreadsheet_ids = vec![
-    "172krpHTo_BI8Bwm9-9aGc5Bt9tm6P3nbiwkveVbO81k",
-  ];
-  let tables = vec!["t1"];
-  let mut row_key_val = generate_truly_random_key_val(5000, 100);
-
-  for &spreadsheet_id in &spreadsheet_ids {
-    for i in 0..5 {
-      for &sheet_name in &tables {
-        row_key_val.insert("A".to_string(), json!(i));
-        _ = gspread::actions::gspread::append_row(&client, spreadsheet_id, sheet_name, &row_key_val).await;
-      }
-    }
-  }
-
-  Ok( () )
-}
-
-
-fn generate_truly_random_key_val(n: usize, str_len: usize) -> HashMap<String, serde_json::Value> {
-  let all_cols = generate_all_columns();
-  let total = all_cols.len();
-
-  let mut rng = OsRng;
-  let mut indices: Vec<usize> = (0..total).collect();
+  let spreadsheet_id = "15_AKiE2nWUYopNpSLsE_G1tBsiZRNoSfdU8VIuostLc";
+  let sheet_id = "0";
+  let range = RowRange::All;
 
-  for i in 0..total {
-    let j = i + (rng.gen_range(0..(total - i)));
-    indices.swap(i, j);
-  }
-
-  let chosen_indices = &indices[0..n.min(total)];
-
-  let mut result = HashMap::new();
-  for &idx in chosen_indices {
-    let col = &all_cols[idx];
-    let val = random_string(&mut rng, str_len);
-    result.insert(col.clone(), json!(val));
-  }
-  result
-}
-
-fn random_string(rng: &mut OsRng, length: usize) -> String {
-  let charset = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ\
-                  abcdefghijklmnopqrstuvwxyz\
-                  0123456789";
-  (0..length)
-  .map(|_| {
-    let idx = rng.gen_range(0..charset.len());
-    charset[idx] as char
-  })
-  .collect()
-}
-
-fn generate_all_columns() -> Vec<String> {
-  let mut columns = Vec::new();
-  for c1 in b'A'..=b'Z' {
-    columns.push((c1 as char).to_string());
-  }
-  for c1 in b'A'..=b'Z' {
-    for c2 in b'A'..=b'Z' {
-      columns.push(format!("{}{}", c1 as char, c2 as char));
-    }
-  }
-  for c1 in b'A'..=b'Z' {
-    for c2 in b'A'..=b'Z' {
-      for c3 in b'A'..=b'Z' {
-        columns.push(format!("{}{}{}", c1 as char, c2 as char, c3 as char));
-      }
-    }
+  match delete_rows( &client, spreadsheet_id, sheet_id, range ).await
+  {
+    Ok( _ ) => println!("Row was deleted"),
+    Err( error ) => eprintln!( "{error}" )
   }
-  columns
 }

module/move/gspread/src/gcore/methods/batch_update.rs

@@ -25,7 +25,29 @@ mod private
       self
     }
 
-    pub async fn doit( &self ) -> Result< Response >
+    pub fn include_spreadsheet_in_response( mut self ) -> SpreadSheetBatchUpdate< 'a, 'b, S >
+    {
+      self.include_spreadsheet_in_response = true;
+      self
+    }
+
+    pub fn response_ranges
+    ( 
+      mut self,
+      ranges : Vec< String >
+    ) -> SpreadSheetBatchUpdate< 'a, 'b, S >
+    {
+      self.response_ranges = ranges;
+      self
+    }
+
+    pub fn response_include_grid_data( mut self ) -> SpreadSheetBatchUpdate< 'a, 'b, S >
+    {
+      self.response_include_grid_data = true;
+      self
+    }
+
+    pub async fn doit( &self ) -> Result< BatchUpdateResponse >
     {
       let endpoint = format!
       (
@@ -86,7 +108,7 @@ mod private
         return Err( Error::ApiError( response_text ) );
       }
 
-      let response_parsed = response.json::< Response >()
+      let response_parsed = response.json::< BatchUpdateResponse >()
       .await
       .map_err( | err | Error::ParseError( err.to_string() ) )?;
 
@@ -103,7 +125,7 @@ mod private
     #[ serde( rename = "includeSpreadsheetInResponse" ) ]
     include_spreadsheet_in_response : bool,
     /// Limits the ranges included in the response spreadsheet. Meaningful only if includeSpreadsheetInResponse is 'true'.
-    #[ serde( rename = "resoponseRanges" ) ]
+    #[ serde( rename = "responseRanges" ) ]
     response_ranges : Vec< String >,
     /// True if grid data should be returned. Meaningful only if includeSpreadsheetInResponse is 'true'. This parameter is ignored if a field mask was set in the request.
     #[ serde( rename = "responseIncludeGridData" ) ]
@@ -114,17 +136,18 @@ mod private
   pub struct BatchUpdateResponse
   {
     #[ serde( rename = "spreadsheetId" ) ]
-    spreadsheet_id : Option< String >,
-    replies : Option< Vec< Response > >,
+    pub spreadsheet_id : Option< String >,
+    pub replies : Option< Vec< Response > >,
     #[ serde( rename = "updatedSpreadsheet" ) ]
-    updated_spreadsheet : Option< Spreadsheet >
+    pub updated_spreadsheet : Option< Spreadsheet >
   }
 }
 
 crate::mod_interface!
 {
   own use
   {
-    SpreadSheetBatchUpdate
+    SpreadSheetBatchUpdate,
+    BatchUpdateResponse
   };
 }

module/move/gspread/src/gcore/methods/sheet.rs

@@ -10,16 +10,11 @@ mod private
   use gcore::
   {
     Client, 
-    Response,
     Secret,
     Error, 
     Result
   };
-  use gcore::types::
-  {
-    DeleteDimensionRequest, 
-    SheetProperties
-  };
+  use gcore::types::SheetProperties;
 
   /// # SpreadSheetMethod
   ///

module/move/gspread/src/gcore/types.rs

@@ -373,7 +373,7 @@ mod private
   }
 
   /// Additional properties of a [DATA_SOURCE](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetType) sheet. 
-  #[ derive( Debug, Serialize, Deserialize ) ]
+  #[ derive( Debug, Serialize, Deserialize, Clone ) ]
   pub struct DataSourceSheetProperties
   {
     /// ID of the [DataSource](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#DataSource) the sheet is connected to. 
@@ -434,13 +434,6 @@ mod private
     pub data_source_sheet_properties : Option< DataSourceSheetProperties >
   }
 
-  #[ derive( Debug ) ]
-  pub struct Range
-  {
-    start_index : usize,
-    end_index   : usize
-  }
-
   /// A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.
   #[ derive( Debug, Serialize, Deserialize, Clone ) ]
   pub struct DimensionRange
@@ -482,9 +475,11 @@ mod private
     }
 
     #[ derive( Debug, Serialize, Deserialize ) ]
+    #[ serde( untagged ) ]
     pub enum Response
     {
-      DeleteDimensionGroupResponse,
+      #[ serde( rename = "deleteDimensionGroup" ) ]
+      DeleteDimensionGroup( DeleteDimensionGroupResponse ),
     }
 
     #[ derive( Debug, ser::Serialize, ser::Deserialize, Clone ) ]
@@ -3974,7 +3969,7 @@ mod private
       enbled : Option< bool >,
       /// The scope of the refresh. Must be ALL_DATA_SOURCES.
       #[ serde( rename = "refreshScope" ) ]
-      refreshScope : Option< DataSourceRefreshScope >,
+      refresh_scope : Option< DataSourceRefreshScope >,
       /// Output only. The time interval of the next run.
       #[ serde( rename = "nextRun" ) ]
       next_run : Option< Interval >,

module/move/gspread/tests/mock/append_row.rs

@@ -2,7 +2,7 @@
 //! Tests for `append_row` function.
 //! 
 
-use gspread::gcore::client::BatchUpdateValuesResponse;
+use gspread::gcore::methods::values::BatchUpdateValuesResponse;
 use httpmock::prelude::*;
 use serde_json::json;
 use std::collections::HashMap;

module/move/gspread/tests/mock/clear.rs

@@ -2,15 +2,12 @@
 //! Tests for `clear` function.
 //!
 
+use gspread::gcore::methods::values::ValuesClearResponse;
 use httpmock::prelude::*;
 use gspread::*;
 use actions::gspread::clear;
 use gcore::ApplicationSecret;
-use gcore::client::
-{
-  Client,
-  ValuesClearResponse
-};
+use gcore::Client;
 
 
 /// # What