Merge pull request #61 from zonyitoo/feature-lowecase-oid

Lowercase ObjectId string

Author: zonyitoo

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bson"
-version = "0.4.4"
+version = "0.5.0"
 authors = [
     "Y. T. Chung <zonyitoo@gmail.com>",
     "Kevin Yeh <kevinyeah@utexas.edu>"
@@ -17,7 +17,6 @@ name = "bson"
 [dependencies]
 byteorder = "1.0"
 chrono = "0.2"
-data-encoding = "1.1.2"
 libc = "0.2"
 rand = "0.3"
 rust-crypto = "0.2"
@@ -26,3 +25,4 @@ serde_json = { version = "0.9.5", features = ["preserve_order"] }
 time = "0.1"
 linked-hash-map = "0.3"
 hostname = "^0.1"
+hex = "^0.2"

README.md

@@ -16,7 +16,7 @@ This crate works with Cargo and can be found on
 
 ```toml
 [dependencies]
-bson = "0.4"
+bson = "0.5"
 ```
 ## Usage
 Link the library in _main.rs_:

src/bson.rs

@@ -25,8 +25,8 @@ use std::fmt::{self, Display, Debug};
 
 use chrono::{DateTime, Timelike, UTC};
 use chrono::offset::TimeZone;
-use data_encoding::hex;
 use serde_json::Value;
+use hex::{FromHex, ToHex};
 
 use oid;
 use ordered::OrderedDocument;
@@ -100,9 +100,7 @@ impl Debug for Bson {
 
                 write!(f, "TimeStamp({}, {})", time, inc)
             }
-            &Bson::Binary(t, ref vec) => {
-                write!(f, "BinData({}, 0x{})", u8::from(t), hex::encode(vec))
-            }
+            &Bson::Binary(t, ref vec) => write!(f, "BinData({}, 0x{})", u8::from(t), vec.to_hex()),
             &Bson::ObjectId(ref id) => write!(f, "ObjectId({:?})", id),
             &Bson::UtcDatetime(date_time) => write!(f, "UtcDatetime({:?})", date_time),
             &Bson::Symbol(ref sym) => write!(f, "Symbol({:?})", sym),
@@ -145,7 +143,7 @@ impl Display for Bson {
                 write!(fmt, "Timestamp({}, {})", time, inc)
             }
             &Bson::Binary(t, ref vec) => {
-                write!(fmt, "BinData({}, 0x{})", u8::from(t), hex::encode(vec))
+                write!(fmt, "BinData({}, 0x{})", u8::from(t), vec.to_hex())
             }
             &Bson::ObjectId(ref id) => write!(fmt, "ObjectId(\"{}\")", id),
             &Bson::UtcDatetime(date_time) => write!(fmt, "Date(\"{}\")", date_time),
@@ -325,7 +323,7 @@ impl Bson {
                 let tval: u8 = From::from(t);
                 json!({
                     "type": tval,
-                    "$binary": hex::encode(v)
+                    "$binary": v.to_hex()
                 })
             }
             &Bson::ObjectId(ref v) => json!({"$oid": v.to_string()}),
@@ -396,7 +394,7 @@ impl Bson {
             Bson::Binary(t, ref v) => {
                 let tval: u8 = From::from(t);
                 doc! {
-                    "$binary" => (hex::encode(v)),
+                    "$binary" => (v.to_hex()),
                     "type" => (tval as i64)
                 }
             }
@@ -444,7 +442,7 @@ impl Bson {
             } else if let (Ok(hex), Ok(t)) = (values.get_str("$binary"), values.get_i64("type")) {
                 let ttype = t as u8;
                 return Bson::Binary(From::from(ttype),
-                                    hex::decode(hex.to_uppercase().as_bytes()).unwrap());
+                                    FromHex::from_hex(hex.as_bytes()).unwrap());
             }
 
         } else if values.len() == 1 {

src/lib.rs

@@ -45,7 +45,6 @@
 extern crate byteorder;
 extern crate chrono;
 extern crate crypto;
-extern crate data_encoding;
 extern crate libc;
 extern crate rand;
 extern crate serde;
@@ -54,6 +53,7 @@ extern crate serde_json;
 extern crate time;
 extern crate linked_hash_map;
 extern crate hostname;
+extern crate hex;
 
 pub use self::bson::{Bson, Document, Array};
 pub use self::encoder::{encode_document, to_bson, Encoder, EncoderResult, EncoderError};

src/oid.rs

@@ -8,7 +8,8 @@ use std::sync::atomic::{AtomicUsize, Ordering, ATOMIC_USIZE_INIT};
 use byteorder::{ByteOrder, BigEndian, LittleEndian};
 use crypto::digest::Digest;
 use crypto::md5::Md5;
-use data_encoding::{self, hex};
+
+use hex::{ToHex, FromHex, FromHexError};
 
 use rand::{Rng, OsRng};
 
@@ -35,13 +36,13 @@ static mut MACHINE_BYTES: Option<[u8; 3]> = None;
 #[derive(Debug)]
 pub enum Error {
     ArgumentError(String),
-    FromHexError(data_encoding::decode::Error),
+    FromHexError(FromHexError),
     IoError(io::Error),
     HostnameError,
 }
 
-impl From<data_encoding::decode::Error> for Error {
-    fn from(err: data_encoding::decode::Error) -> Error {
+impl From<FromHexError> for Error {
+    fn from(err: FromHexError) -> Error {
         Error::FromHexError(err)
     }
 }
@@ -126,7 +127,7 @@ impl ObjectId {
 
     /// Creates an ObjectID using a 12-byte (24-char) hexadecimal string.
     pub fn with_string(s: &str) -> Result<ObjectId> {
-        let bytes = try!(hex::decode(s.to_uppercase().as_bytes()));
+        let bytes: Vec<u8> = try!(FromHex::from_hex(s.as_bytes()));
         if bytes.len() != 12 {
             Err(Error::ArgumentError("Provided string must be a 12-byte hexadecimal string."
                 .to_owned()))
@@ -183,7 +184,7 @@ impl ObjectId {
 
     /// Convert the objectId to hex representation.
     pub fn to_hex(&self) -> String {
-        hex::encode(&self.id)
+        self.id.to_hex()
     }
 
     // Generates a new timestamp representing the current seconds since epoch.
@@ -321,12 +322,12 @@ fn count_generated_is_big_endian() {
 fn test_display() {
     let id = ObjectId::with_string("53e37d08776f724e42000000").unwrap();
 
-    assert_eq!(format!("{}", id), "53E37D08776F724E42000000")
+    assert_eq!(format!("{}", id), "53e37d08776f724e42000000")
 }
 
 #[test]
 fn test_debug() {
     let id = ObjectId::with_string("53e37d08776f724e42000000").unwrap();
 
-    assert_eq!(format!("{:?}", id), "ObjectId(53E37D08776F724E42000000)")
+    assert_eq!(format!("{:?}", id), "ObjectId(53e37d08776f724e42000000)")
 }

tests/lib.rs

@@ -1,20 +1,20 @@
 #[macro_use(bson, doc)]
 extern crate bson;
 extern crate chrono;
-extern crate data_encoding;
+extern crate hex;
 
 mod modules;
 
 use bson::Bson;
 use bson::spec::BinarySubtype;
 use bson::oid::ObjectId;
 use chrono::offset::utc::UTC;
-use data_encoding::hex;
+use hex::ToHex;
 
 #[test]
 fn test_format() {
     let id_string = "thisismyname";
-    let string_bytes : Vec<_> = id_string.bytes().collect();
+    let string_bytes: Vec<_> = id_string.bytes().collect();
     let mut bytes = [0; 12];
 
     for i in 0..12 {
@@ -45,7 +45,14 @@ fn test_format() {
         "date" => (Bson::UtcDatetime(date))
     };
 
-    let expected = format!("{{ float: 2.4, string: \"hello\", array: [\"testing\", 1], doc: {{ fish: \"in\", a: \"barrel\", !: 1 }}, bool: true, null: null, regexp: /s[ao]d/i, code: function(x) {{ return x._id; }}, i32: 12, i64: -55, timestamp: Timestamp(0, 229999444), binary: BinData(5, 0x{}), _id: ObjectId(\"{}\"), date: Date(\"{}\") }}", hex::encode("thingies".as_bytes()), hex::encode(id_string.as_bytes()), date);
+    let expected = format!("{{ float: 2.4, string: \"hello\", array: [\"testing\", 1], doc: {{ \
+                            fish: \"in\", a: \"barrel\", !: 1 }}, bool: true, null: null, \
+                            regexp: /s[ao]d/i, code: function(x) {{ return x._id; }}, i32: 12, \
+                            i64: -55, timestamp: Timestamp(0, 229999444), binary: BinData(5, \
+                            0x{}), _id: ObjectId(\"{}\"), date: Date(\"{}\") }}",
+                           "thingies".to_hex(),
+                           id_string.to_hex(),
+                           date);
 
     assert_eq!(expected, format!("{}", doc));
 }

tests/modules/oid.rs

@@ -1,22 +1,12 @@
 use bson::oid::ObjectId;
-use data_encoding::hex;
+use hex::ToHex;
 
 #[test]
 fn deserialize() {
-    let bytes: [u8; 12] = [
-        0xDEu8,
-        0xADu8,
-        0xBEu8,
-        0xEFu8,  // timestamp is 3735928559
-        0xEFu8,
-        0xCDu8,
-        0xABu8,  // machine_id is 11259375
-        0xFAu8,
-        0x29u8,  // process_id is 10746
-        0x11u8,
-        0x22u8,
-        0x33u8,  // increment is 1122867
-        ];
+    let bytes: [u8; 12] = [0xDEu8, 0xADu8, 0xBEu8, 0xEFu8 /* timestamp is 3735928559 */,
+                           0xEFu8, 0xCDu8, 0xABu8 /* machine_id is 11259375 */, 0xFAu8,
+                           0x29u8 /* process_id is 10746 */, 0x11u8, 0x22u8,
+                           0x33u8 /* increment is 1122867 */];
 
     let oid = ObjectId::with_bytes(bytes);
     assert_eq!(3735928559 as u32, oid.timestamp());
@@ -48,7 +38,7 @@ fn string_oid() {
     let s = "123456789012123456789012";
     let oid_res = ObjectId::with_string(s);
     assert!(oid_res.is_ok());
-    let actual_s = hex::encode(&oid_res.unwrap().bytes());
+    let actual_s = oid_res.unwrap().bytes().to_hex();
     assert_eq!(s.to_owned(), actual_s);
 }
 
@@ -58,12 +48,11 @@ fn byte_string_oid() {
     let oid_res = ObjectId::with_string(s);
     assert!(oid_res.is_ok());
     let oid = oid_res.unwrap();
-    let bytes: [u8; 12] = [0x54u8, 0x1Bu8, 0x1Au8, 0x00u8,
-                           0xE8u8, 0xA2u8, 0x3Au8, 0xFAu8,
-                           0x83u8, 0x2Bu8, 0x21u8, 0x8Eu8];
+    let bytes: [u8; 12] = [0x54u8, 0x1Bu8, 0x1Au8, 0x00u8, 0xE8u8, 0xA2u8, 0x3Au8, 0xFAu8, 0x83u8,
+                           0x2Bu8, 0x21u8, 0x8Eu8];
 
     assert_eq!(bytes, oid.bytes());
-    assert_eq!(s.to_uppercase(), oid.to_string());
+    assert_eq!(s, oid.to_string());
 }
 
 #[test]