Merge pull request #3 from byjg/1.0.8

Some Adjustments

Author: byjg

.run/PHPUnit.run.xml

@@ -0,0 +1,6 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="PHPUnit" type="PHPUnitRunConfigurationType" factoryName="PHPUnit">
+    <TestRunner configuration_file="$PROJECT_DIR$/phpunit.xml.dist" scope="XML" use_alternative_configuration_file="true" />
+    <method v="2" />
+  </configuration>
+</component>

.travis.yml

@@ -1,9 +1,10 @@
 language: php
+
+dist: bionic
+
 php:
-  - "7.2"
-  - "7.1"
-  - "7.0"
-  - "5.6"
+  - "7.4"
+  - "7.3"
 
 install:
   - composer install

README.md

@@ -1,5 +1,5 @@
 # PHP SPARQL Lib
-[![Build Status](https://travis-ci.org/byjg/PHP-SPARQL-Lib.svg?branch=master)](https://travis-ci.org/byjg/PHP-SPARQL-Lib)
+[![Build Status](https://travis-ci.com/byjg/PHP-SPARQL-Lib.svg?branch=master)](https://travis-ci.com/byjg/PHP-SPARQL-Lib)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/41d16c0b-fdd6-4c00-8b46-9197b9489659/mini.png)](https://insight.sensiolabs.com/projects/41d16c0b-fdd6-4c00-8b46-9197b9489659)
 
 Copyright 2010,2011,2012 Christopher Gutteridge & University of Southampton
@@ -26,7 +26,19 @@ print "<table class='example_table'>";
 print "<tr>";
 foreach( $fields as $field )
 {
-	print "<th>$field</th>";
+   print "<th>$field</th>";
+}
+```
+
+## Simplified call
+
+```php
+$results = new \SparQL\Connection::get( "http://rdf.ecs.soton.ac.uk/sparql/" )
+            ->withNamespace( "foaf","http://xmlns.com/foaf/0.1/" )
+            ->fetch("SELECT * WHERE { ?person a foaf:Person . ?person foaf:name ?name } LIMIT 5");
+
+foreach ($results as $item) {
+    print "<th>" . $item["person"]
 }
 ```
 

composer.json

@@ -12,7 +12,8 @@
     }
   ],
   "require": {
-    "byjg/webrequest": "1.0.*"
+    "byjg/webrequest": "2.0.*",
+    "ext-curl": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "5.7.*|7.4.*"

src/Connection.php

@@ -2,8 +2,10 @@
 
 namespace SparQL;
 
-use ByJG\Util\CurlException;
-use ByJG\Util\WebRequest;
+use ByJG\Util\Exception\CurlException;
+use ByJG\Util\HttpClient;
+use ByJG\Util\Psr7\Request;
+use ByJG\Util\Uri;
 
 class Connection
 {
@@ -13,6 +15,8 @@ class Connection
     protected $namespace = array();
     protected $params = null;
     protected $endpoint;
+    protected $timeout = null;
+    protected $validateSsl = true;
 
     # capabilities are either true, false or null if not yet tested.
 
@@ -21,11 +25,6 @@ public function __construct($endpoint)
         $this->endpoint = $endpoint;
     }
 
-    public function ns($short, $long)
-    {
-        $this->namespace[$short] = $long;
-    }
-
     /**
      * @param null $params
      * @return null
@@ -46,32 +45,30 @@ public function cgiParams($params = null)
 
     /**
      * @param string $query
-     * @param int|null $timeout
      * @return Result
      * @throws \SparQL\ConnectionException
      * @throws \SparQL\Exception
      */
-    public function query($query, $timeout = null)
+    public function query($query)
     {
         $prefixes = "";
         foreach ($this->namespace as $k => $v) {
             $prefixes .= "PREFIX $k: <$v>\n";
         }
-        $output = $this->dispatchQuery($prefixes . $query, $timeout);
+        $output = $this->dispatchQuery($prefixes . $query);
 
         $parser = new ParseXml($output);
 
         return new Result($parser->rows, $parser->fields);
     }
 
     /**
-     * @param int $timeout
      * @return bool
      */
-    public function alive($timeout = 3000)
+    public function alive()
     {
         try {
-            $this->query("SELECT * WHERE { ?s ?p ?o } LIMIT 1", $timeout);
+            $this->query("SELECT * WHERE { ?s ?p ?o } LIMIT 1");
             return true;
         } catch (\Exception $ex) {
             return false;
@@ -81,12 +78,11 @@ public function alive($timeout = 3000)
     /**
      *
      * @param string $sparql
-     * @param int $timeout Timeout in mileseconds
      * @return string
      * @throws ConnectionException
      * @throws \SparQL\Exception
      */
-    public function dispatchQuery($sparql, $timeout = null)
+    public function dispatchQuery($sparql)
     {
         $url = $this->endpoint . "?query=" . urlencode($sparql);
         if ($this->params !== null) {
@@ -100,25 +96,31 @@ public function dispatchQuery($sparql, $timeout = null)
             ;
         }
 
-        $webRequest = new WebRequest($url);
-        
-        if (!empty($timeout)) {
-            $webRequest->setCurlOption(CURLOPT_TIMEOUT_MS, $timeout);
+        $request = Request::getInstance(Uri::getInstanceFromString($url));
+        $client = HttpClient::getInstance();
+
+        if (!empty($this->timeout)) {
+            $client->withCurlOption(CURLOPT_TIMEOUT_MS, $this->timeout * 1000);
+        }
+
+        if ($this->validateSsl) {
+            $client->withNoSSLVerification();
         }
 
         try {
-            $output = $webRequest->get();
+            $response = $client->sendRequest($request);
+            $output = $response->getBody();
         } catch (CurlException $ex) {
             throw new ConnectionException($ex->getMessage());
         }
 
         if ($output === '') {
             throw new ConnectionException('URL returned no data', -1);
         }
-        if ($webRequest->getLastStatus() != 200) {
+        if ($response->getStatusCode() != 200) {
             throw new Exception(
-                'Bad response, ' . $webRequest->getLastStatus() . ': ' . $output,
-                $webRequest->getLastStatus()
+                'Bad response, ' . $response->getStatusCode() . ': ' . $output,
+                $response->getStatusCode()
             );
         }
 
@@ -127,26 +129,68 @@ public function dispatchQuery($sparql, $timeout = null)
 
     /**
      * @param string $endpoint
-     * @param string $sparql
-     * @param array $namespace
-     * @return Results
-     * @throws \SparQL\ConnectionException
-     * @throws \SparQL\Exception
+     * @return Connection
+     */
+    public static function get($endpoint)
+    {
+        return new Connection($endpoint);
+
+    }
+
+    /**
+     * @param $prefix
+     * @param $uri
+     * @return $this
      */
-    public static function get($endpoint, $sparql, $namespace = null)
+    public function withNamespace($prefix, $uri = "")
     {
-        $connection = new Connection($endpoint);
-        foreach ((array) $namespace as $key => $value) {
-            $connection->ns($key, $value);
+        if (is_array($prefix)) {
+            foreach ($prefix as $key => $value) {
+                return $this->withNamespace($key, $value);
+            }
+        } else {
+            $this->namespace[$prefix] = $uri;
+        }
+        return $this;
+    }
+
+    /**
+     * @param $timeout
+     * @return Connection
+     */
+    public function withTimeout($timeout)
+    {
+        $this->timeout = $timeout;
+        return $this;
+    }
+
+    public function withNoSSLVerification()
+    {
+        $this->validateSsl = false;
+        return $this;
+    }
+
+    /**
+     * @param $sparql
+     * @param array $params
+     * @return Results|null
+     * @throws ConnectionException
+     * @throws Exception
+     */
+    public function fetch($sparql, $params = [])
+    {
+        foreach ($params as $key => $value) {
+            $sparql = str_replace(":$key", "'$value'", $sparql);
         }
 
-        $result = $connection->query($sparql);
+        $result = $this->query($sparql);
         if (!$result) {
             return null;
         }
 
         return $result->fetchAll();
     }
+
     ####################################
     # Endpoint Capability Testing
     ####################################

tests/SparQL/ConnectionTest.php

@@ -7,11 +7,11 @@
 class ConnectionTest extends TestCase
 {
 
-    const SPARQL_URL = 'http://dbpedia.org/sparql';
+    const SPARQL_URL = 'https://dbpedia.org/sparql';
 
     protected static $SPARQL_NS = [
         'dbpedia-owl' => 'http://dbpedia.org/ontology/',
-        'dbpprop' => 'http://dbpedia.org/property/'
+        'dbpprop' => 'http://dbpedia.org/property/',
     ];
 
     /**
@@ -32,12 +32,16 @@ protected function tearDown()
 
     }
 
+    /**
+     * @throws ConnectionException
+     * @throws Exception
+     */
     public function testQueryOk()
     {
-        $connection = new Connection(self::SPARQL_URL);
-        foreach (self::$SPARQL_NS as $key => $value) {
-            $connection->ns($key, $value);
-        }
+        $connection = Connection::get(self::SPARQL_URL)
+            ->withNoSSLVerification()
+            ->withTimeout(10)
+            ->withNamespace(self::$SPARQL_NS);
 
         $result = $connection->query("select distinct ?Concept where {[] a ?Concept} LIMIT 5");
 
@@ -50,11 +54,12 @@ public function testQueryOk()
      */
     public function testGetOk()
     {
-        $result = Connection::get(
-            self::SPARQL_URL,
-            "select distinct ?Concept where {[] a ?Concept} LIMIT 5",
-            self::$SPARQL_NS
-        );
+        $result = Connection::get(self::SPARQL_URL)
+            ->withNamespace(self::$SPARQL_NS)
+            ->withNoSSLVerification()
+            ->withTimeout(10)
+            ->fetch("select distinct ?Concept where {[] a ?Concept} LIMIT 5");
+
         $this->assertEquals(5, count($result));
     }
 
@@ -63,46 +68,57 @@ public function testGetOk()
      */
     public function testWrongSparQLDataset()
     {
-        Connection::get(
-            "http://invaliddomain:9812/",
-            "select distinct ?Concept where {[] a ?Concept} LIMIT 5",
-            self::$SPARQL_NS
-        );
+        Connection::get("http://invaliddomain:9812/")
+            ->withNamespace(self::$SPARQL_NS)
+            ->withNoSSLVerification()
+            ->withTimeout(10)
+            ->fetch("select distinct ?Concept where {[] a ?Concept} LIMIT 5");
     }
 
     /**
      * @expectedException \SparQL\Exception
+     * @throws ConnectionException
      */
     function test_wrongSparQLDataset2()
     {
-        Connection::get(self::SPARQL_URL, "?Concept  {[] a ?Concept} LIMIT 5");  // Without NS
+        Connection::get(self::SPARQL_URL)
+            ->withNoSSLVerification()
+            ->withTimeout(10)
+            ->fetch( "?Concept  {[] a ?Concept} LIMIT 5");  // Without NS
     }
 
     function test_navigateSparQLDataset()
     {
-        $result = Connection::get(
-            self::SPARQL_URL,
-            'SELECT  ?name ?meaning
-                WHERE 
+        $result = Connection::get(self::SPARQL_URL)
+            ->withNamespace(self::$SPARQL_NS)
+            ->withNoSSLVerification()
+            ->withTimeout(10)
+            ->fetch(
+        'SELECT *
+                WHERE
                 {
-                    ?s a  dbpedia-owl:Name;
-                    dbpprop:name  ?name;
-                    dbpprop:meaning  ?meaning 
-                    . FILTER (str(?name) = "Garrick")
+                  ?athlete  rdfs:label      "Cristiano Ronaldo"@en ;
+                            dbo:birthPlace  ?place .
+                  ?place    a               dbo:City ;
+                            rdfs:label      ?cityName .
+                  FILTER ( LANG ( ?cityName ) = :lang )
                 }',
-            self::$SPARQL_NS
-        );
+                [
+                    "lang" => "en"
+                ]
+            );
 
-        $this->assertEquals(1, count($result));
+        $this->assertEquals(count($result), 1);
 
-
-
-        $this->assertEquals($result[0]["name"], "Garrick");
-        $this->assertEquals($result[0]["name.type"], "literal");
-        $this->assertEquals($result[0]["meaning"], "\"spear king\"");
-        $this->assertEquals($result[0]["meaning.type"], "literal");
+        $this->assertEquals("http://dbpedia.org/resource/Cristiano_Ronaldo", $result[0]["athlete"]);
+        $this->assertEquals("uri", $result[0]["athlete.type"]);
+        $this->assertEquals("http://dbpedia.org/resource/Funchal", $result[0]["place"]);
+        $this->assertEquals("uri", $result[0]["place.type"]);
     }
 
+    /**
+     * @throws Exception
+     */
     function testSupports()
     {
         $connection = new Connection(self::SPARQL_URL);