updated README

filestack · May 17, 2017 · 191070e · 191070e
1 parent 36ef440
commit 191070e
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@ This is the official PHP SDK for Filestack - API and content management system t
 
 * [Filestack](https://www.filestack.com)
 * [Documentation](https://www.filestack.com/docs)
-* [API Reference](https://filestack.github.io/)
 
 ## Installing
 
@@ -26,17 +25,17 @@ or download from GitHub
 
 ## Usage
 
-Filestack library gives you access to two useful classes:
+Filestack library gives you access to three useful classes:
 
 * `FilestackClient` - for easy file upload (creates Filelink objects)
 * `Filelink` - for file handling (downloading, converting etc.)
+* `FileSecurity` - for applying policy and signature values to your API calls
 
 ### Uploading files
 First, you need to create an instance of FilestackClient
 
 ```php
 use Filestack\FilestackClient;
-use Filestack\Filelink;
 
 $client = new FilestackClient('YOUR_API_KEY');
 ```
@@ -57,7 +56,7 @@ $filelink = $client->upload($filepath);
 
 ### Manipulating files
 
-Filelink objects can be created in three ways:
+Filelink objects can be created in two ways:
 
  - by uploading a file with using FilestackClient
  - by initializing Filelink with file handle and api_key
@@ -71,7 +70,7 @@ $file = new Filelink('pGj2wWfBTMuXhWe2J3bL', 'YOUR_API_KEY');
 $transformed_filelink = $filelink
             ->circle()
             ->blur(['amount' => '20'])
-            ->store();
+            ->save();
 ```
 
 For more examples, see the [examples/](examples/) folder in this project.
@@ -116,7 +115,7 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 
 ## Credits
 
-Thank you to all the [contributors](https://github.com/filepicker/filestack-php/graphs/contributors).
+Thank you to all the [contributors](https://github.com/filestack/filestack-php/graphs/contributors).
 
 ## Other Resources
 

diff --git a/examples/client-no-security.php b/examples/client-no-security.php
@@ -3,7 +3,7 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'AefuF1HdTzGBlwfxk1FYWz';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 # Filestack client examples

diff --git a/examples/client-transformations.php b/examples/client-transformations.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 # Filestack client examples

diff --git a/examples/client-with-security.php b/examples/client-with-security.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 # Filestack client examples

diff --git a/examples/converting-file-formats.php b/examples/converting-file-formats.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 /**

diff --git a/examples/create-collages.php b/examples/create-collages.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 $sources = [

diff --git a/examples/create-screenshots.php b/examples/create-screenshots.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 
 $security = new FilestackSecurity($test_secret);
 $client = new FilestackClient($test_api_key, $security);

diff --git a/examples/filelink-no-security.php b/examples/filelink-no-security.php
@@ -2,8 +2,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'AefuF1HdTzGBlwfxk1FYWz';
-$test_handle = 'AxBBQ4MFRIyDz6rZn2AW';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/testing-download.jpg';
 
 # Filestack client examples

diff --git a/examples/filelink-transformations.php b/examples/filelink-transformations.php
@@ -2,8 +2,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'AefuF1HdTzGBlwfxk1FYWz';
-$test_handle = 'AxBBQ4MFRIyDz6rZn2AW';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/testing-download.jpg';
 
 # Filestack client examples

diff --git a/examples/filelink-with-security.php b/examples/filelink-with-security.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 $test_filepath = __DIR__ . '/../tests/testfiles/calvinandhobbes.jpg';
 
 // upload a file to test

diff --git a/examples/video-audio-transcoding.php b/examples/video-audio-transcoding.php
@@ -4,8 +4,8 @@
 use Filestack\Filelink;
 use Filestack\FilestackException;
 
-$test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
-$test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+$test_api_key = 'YOUR_FILESTACK_API_KEY';
+$test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
 
 $security = new FilestackSecurity($test_secret);
 $client = new FilestackClient($test_api_key, $security);
@@ -182,4 +182,4 @@
     "timestamp":"1456384626",
     "uuid":"57694303a5d29c148154d5f706b4c256"
 }
-*/
+*/
diff --git a/filestack/mixins/TransformationMixin.php b/filestack/mixins/TransformationMixin.php
@@ -92,10 +92,8 @@ public function sendDebug($transform_url, $security=null)
 
         // handle response
         if ($status_code == 200) {
-
             $json_response = json_decode($response->getBody(), true);
             return $json_response;
-
         } else {
             throw new FilestackException($response->getBody(), $status_code);
         }
@@ -167,7 +165,6 @@ public function sendTransform($resource, $transform_tasks, $security=null)
      */
     public function sendVideoConvert($resource, $transform_tasks, $security=null)
     {
-
         $tasks_str = $this->createTransformStr($transform_tasks);
 
         // build url

diff --git a/tests/BaseTest.php b/tests/BaseTest.php
@@ -18,14 +18,14 @@ class BaseTest extends \PHPUnit_Framework_TestCase
 
     public function __construct()
     {
-        $this->test_api_key = 'A5lEN6zU8SemSBWiwcGJhz';
+        $this->test_api_key = 'YOUR_FILESTACK_API_KEY';
         $this->test_file_handle = 'IIkUk9D8TWKHldxmMVRt';
 
-        $this->test_api_key_no_sec = 'AefuF1HdTzGBlwfxk1FYWz';
+        $this->test_api_key_no_sec = 'YOUR_FILESTACK_API_KEY';
         $this->test_file_handle_no_sec = 'AxBBQ4MFRIyDz6rZn2AW';
 
         $this->test_file_url = FilestackConfig::CDN_URL . '/' . $this->test_file_handle;
-        $this->test_secret = '3UAQ64UWMNCCRF36CY2NSRSPSU';
+        $this->test_secret = 'YOUR_FILESTACK_SECURITY_SECRET';
         $this->test_filepath = __DIR__ . '/testfiles/calvinandhobbes.jpg';
         $this->test_security = new FilestackSecurity($this->test_secret);