1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
//! Algorithmia client library
//!
//! # Examples
//!
//! ```no_run
//! use algorithmia::Algorithmia;
//!
//!# fn main() -> Result<(), Box<std::error::Error>> {
//! // Initialize with an API key
//! let client = Algorithmia::client("111112222233333444445555566")?;
//! let moving_avg = client.algo("timeseries/SimpleMovingAverage/0.1");
//!
//! // Run the algorithm using a type safe decoding of the output to Vec<f64>
//! //   since this algorithm outputs results as a JSON array of numbers
//! let input = (vec![0,1,2,3,15,4,5,6,7], 3);
//! let result: Vec<f64> = moving_avg.pipe(&input)?.decode()?;
//! println!("Completed with result: {:?}", result);
//! # Ok(())
//! # }
//! ```

#![doc(html_logo_url = "https://algorithmia.com/assets/images/logos/png/bintreePurple.png")]
#![doc(test(attr(allow(unused_variables), allow(dead_code))))]
#![cfg_attr(feature = "nightly", feature(specialization))]
#![allow(unknown_lints)]
#![recursion_limit = "1024"]

#[macro_use]
extern crate serde_derive;
#[macro_use]
extern crate error_chain;

#[cfg(feature = "entrypoint")]
#[allow(unused_imports)]
extern crate algorithmia_entrypoint;

use crate::algo::{AlgoUri, Algorithm};
use crate::client::HttpClient;
use crate::data::{DataDir, DataFile, DataObject, HasDataPath};

pub mod algo;
pub mod data;
pub mod error;

#[cfg(feature = "entrypoint")]
pub mod entrypoint;

use crate::client::ApiAuth;
use crate::error::Result;
pub use reqwest::Body;
pub use reqwest::{IntoUrl, Url};

/// Reexports of the most common types and traits
pub mod prelude {
    pub use crate::algo::AlgoIo;
    pub use crate::data::HasDataPath;
    pub use crate::Algorithmia;
    pub use serde_json::Value;

    #[cfg(feature = "entrypoint")]
    pub use crate::entrypoint::{entrypoint, DecodedEntryPoint, EntryPoint};
}

mod client;
mod version;

const DEFAULT_API_BASE_URL: &'static str = "https://api.algorithmia.com";

/// The top-level struct for instantiating Algorithmia client endpoints
pub struct Algorithmia {
    http_client: HttpClient,
}

impl Algorithmia {
    /// Instantiate a new client
    ///
    /// The Algorithmia client uses environment variables
    ///   `ALGORITHMIA_API` to override the default base URL of the API
    ///   and `ALGORITHMIA_API_KEY` to optionally the API key.
    pub fn new() -> Result<Algorithmia> {
        let api_address =
            std::env::var("ALGORITHMIA_API").unwrap_or_else(|_| DEFAULT_API_BASE_URL.into());
        let auth = std::env::var("ALGORITHMIA_API_KEY")
            .map(ApiAuth::from)
            .unwrap_or(ApiAuth::None);
        Ok(Algorithmia {
            http_client: HttpClient::new(auth, &api_address)?,
        })
    }

    /// Instantiate a new client
    ///
    /// Client should be instatiated with your API key, except
    ///   when running within an algorithm on the Algorithmia platform.
    ///
    /// # Examples
    /// ```
    /// use algorithmia::*;
    /// // Initialize a client
    /// let client = Algorithmia::client("simUseYourApiKey");
    /// ```
    pub fn client<A: Into<String>>(api_key: A) -> Result<Algorithmia> {
        let api_address =
            std::env::var("ALGORITHMIA_API").unwrap_or_else(|_| DEFAULT_API_BASE_URL.into());
        Ok(Algorithmia {
            http_client: HttpClient::new(ApiAuth::from(api_key.into()), &api_address)?,
        })
    }

    /// Instantiate a new client against alternate API servers
    pub fn client_with_url<A: Into<String>, U: IntoUrl>(
        api_key: A,
        base_url: U,
    ) -> Result<Algorithmia> {
        Ok(Algorithmia {
            http_client: HttpClient::new(ApiAuth::from(api_key.into()), base_url)?,
        })
    }

    /// Instantiate an [`Algorithm`](algo/algorithm.struct.html) from this client
    ///
    /// By using In
    /// # Examples
    ///
    /// ```
    /// use algorithmia::Algorithmia;
    /// # fn main() -> Result<(), Box<std::error::Error>> {
    /// let client = Algorithmia::client("111112222233333444445555566")?;
    /// let factor = client.algo("anowell/Dijkstra/0.1");
    /// # Ok(())
    /// # }
    /// ```
    pub fn algo<A: Into<AlgoUri>>(&self, algorithm: A) -> Algorithm {
        Algorithm::new(self.http_client.clone(), algorithm.into())
    }

    /// Instantiate a `DataDirectory` from this client
    ///
    /// # Examples
    ///
    /// ```
    /// use algorithmia::Algorithmia;
    /// # fn main() -> Result<(), Box<std::error::Error>> {
    /// let client = Algorithmia::client("111112222233333444445555566")?;
    /// let rustfoo = client.dir("data://.my/rustfoo");
    /// # Ok(())
    /// # }
    /// ```
    pub fn dir(&self, path: &str) -> DataDir {
        DataDir::new(self.http_client.clone(), path)
    }

    /// Instantiate a `DataDirectory` from this client
    ///
    /// # Examples
    ///
    /// ```
    /// use algorithmia::Algorithmia;
    /// # fn main() -> Result<(), Box<std::error::Error>> {
    /// let client = Algorithmia::client("111112222233333444445555566")?;
    /// let rustfoo = client.file("data://.my/rustfoo");
    /// # Ok(())
    /// # }
    /// ```
    pub fn file(&self, path: &str) -> DataFile {
        DataFile::new(self.http_client.clone(), path)
    }

    /// Instantiate a `DataPath` from this client
    ///
    /// Use this if you don't explicitly know if a Data URI is to a directory or file
    ///
    /// # Examples
    ///
    /// ```
    /// use algorithmia::Algorithmia;
    /// # fn main() -> Result<(), Box<std::error::Error>> {
    /// let client = Algorithmia::client("111112222233333444445555566")?;
    /// let rustfoo = client.data("data://.my/rustfoo/what_am_i");
    /// # Ok(())
    /// # }
    /// ```
    pub fn data(&self, path: &str) -> DataObject {
        DataObject::new(self.http_client.clone(), path)
    }
}

/// Allow cloning in order to reuse http client (and API key) for multiple connections
impl Clone for Algorithmia {
    fn clone(&self) -> Algorithmia {
        Algorithmia {
            http_client: self.http_client.clone(),
        }
    }
}