Updated and added missing metadata (#4)

* Create LICENSE

* Fixed some metadata

* Run cargo fmt

* Added clarification on failing test

Cargo.toml

@@ -1,14 +1,16 @@
 [package]
-name = "apex_legends"
+name = "apex_legends_api"
 description = "An API wrapper for the MozambiqueHe.re Apex Legends API."
-version = "0.1.2"
+version = "0.1.4"
 edition = "2018"
-author = "KasprDev <[email protected]>"
-repository = "https://github.com/KasprDev/Apex-Legends-API-Rust"
+authors = ["KasprDev <[email protected]>", "margual56 <[email protected]>"]
+repository = "https://github.com/margual56/Apex-Legends-API-Rust"
 keywords = ["apex_legends", "apex", "game", "video_game", "api"]
 categories = ["api-bindings", "asynchronous"]
-exclude = ["src/main.rs"]
-license = "MIT OR Apache-2.0"
+exclude = ["src/main.rs", ".github/"]
+license = "MIT"
+readme = "README.md"
+
 
 [dependencies]
 tokio = { version = "1.0", features = ["full"] }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Marcos Gutiérrez Alonso
+
+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.

README.md

@@ -9,13 +9,20 @@ use apex_legends;
 
 #[tokio::main]
 async fn main() {
-    match apex_legends::get_user("HeyImLifeline".to_string(), "your_api_key").await {
+    match apex_legends::get_user_retry("HeyImLifeline".to_string(), "your_api_key", true).await {
         Ok(data) => println!("You are level {}.", data.global.level),
-        Err(e) => {
-            println!("there was an error!: {}", e)
-        }
+        Err(e) => println!("There was an error!: {}", e)
     }
 }
 ```
 
 I have no affiliation with Apex Legends, EA, or Apex Legends Status.
+
+## A note about the failing test
+
+This is a known issue in the API. It has a rate limit, so it should return code 429 when the limit is reached. Instead, it returns 200 OK, so the library immediately retries and, unsurprisingly, it fails.
+
+
+# Authors
+
+The original author is [KasprDev](https://github.com/KasprDev), and this is a fork with some improvements for stability and extra features. Some of them were upstreamed, but not all of them as of yet.

src/http.rs

@@ -19,6 +19,7 @@ pub async fn get_request(url: String) -> Result<String, (reqwest::Error, Option<
     }
 }
 
+#[allow(dead_code)]
 pub async fn post_request(url: &str, body: String) -> Result<String, reqwest::Error> {
     let client = reqwest::Client::new();
 

tests/test.rs

@@ -1,6 +1,6 @@
 #[cfg(test)]
 mod tests {
-    use apex_legends::data_types;
+    use apex_legends_api::data_types;
     use std::env;
 
     fn print_data<T>(res: Result<T, String>, f: fn(T) -> String) -> bool {
@@ -27,7 +27,7 @@ mod tests {
 
         assert!(
             print_data::<data_types::ApexUser>(
-                apex_legends::get_user_retry(String::from(&user_name), &api_key, true).await,
+                apex_legends_api::get_user_retry(String::from(&user_name), &api_key, true).await,
                 |data| {
                     format!(
                         "You are level {}, and you have {} kills.",
@@ -40,7 +40,7 @@ mod tests {
 
         assert!(
             print_data::<data_types::ApexUser>(
-                apex_legends::get_user_retry(String::from(&user_name), &api_key, true).await,
+                apex_legends_api::get_user_retry(String::from(&user_name), &api_key, true).await,
                 |data| {
                     format!(
                         "You are level {}, and you have {} kills.",
@@ -60,17 +60,25 @@ mod tests {
 
         assert!(
             print_data::<data_types::ApexProfile>(
-                apex_legends::get_uid_from_username_retry(String::from(&user_name), &api_key, true)
-                    .await,
+                apex_legends_api::get_uid_from_username_retry(
+                    String::from(&user_name),
+                    &api_key,
+                    true
+                )
+                .await,
                 |data| format!("Your UID is {}", data.uid),
             ),
             "get_uid_from_username_retry"
         );
 
         assert!(
             print_data::<data_types::ApexProfile>(
-                apex_legends::get_uid_from_username_retry(String::from(&user_name), &api_key, true)
-                    .await,
+                apex_legends_api::get_uid_from_username_retry(
+                    String::from(&user_name),
+                    &api_key,
+                    true
+                )
+                .await,
                 |data| format!("Your UID is {}", data.uid),
             ),
             "get_uid_from_username_retry"
@@ -85,7 +93,7 @@ mod tests {
 
         assert!(
             print_data::<data_types::ApexMapRotation>(
-                apex_legends::get_map_rotation_retry(&api_key, true).await,
+                apex_legends_api::get_map_rotation_retry(&api_key, true).await,
                 |data| {
                     format!(
                         "The current ranked map is {}",
@@ -97,7 +105,7 @@ mod tests {
         );
         assert!(
             print_data::<data_types::ApexMapRotation>(
-                apex_legends::get_map_rotation_retry(&api_key, true).await,
+                apex_legends_api::get_map_rotation_retry(&api_key, true).await,
                 |data| {
                     format!(
                         "The current ranked map is {}",