stealth_browser_automation 0.0.11 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e15ce32c691b1275e45f3c5dfbe1019326da8e6
-  data.tar.gz: f2668f3d84ce33b82a6247917460e8709ab66a10
+  metadata.gz: c572d341b87a3b41503bba5fe37f805133d48ebc
+  data.tar.gz: c5e1a0d4d749cfe28ebfab77b3e0d82344588126
 SHA512:
-  metadata.gz: cf31bbe3e6dcc0a5fbd751362bcf29b0cc0908486549e4ac4cca6d8c0be4239a4a7d854a6f4c629cd0b3c65cb4b80c5a17e834465af6590afb9b4455b8da4395
-  data.tar.gz: 5ff3fb6c7ffd04918856d67b37b8b3f4dfc5ef23d1b308efd668c4c50cdb90e04c2e028a42bd5e4d0fb528d714cbc8b4586ac5aa06a8aa4654d4105f09ceb361
+  metadata.gz: 8f880759a9c4ec4e9354eb42c9dabf4122ccb5f5ab5f86c69ad0793528a766916bc49c8513d9e1b85e31b8520ade556b59b43810ed76d1b167567dc40469a63d
+  data.tar.gz: fd4321ed247d53561f45f38176748539fe1cfb78dd4be4ae9c780bc733cf75af1eb8e6922af33628a24348384bccd0e5c99b069be91136029962bcb10e7fbe48

data/lib/browserfactory.rb

@@ -1,12 +1,112 @@
 require 'watir-webdriver'
 require "pathname"
 
+# **ABSTRACT**
+# 
+# PampaBrowser should pull a screenshot every N seconds, from a thread.
+# But can't operate the same browser from more than 1 thread.
+# More information here:
+# https://stackoverflow.com/questions/28093347/is-selenium-webdriver-thread-safe  
+#
+# Should use a lockfile.
+# More information here:
+# https://bibwild.wordpress.com/2015/01/15/ruby-threads-gotcha-with-local-vars-and-shared-state/
+# https://stackoverflow.com/questions/55895952/ruby-how-do-i-share-a-global-variable-amongst-threads-that-are-running-an-objec
+# 
+# So, I should overwrite all methods of the Selenium::Browser, Selenium::Element, and also Watir::Wait  
+# More information here:
+# https://stackoverflow.com/questions/6966708/how-to-add-statements-to-an-existing-method-definition-in-ruby
+# https://stackoverflow.com/questions/44577888/ruby-alias-method-for-module-static-method
+#
+#
+# **The "frequency-based-streaming" model**
+#
+# At this moment, I couldn't overwrite Watir::Wait's methods.
+# At this moment, PampaBrowser is simple sending the screenshot when some particular methods has been called,
+# but this appreach is not updating the screen when the website load new contenct thru AJAX with not need of
+# and user interaction.
+# 
+
+module Selenium
+  module WebDriver
+    class Element
+      alias_method :old_click, :click
+      
+      def click()
+        old_click 
+        BlackStack::BrowserFactory.browser.push_screenshot
+      end # def click
+      
+    end # class Element
+  end # module WebDriver
+end # module Selenium
+
 module BlackStack
 
   class PampaBrowser < Watir::Browser
+
+    # TODO: enable this when you move to the "frequency-based-streaming" model
+    #PAMPA_BROWSER_CHANNEL_LOCK_FILENAME = './browserfactory.channel.%PRFILE_NAME%.lock' # manejo de concurrencia en la creación de browsers
+    #attr_accessor  :lockfile
     
     attr_accessor :proxy, :lnuser, :agent_name, :profile_name
-   
+
+    def lock_channel()
+      self.lockfile.flock(File::LOCK_EX)
+    end
+  
+    def release_channel()
+      self.lockfile.flock(File::LOCK_UN)
+    end
+
+    def initialize(driver)
+      # TODO: enable this when you move to the "frequency-based-streaming" model
+      #fname = PAMPA_BROWSER_CHANNEL_LOCK_FILENAME.gsub('%PRFILE_NAME%', self.profile_name.to_s)
+      #self.lockfile = File.open(fname,"w")
+      
+      #
+      super(driver)
+
+      # TODO: enable this when you move to the "frequency-based-streaming" model
+=begin
+      # Can't operate the same browser from more than 1 thread.
+      # More information here:
+      # https://stackoverflow.com/questions/28093347/is-selenium-webdriver-thread-safe  
+      #
+      # https://bibwild.wordpress.com/2015/01/15/ruby-threads-gotcha-with-local-vars-and-shared-state/
+      # https://stackoverflow.com/questions/55895952/ruby-how-do-i-share-a-global-variable-amongst-threads-that-are-running-an-objec
+      #
+      t0 = Thread.new {
+        minimum_enlapsed_seconds = 5.to_f
+        while true 
+          start_time = Time.now
+          t1 = Thread.new(self) do |t_browser|
+            #while true
+              begin
+                self.lock_channel
+                sleep(1) # para esperar a que se ejecute la sentencia t1.join debajo
+                t_browser.push_screenshot
+                self.release_channel
+              rescue => e
+                # Communication with the chrome driver errors may occur.
+                # If an exception happens here and it is not catched, then
+                # then the thread will stop workng and the streaming will
+                # stop.
+              end
+            #end # while true
+          end # Thread.new
+          t1.join
+          end_time = Time.now
+          elapsed_seconds = (end_time - start_time).to_f
+          if (elapsed_seconds < minimum_enlapsed_seconds)
+            sleep_seconds = minimum_enlapsed_seconds - elapsed_seconds 
+            sleep(sleep_seconds.to_i + 1)
+          end # if
+        end # while true            
+      } # Thread.new
+=end
+    end # def initialize 
+
     def notify(method)
       url = "#{BlackStack::Pampa::api_protocol}://#{PROCESS.ws_url}:#{PROCESS.ws_port}/api1.3/pampa/browser/notify.json"
       res = BlackStack::Netting::call_post(url, {
@@ -25,7 +125,7 @@ module BlackStack
         raise "Error Tracing BrowserActivity: #{parsed['status']}"
       end
     end
-  
+
     def push_screenshot(filename=nil)
       filename = "#{PROCESS.fullWorkerName}.png" if filename.nil?
       BrowserFactory::screenshot(filename)
@@ -40,6 +140,7 @@ module BlackStack
       url = "#{BlackStack::Pampa::api_protocol}://#{PROCESS.ws_url}:#{PROCESS.ws_port}/api1.3/pampa/browser/screenshot.json"
       res = RestClient::Request.execute(
         :api_key => BlackStack::Pampa::api_key,
+        :id_client => PROCESS.id_client,
         :verify_ssl => false,
         :url => url, 
         :method => :post, 
@@ -64,73 +165,80 @@ module BlackStack
     def back
       self.notify("back")
       super
-      self.push_screenshot
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def forward
       self.notify("forward")
       super
-      self.push_screenshot
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def execute_script(script, *args)
       self.notify("execute_script")
       super
-      self.push_screenshot
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
   
     def goto(url)
       self.notify("goto")
       super
-      self.push_screenshot
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
   
     def screenshot
       self.notify("screenshot")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def reset!
       self.notify("reset!")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def refresh
       self.notify("refresh")
       super
-      self.push_screenshot
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def inspect
       self.notify("inspect")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
     
-=begin # se da de baja, porque incremente el # de llamadas a la API de 800/hora a 5000/hora, y eso requiere mas infraestructura
     def send_keys(*args)
-      self.notify("send_keys")
+      # no se notifica el evento, porque incremente el # de llamadas a la API de 800/hora a 5000/hora, y eso requiere mas infraestructura
+      #self.notify("send_keys")
       super
+      #BlackStack::BrowserFactory.browser.push_screenshot
     end
-=end
   
     def text
       self.notify("text")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def title
       self.notify("title")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def url
       self.notify("url")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
       
     def wait(timeout = 5)
       self.notify("wait")
       super
+      BlackStack::BrowserFactory.browser.push_screenshot
     end
   end # class PampaBrowser
   
@@ -187,6 +295,9 @@ module BlackStack
     @@pid = nil
     @@profile_name = nil
   
+    def self.browser()
+      @@browser
+    end
   
     def self.lockProfileList()
   #    @@fd_profile.flock(File::LOCK_EX)
@@ -203,7 +314,6 @@ module BlackStack
 =end
     end
   
-  
     # NOTA: esta lista debe estar permitida por LinkedIn. De caso contrario, aparecera el mensaje "Upgrad your browser"
     # Se puede obtener una lista actualizada de este sitio: https://techblog.willshouse.com/2012/01/03/most-common-user-agents/
     @@arAgents = [

data/lib/proxy.rb

@@ -60,7 +60,7 @@ module BlackStack
     end
   
     # TODO: Reemplazar el parametro records_before_long_sleep por un registro en la tabla PARAMS
-    def endJob(id_object, result, description, records_before_long_sleep)
+    def endJob(id_client, result, description, records_before_long_sleep)
   # => #464
 =begin
       DB.execute("UPDATE proxy SET reservation_end_time=GETDATE(), reservation_result='#{result.to_s}', reservation_description='#{description.to_s}' WHERE [id]='#{self.id}'")
@@ -68,7 +68,7 @@ module BlackStack
       DB.execute(
         "EXEC dbo.endProxyJob " +
         "'#{self.id}', " +
-        "'#{id_object}', " +
+        "'#{id_client}', " +
         "#{result.to_s}, " +
         "'#{description.to_s}', " +
         "#{records_before_long_sleep.to_s} "

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth_browser_automation
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 1.1.1
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -131,47 +131,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.28.0
 - !ruby/object:Gem::Dependency
-  name: blackstack_commons
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.20
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.20
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.20
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.20
-- !ruby/object:Gem::Dependency
-  name: simple_cloud_logging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.16
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.16
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.16
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.16
-- !ruby/object:Gem::Dependency
-  name: simple_command_line_parser
+  name: pampa_workers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -190,26 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
-- !ruby/object:Gem::Dependency
-  name: pampa_workers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.39
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.39
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.39
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.39
 description: 'THIS GEM IS STILL IN DEVELOPMENT STAGE. Find documentation here: https://github.com/leandrosardi/stealth_browser_automation.'
 email: leandro.sardi@expandedventure.com
 executables: []