Cleanup solution + update docs

Author: JimBobSquarePants

README.md

@@ -58,6 +58,15 @@ Update `~/Config/FileSystemProviders.config` replacing the default provider with
         Defaults to 365 days.
       -->
       <add key="maxDays" value="365" />
+      <!--
+        When true this allows the VirtualPathProvider to use the default "media" route prefix regardless 
+        of the container name.
+      -->
+      <add key="useDefaultRoute" value="true" />
+      <!--
+        When true blob containers will be private instead of public what means that you can't access the original blob file directly from its blob url.
+      -->
+      <add key="usePrivateContainer" value="false" />
     </Parameters>
   </Provider>
 </FileSystemProviders>
@@ -124,6 +133,7 @@ In `Web.config` create the new application keys and post fix each key with the `
 <add key="AzureBlobFileSystem.RootUrl:media" value="http://[myAccountName].blob.core.windows.net/" />
 <add key="AzureBlobFileSystem.MaxDays:media" value="365" />
 <add key="AzureBlobFileSystem.UseDefaultRoute:media" value="true" />
+<add key="AzureBlobFileSystem.UsePrivateContainer" value="false" />
 ```
 
 ## Virtual Path Provider
@@ -164,7 +174,8 @@ For **Umbraco v7.5+ you must add the the StaticFileHandler** to the new Web.conf
 
 ## Combining with ImageProcessor
 
-As of ImageProcessor.Web version [4.3.2](https://www.nuget.org/packages/ImageProcessor.Web/4.3.2) a new [`IImageService`](http://imageprocessor.org/imageprocessor-web/extending/#iimageservice) implementation has been available called `CloudImageService`. To enable that service and pull images directly from the cloud simply install the [configuration package](https://www.nuget.org/packages/ImageProcessor.Web.Config/) and replace the `CloudImageService`setting with the following:
+As of ImageProcessor.Web version [4.3.2](https://www.nuget.org/packages/ImageProcessor.Web/4.3.2) a new [`IImageService`](http://imageprocessor.org/imageprocessor-web/extending/#iimageservice) implementation has been available called `CloudImageService`. To enable that service and pull images directly from 
+the cloud simply install the [configuration package](https://www.nuget.org/packages/ImageProcessor.Web.Config/) and replace the `CloudImageService`setting with the following:
 
 ```xml
 <?xml version="1.0"?>
@@ -181,6 +192,8 @@ As of ImageProcessor.Web version [4.3.2](https://www.nuget.org/packages/ImagePro
   </services>  
 </security>
 ```
+**Note** The `CloudImageService`is not compatible with the FileSystemProvider when using private storage. You will have to build your own `IImageService` implementation.
+
 If using a version of ImageProcessor.Web version [4.5.0](https://www.nuget.org/packages/ImageProcessor.Web/4.5.0) the configuration details will need to be configured as follows:
 
 ```xml

src/UmbracoFileSystemProviders.Azure.Installer/Models/Parameter.cs

@@ -13,13 +13,13 @@ namespace Our.Umbraco.FileSystemProviders.Azure.Installer.Models
     public class Parameter
     {
         /// <summary>
-        /// The key.
+        /// Gets or sets the key.
         /// </summary>
         [JsonProperty("key")]
         public string Key { get; set; }
 
         /// <summary>
-        /// The value.
+        /// Gets or sets the value.
         /// </summary>
         [JsonProperty("value")]
         public string Value { get; set; }

src/UmbracoFileSystemProviders.Azure.Installer/PackageActions.cs

@@ -67,7 +67,7 @@ private bool Transform(string packageName, XmlNode xmlData, bool uninstall = fal
 
                     string sourceDocFileName = VirtualPathUtility.ToAbsolute(file);
 
-                    // The xdt file used for tranformation 
+                    // The xdt file used for tranformation
                     string fileEnd = "install.xdt";
                     if (uninstall)
                     {

src/UmbracoFileSystemProviders.Azure.Installer/Properties/AssemblyInfo.cs

@@ -1,8 +1,13 @@
-using System.Reflection;
+// <copyright file="AssemblyInfo.cs" company="James Jackson-South, Jeavon Leopold, and contributors">
+// Copyright (c) James Jackson-South, Jeavon Leopold, and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
+// </copyright>
+
+using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
-// General Information about an assembly is controlled through the following 
+// General Information about an assembly is controlled through the following
 // set of attributes. Change these attribute values to modify the information
 // associated with an assembly.
 [assembly: AssemblyTitle("UmbracoFileSystemProviders.Azure.Installer")]
@@ -14,8 +19,8 @@
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
-// Setting ComVisible to false makes the types in this assembly not visible 
-// to COM components.  If you need to access a type in this assembly from 
+// Setting ComVisible to false makes the types in this assembly not visible
+// to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
 

src/UmbracoFileSystemProviders.Azure.Installer/Properties/VersionInfo.cs

@@ -1,5 +1,5 @@
-// <copyright file="VersionInfo.cs" company="James Jackson-South">
-// Copyright (c) James Jackson-South. All rights reserved.
+// <copyright file="VersionInfo.cs" company="James Jackson-South, Jeavon Leopold, and contributors">
+// Copyright (c) James Jackson-South, Jeavon Leopold, and contributors. All rights reserved.
 // Licensed under the Apache License, Version 2.0.
 // </copyright>
 
@@ -8,11 +8,11 @@
 // Version information for an assembly consists of the following four values:
 //
 //      Major Version
-//      Minor Version 
+//      Minor Version
 //      Build Number
 //      Revision
 //
-// You can specify all the values or you can default the Build and Revision Numbers 
+// You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("0.5.0.10")]
 [assembly: AssemblyVersion("0.5.0.0")]

src/UmbracoFileSystemProviders.Azure.Tests/AzureBlobFileSystemAbsoluteTests.cs

@@ -1,12 +1,7 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="AzureBlobFileSystemAbsoluteTests.cs" company="James Jackson-South">
-//   Copyright (c) James Jackson-South and contributors.
-//   Licensed under the Apache License, Version 2.0.
+// <copyright file="AzureBlobFileSystemAbsoluteTests.cs" company="James Jackson-South and contributors">
+// Copyright (c) James Jackson-South and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// <summary>
-//   The <see cref="AzureBlobFileSystem" /> absolute tests.
-// </summary>
-// --------------------------------------------------------------------------------------------------------------------
 
 namespace Our.Umbraco.FileSystemProviders.Azure.Tests
 {

src/UmbracoFileSystemProviders.Azure.Tests/AzureBlobFileSystemRelativeTests.cs

@@ -1,12 +1,7 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="AzureBlobFileSystemRelativeTests.cs" company="James Jackson-South">
-//   Copyright (c) James Jackson-South and contributors.
-//   Licensed under the Apache License, Version 2.0.
+// <copyright file="AzureBlobFileSystemRelativeTests.cs" company="James Jackson-South and contributors">
+// Copyright (c) James Jackson-South and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// <summary>
-//   The <see cref="AzureBlobFileSystem" /> relative tests.
-// </summary>
-// --------------------------------------------------------------------------------------------------------------------
 
 namespace Our.Umbraco.FileSystemProviders.Azure.Tests
 {

src/UmbracoFileSystemProviders.Azure.Tests/AzureBlobFileSystemTestsBase.cs

@@ -1,14 +1,7 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="AzureBlobFileSystemTestsBase.cs" company="James Jackson-South">
-//   Copyright (c) James Jackson-South and contributors.
-//   Licensed under the Apache License, Version 2.0.
+// <copyright file="AzureBlobFileSystemTestsBase.cs" company="James Jackson-South and contributors">
+// Copyright (c) James Jackson-South and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// <summary>
-//   The <see cref="AzureBlobFileSystem" /> tests base.
-// </summary>
-// --------------------------------------------------------------------------------------------------------------------
-
-using System.Threading;
 
 namespace Our.Umbraco.FileSystemProviders.Azure.Tests
 {
@@ -17,9 +10,8 @@ namespace Our.Umbraco.FileSystemProviders.Azure.Tests
     using System.IO;
     using System.Linq;
     using System.Text;
-
+    using System.Threading;
     using Moq;
-
     using NUnit.Framework;
 
     /// <summary>
@@ -142,7 +134,7 @@ public void TestFileExists()
         }
 
         /// <summary>
-        /// Asserts that the file system correctly determines whether a file exists 
+        /// Asserts that the file system correctly determines whether a file exists
         /// when the input has been prefixed.
         /// </summary>
         [Test]
@@ -319,7 +311,7 @@ public void TestGetDirectoriesPrefixed()
             string[] expected = { "1010", "1011", "1012" };
             Assert.IsTrue(expected.SequenceEqual(actual));
         }
-        
+
         /// <summary>
         /// Asserts that the file system correctly returns a sequence of files from the root
         /// container in the correct format.
@@ -365,7 +357,7 @@ public void TestGetFilesFromRootFiltered()
         }
 
         /// <summary>
-        /// Asserts that the file system correctly returns a sequence of files from a 
+        /// Asserts that the file system correctly returns a sequence of files from a
         /// subfolder in the correct format.
         /// </summary>
         [Test]
@@ -456,6 +448,9 @@ public void TestDeleteDirectory()
             Assert.IsFalse(provider.FileExists("1010/media.jpg"));
         }
 
+        /// <summary>
+        /// Asserts that the file system correctly creates a directory.
+        /// </summary>
         [Test]
         public void TestValidDirectory()
         {
@@ -467,6 +462,9 @@ public void TestValidDirectory()
             provider.DeleteDirectory("testvalid");
         }
 
+        /// <summary>
+        /// Asserts that the file system does not automatically create a directory.
+        /// </summary>
         [Test]
         public void TestInvalidDirectory()
         {
@@ -498,6 +496,9 @@ public void TestDeleteDirectoryPrefixed()
             Assert.IsFalse(provider.FileExists("media/1010/media.jpg"));
         }
 
+        /// <summary>
+        /// Asserts that the file system correctly deletes a relative directory and file.
+        /// </summary>
         [Test]
         public void TestDeleteDirectoryRelative()
         {

src/UmbracoFileSystemProviders.Azure.Tests/FileSystemVirtualPathProviderTests.cs

@@ -1,27 +1,18 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="FileSystemVirtualPathProviderTests.cs" company="James Jackson-South">
-//   Copyright (c) James Jackson-South and contributors.
-//   Licensed under the Apache License, Version 2.0.
+// <copyright file="FileSystemVirtualPathProviderTests.cs" company="James Jackson-South and contributors">
+// Copyright (c) James Jackson-South and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// <summary>
-//   The <see cref="FileSystemVirtualPathProvider" /> tests.
-// </summary>
-// --------------------------------------------------------------------------------------------------------------------
 
 namespace Our.Umbraco.FileSystemProviders.Azure.Tests
 {
     using System;
     using System.IO;
     using System.Web.Hosting;
-
+    using Azure;
+    using global::Umbraco.Core.IO;
     using Moq;
-
     using NUnit.Framework;
 
-    using Our.Umbraco.FileSystemProviders.Azure;
-
-    using global::Umbraco.Core.IO;
-
     /// <summary>
     /// The <see cref="FileSystemVirtualPathProvider"/> tests.
     /// </summary>

src/UmbracoFileSystemProviders.Azure.Tests/InstallerTests.cs

@@ -1,45 +1,60 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="InstallerTests.cs" company="James Jackson-South">
-//   Copyright (c) James Jackson-South and contributors.
-//   Licensed under the Apache License, Version 2.0.
+// <copyright file="InstallerTests.cs" company="James Jackson-South and contributors">
+// Copyright (c) James Jackson-South and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// --------------------------------------------------------------------------------------------------------------------
+
 namespace Our.Umbraco.FileSystemProviders.Azure.Tests
 {
+    using System.Collections.Generic;
     using System.Linq;
-    using NUnit.Framework;
-
+    using Azure.Installer.Models;
     using Installer;
+    using NUnit.Framework;
 
+    /// <summary>
+    /// Tests the Umbraco installer
+    /// </summary>
     [TestFixture]
     public class InstallerTests
     {
+        /// <summary>
+        /// Asserts that the first parameter is correct.
+        /// </summary>
         [Test]
         public void CheckXdtFirstParameterKey()
         {
-            var parameters = InstallerController.GetParametersFromXml("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt");
+            IEnumerable<Parameter> parameters = InstallerController.GetParametersFromXml("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt");
             Assert.AreEqual("containerName", parameters.First().Key);
         }
 
+        /// <summary>
+        /// Asserts that the parameter count is correct.
+        /// </summary>
         [Test]
         public void CheckXdtNumberOfParameters()
         {
-            var parameters = InstallerController.GetParametersFromXml("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt");
+            IEnumerable<Parameter> parameters = InstallerController.GetParametersFromXml("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt");
             Assert.AreEqual(6, parameters.Count());
         }
 
+        /// <summary>
+        /// Asserts that the "rootUrl" parameter is correct on upgrade.
+        /// </summary>
         [Test]
         public void CheckUpgradeRootUrlParameter()
         {
-            var parameters = InstallerController.GetParametersFromXdt("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt", "FileSystemProviders.upgrade.config");
+            IEnumerable<Parameter> parameters = InstallerController.GetParametersFromXdt("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt", "FileSystemProviders.upgrade.config");
             Assert.AreEqual("http://existing123456789.blob.core.windows.net/", parameters.Single(k => k.Key == "rootUrl").Value);
         }
 
+        /// <summary>
+        /// Asserts that the "rootUrl" parameter is correct.
+        /// </summary>
         [Test]
         public void CheckNewInstallDefaultConfig()
         {
-            var parameters = InstallerController.GetParametersFromXdt("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt", "FileSystemProviders.default.config");
+            IEnumerable<Parameter> parameters = InstallerController.GetParametersFromXdt("..\\..\\build\\transforms\\FileSystemProviders.config.install.xdt", "FileSystemProviders.default.config");
             Assert.AreEqual("http://[myAccountName].blob.core.windows.net/", parameters.Single(k => k.Key == "rootUrl").Value);
         }
     }
-}
+}