Publish to PyPi

Refactoring code, with version change.

Author: 2knal

README.md

@@ -19,14 +19,15 @@ Python package to generate a random proxy on the fly!
 - Fetch elite / transparent / anonymous proxies respectively.
 - Fetch directly from [free-proxy-list](https://free-proxy-list.net).
 - For better response time, fetch from an elasticsearch `cache_server`.
-- `cache_server` is updated via routines described [here](./random_proxies/cache_server/README.md)
+- `cache_server` is updated via routines described [here](./random_proxies/cache/README.md)
 
 
 ## Example usage
-<!-- ```bash
-  pip install random_proxies
+
+```bash
+  pip install random-proxies
 ```
-or  -->
+or 
 ```bash
   $ git clone https://github.com/2knal/random_proxies.git`
   $ cd random_proxies/ 
@@ -40,16 +41,16 @@ Open python interpreter. (Supports version 3.7+)
 '23.101.2.247:81'
 ```
 
-Refer more examples [here](./examples/)
+Refer more examples [here](./examples/example.py)
 
 ## TODO
 
 - [x] Port to MongoDB
-- [ ] Publish package version 0.0.1 
+- [x] Publish package version 0.0.2 
 - [ ] Return meta data, response structure found [here](./random_proxies/cache/README.md)
 - [ ] Scrape proxies from other sources
 - [ ] Add support for SOCKS version 5
-- [ ] Implement REST API to allow other languages to interface with it
+- [x] Implement REST API to allow other languages to interface with it
 - [ ] Setup documentation page
 - [ ] Add unit tests
 

examples/example.py

@@ -1,6 +1,6 @@
 '''
 (Once the package is published)
-pip install random_proxies 
+pip install random-proxies 
     or 
 Follow example usage to import the package
 '''

random_proxies/cache/app.py

@@ -22,7 +22,7 @@ def fetch():
     # Fetch from proxies
     proxies = proxies_collection.find(conditions)
     if proxies.count() == 0:
-        raise NoSuchProxyError('No proxy satisfying given conditions.')
+        return jsonify({ 'success': 'no' })
 
     # Randomly select it
     proxies = list(proxies)
@@ -36,7 +36,7 @@ def fetch():
         # Add it to recents index
         recents_collection.insert_one(proxy)
 
-        return jsonify({ 'ip': ip })
+        return jsonify({ 'ip': ip, 'success': 'yes' })
 
     except Exception as e:
         template = 'An exception of type {0} occurred.\nArguments: {1!r}'

random_proxies/proxies/db.py

@@ -3,7 +3,9 @@
 
 import json
 import requests
+
 from random_proxies.proxies.settings import CACHE_SERVER_URL
+from random_proxies.proxies.exception import NoSuchProxyError
 
 def pop(conditions):
     query_string = '?'
@@ -14,4 +16,7 @@ def pop(conditions):
     data = requests.get(url).text
     data = json.loads(data)
 
-    return data['ip']
+    if data['success'] == 'yes':
+        return data['ip']
+    else:
+        raise NoSuchProxyError('No proxy satisfying given conditions.')

random_proxies/proxies/settings.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 
-__version__ = '0.0.1'
+__version__ = '0.0.2'
 
 BASE_URL = 'https://free-proxy-list.net/'
 SSL_URL = 'http://sslproxies.org/'