proxy-rotator-js 1.0.5 → 1.0.7

package/README.md

@@ -20,7 +20,7 @@ import ProxyRotator from 'proxy-rotator-js'
 
 let proxies = ['proxy1', 'proxy2', 'proxy3']
 
-let rotator = ProxyRotator(proxies, options={})
+let rotator = new ProxyRotator(proxies, options={})
 
 console.log( rotator.next() ) // 'proxy1'
 console.log( rotator.next() ) // 'proxy2'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "proxy-rotator-js",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "type": "module",
   "description": "Proxy Rotator",
   "main": "index.js",

package/src/ProxyRotator.js

@@ -7,12 +7,12 @@ class ProxyRotator {
         this.pool = new Queue();
         this.graveyard = [];
         // handle options
-        let { proxyType, revive_timer, shuffle, protocol, assume_aliveness, check_on_next } = options;
+        let { returnAs, revive_timer, shuffle, protocol, assume_aliveness, check_on_next } = options;
         // how long to wait before reviving a dead proxy
         // default: 30 minutes
         this.revive_timer = revive_timer ?? 1000 * 60 * 30;
         // return type of proxy, either 'string' or 'object'
-        this.proxyType = proxyType? this._handleProxyTypeInput(proxyType) : 'string';
+        this.returnAs = returnAs? this._handleReturnAsInput(returnAs) : 'string';
         // assume a a protocol for all proxies
         this.protocol = protocol ?? null;
         // shuffle the proxies before adding them to the queue
@@ -113,7 +113,8 @@ class ProxyRotator {
         return this.setDead(proxy);
     }
 
-    next(proxyType=null){
+    next(options={}){
+        let { returnAs } = options;
         // resurect a proxy from the graveyard
         if(this.check_on_next) _resurection();
         // if there are no proxies in the pool
@@ -122,12 +123,13 @@ class ProxyRotator {
         let proxy = this.pool.dequeue();
         // add to back
         this.pool.enqueue(proxy);
-        // if returnType is 'string'
-        if(proxyType === null) proxyType = this.proxyType;
-        else proxyType = this._handleProxyTypeInput(proxyType);
-        // return proxy
-        if(proxyType === 'string') return proxy.proxy;
-        else if(this.returnType === 'object') return proxy.toObject();
+        // if parameter is passed
+        if(returnAs) returnAs = this._handleReturnAsInput(returnAs)
+        // else use default
+        else returnAs = this.returnAs;
+        // retun proxy as string or object
+        if(returnAs === 'string') return proxy.toString();
+        else if(returnAs === 'object') return proxy.obj()
     }
 
     /* Randomize array in-place using Durstenfeld shuffle algorithm */
@@ -141,16 +143,18 @@ class ProxyRotator {
         return array;
     }
 
-    _handleProxyTypeInput(proxyType=null){
-        if(proxyType === null) return null;
-        proxyType = proxyType.toLowerCase();
-        if(proxyType === 'str') proxyType = 'string';
-        if(proxyType === 'obj') proxyType = 'object';
-        if(proxyType !== 'string' && proxyType !== 'object'){
-            console.error('proxyType must be either "string" or "object"');
-            proxyType = 'string';
-        }
-        return proxyType;
+    _handleReturnAsInput(proxyType=null){
+        if(typeof proxyType === 'string'){
+            proxyType = proxyType.toLowerCase();
+            if(proxyType === 'str') proxyType = 'string';
+            if(proxyType === 'obj') proxyType = 'object';
+            if(proxyType !== 'string' && proxyType !== 'object'){
+                console.error('proxyType must be either "string" or "object"');
+                proxyType = null
+            }
+            return proxyType;
+        }else
+            return null;
     }
     
     _parseFile(filename) {

package/test/test.js

@@ -47,14 +47,14 @@ describe('read form proxy files', () => {
 describe('basic functionality', () => {
     // test if it can process a string point to a file
     it('add proxies array', () => {
-        // make rotator with file with newlines
+        // make rotator 
         let rotator = new ProxyRotator(test_proxies);
         // get pool
         assert.deepEqual(test_proxies,rotator.getPool())
     })
     // adding one by one
     it('add proxy one by one ', () => {
-        // make rotator with file with newlines
+        // make rotator
         let rotator = new ProxyRotator();
         // add proxies one by one
         for(let proxy of test_proxies) rotator.add(proxy)
@@ -167,3 +167,38 @@ describe('basic functionality', () => {
         }, 1000);
     })
 });
+
+// check return type of proxy
+describe('Test return type', () => {
+    // test if it return as obj when option is set
+    it('test default return string type', () => {
+        // make rotator
+        let rotator = new ProxyRotator(test_proxies);
+        // remove proxies one by one
+        let proxy = rotator.next()
+        // test if it is string
+        assert.equal(typeof proxy, 'string')
+    })
+    it('test if it return object when passed returnAs obj', () => {
+        // make rotator
+        let rotator = new ProxyRotator(test_proxies, { returnAs: 'object' });
+        // remove proxies one by one
+        let proxy = rotator.next()
+        // test if it is string
+        assert.equal(typeof proxy, 'object')
+    })
+    it('test if it return obj when passed as paramter', () => {
+        // make rotator
+        let rotator = new ProxyRotator(test_proxies);
+        // remove proxies one by one
+        let proxy = rotator.next({ returnAs:'obj'})
+        // test if it is string
+        assert.equal(typeof proxy, 'object')
+        // try to get sring
+        let proxy2 = rotator.next({ returnAs: 'str'})
+        // test if it is string
+        assert.equal(typeof proxy2, 'string')
+    })
+});
+
+