Reimplement OAuth2 library - Step 1

Src/GoogleApis/Apis/Requests/Parameters/ParameterUtils.cs

 /*
 Copyright 2013 Google Inc
 
 Licensed 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 System.Collections.Generic;
 using System.Net.Http;
 using System.Linq;
 using System.Reflection;
 
 using Google.Apis.Util;
 
 namespace Google.Apis.Requests.Parameters
 {
+/// <summary>
+/// Utility class for iterating on <seealso cref="RequestParameterAttribute"
/> properties in a request object.
+/// </summary>
 public static class ParameterUtils

[peleyal, 2013/09/10 01:14:44]

add comment

[peleyal, 2013/09/10 12:32:22]

Done.

 {
 /// <summary>
 /// Creates a <seealso cref="System.Net.Http.FormUrlEncodedContent"/> wi
th all the specified parameters in·
- /// input request. It uses reflection to look at all properties marked w
 ith 

[peleyal, 2013/09/10 01:14:44]

to get all properties with the ... attribute

[peleyal, 2013/09/10 12:32:22]

Done.

- /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/>.
+ /// input request. It uses reflection to iterate over all properties wit
 h
+ /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
 te.
 /// </summary>
+/// <param name="request">
+/// A request object which contains properties with·
+/// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
te. Those properties will be serialized
+/// to the returned <seealso cref="System.Net.Http.FormUrlEncodedContent
"/>.
+/// </param>
+/// <returns>
+/// A <seealso cref="System.Net.Http.FormUrlEncodedContent"/> which cont
ains the all the given object required·
+/// values
+/// </returns>
 public static FormUrlEncodedContent CreateFormUrlEncodedContent(object r
equest)
 {
 IList<KeyValuePair<string, string>> list = new List<KeyValuePair<str
ing, string>>();
 IterateParameters(request, (type, name, value) =>
 {
 list.Add(new KeyValuePair<string, string>(name, value.ToStri
ng()));
 });
 return new FormUrlEncodedContent(list);
 }
 
 /// <summary>
- /// Creates a parameter dictionary by using reflection to look at all pr
 operties marked with 

[peleyal, 2013/09/10 01:14:44]

look --> get all

[peleyal, 2013/09/10 12:32:22]

Done.

- /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/>.
+ /// Creates a parameter dictionary by using reflection to iterate over a
 ll properties with
+ /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
 te.
 /// </summary>
+/// <param name="request">
+/// A request object which contains properties with·
+/// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
te. Those properties will be set
+/// in the output dictionary
+/// </param>
 public static IDictionary<string, object> CreateParameterDictionary(obje
ct request)
 {
 var dict = new Dictionary<string, object>();
 IterateParameters(request, (type, name, value) =>
 {
 dict.Add(name, value);
 });
 return dict;
 }
 
 /// <summary>
- /// Creates a parameter dictionary by using reflection to look at all pr
 operties marked with

[peleyal, 2013/09/10 01:14:44]

ditto

[peleyal, 2013/09/10 12:32:22]

Done.

- /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/>.
+ /// Sets query parameters in the given builder with all all properties w
 ith the
+ /// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
 te.
 /// </summary>
+/// <param name="builder">The request builder</param>
+/// <param name="request">
+/// A request object which contains properties with·
+/// <seealso cref="Google.Apis.Util.RequestParameterAttribute"/> attribu
te. Those properties will be set in the·
+/// given request builder object
+/// </param>
 public static void InitParameters(RequestBuilder builder, object request
)
 {
 IterateParameters(request, (type, name, value) =>
 {
 builder.AddParameter(type, name, value.ToString());
 });
 }
 
+/// <summary>
+/// Iterates over all <seealso cref="RequestParameterAttribute"/> proper
ties in the request object and invokes
+/// the specified action for each of them.
+/// </summary>
+/// <param name="request">A request object</param>
+/// <param name="action">An action to invoke which gets the parameter ty
pe, name and its value</param>
 private static void IterateParameters(object request, Action<RequestPara
meterType, string, object> action)

[peleyal, 2013/09/10 01:14:44]

add comment

[peleyal, 2013/09/10 12:32:22]

Done.

 {
- // use reflection to build the parameter dictionary.
+ // Use reflection to build the parameter dictionary.
 foreach (PropertyInfo property in request.GetType().GetProperties(Bi
ndingFlags.Instance |
 BindingFlags.Public))
 {
- // retrieve the RequestParameterAttribute
+ // Retrieve the RequestParameterAttribute.
 RequestParameterAttribute attribute =
 property.GetCustomAttributes(typeof(RequestParameterAttribut
e), false).FirstOrDefault() as
 RequestParameterAttribute;
 if (attribute == null)
 {
 continue;
 }
 
- // get the name of this parameter from the attribute, if it does
 n't exist take a lower-case variant of·
- // property name
+ // Get the name of this parameter from the attribute, if it does
 n't exist take a lower-case variant of·
+ // property name.
 string name = attribute.Name ?? property.Name.ToLower();
 
 var propertyType = property.PropertyType;
 var value = property.GetValue(request, null);
 
- // call action with the type name and value
+ // Call action with the type name and value.
 if (propertyType.IsValueType || value != null)
 {
 action(attribute.Type, name, value);
 }
 }
 }
 }
 }