Merge pull request #211 from jeremykendall/develop

prepare 5.1.0

Author: nyamsprod

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All Notable changes to `PHP Domain Parser` will be documented in this file
 
+## 5.1.0 - 2017-12-18
+
+### Added
+
+- `Pdp\Rules::createFromPath` named constructor to returns a new instance from a path
+- `Pdp\Rules::createFromString` named constructor to returns a new instance from a string
+
+### Fixed
+
+- None
+
+### Deprecated
+
+- None
+
+### Removed
+
+- None
+
 ## 5.0.0 - 2017-12-13
 
 ### Added

README.md

@@ -3,9 +3,11 @@
 **PHP Domain Parser** is a [Public Suffix List](http://publicsuffix.org/) based
 domain parser implemented in PHP.
 
-[![Build Status](https://travis-ci.org/jeremykendall/php-domain-parser.png?branch=master)](https://travis-ci.org/jeremykendall/php-domain-parser)
-[![Total Downloads](https://poser.pugx.org/jeremykendall/php-domain-parser/downloads.png)](https://packagist.org/packages/jeremykendall/php-domain-parser)
-[![Latest Stable Version](https://poser.pugx.org/jeremykendall/php-domain-parser/v/stable.png)](https://packagist.org/packages/jeremykendall/php-domain-parser)
+[![Build Status](https://img.shields.io/travis/jeremykendall/php-domain-parser/master.svg?style=flat-square)](https://travis-ci.org/jeremykendall/php-domain-parser)
+[![Total Downloads](https://img.shields.io/packagist/dt/jeremykendall/php-domain-parser.svg?style=flat-square)](https://packagist.org/packages/jeremykendall/php-domain-parser)
+[![Latest Stable Version](https://img.shields.io/github/release/jeremykendall/php-domain-parser.svg?style=flat-square)](https://github.com/jeremykendall/php-domain-parser/releases)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE)
+
 
 Motivation
 -------
@@ -46,7 +48,6 @@ Documentation
 
 ### Domain name resolution
 
-
 In order to resolve a domain name one we must:
 
 - Convert the Public Suffix List (PSL) into a structure usable in PHP
@@ -80,11 +81,25 @@ final class Rules
     const ICANN_DOMAINS = 'ICANN_DOMAINS';
     const PRIVATE_DOMAINS = 'PRIVATE_DOMAINS';
 
+    public static function createFromPath(string $path, $context = null): self
+    public static function createFromString(string $content): self
     public function __construct(array $rules)
     public function resolve(string $domain = null, string $section = self::ALL_DOMAINS): Domain
 }
 ~~~
 
+Starting with version 5.1.0, the following named constructors arre added to ease `Rules` instantiation.
+
+- `Rules::createFromString` expects a string content which follows [the PSL format](https://publicsuffix.org/list/#list-format);
+
+- `Rules::createFromPath` expects a valid path to a readable PSL. You can optionnally submit a context resource as defined in PHP's `fopen` function;
+
+Both named constructors:
+
+- uses internally a `Pdp\Converter` object to convert the raw content into a suitable array to instantiate a valid `Pdp\Rules`;
+- do not have any cache functionnality;
+
+
 Domain name resolution is done using the `Pdp\Rules::resolve` method which expects at most two parameters:
 
 - `$domain` a domain name as a string
@@ -95,6 +110,7 @@ Domain name resolution is done using the `Pdp\Rules::resolve` method which expec
 
  By default, the `$section` argument is equal to `Rules::ALL_DOMAINS`. If an unsupported section is submitted a `Pdp\Exception` exception will be thrown.
 
+**WARNING: The `Pdp\Rules::resolve` does not validate the submitted host. You are require to use a host validator prior to using this library.**
 
 The `Pdp\Rules::resolve` returns a `Pdp\Domain` object.
 
@@ -133,12 +149,9 @@ If the domain name or some of its part are seriously malformed or unrecognized,
 ~~~php
 <?php
 
-use Pdp\Converter;
 use Pdp\Rules;
 
-$content = file_get_contents('https://raw.githubusercontent.com/publicsuffix/list/master/public_suffix_list.dat');
-$arr_rules = (new Converter())->convert($content);
-$rules = new Rules($arr_rules);
+$rules = Rules::createFromPath('https://raw.githubusercontent.com/publicsuffix/list/master/public_suffix_list.dat');
 
 $domain = $rules->resolve('www.ulb.ac.be'); //using Rules::ALL_DOMAINS
 $domain->getDomain();            //returns 'www.ulb.ac.be'

src/CurlHttpClient.php

@@ -44,6 +44,7 @@ public function __construct(array $options = [])
             CURLOPT_FOLLOWLOCATION => true,
             CURLOPT_RETURNTRANSFER => true,
             CURLOPT_SSL_VERIFYPEER => false,
+            CURLOPT_SSL_VERIFYHOST => false,
             CURLOPT_HTTPGET => true,
         ];
 

src/Rules.php

@@ -30,6 +30,43 @@ final class Rules
      */
     private $rules;
 
+    /**
+     * Returns a new instance from a file path.
+     *
+     * @param string        $path
+     * @param null|resource $context
+     *
+     * @return self
+     */
+    public static function createFromPath(string $path, $context = null): self
+    {
+        $args = [$path, 'r', false];
+        if (null !== $context) {
+            $args[] = $context;
+        }
+
+        if (!($resource = @fopen(...$args))) {
+            throw new Exception(sprintf('`%s`: failed to open stream: No such file or directory', $path));
+        }
+
+        $content = stream_get_contents($resource);
+        fclose($resource);
+
+        return self::createFromString($content);
+    }
+
+    /**
+     * Returns a new instance from a string.
+     *
+     * @param string $content
+     *
+     * @return self
+     */
+    public static function createFromString(string $content): self
+    {
+        return new self((new Converter())->convert($content));
+    }
+
     /**
      * new instance.
      *
@@ -51,7 +88,7 @@ public function __construct(array $rules)
     public function resolve(string $domain = null, string $section = self::ALL_DOMAINS): Domain
     {
         if (!in_array($section, [self::PRIVATE_DOMAINS, self::ICANN_DOMAINS, self::ALL_DOMAINS], true)) {
-            throw new Exception(sprintf('%s is an unknown Domain section', $section));
+            throw new Exception(sprintf('%s is an unknown Public Suffix List section', $section));
         }
 
         if (!$this->isMatchable($domain)) {

tests/RulesTest.php

@@ -25,6 +25,25 @@ public function setUp()
         $this->rules = $manager->getRules();
     }
 
+    public function testCreateFromPath()
+    {
+        $context = stream_context_create([
+            'http'=> [
+                'method' => 'GET',
+                'header' => "Accept-language: en\r\nCookie: foo=bar\r\n",
+            ],
+        ]);
+
+        $rules = Rules::createFromPath(__DIR__.'/data/public_suffix_list.dat', $context);
+        $this->assertInstanceOf(Rules::class, $rules);
+    }
+
+    public function testCreateFromPathThrowsException()
+    {
+        $this->expectException(Exception::class);
+        Rules::createFromPath('/foo/bar.dat');
+    }
+
     public function testNullWillReturnNullDomain()
     {
         $domain = $this->rules->resolve('COM');