remove error_chain dependency in favor of std::error

Author: softprops

Diff for: CHANGELOG.md

@@ -1,6 +1,7 @@
 # 0.6.0
 
-* BREAKING CHANGE: Migrate from old `futures` crate futures to std library futures making it possible to use `async`/`await` with this library. Please see the examples directory for updated examples of how to use these. [#254](https://github.com/softprops/hubcaps/pull/254)
+* BREAKING CHANGE: Migrate from old `futures` crate futures to std library futures making it possible to use `async`/`await` with this library. This puts this library in better compatibility with the current rust async ecosystem. Please see the examples directory for updated examples of how to use these. [#254](https://github.com/softprops/hubcaps/pull/254)
+* BREAKING CHANGE: replace `error_chain` derived errors with `std::error::Error` implementing `Error` enum. The motivation is that the error crate ecosystem is a moving target. The `std::error` package is not. This also makes for a smaller crate and smaller surface area. This moves away from errors of the form `Error(ErrorKind::Codec(_), _)` to errors of the form `Error::Codec(_)`
 * Add support for Content create and update apis [#253](https://github.com/softprops/hubcaps/pull/253)
 * Add description field to label apis [#252](https://github.com/softprops/hubcaps/pull/252)
 * Make status fields `created_at`, `updated_at` and `target_url` optional [#250](https://github.com/softprops/hubcaps/pull/250) [#249](https://github.com/softprops/hubcaps/pull/249)

Diff for: Cargo.toml

@@ -33,7 +33,6 @@ reqwest = { version = "0.10", default-features = false }
 serde = { version = "1.0.84", features = ['derive'] }
 serde_derive = "1.0"
 serde_json = "1.0"
-error-chain = "0.12"
 base64 = "0.12"
 percent-encoding = "2"
 

Diff for: examples/assignees.rs

@@ -1,35 +1,31 @@
+use hubcaps::{Credentials, Github};
 use std::env;
-
-use hubcaps::{Credentials, Github, Result};
+use std::error::Error;
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
-    match env::var("GITHUB_TOKEN").ok() {
-        Some(token) => {
-            let github = Github::new(
-                concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
-                Credentials::Token(token),
-            )?;
-            let pull = github
-                .repo("softprops", "hubcaps")
-                .pulls()
-                .get(122)
-                .assignees()
-                .add(vec!["softprops"])
-                .await?;
-            println!("{:#?}", pull);
+    let token = env::var("GITHUB_TOKEN")?;
+    let github = Github::new(
+        concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
+        Credentials::Token(token),
+    )?;
+    let pull = github
+        .repo("softprops", "hubcaps")
+        .pulls()
+        .get(122)
+        .assignees()
+        .add(vec!["softprops"])
+        .await?;
+    println!("{:#?}", pull);
 
-            let issue = github
-                .repo("softprops", "hubcaps")
-                .issues()
-                .get(125)
-                .assignees()
-                .add(vec!["softprops"])
-                .await?;
-            println!("{:#?}", issue);
-            Ok(())
-        }
-        _ => Err("example missing GITHUB_TOKEN".into()),
-    }
+    let issue = github
+        .repo("softprops", "hubcaps")
+        .issues()
+        .get(125)
+        .assignees()
+        .add(vec!["softprops"])
+        .await?;
+    println!("{:#?}", issue);
+    Ok(())
 }

Diff for: examples/branches.rs

@@ -1,63 +1,58 @@
-use std::env;
-
 use futures::prelude::*;
-
 use hubcaps::branches::Protection;
-use hubcaps::{Credentials, Github, Result};
+use hubcaps::{Credentials, Github};
+use std::env;
+use std::error::Error;
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
-    match env::var("GITHUB_TOKEN").ok() {
-        Some(token) => {
-            let github = Github::new(
-                concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
-                Credentials::Token(token),
-            )?;
+    let token = env::var("GITHUB_TOKEN")?;
+    let github = Github::new(
+        concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
+        Credentials::Token(token),
+    )?;
 
-            if let Err(err) = github
-                .repo("softprops", "hubcaps")
-                .branches()
-                .iter()
-                .try_for_each(|branch| async move {
-                    println!("{:#?}", branch);
-                    Ok(())
-                })
-                .await
-            {
-                println!("err {:#?}", err)
-            }
+    if let Err(err) = github
+        .repo("softprops", "hubcaps")
+        .branches()
+        .iter()
+        .try_for_each(|branch| async move {
+            println!("{:#?}", branch);
+            Ok(())
+        })
+        .await
+    {
+        println!("err {:#?}", err)
+    }
 
-            match github
-                .repo("softprops", "hubcaps")
-                .branches()
-                .get("master")
-                .await
-            {
-                Ok(branch) => println!("{:#?}", branch),
-                Err(err) => println!("err {:#?}", err),
-            }
+    match github
+        .repo("softprops", "hubcaps")
+        .branches()
+        .get("master")
+        .await
+    {
+        Ok(branch) => println!("{:#?}", branch),
+        Err(err) => println!("err {:#?}", err),
+    }
 
-            // protect master branch
-            match github
-                .repo("softprops", "hubcaps")
-                .branches()
-                .protection(
-                    "master",
-                    &Protection {
-                        required_status_checks: None,
-                        enforce_admins: false,
-                        required_pull_request_reviews: None,
-                        restrictions: None,
-                    },
-                )
-                .await
-            {
-                Ok(pro) => println!("{:#?}", pro),
-                Err(err) => println!("err {:#?}", err),
-            }
-            Ok(())
-        }
-        _ => Err("example missing GITHUB_TOKEN".into()),
+    // protect master branch
+    match github
+        .repo("softprops", "hubcaps")
+        .branches()
+        .protection(
+            "master",
+            &Protection {
+                required_status_checks: None,
+                enforce_admins: false,
+                required_pull_request_reviews: None,
+                restrictions: None,
+            },
+        )
+        .await
+    {
+        Ok(pro) => println!("{:#?}", pro),
+        Err(err) => println!("err {:#?}", err),
     }
+    Ok(())
 }

Diff for: examples/checks.rs

@@ -1,31 +1,23 @@
-use std::env;
-use std::fs::File;
-use std::io::Read;
-
 use hubcaps::checks::{
     Action, Annotation, AnnotationLevel, CheckRunOptions, Conclusion, Image, Output,
 };
 use hubcaps::git::GetReferenceResponse;
-use hubcaps::{Credentials, Github, InstallationTokenGenerator, JWTCredentials, Result};
-
-fn var(name: &str) -> Result<String> {
-    if let Ok(v) = env::var(name) {
-        Ok(v)
-    } else {
-        Err(format!("example missing {}", name).into())
-    }
-}
+use hubcaps::{Credentials, Github, InstallationTokenGenerator, JWTCredentials};
+use std::env;
+use std::error::Error;
+use std::fs::File;
+use std::io::Read;
 
 const USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
-    let key_file = var("GH_APP_KEY")?;
-    let app_id = var("GH_APP_ID")?;
-    let user_name = var("GH_USERNAME")?;
-    let repo = var("GH_REPO")?;
-    let branch = var("GH_BRANCH")?;
+    let key_file = env::var("GH_APP_KEY")?;
+    let app_id = env::var("GH_APP_ID")?;
+    let user_name = env::var("GH_USERNAME")?;
+    let repo = env::var("GH_REPO")?;
+    let branch = env::var("GH_BRANCH")?;
 
     let mut key = Vec::new();
     File::open(&key_file)?.read_to_end(&mut key)?;

Diff for: examples/collaborators.rs

@@ -1,53 +1,50 @@
-use hubcaps::{self, Credentials, Github, Result};
+use hubcaps::{self, Credentials, Github};
 use std::env;
+use std::error::Error;
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
-    match env::var("GITHUB_TOKEN").ok() {
-        Some(token) => {
-            let github = Github::new(
-                concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
-                Credentials::Token(token),
-            )?;
+    let token = env::var("GITHUB_TOKEN")?;
+    let github = Github::new(
+        concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
+        Credentials::Token(token),
+    )?;
 
-            println!("My organizations:");
-            println!();
+    println!("My organizations:");
+    println!();
 
-            for org in github.orgs().list().await? {
-                println!("{}", org.login);
-                println!("=============");
-                println!("Repos:");
+    for org in github.orgs().list().await? {
+        println!("{}", org.login);
+        println!("=============");
+        println!("Repos:");
 
-                for repo in github
-                    .org_repos(&org.login[..])
-                    .list(&Default::default())
-                    .await?
-                {
-                    println!("* {}", repo.name);
+        for repo in github
+            .org_repos(&org.login[..])
+            .list(&Default::default())
+            .await?
+        {
+            println!("* {}", repo.name);
 
-                    // If you have push permissions on an org, you can list collaborators.
-                    // Otherwise, don't print them.
-                    if let Ok(collabs) = github
-                        .repo(&org.login[..], &repo.name[..])
-                        .collaborators()
-                        .list()
-                        .await
-                    {
-                        println!(
-                            "  * Collaborators: {}",
-                            collabs
-                                .into_iter()
-                                .map(|c| { c.login })
-                                .collect::<Vec<_>>()
-                                .join(", ")
-                        );
-                    }
-                }
-                println!()
+            // If you have push permissions on an org, you can list collaborators.
+            // Otherwise, don't print them.
+            if let Ok(collabs) = github
+                .repo(&org.login[..], &repo.name[..])
+                .collaborators()
+                .list()
+                .await
+            {
+                println!(
+                    "  * Collaborators: {}",
+                    collabs
+                        .into_iter()
+                        .map(|c| { c.login })
+                        .collect::<Vec<_>>()
+                        .join(", ")
+                );
             }
-            Ok(())
         }
-        _ => Err("example missing GITHUB_TOKEN".into()),
+        println!()
     }
+    Ok(())
 }

Diff for: examples/comments.rs

@@ -1,28 +1,25 @@
 use hubcaps::comments::CommentOptions;
-use hubcaps::{Credentials, Github, Result};
+use hubcaps::{Credentials, Github};
 use std::env;
+use std::error::Error;
 
 const USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
-    match env::var("GITHUB_TOKEN").ok() {
-        Some(token) => {
-            let github = Github::new(USER_AGENT, Credentials::Token(token))?;
+    let token = env::var("GITHUB_TOKEN")?;
+    let github = Github::new(USER_AGENT, Credentials::Token(token))?;
 
-            let issue = github.repo("softprops", "hubcat").issues().get(1);
-            let f = issue.comments().create(&CommentOptions {
-                body: format!("Hello, world!\n---\nSent by {}", USER_AGENT),
-            });
+    let issue = github.repo("softprops", "hubcat").issues().get(1);
+    let f = issue.comments().create(&CommentOptions {
+        body: format!("Hello, world!\n---\nSent by {}", USER_AGENT),
+    });
 
-            match f.await {
-                Ok(comment) => println!("{:?}", comment),
-                Err(err) => println!("err {}", err),
-            }
-
-            Ok(())
-        }
-        _ => Err("example missing GITHUB_TOKEN".into()),
+    match f.await {
+        Ok(comment) => println!("{:?}", comment),
+        Err(err) => println!("err {}", err),
     }
+
+    Ok(())
 }

Diff for: examples/conditional_requests.rs

@@ -1,11 +1,11 @@
-use hubcaps::Result;
 #[cfg(feature = "httpcache")]
 use hubcaps::{Github, HttpCache};
 #[cfg(feature = "httpcache")]
 use reqwest::Client;
+use std::error::Error;
 
 #[tokio::main]
-async fn main() -> Result<()> {
+async fn main() -> Result<(), Box<dyn Error>> {
     pretty_env_logger::init();
 
     #[cfg(not(feature = "httpcache"))]