Merge pull request #136 from bdjankowski/StreetViewAdditions

Enhance street view requests

Author: ericnewton76

src/Google.Maps.Test/StreetView/StreetViewRequestTests.cs

@@ -46,6 +46,21 @@ public void Pitch_argumentoutofrange(short badvalue)
 			});
 		}
 
+		[Test]
+		[TestCase(121)]
+		[TestCase(-1)]
+		[TestCase(0)]
+		public void FieldOfView_argumentoutofrange(short badvalue)
+		{
+			Assert.Throws<ArgumentOutOfRangeException>(() =>
+			{
+				StreetViewRequest sm = new StreetViewRequest()
+				{
+					FieldOfView = badvalue
+				};
+			});
+		}
+
 		[Test]
 		[TestCase(-1)]
 		[TestCase(361)]

src/Google.Maps/Constants.cs

@@ -88,6 +88,12 @@ internal static void CheckPitchRange(short value, string parameterName)
 			if(value < -90 || value > 90) throw new ArgumentOutOfRangeException(PITCH_PARAMETER_RANGE, parameterName);
 		}
 
+		internal static void CheckFieldOfViewRange(short value, string parameterName)
+		{
+			const string FIELD_OF_VIEW_PARAMETER_RANGE = "Field of view value must be greater or equal to 1 and less than or equal to 120.";
+			if (value < 1 || value > 120) throw new ArgumentOutOfRangeException(FIELD_OF_VIEW_PARAMETER_RANGE, parameterName);
+		}
+
 		#endregion
 
 	}

src/Google.Maps/GoogleSigned.cs

@@ -1,8 +1,6 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Security.Cryptography;
+using System.Text;
 
 namespace Google.Maps
 {
@@ -16,6 +14,8 @@ public class GoogleSigned
 	{
 		private byte[] _privateKeyBytes;
 		private string _idString;
+		private string _channelId;
+		private string _referralUrl;
 		private GoogleSignedType _signType = GoogleSignedType.ApiKey;
 
 		/// <summary>
@@ -106,6 +106,9 @@ public static GoogleSigned SigningInstance
 		}
 
 
+		public string ReferralUrl { get { return _referralUrl; } }
+
+
 		/// <summary>
 		/// Assigns the given SigningInstance to all services that can utilize it.  Note that some of the services do not currently use the signature method.
 		/// </summary>
@@ -130,6 +133,13 @@ public string GetSignedUri(Uri uri)
 			if(_signType == GoogleSignedType.Business)
 			{
 				builder.Query = builder.Query.Substring(1) + "&client=" + _idString;
+				
+
+				if (!string.IsNullOrEmpty(_channelId))
+				{
+					builder.Query = builder.Query.Substring(1) + "&channel=" + _channelId;
+				}
+
 			}
 			else
 			{

src/Google.Maps/Internal/MapsHttp.cs

@@ -15,13 +15,12 @@
  * limitations under the License.
  */
 
+using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Net.Http;
 using System.Threading.Tasks;
-using System.IO;
-
-using Newtonsoft.Json;
 
 namespace Google.Maps.Internal
 {
@@ -39,6 +38,11 @@ public MapsHttp(GoogleSigned signingSvc)
 		{
 			this.signingSvc = signingSvc;
 			this.client = new HttpClient();
+
+			if (signingSvc != null && string.IsNullOrEmpty(signingSvc.ReferralUrl) == false)
+			{
+				client.DefaultRequestHeaders.Add("Referer", signingSvc.ReferralUrl);
+			}
 		}
 
 		public async Task<T> GetAsync<T>(Uri uri) where T : class

src/Google.Maps/StreetView/StreetViewBase.cs

@@ -0,0 +1,20 @@
+namespace Google.Maps.StreetView
+{
+	public abstract class StreetViewBase : BaseRequest
+	{
+		/// <summary>
+		/// Defines the center of the map, equidistant from all edges of the
+		/// map. This parameter takes an <see cref="Location" />-derived instance identifying a
+		/// unique location on the face of the earth. Use <see cref="LatLng" /> for a
+		/// {latitude,longitude} pair (e.g. 40.714728,-73.998672) or use <see cref="Location" /> for a
+		/// string address (e.g. "city hall, new york, ny"). Either Location or PanoramaId is required.
+		/// </summary>
+		public Location Location { get; set; }
+
+		/// <summary>
+		/// PanoramaId is a specific panorama ID. These are generally stable.
+		/// Either Location or PanoramaId is required.
+		/// </summary>
+		public string PanoramaId { get; set; }
+	}
+}

src/Google.Maps/StreetView/StreetViewMetadataRequest.cs

@@ -0,0 +1,37 @@
+
+using System;
+
+using Google.Maps.Internal;
+
+namespace Google.Maps.StreetView
+{
+	/// <summary>
+	/// The Google Static Maps API returns metadata about availablility
+	/// in response to a HTTP request via a URL. For each request, you can
+	/// specify the <see cref="StreetViewBase.Location"/> of the map, or <see cref="StreetViewBase.PanoramaId"/>,
+	/// </summary>
+	public class StreetViewMetadataRequest : StreetViewBase
+	{
+		public override Uri ToUri()
+		{
+			QueryStringBuilder qs = new QueryStringBuilder();
+
+			if (this.Location != null)
+			{
+				qs.Append("location", this.Location.GetAsUrlParameter());
+			}
+			else if (string.IsNullOrEmpty(this.PanoramaId) == false)
+			{
+				qs.Append("pano", this.PanoramaId);
+			}
+			else
+			{
+				throw new InvalidOperationException("Either Location or PanoramaId property are required.");
+			}
+
+			var url = "streetview/metadata?" + qs.ToString();
+
+			return new Uri(StreetViewService.HttpsUri, new Uri(url, UriKind.Relative));
+		}
+	}
+}

src/Google.Maps/StreetView/StreetViewMetadataResponse.cs

@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using System;
+
+using Google.Maps.Common;
+
+using Newtonsoft.Json;
+
+
+namespace Google.Maps.StreetView
+{
+	[JsonObject(MemberSerialization.OptIn)]
+	public class StreetViewMetadataResponse : IServiceResponse
+	{
+		/// <summary>
+		/// The response location
+		/// </summary>
+		[JsonProperty("location")]
+		public LatLng Location { get; set; }
+
+		/// <summary>
+		/// The panorama id
+		/// </summary>
+		[JsonProperty("pano_id")]
+		public string PanoId { get; set; }
+
+		/// <inheritdoc />
+		[JsonProperty("status")]
+		public ServiceResponseStatus Status { get; set; }
+
+
+		/// <inheritdoc />
+		[JsonProperty("error_message")]
+		public string ErrorMessage { get; set; }
+
+		/// <summary>
+		/// The copyright info for the image if requested
+		/// </summary>
+		[JsonProperty("copyright")]
+		public string Copywrite { get; set; }
+
+		/// <summary>
+		/// Date photo was taken
+		/// </summary>
+		[JsonProperty("date")]
+		public DateTime Date { get; set; }
+
+	}
+}

src/Google.Maps/StreetView/StreetViewRequest.cs

@@ -31,29 +31,13 @@ namespace Google.Maps.StreetView
 	/// the type of map, and the placement of optional markers at locations on
 	/// the map.
 	/// </summary>
-	public class StreetViewRequest : BaseRequest
+	public class StreetViewRequest : StreetViewBase
 	{
 		public StreetViewRequest()
 		{
 			this.Size = new MapSize(512, 512); //default size is 512x512
 		}
 
-		/// <summary>
-		/// Defines the center of the map, equidistant from all edges of the
-		/// map. This parameter takes an <see cref="Location" />-derived instance identifying a
-		/// unique location on the face of the earth. Use <see cref="LatLng" /> for a
-		/// {latitude,longitude} pair (e.g. 40.714728,-73.998672) or use <see cref="Location" /> for a
-		/// string address (e.g. "city hall, new york, ny"). Either Location or PanoramaId is required.
-		/// </summary>
-		public Location Location { get; set; }
-
-		/// <summary>
-		/// PanoramaId is a specific panorama ID. These are generally stable.
-		/// Either Location or PanoramaId is required.
-		/// </summary>
-		public string PanoramaId { get; set; }
-
-
 		/// <summary>
 		/// Size specifies the output size of the image in pixels.
 		/// For example Size = new MapSize(600,400) returns an image 600 pixels wide, and 400 high.
@@ -124,6 +108,20 @@ public short Pitch
 		}
 		private short _pitch;
 
+		/// <summary>
+		/// Field of view
+		/// </summary>
+		[DefaultValue(90)]
+		public short FieldOfView
+		{
+			get { return _fieldOfView; }
+			set
+			{
+				Constants.CheckFieldOfViewRange(value, "value");
+				_fieldOfView = value;
+			}
+		}
+		private short _fieldOfView;
 
 		/// <summary>
 		/// Builds the request uri parameters

src/Google.Maps/StreetView/StreetViewService.cs

@@ -56,6 +56,13 @@ public async Task<byte[]> GetImageAsync(StreetViewRequest request)
 			return StreamToArray(stream);
 		}
 
+		public StreetViewMetadataResponse GetMetadataResponse(StreetViewMetadataRequest request)
+		{
+			var uri = new Uri(baseUri, request.ToUri());
+
+			return http.Get<StreetViewMetadataResponse>(uri);
+		}
+
 		public Stream GetStream(StreetViewRequest request)
 		{
 			var uri = new Uri(baseUri, request.ToUri());