Category tree Update

api.md

@@ -1,4 +1,18 @@
-# API INFORMATION
+s# API INFORMATION
+
+## INTRODUCTION
+
+The api  allows data being published to scry.info website.
+
+If the data published has a category and this category requires data testing, the application will check data.
+
+Check "category" below for information about how the data is being tested.
+
+
+Step 1 : Get JWT Token - https://dev.scry.info:443/scry2/login
+Step 2 : Send data to the publisher - https://dev.scry.info:443/meta/publisher
+
+
 
 ## AUTHENTICATION
 
@@ -72,110 +86,164 @@ RESPONSE:
 
 
 
-  ## PUBLISH DATA
 
+## DELETE CATEGORY
 
-  To publish data
 
-  ```
-  GET https://dev.scry.info:443/meta/getcategories
-  ```
+To delete a category
 
-  AUTHENTICATION
+```
+POST https://dev.scry.info:443/meta/delete_categories
+```
 
-  Headers :
-  ```
-  "Authorization : JWT JwtToken"
-  ```
+AUTHENTICATION
 
-INPUT
+Headers :
+```
+"Authorization : JWT JwtToken"
+```
+The json must contain the id of the category. Ex:
 
+```
+{"Id":32}
+```
 
-Multiple file post, enctype="multiparnt/form-data".
+If some childs depend on parent, the API will return the following error.
+```
+      {'description': 'DB Error',
+      'status_code': 401,
+      'error': '{"message": "Dependent Categories"}'}
+  )
+```
 
-1) The first file should have name "data" and should contain a csv without headers.
-2) The second file should be named "listing_info "
+## CREATE CATEGORY
 
-Listing info :
-- category_name : extracted from "/getcategories" above. Must match exact values.
-- price : price of the listing
-- filename : name of the file that will be listed on scry.info and downloaded
-- keyword : keywords related to the file that can be searched on scry.
 
+To create a category
+
+```
+POST https://dev.scry.info:443/meta/categories
+```
+
+AUTHENTICATION
+
+Headers :
 ```
-   {
-     "category_name":["Aviation", "Commercial", "Airline"],
-     "price":1000,
-     "filename":"Airlines.csv",
-     "keywords":"Commercial Airlines"
-   }
+"Authorization : JWT JwtToken"
 ```
 
+INPUT
 
+Posts a json containing the following info
 
+Listing info :
+- category_name (String): Name of the category. For a parent category, all child names must unique, but different parent categories can have the same child name
+- parent_id (Int, Optional): Category_id of the parent category. Can be left NULL.
+- IsStructured (Boolean): If True, means the data is structured and must have metedata.
+- Metadata (Json): keywords related to the file that can be searched on scry. Json is a list of objects structured as follow : {"ColumnName" : [{"MasterData":"Value"}]}
+
+Ex.: [
+      {"Id" : [
+        { "DataType": "Int",
+          "IsUnique" : "True"
+          "IsPrimaryKey":"True"}
+        ]},
+        {"UserName" : [
+          { "DataType": "String",
+            "IsUnique" : "True"
+            "IsPrimaryKey":"True"}
+          ]},
+          ,
+          {"PhoneNumber" : [
+            { "DataType": "Int",
+              "IsUnique" : "True"
+            ]}
+      ]
+
+
+- DataType (String) : Define the type of the structure for a column
+- IsNull (String) : True if the data can be null. If not value is specified, the default is value is False
+- IsUnique (String) : Unique constraint on the column. It Default value is False.
+ the structure will be checked if it matches the the structure below. "DataType" is compulsory, "IsNull", "IsUnique"  are optional
+
+masterMetaData={
+                 "DataType":["String","Int","Float","Date","Datetime","StandardTime"],
+                 "IsNull" : ["True","False"],
+                 "IsUnique":["True","False"],
+                 "IsPrimaryKey":["True","False"]
+            }
+
+Ex 1 :
+```
+ {
+   "category_name": "Airline",
+   "parent_id": null,
+   "IsStructured": False,
+   "Metadata": null
+ }
+```
 
-  ## LISTING QUERY BY KEYWORDS
+Ex 2 :
+```
+ {
+   "category_name": "Airport",
+   "parent_id": 101,
+   "IsStructured": True,
+   "Metadata": [
+         {"Id" : [
+           { "DataType": "Int",
+             "IsUnique" : "True"
+             "IsPrimaryKey":"True"}
+           ]},
+           {"UserName" : [
+             { "DataType": "String",
+               "IsUnique" : "True"
+               "IsPrimaryKey":"True"}
+             ]},
+             ,
+             {"PhoneNumber" : [
+               { "DataType": "Int",
+                 "IsUnique" : "True"
+               ]}
+         ]
+ }
+```
 
+## PUBLISH DATA
 
-  Keywords based listin gsearch function.
-  The funnction can search by categoryname, keywords provided by publisher or both.
-  If more than one keyword is provided, a "OR" is applied.
-  The function tokenizes using postgresql to vector so plural and verb tenses are handled.
 
-    Ex. aviation and aviations will be considered as the same.
+To publish data
 
-  ```
-  GET https://dev.scry.info:443/meta/search_keywords
-  ```
-  AUTHENTICATION
+```
+POST https://dev.scry.info:443/meta/publisher
+```
 
+AUTHENTICATION
 
-  Headers :
-  ```
-  "Authorization : JWT JwtToken"
-  ```
+Headers :
+```
+"Authorization : JWT JwtToken"
+```
 
 INPUT
 
-- keywords : a string of keywords separated by a space
-  Ex : 'aviation commercial'
-- searchtype: a string containining list of string. As of now there are two options
-    - 'keywords' : the keyword specified on publication
-        Ex :
-        ```
-        keywords='schedule airline'
-        ```
-    - 'searchtype' : area covered in the search. Can be either keywords provided by data publisher, categories name or both.
-        Ex :
-      ```
-              searchtype='["keywords","category"]'
-              searchtype='["keywords"]'
-              searchtype='["category"]'
-      ```
 
+Multiple file post, enctype="multiparnt/form-data".
 
--> note : must be lowercase
+1) The first file should have name "data" and should contain a csv without headers.
+2) The second file should be named "listing_info "
+
+Listing info :
+- category_name (String): extracted from "/getcategories" above. Must match exact values.
+- price (Int): price of the listing
+- filename (String) : name of the file that will be listed on scry.info and downloaded
+- keyword (String): keywords related to the file that can be searched on scry. Must be separated by a space.
 
 ```
-[
  {
-   "categoryId": 51,
-   "cid": "QmVdfC5kG7nTf69yaHryPVEcLKhxZNHff49UHSL8YBbYYm",
-   "created_at": "Thu, 14 Jun 2018 16:27:00 GMT",
-   "id": 16,
-   "isstructured": true,
-   "keywords": "Aviation,Commercial Flight, Schedule",
-   "name": "Schedule.csv",
-   "owner": {
-     "account": "0xef97584f1a5f98a51d8f8b68dfb3c165045e508e",
-     "created_at": "Mon, 28 May 2018 16:55:49 GMT",
-     "id": 8,
-     "name": "22",
-     "password_hash": "pbkdf2:sha256:50000$bf801740b8f08e65$294a006c03083fc08b43bf0d08226d6a2ce91b8cbc5f784dcb7ecf9c756def3e"
-   },
-   "price": 5000,
-   "size": "179831"
+   "category_name":["Aviation", "Commercial", "Airline"],
+   "price":1000,
+   "filename":"Airlines.csv",
+   "keywords":"Commercial Airlines"
  }
-]
-
 ```

api.py

@@ -1,5 +1,5 @@
-import json
-import requests
+import json, io, requests
+from categories import get_last_category_id
 
 
 #scry_path='https://dev.scry.info:443/scry2/'
@@ -24,12 +24,16 @@ class ScryApi(object):
         publisher=publisher_url,
         categories=publisher_url,
         listing_by_categories=publisher_url,
-        listing=publisher_url
+        listing=publisher_url,
+        get_categories=publisher_url,
+        get_categories_parents=publisher_url,
+        delete_categories=publisher_url,
     )
 
     def _get_url(self, path):
         return self.paths[path] + path
 
+
     def _make_headers(self):
         if getattr(self, 'jwt_token', None) is not None:
             return {"Authorization": "JWT " + self.jwt_token}
@@ -46,6 +50,7 @@ def _post(self, path, **payload):
             raise ScryApiException(r.status_code, response)
         return json.loads(r.text)
 
+
     def _get(self, path, **payload):
         r = requests.get(self._get_url(path), payload, headers=self._make_headers())
         if r.status_code >= 400:
@@ -78,11 +83,42 @@ def publisher(self, data=None, listing_info=None):
                 f.close()
         return res
 
+    def publisher2(self, data=None, listing_info=None):
+        files = {}
+        if data:
+            files['data'] = open(self.data_path + data, 'rb')
+        if listing_info:
+            f1 = open(self.listing_path + listing_info)
+            listing_info = json.loads(f1.read())
+            f1.close()
+            listing_info['category_id'] = get_last_category_id(listing_info['category_name'])
+            listing_info = json.dumps(listing_info)
+
+            files['listing_info'] = listing_info
+        try:
+            res = self._post('publisher', files=files)
+        finally:
+            for f in files.values():
+                try:
+                    f.close()
+                except:
+                    continue
+        return res
+
     def search(self, payload):
         return self._get('search_keywords', params=payload)
 
     def categories(self, metadata):
         return self._post('categories', json=metadata)
 
+    def get_categories(self, payload):
+        return self._post('get_categories', json=payload)
+
+    def get_categories_parents(self, payload):
+        return self._post('get_categories_parents', json=payload)
+
+    def delete_categories(self, payload):
+        return self._post('delete_categories', json=payload)
+
     def listing_by_categories(self, payload):
         return self._get('listing_by_categories', params=payload)