Added methods to test if resource is local or remote; fixed BaseDatapackage->save to not attempt to save remote resources;

Added a test to verify that http resources work as expected.
Made DatapackageTest to use php-generated temporary files rather than hard-coded names
Added a few docblocks

Author: jonrmitchell

src/Datapackages/BaseDatapackage.php

@@ -191,7 +191,9 @@ public function save($zip_filename)
             'datapackage.json' => $base.'datapackage.json',
         ];
         $ri = 0;
-        foreach ($packageCopy->resources() as $resource) {
+        foreach ($packageCopy as $resource) {
+            if ($resource->isRemote()) continue;
+
             $resourceFiles = [];
             $fileNames = $resource->save($base.'resource-'.$ri);
             foreach ($fileNames as $fileName) {
@@ -217,6 +219,11 @@ public function save($zip_filename)
         }
     }
 
+    /**
+     * Make a new Datapackage object that is a copy of the current Datapackage. Bypasses validation.
+     * @return $this
+     * @throws DatapackageValidationFailedException
+     */
     protected function copy()
     {
         return new static($this->descriptor, $this->basePath, true);

src/Resources/BaseResource.php

@@ -75,6 +75,10 @@ public function read($readOptions = null)
         return $rows;
     }
 
+    /**
+     * Loads $this->dataStreams based on $this->path() and $this->data
+     * @return BaseDataStream[]|null
+     */
     public function dataStreams()
     {
         if (is_null($this->dataStreams)) {
@@ -121,6 +125,25 @@ public function path()
         }
     }
 
+    /**
+     * If the resource's $path is local (non-http)
+     * @return bool
+     */
+    public function isLocal()
+    {
+        return !$this->isRemote();
+    }
+
+    /**
+     * If the resource's $path is remote (http)
+     * @return bool
+     */
+    public function isRemote()
+    {
+        $path = $this->path();
+        return Utils::isHttpSource(is_array($path) && count($path) > 0 ? $path[0] : $path);
+    }
+
     public function data()
     {
         return isset($this->descriptor()->data) ? $this->descriptor()->data : null;

tests/DatapackageTest.php

@@ -141,6 +141,37 @@ public function testHttpSource()
         );
     }
 
+    public function testHttpSourceSaveAndLoad()
+    {
+        $package = Mocks\MockFactory::datapackage('mock-http://simple_valid_datapackage_mock_http_data.json');
+
+        $filename = tempnam(sys_get_temp_dir(), 'datapackage-php-tests-').'.zip';
+        //save the datapackage
+        if (is_file($filename)) {
+            unlink($filename);
+        }
+        $package->save($filename);
+
+        //load the new package
+        $package2 = Mocks\MockFactory::datapackage($filename);
+
+        $this->assertDatapackage(
+            (object) [
+                'name' => 'datapackage-name',
+                'resources' => [
+                    (object) [
+                        'name' => 'resource-name',
+                        'path' => ['mock-http://foo.txt', 'mock-http://foo.txt'],
+                    ],
+                ],
+            ],
+            ['resource-name' => ['foo', 'foo']],
+            $package2
+        );
+
+        unlink($filename);
+    }
+
     public function testMultiDataDatapackage()
     {
         $out = [];
@@ -509,8 +540,11 @@ public function testCreateEditDatapackageDescriptor()
 
     public function testSaveAndLoadZip()
     {
+        //generate a csv file
+        $csv_filepath = tempnam(sys_get_temp_dir(),'example-csv');
+
         //create example csv
-        file_put_contents('/tmp/example.csv', "name,email\nJohn Doe,john@example.com");
+        file_put_contents($csv_filepath, "name,email\nJohn Doe,john@example.com");
 
         //create a new datapackage object
         $package = Package::create(['name' => 'csv-example','profile' => 'tabular-data-package']);
@@ -519,25 +553,26 @@ public function testSaveAndLoadZip()
         $package->addResource('example.csv', [
             "profile" => "tabular-data-resource",
             "schema" => ["fields" => [["name" => "name", "type" => "string"],["name" => "email", "type" => "string"]]],
-            "path" => '/tmp/example.csv'
+            "path" => $csv_filepath
         ]);
 
         //save the datapackage
-        if (is_file('datapackage.zip')) {
-            unlink('datapackage.zip');
+        $filename = tempnam(sys_get_temp_dir(), 'datapackage-php-tests-').'.zip';
+        if (is_file($filename)) {
+            unlink($filename);
         }
-        $package->save("datapackage.zip");
+        $package->save($filename);
 
         //delete example csv
-        unlink('/tmp/example.csv');
+        unlink($csv_filepath);
 
         //load the new package
-        $package2 = Package::load('datapackage.zip');
+        $package2 = Package::load($filename);
 
         //assert you get expected content back out
         $this->assertEquals([['name' => 'John Doe', 'email' => 'john@example.com']], $package2->resource('example.csv')->read());
 
-        unlink('datapackage.zip');
+        unlink($filename);
     }
 
     public function testLoadDatapackageZip()

tests/Mocks/MockDefaultResource.php

@@ -41,4 +41,17 @@ protected function validateResource()
     {
         return MockResourceValidator::validate($this->descriptor(), $this->basePath);
     }
+
+
+    /**
+     * @inheritDoc
+     * @return bool
+     */
+    public function isRemote()
+    {
+        $path = $this->path();
+        $path_to_check = is_array($path) && count($path) > 0 ? $path[0] : $path;
+        return strpos($path_to_check, 'mock-http://') === 0 || parent::isRemote();
+    }
+
 }