openethereum/price-info/src/lib.rs

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
// This file is part of Parity.

// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Parity.  If not, see <http://www.gnu.org/licenses/>.

#![warn(missing_docs)]

//! A simple client to get the current ETH price using an external API.

extern crate futures;
extern crate serde_json;

#[macro_use]
extern crate log;

pub extern crate fetch;

use std::cmp;
use std::fmt;
use std::io;
use std::io::Read;

use fetch::{Client as FetchClient, Fetch};
use futures::Future;
use serde_json::Value;

/// Current ETH price information.
#[derive(Debug)]
pub struct PriceInfo {
	/// Current ETH price in USD.
	pub ethusd: f32,
}

/// Price info error.
#[derive(Debug)]
pub enum Error {
	/// The API returned an unexpected status code.
	StatusCode(&'static str),
	/// The API returned an unexpected status content.
	UnexpectedResponse(String),
	/// There was an error when trying to reach the API.
	Fetch(fetch::Error),
	/// IO error when reading API response.
	Io(io::Error),
}

impl From<io::Error> for Error {
	fn from(err: io::Error) -> Self { Error::Io(err) }
}

impl From<fetch::Error> for Error {
	fn from(err: fetch::Error) -> Self { Error::Fetch(err) }
}

/// A client to get the current ETH price using an external API.
pub struct Client<F = FetchClient> {
	api_endpoint: String,
	fetch: F,
}

impl<F> fmt::Debug for Client<F> {
	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
		fmt.debug_struct("price_info::Client")
		   .field("api_endpoint", &self.api_endpoint)
		   .finish()
	}
}

impl<F> cmp::PartialEq for Client<F> {
	fn eq(&self, other: &Client<F>) -> bool {
		self.api_endpoint == other.api_endpoint
	}
}

impl<F: Fetch> Client<F> {
	/// Creates a new instance of the `Client` given a `fetch::Client`.
	pub fn new(fetch: F) -> Client<F> {
		let api_endpoint = "https://api.etherscan.io/api?module=stats&action=ethprice".to_owned();
		Client { api_endpoint, fetch }
	}

	/// Gets the current ETH price and calls `set_price` with the result.
	pub fn get<G: Fn(PriceInfo) + Sync + Send + 'static>(&self, set_price: G) {
		self.fetch.process_and_forget(self.fetch.fetch(&self.api_endpoint)
			.map_err(|err| Error::Fetch(err))
			.and_then(move |mut response| {
				if !response.is_success() {
					return Err(Error::StatusCode(response.status().canonical_reason().unwrap_or("unknown")));
				}
				let mut result = String::new();
				response.read_to_string(&mut result)?;

				let value: Option<Value> = serde_json::from_str(&result).ok();

				let ethusd = value
					.as_ref()
					.and_then(|value| value.pointer("/result/ethusd"))
					.and_then(|obj| obj.as_str())
					.and_then(|s| s.parse().ok());

				match ethusd {
					Some(ethusd) => {
						set_price(PriceInfo { ethusd });
						Ok(())
					},
					None => Err(Error::UnexpectedResponse(result)),
				}
			})
			.map_err(|err| {
				warn!("Failed to auto-update latest ETH price: {:?}", err);
				err
			})
		);
	}
}

#[cfg(test)]
mod test {
	extern crate parking_lot;

	use self::parking_lot::Mutex;
	use std::sync::Arc;
	use std::sync::atomic::{AtomicBool, Ordering};
	use fetch;
	use fetch::Fetch;
	use futures;
	use futures::future::{Future, FutureResult};
	use Client;

	#[derive(Clone)]
	struct FakeFetch(Option<String>, Arc<Mutex<u64>>);
	impl Fetch for FakeFetch {
		type Result = FutureResult<fetch::Response, fetch::Error>;
		fn new() -> Result<Self, fetch::Error> where Self: Sized { Ok(FakeFetch(None, Default::default())) }
		fn fetch_with_abort(&self, url: &str, _abort: fetch::Abort) -> Self::Result {
			assert_eq!(url, "https://api.etherscan.io/api?module=stats&action=ethprice");
			let mut val = self.1.lock();
			*val = *val + 1;
			if let Some(ref response) = self.0 {
				let data = ::std::io::Cursor::new(response.clone());
				futures::future::ok(fetch::Response::from_reader(data))
			} else {
				futures::future::ok(fetch::Response::not_found())
			}
		}

		// this guarantees that the calls to price_info::Client::get will block for execution
		fn process_and_forget<F, I, E>(&self, f: F) where
			F: Future<Item=I, Error=E> + Send + 'static,
			I: Send + 'static,
			E: Send + 'static,
		{
			let _ = f.wait();
		}
	}

	fn price_info_ok(response: &str) -> Client<FakeFetch> {
		Client::new(FakeFetch(Some(response.to_owned()), Default::default()))
	}

	fn price_info_not_found() -> Client<FakeFetch> {
		Client::new(FakeFetch::new().unwrap())
	}

	#[test]
	fn should_get_price_info() {
		// given
		let response = r#"{
			"status": "1",
			"message": "OK",
			"result": {
				"ethbtc": "0.0891",
				"ethbtc_timestamp": "1499894236",
				"ethusd": "209.55",
				"ethusd_timestamp": "1499894229"
			}
		}"#;

		let price_info = price_info_ok(response);

		// when
		price_info.get(|price| {

			// then
			assert_eq!(price.ethusd, 209.55);
		});
	}

	#[test]
	fn should_not_call_set_price_if_response_is_malformed() {
		// given
		let response = "{}";

		let price_info = price_info_ok(response);
		let b = Arc::new(AtomicBool::new(false));

		// when
		let bb = b.clone();
		price_info.get(move |_| {
			bb.store(true, Ordering::Relaxed);
		});

		// then
		assert_eq!(b.load(Ordering::Relaxed), false);
	}

	#[test]
	fn should_not_call_set_price_if_response_is_invalid() {
		// given
		let price_info = price_info_not_found();
		let b = Arc::new(AtomicBool::new(false));

		// when
		let bb = b.clone();
		price_info.get(move |_| {
			bb.store(true, Ordering::Relaxed);
		});

		// then
		assert_eq!(b.load(Ordering::Relaxed), false);
	}
}