adspower-client 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c501652495782fd4189744be32dc8fa7b9aa0a11239b0ee168c7328c4dc7413b
-  data.tar.gz: 77b0955f0b309282a341f90b1fc7117e80dfe7a69b4dbb3482a7ebfbc784dcd9
+  metadata.gz: 1289e195355621cc166ac8cb97668015390fa31b5bb0db7579c7b397bad31fcf
+  data.tar.gz: b467fd3a6e5bbbcec7ddf207b1ce2909e480db5fc66849548be27154414bac32
 SHA512:
-  metadata.gz: 23dbb293d7261bd1ddbeefc2dfa681e2d66a6731c3104483a17917c342fbb2e003fdab74b7a93caeb48165cfddd52e90db5c52725d368e336666c71d5db034f5
-  data.tar.gz: e250a7ac45157d749b52091353db11202e15ad7c91a647fc4ef9ca476638b69de0bc736e9c5ed75fd35f994356ab660a955ad170c1d43482c7d1a66cc15ea0e1
+  metadata.gz: a9ae982a04c8e734bf33bb2864ae247c8ce180b136c79e290d6dadabd0957b0ca33b1b2f62cff06fef5fcd12b4f4f9f5eb61fe24eed489d562210cdbc1c9cf84
+  data.tar.gz: 72a3f7138ee351ee425ca9aa7243a70e8951f5a04df357257734e991a180dc2e207782fd9d858f61462747d4576eee05820c9adb4dc685c35f5a74cbf7f280b4

data/adspower-client.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
     s.name        = 'adspower-client'
-    s.version     = '1.0.2'
-    s.date        = '2023-12-05'
+    s.version     = '1.0.4'
+    s.date        = '2023-12-31'
     s.summary     = "Ruby library for operating AdsPower API."
     s.description = "Ruby library for operating AdsPower API."
     s.authors     = ["Leandro Daniel Sardi"]
@@ -18,4 +18,7 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency 'blackstack-core', '~> 1.2.15', '>= 1.2.15'
     s.add_runtime_dependency 'selenium-webdriver', '~> 4.10.0', '>= 4.10.0'
     s.add_runtime_dependency 'watir', '~> 7.3.0', '>= 7.3.0'
+    s.add_runtime_dependency 'sequel', '~> 5.75.0', '>= 5.75.0'
+    s.add_runtime_dependency 'colorize', '~> 1.1.0', '>= 1.1.0'
+    s.add_runtime_dependency 'simple_cloud_logging', '~> 1.2.2', '>= 1.2.2'
 end

data/lib/adspower-client.rb

@@ -9,24 +9,30 @@ 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 :profiles_created
 
     def initialize(h={})
         self.key = h[:key] # mandatory
         self.adspower_listener = h[:adspower_listener] || 'http://127.0.0.1:50325'
         self.adspower_default_browser_version = h[:adspower_default_browser_version] || '116'
+#        self.profiles_created = []
     end
 
-    # send an GET request to "#{url}/status"
-    # and return the response body.
+    # send an GET request to "#{url}/status".
+    # Return true if it responded successfully.
     # 
     # reference: https://localapi-doc-en.adspower.com/docs/6DSiws
     # 
-    def status
-        url = "#{self.adspower_listener}/status"
-        uri = URI.parse(url)
-        res = Net::HTTP.get(uri)
-        # show respose body
-        return JSON.parse(res)['msg']
+    def online?
+        begin
+            url = "#{self.adspower_listener}/status"
+            uri = URI.parse(url)
+            res = Net::HTTP.get(uri)
+            # show respose body
+            return JSON.parse(res)['msg'] == 'success'
+        rescue => e
+            return false
+        end
     end
 
     # send a post request to "#{url}/api/v1/user/create"
@@ -53,6 +59,8 @@ class AdsPowerClient
         # show respose body
         ret = JSON.parse(res.body)
         raise "Error: #{ret.to_s}" if ret['msg'].to_s.downcase != 'success'
+        # add to array of profiles created
+#        self.profiles_created << ret
         # return id of the created user
         ret['data']['id']
     end
@@ -76,8 +84,8 @@ class AdsPowerClient
     # 
     # reference: https://localapi-doc-en.adspower.com/docs/FFMFMf
     # 
-    def start(id)
-        uri = URI.parse("#{self.adspower_listener}/api/v1/browser/start?user_id=#{id}")
+    def start(id, headless=false)
+        uri = URI.parse("#{self.adspower_listener}/api/v1/browser/start?user_id=#{id}&headless=#{headless ? '1' : '0'}'}")
         res = Net::HTTP.get(uri)
         # show respose bo
         ret = JSON.parse(res)
@@ -101,9 +109,25 @@ class AdsPowerClient
         ret
     end
 
+    # send an GET request to "#{url}/status"
+    # and return if I get the json response['data']['status'] == 'Active'.
+    # Otherwise, return false.
+    # 
+    # reference: https://localapi-doc-en.adspower.com/docs/YjFggL
+    # 
+    def check(id)
+        url = "#{self.adspower_listener}/api/v1/browser/active?user_id=#{id}"
+        uri = URI.parse(url)
+        res = Net::HTTP.get(uri)
+        # show respose body
+        return false if JSON.parse(res)['msg'] != 'success'
+        # return
+        JSON.parse(res)['data']['status'] == 'Active'
+    end
+
     #
-    def driver(id)
-        ret = self.start(id)
+    def driver(id, headless=false)
+        ret = self.start(id, headless)
 
         # Attach test execution to the existing browser
         # reference: https://zhiminzhan.medium.com/my-innovative-solution-to-test-automation-attach-test-execution-to-the-existing-browser-b90cda3b7d4a
@@ -128,13 +152,64 @@ class AdsPowerClient
     # delete the profile
     # return the html
     def html(url)
-        id = self.create
-        driver = self.driver(id)
-        driver.get(url)
-        html = driver.find_element(:tag_name => 'html')
-        self.stop(id)
-        driver.quit
-        self.delete(id)
-        html
-    end
+        ret = {
+            :profile_id => nil,
+            :html => nil,
+            :status => 'success',
+        }
+        id = nil
+        html = nil
+        begin
+            # create the profile
+            sleep(1) # Avoid the "Too many request per second" error
+            id = self.create
+
+            # update the result
+            ret[:profile_id] = id
+
+            # start the profile and attach the driver
+            driver = self.driver(id)
+
+            # get html
+            driver.get(url)
+            html = driver.page_source
+
+            # update the result
+            ret[:html] = html
+
+            # stop the profile
+            sleep(1) # Avoid the "Too many request per second" error
+            driver.quit
+            self.stop(id)
+
+            # delete the profile
+            sleep(1) # Avoid the "Too many request per second" error
+            self.delete(id)
+
+            # reset id
+            id = nil
+        rescue => e
+            # stop and delete current profile
+            if id
+                sleep(1) # Avoid the "Too many request per second" error
+                self.stop(id)
+                sleep(1) # Avoid the "Too many request per second" error
+                driver.quit
+                self.delete(id) if id
+            end # if id
+            # inform the exception
+            ret[:status] = e.to_s
+#        # process interruption
+#        rescue SignalException, SystemExit, Interrupt => e 
+#            if id
+#                sleep(1) # Avoid the "Too many request per second" error
+#                self.stop(id)
+#                sleep(1) # Avoid the "Too many request per second" error
+#                driver.quit
+#                self.delete(id) if id
+#            end # if id
+        end
+        # return
+        ret
+    end # def html
 end # class AdsPowerClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adspower-client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri
@@ -130,6 +130,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.3.0
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.75.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.75.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.75.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.75.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: simple_cloud_logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 description: Ruby library for operating AdsPower API.
 email: leandro@connectionsphere.com
 executables: []