adspower-client 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a4cbcbdabbd1f597745c5604f03d3eb052d998f81a5167737a552060d8c65af
-  data.tar.gz: 05b42ad5140074a8488d4b9424fd6d723873daf3c901c5317352076aafc050b5
+  metadata.gz: 9dd3f5b867718ddd2e21e1aab984d651cec9bf7f713b4edeb71a3b42bf0759bd
+  data.tar.gz: 6a88a31aa0817eeb9c10f5b0dfcd78b7952347465ffd86577d4163a3c5bfe353
 SHA512:
-  metadata.gz: c9c58297ba76e0c27b72d3c79ef185bf02814620869f2deb873820bfba211564e05cb728615623036d26683c0c0b9a6448e78cec85d1cff3fc14bdec6ed51e66
-  data.tar.gz: 73537e1167da16936197c508bdb76c055d772bde2ef5b9666d67bf9e2da92de1b6355e2f73897dd190bec009959757fcba40d16348d75f6722da6f6930d4f5b1
+  metadata.gz: 4d6f9ead256561e209ca730845bb0440f3f56c02258c0b4b4cf18073cb1c0390028b75e40569bf8291c16935cd893d4436810fa62dc1ef28bd7d2bf143196caa
+  data.tar.gz: b7004600a91234ad992858335f987f4966ea32f7ad497b7ce483384a2ff2ca52e60116346cad5f45ed0dc7bf645fc97ac343019b1d54bea989debc94648b483a

data/adspower-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name        = 'adspower-client'
-    s.version     = '1.0.7'
+    s.version     = '1.0.9'
     s.date        = '2024-02-07'
     s.summary     = "Ruby library for operating AdsPower API."
     s.description = "Ruby library for operating AdsPower API."

data/lib/adspower-client.rb

@@ -8,7 +8,7 @@ require 'watir'
 class AdsPowerClient    
     # reference: https://localapi-doc-en.adspower.com/
     # reference: https://localapi-doc-en.adspower.com/docs/Rdw7Iu
-    attr_accessor :key, :adspower_listener, :adspower_default_browser_version
+    attr_accessor :key, :port, :server_log, :adspower_listener, :adspower_default_browser_version
     
     # control over the drivers created, in order to don't create the same driver twice and don't generate memory leaks.
     # reference: https://github.com/leandrosardi/adspower-client/issues/4
@@ -16,11 +16,47 @@ class AdsPowerClient
 
     def initialize(h={})
         self.key = h[:key] # mandatory
-        self.adspower_listener = h[:adspower_listener] || 'http://127.0.0.1:50325'
+        self.port = h[:port] || '50325'
+        self.server_log = h[:server_log] || '~/adspower-client.log'
+        self.adspower_listener = h[:adspower_listener] || 'http://127.0.0.1'
         self.adspower_default_browser_version = h[:adspower_default_browser_version] || '116'
 #        self.profiles_created = []
     end
 
+    # return an array of PIDs of all the adspower_global processes running in the local computer.
+    def server_pids
+        `ps aux | grep "adspower_global" | grep -v grep | awk '{print $2}'`.split("\n")
+    end
+
+    # return true if there is any adspower_global process running in the local computer.
+    def server_running?
+        self.server_pids.size > 0
+    end
+
+    # run async command to start adspower server in headless mode.
+    # wait up to 10 seconds to start the server, or raise an exception.
+    def server_start(timeout=10)
+        `/usr/bin/adspower_global --headless=true --api-key=#{ADSPOWER_API_KEY} --api-port=#{ADSPOWER_PORT} > #{self.server_log} 2>&1 &`
+        # wait up to 10 seconds to start the server
+        timeout.times do
+            break if self.server_running?
+            sleep(1)
+        end
+        # add a delay of 5 more seconds
+        sleep(5)
+        # raise an exception if the server is not running
+        raise "Error: the server is not running" if self.server_running? == false
+        return
+    end
+
+    # kill all the adspower_global processes running in the local computer.
+    def server_stop
+        self.server_pids.each { |pid|
+            `kill -9 #{pid}`
+        }
+        return
+    end
+    
     # send an GET request to "#{url}/status".
     # Return true if it responded successfully.
     # 
@@ -28,7 +64,7 @@ class AdsPowerClient
     # 
     def online?
         begin
-            url = "#{self.adspower_listener}/status"
+            url = "#{self.adspower_listener}:#{port}/status"
             uri = URI.parse(url)
             res = Net::HTTP.get(uri)
             # show respose body
@@ -48,7 +84,7 @@ class AdsPowerClient
     # reference: https://localapi-doc-en.adspower.com/docs/Awy6Dg
     # 
     def create
-        url = "#{self.adspower_listener}/api/v1/user/create"
+        url = "#{self.adspower_listener}:#{port}/api/v1/user/create"
         body = {
             #'api_key' => self.key,
             'group_id' => '0',
@@ -69,7 +105,7 @@ class AdsPowerClient
     end
 
     def delete(id)
-        url = "#{self.adspower_listener}/api/v1/user/delete"
+        url = "#{self.adspower_listener}:#{port}/api/v1/user/delete"
         body = {
             'api_key' => self.key,
             'user_ids' => [id],
@@ -88,7 +124,8 @@ class AdsPowerClient
     # reference: https://localapi-doc-en.adspower.com/docs/FFMFMf
     # 
     def start(id, headless=false)
-        uri = URI.parse("#{self.adspower_listener}/api/v1/browser/start?user_id=#{id}&headless=#{headless ? '1' : '0'}'}")
+        url = "#{self.adspower_listener}:#{port}/api/v1/browser/start?user_id=#{id}&headless=#{headless ? '1' : '0'}"
+        uri = URI.parse(url)
         res = Net::HTTP.get(uri)
         # show respose bo
         ret = JSON.parse(res)
@@ -103,7 +140,13 @@ class AdsPowerClient
     # reference: https://localapi-doc-en.adspower.com/docs/DXam94
     # 
     def stop(id)
-        uri = URI.parse("#{self.adspower_listener}/api/v1/browser/stop?user_id=#{id}")
+        # if the profile is running with driver, kill chromedriver
+        if @@drivers[id] && self.check(id)
+            @@drivers[id].quit
+            @@drivers[id] = nil
+        end
+
+        uri = URI.parse("#{self.adspower_listener}:#{port}/api/v1/browser/stop?user_id=#{id}")
         res = Net::HTTP.get(uri)
         # show respose body
         ret = JSON.parse(res)
@@ -119,7 +162,7 @@ class AdsPowerClient
     # reference: https://localapi-doc-en.adspower.com/docs/YjFggL
     # 
     def check(id)
-        url = "#{self.adspower_listener}/api/v1/browser/active?user_id=#{id}"
+        url = "#{self.adspower_listener}:#{port}/api/v1/browser/active?user_id=#{id}"
         uri = URI.parse(url)
         res = Net::HTTP.get(uri)
         # show respose body

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adspower-client
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Leandro Daniel Sardi