Develop

.github/workflows/rust.yml

@@ -69,7 +69,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --verbose --all-features -- --ignored
+          args: --verbose --all-features -- --ignored --nocapture
 
   release:
     name: Release x86_64-unknown-linux-gnu

.gitignore

@@ -1 +1,2 @@
 /target
+**/main.rs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vinted-rs"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 repository = "https://github.com/TuTarea/vinted-rs"
 authors = ["Pepe Márquez <pepe.marquezromero@gmail.com>" , "Álvaro Cabo <alvarocaboac2@gmail.com>"]

README.md

@@ -6,32 +6,34 @@
  [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
  [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
 
-A complete Vinted API-Wrapper in Rust
+## Table of Contents
+
+- [Vinted-rs: A Vinted API wrapper](#vinted-rs-a-vinted-api-wrapper)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [DB setup](#db-setup)
+    - [Create a migration](#create-a-migration)
+    - [Run a Docker container with PostgreSQL](#run-a-docker-container-with-postgresql)
+    - [Run migrations](#run-migrations)
+    - [Stop DB](#stop-db)
+  - [Running Tests](#running-tests)
 
 ## Installation
 
 Via `cargo` you can add the library to your project's `Cargo.toml`
 
 ```toml
 [dependencies]
-vinted-rs = "0.0.1"
+vinted-rs = "0.2"
 ```
 
-## Authors
-
-[Álvaro Cabo](https://github.com/alvarocabo)
-
-[Pepe Márquez](https://github.com/pxp9)
-
 ## DB setup
 
 Advanced filtering features must require this setup before running.
 
 - First start installing diesel-cli (in order to run the migrations in PostgreSQL database)
 
-### VERY IMPORTANT
-
-diesel-cli installation may fail if you do not have `libpq` library installed.
+⚠️**Very important:** diesel-cli installation may fail if you do not have `libpq` library installed.
 
 To install `libpq`, just install PostgreSQL package on your machine.
 
@@ -85,9 +87,7 @@ make stop
 
 ## Running Tests
 
-### Very important
-
-Before running tests is important to do the DB setup
+⚠️**Very important:** Before running tests is important to do the [DB setup](#db-setup)
 
 Then run the tests
 

src/db.rs

@@ -22,11 +22,12 @@ use bb8_postgres::{
 use postgres_types::ToSql;
 use thiserror::Error;
 
-use crate::model::filter::{brand::Brand, category::Category};
+use crate::model::filter::{brand::Brand, category::Category, country::Country};
 
 const GET_BRAND_BY_NAME: &str = include_str!("sql_queries/GET_BRAND_BY_NAME.sql");
 const GET_BRANDS_BY_NAME: &str = include_str!("sql_queries/GET_BRANDS_BY_NAME.sql");
 const GET_CATEGORY_BY_NAME: &str = include_str!("sql_queries/GET_CATEGORY_BY_NAME.sql");
+const GET_COUNTRY_BY_ISO_CODE: &str = include_str!("sql_queries/GET_COUNTRY_BY_ISO_CODE.sql");
 
 /**
 Represents an error that can occur during database operations.
@@ -122,4 +123,18 @@ where
 
         Ok(cat)
     }
+
+    /// Retrieves a category by its title from the database
+    pub async fn get_country_by_iso<S: AsRef<str> + Sync + ToSql + Display>(
+        &self,
+        code: &S,
+    ) -> Result<Country, DbError> {
+        let conn = self.pool.get().await?;
+        let row: Row = conn.query_one(GET_COUNTRY_BY_ISO_CODE, &[&code]).await?;
+
+        // Works because From<Row> for Category is implemented
+        let country: Country = row.into();
+
+        Ok(country)
+    }
 }

src/model/filter.rs

@@ -9,7 +9,7 @@ pub mod material;
 pub mod size;
 
 /// Represents a filter for querying items.
-
+///
 /// Trait Implementations:
 /// - `TypedBuilder`: Implements the builder pattern for constructing a `Filter` instance.
 ///
@@ -19,6 +19,7 @@ pub mod size;
 ///### Example
 ///
 ///```rust
+/// use vinted_rs::Filter;
 ///
 /// let filter: Filter = Filter::builder()
 ///      .catalog_ids(String::from("4,16"))
@@ -30,11 +31,16 @@ pub mod size;
 ///
 ///```
 ///
+///
+/// `price_from` filter should be always <= `price_to` , otherwise Vinted will not find anything
+///
 #[derive(TypedBuilder, Debug, Clone)]
 pub struct Filter {
     ///The search text to filter items by.
     ///### Example
     ///```rust
+    /// use vinted_rs::Filter;
+    ///
     ///let filter: Filter = Filter::builder().search_text(String::from("shoes")).build();
     ///```
     ///
@@ -73,6 +79,8 @@ pub struct Filter {
     ///
     ///Try it in [Regex 101](https://regex101.com/r/u8ZEpv/1)
     ///
+    ///
+    /// **Note:** Color names are only avalible in French in our database at the moment
     ///### Example
     ///```rust
     /// use vinted_rs::Filter;
@@ -117,7 +125,7 @@ pub struct Filter {
     /// use vinted_rs::Filter;
     ///
     ///
-    /// let filter: Filter = Filter::builder().country_ids(String::from("7,16")).build();
+    /// let filter: Filter = Filter::builder().countries_ids(String::from("7,16")).build();
     /// // Where 7 and 16 are country_ids from Vinted
     /// // 7 is country_id for Spain
     /// // 16 is country_id for France
@@ -144,14 +152,34 @@ pub struct Filter {
     ///```
     ///
     #[builder(default, setter(strip_option))]
+    pub material_ids: Option<String>,
+    /// The material IDs to filter items by. Must be formatted as `^[\d+,]*\d+$` regex.
+    ///
+    ///If not formated with the specified regex, undefined behaviour. (Input will not be checked).
+    ///
+    ///
+    ///Try it in [Regex 101](https://regex101.com/r/u8ZEpv/1)
+    ///
+    ///### Example
+    ///```rust
+    /// use vinted_rs::Filter;
+    ///
+    ///
+    /// let filter: Filter = Filter::builder().material_ids(String::from("44,102")).build();
+    /// // Where 7 and 16 are country_ids from Vinted
+    /// // 44 is material_id for coton
+    /// // 49 is material_id for silk
+    ///```
+    ///
+    #[builder(default, setter(strip_option))]
     pub size_ids: Option<String>,
     #[builder(default, setter(strip_option))]
     /// The article statuses to filter items by.
     ///
     ///### Example
     ///```rust
     /// use vinted_rs::Filter;
-    ///
+    /// use vinted_rs::model::filter::ArticleStatus;
     ///
     /// let filter: Filter = Filter::builder().article_status(vec![ArticleStatus::NewTags ,
     /// ArticleStatus::NewNoTags]).build();
@@ -163,13 +191,38 @@ pub struct Filter {
     ///### Example
     ///```rust
     /// use vinted_rs::Filter;
-    ///
+    /// use vinted_rs::model::filter::SortBy;
+
     ///
     /// let filter: Filter = Filter::builder().sort_by(SortBy::PriceAscendant).build();
     ///```
     ///
     #[builder(default, setter(strip_option))]
     pub sort_by: Option<SortBy>,
+    /// The minimum price of the article
+    ///
+    ///### Example
+    ///```rust
+    /// use vinted_rs::Filter;
+    ///
+    ///
+    /// let filter: Filter = Filter::builder().price_from(10u32).build();
+    ///```
+    ///
+    #[builder(default, setter(strip_option))]
+    pub price_from: Option<u32>,
+    /// The max price of the article
+    ///
+    ///### Example
+    ///```rust
+    /// use vinted_rs::Filter;
+    ///
+    ///
+    /// let filter: Filter = Filter::builder().price_from(20u32).build();
+    ///```
+    ///
+    #[builder(default, setter(strip_option))]
+    pub price_to: Option<u32>,
 }
 
 /*

src/model/filter/category.rs

@@ -4,13 +4,13 @@ use typed_builder::TypedBuilder;
 
 #[derive(Debug, Clone, TypedBuilder, PartialEq, Eq)]
 pub struct Category {
-    id: i32,
+    pub id: i32,
     // TODO creo que estos titulos solo estan en ingles
-    title: String,
-    code: String,
-    parent_id: i32,
-    url: String,
-    url_en: String,
+    pub title: String,
+    pub code: String,
+    pub parent_id: i32,
+    pub url: String,
+    pub url_en: String,
 }
 
 #[cfg(feature = "advanced_filters")]

src/model/filter/category_tree.rs

@@ -4,9 +4,9 @@ use typed_builder::TypedBuilder;
 
 #[derive(Debug, Clone, TypedBuilder, PartialEq, Eq)]
 pub struct CategoryTree {
-    id: i32,
-    parent_id: i32,
-    child_id: i32,
+    pub id: i32,
+    pub parent_id: i32,
+    pub child_id: i32,
 }
 
 #[cfg(feature = "advanced_filters")]

src/model/filter/colors.rs

@@ -4,10 +4,9 @@ use typed_builder::TypedBuilder;
 
 #[derive(Debug, Clone, TypedBuilder, PartialEq, Eq)]
 pub struct Color {
-    id: i32,
-    // TODO el titulo solo está en francés valorar que podemos hacer
-    title: String,
-    hex: String,
+    pub id: i32,
+    pub title: String,
+    pub hex: String,
 }
 
 #[cfg(feature = "advanced_filters")]

src/model/filter/country.rs

@@ -3,18 +3,20 @@ use bb8_postgres::tokio_postgres::Row;
 use typed_builder::TypedBuilder;
 
 #[derive(Debug, Clone, TypedBuilder, PartialEq, Eq)]
-struct Country {
-    id: i32,
-    local_name: String,
-    iso_code: String,
-    flag: String,
+pub struct Country {
+    pub id: i32,
+    pub name: String,
+    pub local_name: String,
+    pub iso_code: String,
+    pub flag: String,
 }
 
 #[cfg(feature = "advanced_filters")]
 impl From<Row> for Country {
     fn from(row: Row) -> Self {
         Country::builder()
             .id(row.get("id"))
+            .name(row.get("name"))
             .local_name(row.get("local_name"))
             .iso_code(row.get("iso_code"))
             .flag(row.get("flag"))

src/model/filter/material.rs

@@ -4,10 +4,10 @@ use typed_builder::TypedBuilder;
 
 #[derive(Debug, Clone, TypedBuilder, PartialEq, Eq)]
 pub struct Material {
-    id: i32,
-    material_es: String,
-    material_fr: String,
-    material_en: String,
+    pub id: i32,
+    pub material_es: String,
+    pub material_fr: String,
+    pub material_en: String,
 }
 
 #[cfg(feature = "advanced_filters")]

src/model/photo.rs

@@ -2,8 +2,8 @@ use crate::model::{Deserialize, Serialize};
 #[derive(Debug, Clone, Serialize, Deserialize)]
 
 pub struct Photo {
-    id: i64,
-    url: String,
-    dominant_color: String,
-    dominant_color_opaque: String,
+    pub id: i64,
+    pub url: String,
+    pub dominant_color: String,
+    pub dominant_color_opaque: String,
 }