proxy-rotator-js 1.0.4 → 1.0.6

package/package.json

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

package/src/Proxy.js

@@ -1,5 +1,5 @@
 class Proxy {
-    constructor(proxy, protocol = null) {
+    constructor(proxy, protocol = null, assumeAlive = false) {
         // if proxy string starts with protocol
         if( proxy.includes('://') ){
             this.protocol = proxy.split('://')[0];
@@ -13,7 +13,7 @@ class Proxy {
         // the proxy 
         this.proxy = `${(this.protocol)? this.protocol+'://' : ''}${this.ip}:${this.port}`;
         // status can be 'new', 'alive', 'dead'
-        this.status = 'new';
+        this.status = (assumeAlive)? 'alive' : 'new';
         this.changeTimeStamp = Date.now();
     }
     // method to return as string

package/src/ProxyRotator.js

@@ -6,24 +6,13 @@ class ProxyRotator {
     constructor(proxies, options={} ){
         this.pool = new Queue();
         this.graveyard = [];
-        // examine proxies passed
-        // check if it is a file path
-        if( typeof proxies === 'string' ){
-            // parse file
-            proxies = this._parseFile(proxies);
-            // add proxies to queue
-            proxies.forEach( p => this._add(p) );
-        }else if( this._isArray(proxies) ){
-            // add proxies to queue
-            proxies.forEach( p => this._add(p) );
-        }
         // 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 = _handleProxyTypeInput(proxyType);
+        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
@@ -32,6 +21,17 @@ class ProxyRotator {
         this.assume_aliveness = assume_aliveness ?? false;
         // check if proxies are alive when they are added to the queue
         this.check_on_next = check_on_next ?? false;
+        // examine proxies passed
+        // check if it is a file path
+        if( typeof proxies === 'string' ){
+            // parse file
+            proxies = this._parseFile(proxies);
+            // add proxies to queue
+            proxies.forEach( p => this._add(p) );
+        }else if( this._isArray(proxies) ){
+            // add proxies to queue
+            proxies.forEach( p => this._add(p) );
+        }
     }
 
     getGraveyard(){ return this.graveyard.map(p => p.proxy) }
@@ -50,7 +50,7 @@ class ProxyRotator {
     }
 
     _add(proxy){ // add proxy to queue
-        let p = new Proxy(proxy);
+        let p = new Proxy(proxy, this.protocol, this.assume_aliveness);
         this.pool.enqueue(p);
     }
 
@@ -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,15 +143,18 @@ class ProxyRotator {
         return array;
     }
 
-    _handleProxyTypeInput(proxyType){
-        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('teset 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('teset 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')
+    })
+});
+
+