Merge pull request #76 from katmsft/cors

0.14.0 Pull request.

Author: vinjiang

.gitignore

@@ -8,6 +8,7 @@ test-file-*
 /vendor/*
 /output/*
 /build/*
+/doc/*
 
 
 

BreakingChanges.md

@@ -1,3 +1,16 @@
+Tracking Breaking changes in 0.14.0
+
+* Restructured the classes based on their intended functionality and visiblity. The changes includes:
+  - `MicrosoftAzure\Storage\Common\Internal\InvalidArgumentTypeException` was moved to `MicrosoftAzure\Storage\Common\Exceptions\InvalidArgumentTypeException`
+  - `MicrosoftAzure\Storage\Common\ServiceException` was moved to `MicrosoftAzure\Storage\Exceptions\ServiceException`
+  - `MicrosoftAzure\Storage\Common\Internal\HttpFormatter` was moved to `MicrosoftAzure\Storage\Common\Internal\Http\HttpFormatter`
+  - `MicrosoftAzure\Storage\Common\ServiceOptionsBase` was moved to `MicrosoftAzure\Storage\Common\Internal\ServiceOptionsBase`
+  - `MicrosoftAzure\Storage\Common\Internal\Logger` was moved to `MicrosoftAzure\Storage\Common\Logger`
+  - `MicrosoftAzure\Storage\Common\Internal\Middlewares\HistoryMiddleware` was moved to `MicrosoftAzure\Storage\Common\Middlewares\HistoryMiddleware`
+  - `MicrosoftAzure\Storage\Common\Internal\IMiddleware` was moved to `MicrosoftAzure\Storage\Common\Middlewares\IMiddleware`
+  - `MicrosoftAzure\Storage\Common\Internal\Middlewares\MiddlewareBase` was moved to `MicrosoftAzure\Storage\Common\Middlewares\MiddlewareBase`
+  - `MicrosoftAzure\Storage\Common\Internal\RetryMiddlewareFactory` was moved to `MicrosoftAzure\Storage\Common\Middlewares\RetryMiddlewareFactory`
+
 Tracking Breaking changes in 0.13.0
 
 * Modified the setters of most classes that represent API call result from `public` to `protected` to avoid unwanted corruption of SDK constructed data. If the user is using the setters prior to the release there could be a breaking change.

ChangeLog.md

@@ -1,3 +1,34 @@
+2017.04 - version 0.14.0
+
+ALL
+* Improved the documentation.
+* Restructured the classes based on their intended functionality and visiblity. The changes includes:
+  - `MicrosoftAzure\Storage\Common\Internal\InvalidArgumentTypeException` was moved to `MicrosoftAzure\Storage\Common\Exceptions\InvalidArgumentTypeException`
+  - `MicrosoftAzure\Storage\Common\ServiceException` was moved to `MicrosoftAzure\Storage\Exceptions\ServiceException`
+  - `MicrosoftAzure\Storage\Common\Internal\HttpFormatter` was moved to `MicrosoftAzure\Storage\Common\Internal\Http\HttpFormatter`
+  - `MicrosoftAzure\Storage\Common\ServiceOptionsBase` was moved to `MicrosoftAzure\Storage\Common\Internal\ServiceOptionsBase`
+  - `MicrosoftAzure\Storage\Common\Internal\Logger` was moved to `MicrosoftAzure\Storage\Common\Logger`
+  - `MicrosoftAzure\Storage\Common\Internal\Middlewares\HistoryMiddleware` was moved to `MicrosoftAzure\Storage\Common\Middlewares\HistoryMiddleware`
+  - `MicrosoftAzure\Storage\Common\Internal\IMiddleware` was moved to `MicrosoftAzure\Storage\Common\Middlewares\IMiddleware`
+  - `MicrosoftAzure\Storage\Common\Internal\Middlewares\MiddlewareBase` was moved to `MicrosoftAzure\Storage\Common\Middlewares\MiddlewareBase`
+  - `MicrosoftAzure\Storage\Common\Internal\RetryMiddlewareFactory` was moved to `MicrosoftAzure\Storage\Common\Middlewares\RetryMiddlewareFactory`
+* Added Cross-Origin Resource Sharing (CORS) support. Now setting service properties can set CORS rules at the same time.
+* Added support for account-level Shared Access Signature generation.
+* Resolved an error reported from some IDEs about the phpcs.xml.
+* Fixed multiple test issues.
+
+Blob
+* Added API `createPageBlobFromContent` to support creating page blob directly from contents which includes local file, stream, etc...
+* Added support for append blob.
+* Added support for Container ACL.
+
+Queue
+* Added support for Queue ACL.
+
+Table
+* Added support for Table ACL.
+* Fixed an issue that user could not set entity type to be double and integer as a value for PHP 7
+
 2017.02 - version 0.13.0
 
 ALL

README.md

@@ -4,7 +4,8 @@ This project provides a set of PHP client libraries that make it easy to access
 
 > **Note**
 > 
-> If you are looking for the Service Bus, Service Runtime, Service Management or Media Services libraries, please visit https://github.com/Azure/azure-sdk-for-php.
+> * If you are looking for the Service Bus, Service Runtime, Service Management or Media Services libraries, please visit https://github.com/Azure/azure-sdk-for-php.
+> * If you need big file or 64-bit integer support, please install PHP 7 64-bit version.
 
 # Features
 

build.xml

@@ -7,7 +7,8 @@
  <property name="phpdox"  value="phpdox.bat"/>
  <property name="phploc"  value="phploc.bat"/>
  <property name="phpmd"   value="phpmd.bat"/>
- <property name="phpunit" value="phpunit.bat"/> -->
+ <property name="phpunit" value="phpunit.bat"/>
+ <property name="phpdoc"  value="phpdoc.bat"/> -->
 
  <!-- Use this when the tools are located as PHARs in ${basedir}/build/tools
  <property name="pdepend" value="${basedir}/build/tools/pdepend.phar"/>
@@ -16,7 +17,8 @@
  <property name="phpdox"  value="${basedir}/build/tools/phpdox.phar"/>
  <property name="phploc"  value="${basedir}/build/tools/phploc.phar"/>
  <property name="phpmd"   value="${basedir}/build/tools/phpmd.phar"/>
- <property name="phpunit" value="${basedir}/build/tools/phpunit.phar"/>  -->
+ <property name="phpunit" value="${basedir}/build/tools/phpunit.phar"/>
+ <property name="phpdoc"  value="${basedir}/build/tools/phpDocumentator.phar"/>  -->
 
  <!-- Use this when the tools are managed by Composer in ${basedir}/vendor/bin -->
  <property name="pdepend" value="${basedir}/vendor/bin/pdepend.bat"/>
@@ -25,7 +27,8 @@
  <property name="phpdox"  value="${basedir}/vendor/bin/phpdox.bat"/>
  <property name="phploc"  value="${basedir}/vendor/bin/phploc.bat"/>
  <property name="phpmd"   value="${basedir}/vendor/bin/phpmd.bat"/>
- <property name="phpunit" value="${basedir}/vendor/bin/phpunit.bat"/> 
+ <property name="phpunit" value="${basedir}/vendor/bin/phpunit.bat"/>
+ <property name="phpdoc"  value="${basedir}/vendor/bin/phpdoc.bat"/>
 
  <target name="full-build"
          depends="prepare,static-analysis,phpunit,phpdox,-check-failure"
@@ -299,4 +302,17 @@
    </condition>
   </fail>
  </target>
+
+ <target name="doc" description="Generate project documentation using phpDocumentator">
+   <exec executable="${phpdoc}" taskname="phpdoc">
+     <arg value="-t" />
+     <arg value=".\doc" />
+     <arg value="-d" />
+     <arg value=".\src" />
+     <arg value="--visibility" />
+     <arg value="public,protected" />
+     <arg value="--template" />
+     <arg value="zend" />
+   </exec>
+ </target>
 </project>

build/phpcs.xml

@@ -33,7 +33,7 @@
 
  <rule ref="Squiz.PHP.Eval.Discouraged"/>
 
- <rule ref="Zend.Files.ClosingTag.NotAllowed">
+ <rule ref="Zend.Files.ClosingTag.NotAllowed/">
 
  <rule ref="PEAR"/>
 

composer.json

@@ -21,7 +21,8 @@
         "squizlabs/php_codesniffer": "2.*",
         "phploc/phploc": "~2.1",
         "phpmd/phpmd": "@stable",
-        "theseer/phpdox": "~0.8" 
+        "theseer/phpdox": "~0.8",
+        "phpdocumentor/phpdocumentor": "dev-master"
     },
     "autoload": {
         "psr-4": {

samples/BlobSamples.php

@@ -28,8 +28,8 @@
 use MicrosoftAzure\Storage\Blob\Models\PublicAccessType;
 use MicrosoftAzure\Storage\Blob\Models\ListContainersResult;
 use MicrosoftAzure\Storage\Common\ServicesBuilder;
-use MicrosoftAzure\Storage\Common\ServiceException;
-use MicrosoftAzure\Storage\Common\Internal\InvalidArgumentTypeException;
+use MicrosoftAzure\Storage\Common\Exceptions\ServiceException;
+use MicrosoftAzure\Storage\Common\Exceptions\InvalidArgumentTypeException;
 
 $connectionString = 'DefaultEndpointsProtocol=https;AccountName=<yourAccount>;AccountKey=<yourKey>';
 $blobClient = ServicesBuilder::getInstance()->createBlobService($connectionString);

samples/QueueSamples.php

@@ -24,7 +24,7 @@
 require_once "../vendor/autoload.php";
 
 use MicrosoftAzure\Storage\Common\ServicesBuilder;
-use MicrosoftAzure\Storage\Common\ServiceException;
+use MicrosoftAzure\Storage\Common\Exceptions\ServiceException;
 use MicrosoftAzure\Storage\Queue\Models\CreateQueueOptions;
 use MicrosoftAzure\Storage\Queue\Models\PeekMessagesOptions;
 

samples/TableSamples.php

@@ -24,7 +24,7 @@
 require_once "../vendor/autoload.php";
 
 use MicrosoftAzure\Storage\Common\ServicesBuilder;
-use MicrosoftAzure\Storage\Common\ServiceException;
+use MicrosoftAzure\Storage\Common\Exceptions\ServiceException;
 use MicrosoftAzure\Storage\Table\Models\BatchOperations;
 use MicrosoftAzure\Storage\Table\Models\Entity;
 use MicrosoftAzure\Storage\Table\Models\EdmType;
@@ -38,7 +38,7 @@
 // To add an entity to a table, create a new Entity object and pass it to TableRestProxy->insertEntity.
 // Note that when you create an entity you must specify a PartitionKey and RowKey. These are the unique
 // identifiers for an entity and are values that can be queried much faster than other entity properties.
-// The system uses PartitionKey to automatically distribute the table¡¯s entities over many storage nodes.
+// The system uses PartitionKey to automatically distribute the table's entities over many storage nodes.
 insertEntitySample($tableClient);
 
 // To add mutiple entities with one call, create a BatchOperations and pass it to TableRestProxy->batch.