Merge pull request #4 from preprio/develop

Update PHP Client (for PHP 7<)

Author: tim-hanssen

README.md

@@ -1,11 +1,13 @@
-# Getting started with PHP
+# PHP + Prepr SDK
 
-This package is a wrapper for the <a href="https://prepr.dev">Prepr</a> REST API.
+This package is an SDK for the REST API.
 
 ## Basics
 The SDK on [GitHub](https://github.com/preprio/php-sdk)  
-Minimal PHP version: `> 5.6.4`   
-Requires `GuzzleHttp 7.0.X`, `Murmurhash 2.0.X`
+Minimal PHP version: `> 5.6.4`
+Requires `GuzzleHttp 7.0.X`
+
+For Laravel projects we recommend using the Laravel providers for [REST](https://github.com/preprio/laravel-rest-sdk) or [GraphQL](https://github.com/preprio/laravel-graphql-sdk).
 
 ## Installation
 
@@ -17,7 +19,7 @@ composer require preprio/php-sdk
 
 ## Making your first request
 
-Let's start with getting all publications from your Prepr Environment. 
+Let's start with getting some content items from your Prepr Environment. 
 
 ```php
 <?php
@@ -27,7 +29,7 @@ use Preprio\Prepr;
 $apiRequest = new Prepr('{ACCESS_TOKEN}');
 
 $apiRequest
-    ->path('publications')
+    ->path('content_items')
     ->query([
         'fields' => 'items'
     ])
@@ -40,7 +42,7 @@ if($apiRequest->getStatusCode() == 200) {
 ```
 
 
-To get a single publication, pass the Id to the request.
+To get a single content item, pass the ID to the request.
 
 ```php
 <?php
@@ -50,7 +52,7 @@ use Preprio\Prepr;
 $apiRequest = new Prepr('{ACCESS_TOKEN}');
 
 $apiRequest
-    ->path('publications/{id}', [
+    ->path('content_items/{id}', [
         'id' => '1236f0b1-b26d-4dde-b835-9e4e441a6d09'
     ])
     ->query([
@@ -64,61 +66,13 @@ if($apiRequest->getStatusCode() == 200) {
 }
 ```
 
-
-## A/B testing with Optimize
-
-To enable A/B testing you can pass a User ID to provide a consistent result.
-The A/B testing feature requires the use of the cached CDN API.
-
-To switch off A/B testing, pass NULL to the UserId param.
-
-```php
-$apiRequest = new Prepr('{ACCESS_TOKEN}', '{{YourCustomUserId}}');
-```
-
-or per request
-
-```php
-$apiRequest
-    ->path('publications/{id}',[
-        'id' => 1
-    ]),
-    ->query([
-        'fields' => 'example'
-    ])
-    ->userId(
-        '{{YourCustomUserId}}'
-    )
-    ->get();
-
-if($apiRequest->getStatusCode() == 200) {
-
-    print_r($apiRequest->getResponse());
-}
-```
-
-For more information check the [Optimize documentation](/docs/optimize/v1/introduction).
-
-## Using the CDN
-
-To use Prepr in production we advise you to use the API CDN for a fast response.
-Add the API CDN Url to the init of the SDK.
-
-```php
-<?php
-
-use Preprio\Prepr;
-
-$apiRequest = new Prepr('{ACCESS_TOKEN}', null, 'https://cdn.prepr.io/');
-```
-
 ### Auto paging results
 
 To get all resources for an endpoint, you can use the auto paging feature.
 
 ```php
 $apiRequest
-    ->path('publications')
+    ->path('content_items')
     ->query([
         'limit' => 200 // optional
     ])
@@ -138,7 +92,7 @@ The authorization can also be set for one specific request `->url('url')->author
 
 ```php
 $apiRequest
-    ->path('tags')
+    ->path('content_items')
     ->params([
         'body' => 'Example'
     ])
@@ -154,7 +108,7 @@ if($apiRequest->getStatusCode() == 201) {
 
 ```php
 $apiRequest
-    ->path('tags')
+    ->path('content_items')
     ->params([
         'body' => 'Example'
     ])
@@ -170,8 +124,8 @@ if($apiRequest->getStatusCode() == 200) {
 
 ```php
 $apiRequest
-    ->path('tags/{id}',[
-        'id' => 1
+    ->path('content_items/{id}',[
+        'id' => "398402d-dd-asd-ads3343dad"
     ])
     ->delete();
 
@@ -189,7 +143,7 @@ $apiRequest
     ->params([
       'body' => 'Example',
     ])
-    ->file('/path/to/file.txt') // For laravel storage: storage_path('app/file.ext')
+    ->file('/path/to/file.txt')
     ->post();
 
 if($apiRequest->getStatusCode() == 200) {

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "preprio/php-sdk",
-    "description": "Prepr API wrapper",
-    "keywords": ["laravel", "prepr"],
+    "description": "Prepr PHP SDK",
+    "keywords": ["php", "prepr"],
     "license": "MIT",
     "authors": [
         {
@@ -12,8 +12,7 @@
     "minimum-stability": "dev",
     "require": {
         "php": ">=5.6.4",
-        "guzzlehttp/guzzle": "^7.0.1",
-        "lastguest/murmurhash": "^2.0.0"
+        "guzzlehttp/guzzle": "^7.0.1"
     },
     "autoload": {
         "psr-4": {

src/Prepr.php

@@ -3,10 +3,6 @@
 namespace Preprio;
 
 use GuzzleHttp\Client;
-use Cache;
-use Artisan;
-use lastguest\Murmur;
-use Session;
 
 class Prepr
 {
@@ -22,18 +18,14 @@ class Prepr
     protected $authorization;
     protected $file = null;
     protected $statusCode;
-    protected $userId;
+    protected $client;
 
     private $chunkSize = 26214400;
 
-    public function __construct($authorization = null, $userId = null, $baseUrl = 'https://api.eu1.prepr.io/')
+    public function __construct($authorization = null, $baseUrl = 'https://cdn.prepr.io/')
     {
         $this->baseUrl = $baseUrl;
         $this->authorization = $authorization;
-
-        if($userId) {
-            $this->userId = $this->hashUserId($userId);
-        }
     }
 
     protected function client()
@@ -44,7 +36,6 @@ protected function client()
                 'Accept' => 'application/json',
                 'Content-Type' => 'application/json',
                 'Authorization' => $this->authorization,
-                'Prepr-ABTesting' => $this->userId
             ]
         ]);
     }
@@ -70,22 +61,23 @@ protected function request($options = [])
         $this->rawResponse = $this->request->getBody()->getContents();
         $this->response = json_decode($this->rawResponse, true);
 
-        // Files larger then 25 MB (upload chunked)
-        if ($this->data_get($this->file, 'chunks') > 1 && ($this->getStatusCode() === 201 || $this->getStatusCode() === 200)) {
+        // Files larger than 25 MB (upload chunked)
+        if ($this->data_get($this->file, 'chunks') > 1 &&
+            ($this->getStatusCode() === 201 || $this->getStatusCode() === 200)) {
             return $this->processFileUpload();
         }
 
         return $this;
     }
 
-    public function authorization($authorization)
+    public function authorization(string $authorization)
     {
         $this->authorization = $authorization;
 
         return $this;
     }
 
-    public function url($url)
+    public function url(string $url)
     {
         $this->baseUrl = $url;
 
@@ -168,10 +160,11 @@ public function getStatusCode()
         if($this->statusCode) {
             return $this->statusCode;
         }
+
         return $this->request->getStatusCode();
     }
 
-    public function file($filepath)
+    public function file(string $filepath)
     {
         $fileSize = filesize($filepath);
         $file = fopen($filepath, 'r');
@@ -186,13 +179,13 @@ public function file($filepath)
 
         if ($this->file) {
 
-            // Files larger then 25 MB (upload chunked)
+            // Files larger than 25 MB (upload chunked)
             if ($this->data_get($this->file, 'chunks') > 1) {
 
                 $this->params['upload_phase'] = 'start';
                 $this->params['file_size'] = $this->data_get($this->file, 'size');
 
-                // Files smaller then 25 MB (upload directly)
+                // Files smaller than 25 MB (upload directly)
             } else {
                 $this->params['source'] = $this->data_get($this->file, 'file');
             }
@@ -293,26 +286,13 @@ public function autoPaging()
             'items' => $arrayItems,
             'total' => count($arrayItems)
         ];
-        $this->statusCode = 200;
-
-        return $this;
-    }
-
-    public function hashUserId($userId)
-    {
-        $hashValue = Murmur::hash3_int($userId, 1);
-        $ratio = $hashValue / pow(2, 32);
-        return intval($ratio*10000);
-    }
 
-    public function userId($userId)
-    {
-        $this->userId = $this->hashUserId($userId);
+        $this->statusCode = 200;
 
         return $this;
     }
 
-    public function nestedArrayToMultipart($array)
+    public function nestedArrayToMultipart(array $array)
     {
         $flatten = function ($array, $original_key = '') use (&$flatten) {
             $output = [];
@@ -347,7 +327,7 @@ public function nestedArrayToMultipart($array)
         return $multipart;
     }
 
-    public function data_get($array, $variable)
+    public function data_get(array $array, string $variable)
     {
         if(isset($array[$variable])) {
             return $array[$variable];