moved to API v2

Author: root

README.md

@@ -1,8 +1,8 @@
 # exportcomments-php
+
 Official PHP client for the ExportComments API. Export Social Media Comments from your PHP apps.
 
-Autoload
---------
+## Autoload
 
 The first step to use `exportcomments-php` is to download composer:
 
@@ -11,28 +11,29 @@ $ curl -s http://getcomposer.org/installer | php
 ```
 
 Then we have to install our dependencies using:
+
 ```bash
 $ php composer.phar install
 ```
+
 Now we can use autoloader from Composer by:
 
 ```json
 {
-    "require": {
-        "exportcomments/exportcomments-php": "~0.1"
-    }
+  "require": {
+    "exportcomments/exportcomments-php": "~0.1"
+  }
 }
 ```
 
 Or, if you don't want to use composer, clone the code and include this line of code:
 
     require 'autoload.php';
 
-
-Usage examples
---------------
+## Usage examples
 
 Here are some examples of how to use the library in order to create and use exports:
+
 ```php
 require 'autoload.php';
 
@@ -42,6 +43,7 @@ $export = new ExportComments\Client('<YOUR API KEY HERE>');
 ```
 
 Create export
+
 ```php
 // Create a new export
 $data = array('url' => 'https://www.facebook.com/post/123456789', 'replies' => false, 'twitterType' => null);
@@ -53,16 +55,35 @@ var_dump($res);
 Response
 
 ```json
-
 {
-  "uniqueId": "dfd6a2f2-5579-421f-96ac-98993d0edea1",
-  "date_created": "2016-08-26T11:44:09+00:00",
-  "status": false,
-  "error": null
+  "code": 200,
+  "success": true,
+  "data": {
+    "url": "https://www.instagram.com/p/1234567",
+    "guid": "2cfb0b9d-7633-4341-a702-cb889fe549eb",
+    "status": "done",
+    "replies": false,
+    "fileName": "comments5ea4b4d5a7602-1325511884314646.xlsx",
+    "fileNameRAW": "08b735760a5a40eb1fd70ca16e97aed3-2e0916fe-de86-4422-8449-fb608cbe5221.json",
+    "total": 100,
+    "totalExported": 98,
+    "retry": 0,
+    "error": null,
+    "repliesCount": 0,
+    "twitterType": null,
+    "timezone": "UTC",
+    "createdAt": "2016-08-26T07:32:27+00:00",
+    "updatedAt": "2016-08-26T07:32:27+00:00",
+    "exportedAt": "",
+    "downloadUrl": "/exports/comments5ea4b4d5a7602-1325511884314646.xlsx",
+    "rawUrl": "/exports/08b735760a5a40eb1fd70ca16e97aed3-2e0916fe-de86-4422-8449-fb608cbe5221.json"
+  },
+  "message": null
 }
-
 ```
 
+````
+
 Checking export status
 
 ```php
@@ -71,32 +92,40 @@ $uniqueId = 'dfd6a2f2-5579-421f-96ac-98993d0edea1';
 $res = $export->exports->checkExport($uniqueId);
 var_dump($res);
 
-```
+````
 
 Response
-```json
 
-[
-  {
+```json
+{
+  "code": 200,
+  "success": true,
+  "data": {
     "url": "https://www.instagram.com/p/1234567",
-    "datecreated": "2016-08-26T07:32:09+00:00",
-    "uniqueId": "dfd6a2f2-5579-421f-96ac-98993d0edea1",
-    "done": true,
-    "dateexported": "2016-08-26T07:32:27+00:00",
+    "guid": "2cfb0b9d-7633-4341-a702-cb889fe549eb",
+    "status": "queueing",
+    "replies": false,
+    "fileName": "comments5ea4b4d5a7602-1325511884314646.xlsx",
+    "fileNameRAW": "08b735760a5a40eb1fd70ca16e97aed3-2e0916fe-de86-4422-8449-fb608cbe5221.json",
+    "total": 0,
+    "totalExported": 0,
+    "retry": 0,
     "error": null,
-    "total": 306,
-    "totalExported": 306,
-    "replies": true,
-    "dateNotified": null,
     "repliesCount": 0,
-    "downloadUrl": "/exports/comments5d638af93ab70-1234567.xlsx",
-    "rawUrl": "/exports/6dbf1a87e0fb1f7f16b25be55bb37647-148d4d42-9db8-4e5a-9b51-a860e3646cb0.json"
-  }
-]
-
+    "twitterType": null,
+    "timezone": "UTC",
+    "createdAt": "2016-08-26T07:32:27+00:00",
+    "updatedAt": "2016-08-26T07:32:27+00:00",
+    "exportedAt": "",
+    "downloadUrl": "/exports/comments5ea4b4d5a7602-1325511884314646.xlsx",
+    "rawUrl": "/exports/08b735760a5a40eb1fd70ca16e97aed3-2e0916fe-de86-4422-8449-fb608cbe5221.json"
+  },
+  "message": null
+}
 ```
 
 Exports list
+
 ```php
 
 $res = $export->exports->listExports();
@@ -107,38 +136,34 @@ var_dump($res);
 Response
 
 ```json
-
 [
   {
     "url": String,
-    "datecreated": Date,
-    "uniqueId": Uuid,
-    "done": Bool,
-    "dateexported": Date,
+    "createdAt": Date,
+    "guid": Uuid,
+    "status": String,
+    "exportedAt": Date,
     "error": String,
     "total": Int,
     "totalExported": Int,
     "replies": Bool,
-    "dateNotified": Date,
     "repliesCount": Int,
     "downloadUrl": String,
     "rawUrl": String
   },
   {
     "url": String,
-    "datecreated": Date,
-    "uniqueId": Uuid,
-    "done": Bool,
-    "dateexported": Date,
+    "createdAt": Date,
+    "guid": Uuid,
+    "status": String,
+    "exportedAt": Date,
     "error": String,
     "total": Int,
     "totalExported": Int,
     "replies": Bool,
-    "dateNotified": Date,
     "repliesCount": Int,
     "downloadUrl": String,
     "rawUrl": String
   }
 ]
-
-```
+```

src/Config.php

@@ -4,6 +4,6 @@
 
 class Config {
 
-    const DEFAULT_BASE_ENDPOINT = 'https://exportcomments.com/api';
+    const DEFAULT_BASE_ENDPOINT = 'https://exportcomments.com/api/v2';
 
 }

src/Exports.php

@@ -5,17 +5,20 @@
 use ExportComments\ExportCommentsResponse;
 use ExportComments\ExportCommentsException;
 
-class Exports extends Request {
+class Exports extends Request
+{
 
-    function __construct($token, $base_endpoint) {
+    function __construct($token, $base_endpoint)
+    {
         $this->token = $token;
         $this->endpoint = $base_endpoint;
     }
 
-    function checkExport($uniqueId) {
+    function checkExport($guid)
+    {
         $url = $this->endpoint . '/export';
         $query_params = http_build_query(
-                array('uniqueId' => $uniqueId)
+            array('guid' => $guid)
         );
         $url = $url . '?' . $query_params;
         try {
@@ -26,7 +29,8 @@ function checkExport($uniqueId) {
         return new ExportCommentsResponse($response, array($header));
     }
 
-    function createExport($data = array()) {
+    function createExport($data = array())
+    {
         $url = $this->endpoint . '/export';
         $params = array(
             'url' => $data['url'],
@@ -37,14 +41,15 @@ function createExport($data = array()) {
         }
         $url = $url . '?' . http_build_query($params);
         try {
-            list($response, $header) = $this->make_request($url, 'POST');
+            list($response, $header) = $this->make_request($url, 'PUT');
         } catch (ExportCommentsException $ex) {
             throw $ex;
         }
         return new ExportCommentsResponse($response, array($header));
     }
 
-    function listExports() {
+    function listExports()
+    {
         $url = $this->endpoint . '/exports/me';
         try {
             list($response, $header) = $this->make_request($url, 'GET', null);
@@ -53,5 +58,4 @@ function listExports() {
         }
         return new ExportCommentsResponse($response, array($header));
     }
-
 }