adspower-client 1.0.12 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f1a3cd88b7f76b1514641e9fbc54b2c1b7dd15945da9f07533be8bb9782a812
-  data.tar.gz: b6d7708277cbaeae8cad513362a29b2260b4ee516b88a698894a0d0284cc32e0
+  metadata.gz: 78c1201b2d2e5a524b67b7cac64506ba9afc2538e9890a387a02252387dd1259
+  data.tar.gz: c82ad9106e87929604fc7242e13680cdeddef6e0ede4e1bfe8181eb7e5c042d9
 SHA512:
-  metadata.gz: da5102f80bac0665d4117ab96d76ebfc6a82e8421ef8b61f0c5bed11429a9d11d218e1711b6e99e14b8778c54b139ab5ba4d84c4d0733b3f69ebea83a6e6d0fc
-  data.tar.gz: 9ec0a6920213f25c472a749b91231c2a33241d00093c5a32e166f3ee3fee3c40ff22189ec5f6bcf2b8b40a436b5ee6cfee3fe14bb17ca703e792e528fbe3f915
+  metadata.gz: 4a9ef2494df3d2c2adbd7d9d16286ff2b5e5b05f0f1872c32cb3d0439db1d915df5c4de9b2ff1a2321e09f96dccd4122da266f749c4c7f9fd89d45490144e2f4
+  data.tar.gz: a1d62383908125640ea807fcd96e38577c821ee7f4785b37936666aa892fa2462d6897c06861f084f265a431391dcf523424cff2a4799244e0b5fdd24cb59266

data/adspower-client.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
     s.name        = 'adspower-client'
-    s.version     = '1.0.12'
-    s.date        = '2024-10-07'
+    s.version     = '1.0.15'
+    s.date        = '2025-07-17'
     s.summary     = "Ruby library for operating AdsPower API."
     s.description = "Ruby library for operating AdsPower API."
     s.authors     = ["Leandro Daniel Sardi"]

data/lib/adspower-client.rb

@@ -6,10 +6,12 @@ require 'selenium-webdriver'
 require 'watir'
 require 'fileutils'
 
-class AdsPowerClient    
+class AdsPowerClient  
+    CLOUD_API_BASE = 'https://api.adspower.com/v1'
+
     # reference: https://localapi-doc-en.adspower.com/
     # reference: https://localapi-doc-en.adspower.com/docs/Rdw7Iu
-    attr_accessor :key, :port, :server_log, :adspower_listener, :adspower_default_browser_version
+    attr_accessor :key, :port, :server_log, :adspower_listener, :adspower_default_browser_version, :cloud_token
 
     # control over the drivers created, in order to not create the same driver twice and not generate memory leaks.
     # reference: https://github.com/leandrosardi/adspower-client/issues/4
@@ -22,7 +24,12 @@ class AdsPowerClient
         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'
+        
+        # DEPRECATED
         self.adspower_default_browser_version = h[:adspower_default_browser_version] || '116'
+
+        # PENDING
+        self.cloud_token = h[:cloud_token]
     end
 
     # Acquire the lock
@@ -89,6 +96,54 @@ class AdsPowerClient
         end
     end
 
+    # Count current profiles (optionally filtered by group)
+    def profile_count(group_id: nil)
+        count = 0
+        page  = 1
+
+        loop do
+        params = { page: page, limit: 100 }
+        params[:group_id] = group_id if group_id
+        url   = "#{adspower_listener}:#{port}/api/v2/browser-profile/list"
+        res   = BlackStack::Netting.call_post(url, params)
+        data  = JSON.parse(res.body)
+        raise "Error listing profiles: #{data['msg']}" unless data['code'] == 0
+
+        list = data['data']['list']
+        count += list.size
+        break if list.size < 100
+
+        page += 1
+        end
+
+        count
+    end
+
+    # Return a hash with:
+    #  • :limit     ⇒ total profile slots allowed (-1 = unlimited)
+    #  • :used      ⇒ number of profiles currently created
+    #  • :remaining ⇒ slots left (nil if unlimited)
+    # Fetch your real profile quota from the Cloud API
+    def cloud_profile_quota
+        uri = URI("#{CLOUD_API_BASE}/account/get_info")
+        req = Net::HTTP::Get.new(uri)
+        req['Authorization'] = "Bearer #{self.cloud_token}"
+
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(req)
+        end
+        data = JSON.parse(res.body)
+        raise "Cloud API error: #{data['msg']}" unless data['code'] == 0
+
+        allowed = data['data']['total_profiles_allowed'].to_i
+        used    = data['data']['profiles_used'].to_i
+        remaining = allowed < 0 ? nil : (allowed - used)
+
+        { limit:     allowed,
+        used:      used,
+        remaining: remaining }
+    end # cloud_profile_quota
+
     # Create a new user profile via API call and return the ID of the created user.
     def create
         with_lock do
@@ -106,8 +161,62 @@ class AdsPowerClient
             raise "Error: #{ret.to_s}" if ret['msg'].to_s.downcase != 'success'
             ret['data']['id']
         end
-    end
+    end # def create
+
+    # Create a new desktop profile with custom name, proxy, and fingerprint settings
+    #
+    # @param name            [String] the profile’s display name
+    # @param proxy_config    [Hash]   keys: :ip, :port, :user, :password, :proxy_soft (default 'other'), :proxy_type (default 'http')
+    # @param group_id        [String] which AdsPower group to assign (default '0')
+    # @param browser_version [String] Chrome version to use (must match Chromedriver), defaults to adspower_default_browser_version
+    # @return String the new profile’s ID
+    def create2(name:, proxy_config:, group_id: '0', browser_version: nil)
+        browser_version ||= adspower_default_browser_version
+
+        with_lock do
+            url = "#{adspower_listener}:#{port}/api/v2/browser-profile/create"
+            body = {
+                'name'            => name,
+                'group_id'        => group_id,
+                'user_proxy_config' => {
+                'proxy_soft'     => proxy_config[:proxy_soft]     || 'other',
+                'proxy_type'     => proxy_config[:proxy_type]     || 'http',
+                'proxy_host'     => proxy_config[:ip],
+                'proxy_port'     => proxy_config[:port].to_s,
+                'proxy_user'     => proxy_config[:user],
+                'proxy_password' => proxy_config[:password]
+                },
+                'fingerprint_config' => {
+                    # 1) Chrome kernel version → must match your Chromedriver
+                    'browser_kernel_config' => {
+                        'version' => browser_version,
+                        'type'    => 'chrome'
+                    },
+                    # 2) Auto‐detect timezone (and locale) from proxy IP
+                    'automatic_timezone' => '1',
+                    'timezone'           => '',
+                    'language'           => [],
+                    # 3) Force desktop UA (no mobile): empty random_ua & default UA settings
+                    'ua' => "Mozilla/5.0 (Windows NT 10.0; Win64; x64) "\
+"AppleWebKit/537.36 (KHTML, like Gecko) Chrome/#{browser_version}.0.0.0 Safari/537.36",
+                    'ua_category' => 'desktop',
+                    #'screen_resolution' => '1920*1080',
+                    'is_mobile' => false,
+                    # standard desktop fingerprints
+                    'webrtc'  => 'disabled',  # hide real IP via WebRTC
+                    'flash'   => 'allow',
+                    'fonts'   => [],          # default fonts
+                }
+            }
+
+            res = BlackStack::Netting.call_post(url, body)
+            ret = JSON.parse(res.body)
+            raise "Error creating profile: #{ret['msg']}" unless ret['code'] == 0
 
+            ret['data']['profile_id']
+        end
+    end # def create2
+    
     # Delete a user profile via API call.
     def delete(id)
         with_lock do
@@ -186,6 +295,36 @@ class AdsPowerClient
         driver
     end
 
+    # Attach to the existing browser session with Selenium WebDriver.
+    def driver2(id, headless: false, read_timeout: 180)
+        # Return the existing driver if it's still active.
+        old = @@drivers[id]
+        return old if old
+
+        # Otherwise, start the driver
+        ret = self.start(id, headless)
+
+        # Attach test execution to the existing browser
+        url = ret['data']['ws']['selenium']
+        opts = Selenium::WebDriver::Chrome::Options.new
+        opts.add_option("debuggerAddress", url)
+
+        # Set up the custom HTTP client with a longer timeout
+        client = Selenium::WebDriver::Remote::Http::Default.new
+        client.read_timeout = read_timeout # Set this to the desired timeout in seconds
+
+        # Connect to the existing browser
+        driver = Selenium::WebDriver.for(:chrome, options: opts, http_client: client)
+
+        # Save the driver
+        @@drivers[id] = driver
+
+        # Return the driver
+        driver
+    end
+
+    # DEPRECATED - Use Zyte instead of this method.
+    #
     # Create a new profile, start the browser, visit a page, grab the HTML, and clean up.
     def html(url)
         ret = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adspower-client
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.15
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri