Merge pull request #32 from tinaun/doc-search

added `?docs` command

Author: technetos

README.md

@@ -26,6 +26,17 @@ Get all tags
 ```
 ?tags
 ```
+
+### Crates
+Search for a crate on crates.io
+```
+?crate query...
+```
+Retreive documentation for a crate
+```
+?docs query...
+```
+
 ### Ban
 Ban a user
 ```

src/crates.rs

@@ -22,9 +22,10 @@ struct Crate {
     updated: String,
     downloads: u64,
     description: String,
+    documentation: Option<String>,
 }
 
-pub fn search(args: Args) -> Result<()> {
+fn get_crate(args: &Args) -> Result<Option<Crate>> {
     let query = args
         .params
         .get("query")
@@ -40,7 +41,11 @@ pub fn search(args: Args) -> Result<()> {
         .send()?
         .json::<Crates>()?;
 
-    if let Some(krate) = crate_list.crates.get(0) {
+    Ok(crate_list.crates.into_iter().nth(0))
+}
+
+pub fn search(args: Args) -> Result<()> {
+    if let Some(krate) = get_crate(&args)? {
         args.msg.channel_id.send_message(&args.cx, |m| {
             m.embed(|e| {
                 e.title(&krate.name)
@@ -61,6 +66,22 @@ pub fn search(args: Args) -> Result<()> {
     Ok(())
 }
 
+pub fn doc_search(args: Args) -> Result<()> {
+    if let Some(krate) = get_crate(&args)? {
+        let name = krate.name;
+        let message = krate
+            .documentation
+            .unwrap_or_else(|| format!("https://docs.rs/{}", name));
+
+        api::send_reply(&args, &message)?;
+    } else {
+        let message = "No crates found.";
+        api::send_reply(&args, message)?;
+    }
+
+    Ok(())
+}
+
 /// Print the help message
 pub fn help(args: Args) -> Result<()> {
     let help_string = "search for a crate on crates.io
@@ -70,3 +91,13 @@ pub fn help(args: Args) -> Result<()> {
     api::send_reply(&args, &help_string)?;
     Ok(())
 }
+
+/// Print the help message
+pub fn doc_help(args: Args) -> Result<()> {
+    let help_string = "retrieves documentation for a given crate
+```
+?docs query...
+```";
+    api::send_reply(&args, &help_string)?;
+    Ok(())
+}

src/main.rs

@@ -82,6 +82,10 @@ fn app() -> Result {
     cmds.add("?crate help", crates::help);
     cmds.add("?crate query...", crates::search);
 
+    // docs.rs
+    cmds.add("?docs help", crates::doc_help);
+    cmds.add("?docs query...", crates::doc_search);
+
     // Slow mode.
     // 0 seconds disables slowmode
     cmds.add("?slowmode {channel} {seconds}", slow_mode);