rust-lang-ve / libcne-ve

Fetches data from a public endpoint in the CNE website and deserializes its contents

libcne-ve

Fetches data from a public endpoint in the CNE website and deserializes its contents.

Installation

To install the latest release, add the crate as follows to your dependencies list in your Cargo.toml.

[dependencies]
libcne-ve = "0.1.0"

If you want to use a specific version, you must add the crate to your Cargo.toml as follows:

[dependencies]
libcne = { git = "https://github.com/rust-lang-ve/libcne-ve.git", tag = "v0.1.0" }

Motivation

The first motivation for this repository is to learn Rust. We have a very good feeling regarding the future of Rust so we decided to learn about the language in community.

libcne-ve is a hobbist project to gather public data available in the CNE website.

Basically this crate, makes a request to the endpoint available in the site used to fetch date about where a given ID (CID) belongs as voting center, scraps the HTML response into an Elector struct and returns it.

Example

The following sample is available in the libcne-ve/example directory:

use libcne_ve::request::find;
use libcne_ve::cne::{Citizenship, Elector};

#[tokio::main]
async fn main() {
  let elector_id: String = String::from("123123123");
  let elector: Elector = find(Citizenship::V, elector_id).await.unwrap();

  println!("{:?}", elector);
}

Releasing

To release a new version you must tag with git and push to the main branch.

git tag -a v0.1.0 -m "First Release"
git push origin main --follow-tags

Contributing

Every contribution to this project is welcome! Feel free to open a pull request or an issue.

License

Licensed under the GNU General Public License.

libcne-ve's Issues

Instance `Elector` from HTML response

Requirement

The From trait which is already implemented for the Elector struct should return an Elector instance given the HTML document returned by:
http_client.get(&url).send().await?

Overview

Elector From trait Implementation

https://github.com/rust-lang-ve/libcne/blob/8461bc153bcbaf3448eb8ada2a06840e625a97d3/src/cne/elector.rs#L20

Request that returns HTML

https://github.com/rust-lang-ve/libcne/blob/8461bc153bcbaf3448eb8ada2a06840e625a97d3/src/request/request.rs#L11

Setup CI integrations for clippy and fmt

Setup CI workflows to run clippy and the rust fmt checker on every PR

Write README samples