stealth_browser_automation 1.1.34 → 1.2.38

data/lib/proxy.rb

@@ -5,9 +5,23 @@ module BlackStack
   # proxy almacenado en la base de datos
   class Proxy < Sequel::Model(:proxy)
     include BaseProxy
-  
     Proxy.dataset = Proxy.dataset.disable_insert_output
-    
+        
+    ##
+    # creates new connection to google.com using +Faraday+ lib. Uses CGI::Cookie class
+    # to parse the cookie returned in the response. It then checks for the presense of
+    # "NID" cookie set by Google. If the cookie exists, proxy server is working just fine.
+    #
+    # reference: https://github.com/apoorvparijat/proxy-test
+    # 
+    def test
+      if self.user.to_s.size > 0 && self.password.to_s.size > 0
+        return BlackStack::Proxy.test("#{self.ip}:#{self.port.to_s}")
+      else
+        return BlackStack::Proxy.test("#{self.user}:#{self.password}@#{self.ip}:#{self.port.to_s}")
+      end
+    end
+
     # TODO: deprecated
     def self.availablesWithStealth(
           process, 

data/lib/stealth_browser_automation.rb

@@ -1,3 +1,4 @@
+require 'faraday'
 require 'mini_magick'
 require 'rest_client'
 require 'pampa_workers'
@@ -9,17 +10,198 @@ require_relative './browserfactory'
 module BlackStack
 
   module StealthBrowserAutomation
-    
+# TODO: Develop this!
+=begin
+    module RQuery
+
+      # TODO: doc me
+      def self.set(h)
+        # TODO: code me
+      end
+
+      # Create custom exceptions
+      # More information: https://www.honeybadger.io/blog/ruby-custom-exceptions/
+      class ElementNotFound < StandardError
+        # TODO: code me
+      end
+
+      # Create custom exceptions
+      # More information: https://www.honeybadger.io/blog/ruby-custom-exceptions/
+      class UntilTimeout < StandardError
+        # TODO: code me
+      end
+
+      # Create custom exceptions
+      # More information: https://www.honeybadger.io/blog/ruby-custom-exceptions/
+      class WhileTimeout < StandardError
+        # TODO: code me
+      end
+
+      # TODO: doc me
+      class ElementCollection
+        # array of watir elements
+        attr_accessor :elements
+
+        # TODO: doc me
+        def initialize()
+          self.elements = []
+        end 
+
+        # TODO: doc me
+        def size()
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def count()
+          self.size
+        end
+
+        # TODO: doc me
+        def get(n)
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def first
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def last
+          # TODO: code me
+        end
+      end
+
+      # TODO: doc me
+      class TextFieldCollection < BlackStack::StealthBrowserAutomation::RQuery::ElementCollection
+        # TODO: doc me
+        def get(n)
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def first
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def last
+          # TODO: code me
+        end
+      end # class TextFieldCollection
+
+      # TODO: doc me
+      class ButtonCollection < BlackStack::StealthBrowserAutomation::RQuery::ElementCollection
+        # TODO: doc me
+        def get(n)
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def first
+          # TODO: code me
+        end
+
+        # TODO: doc me
+        def last
+          # TODO: code me
+        end
+      end # class ButtonCollection
+
+      # TODO: doc me
+      class Element
+
+        # return true if there is one or more elemnts in the screenshot that match with the cutout 
+        def exists?
+          # TODO: code me
+        end
+
+        # return the watir element
+        # raise ElementNotFound exception if the element does not exist.
+        def wc
+          # TODO: code me
+        end
+
+      end # class Element
+
+      # TODO: doc me
+      class TextField < BlackStack::StealthBrowserAutomation::RQuery::Element
+        # return the watir textfield
+        # raise ElementNotFound exception if the element does not exist.
+        def wc
+          # TODO: code me
+        end
+      end # class TextField
+
+      # TODO: doc me
+      class Button < BlackStack::StealthBrowserAutomation::RQuery::Element
+        # return the watir button
+        # raise ElementNotFound exception if the element does not exist.
+        def wc
+          # TODO: code me
+        end
+      end # class Button
+
+
+      class FixedMatching
+        attr_accessor :br
+
+        # TODO: doc me
+        def initialize(init_br)
+          self.br = init_br
+        end
+
+        # return a BlackStack::StealthBrowserAutomation::RQuery::TextField
+        def text_field(image_path, options={})
+          # TODO: code me
+        end
+
+        # return a BlackStack::StealthBrowserAutomation::RQuery::TextFields
+        def text_fields(image_path, options={})
+          # TODO: code me
+        end
+
+        # return a BlackStack::StealthBrowserAutomation::RQuery::Button
+        def button(image_path, options={})
+          # TODO: code me
+        end
+
+        # return a BlackStack::StealthBrowserAutomation::RQuery::Buttons
+        def buttons(image_path, options={})
+          # TODO: code me
+        end
+
+        # how to write a function that receive a block of code between {} ?
+        # more infromation: https://flylib.com/books/en/2.44.1/writing_a_method_that_accepts_a_block.html
+        # 
+        # raise UntilTimeout exception if the condition is never true during the timeout period.
+        def until(timeout)
+          # TODO: code me
+        end
+
+        # how to write a function that receive a block of code between {} ?
+        # more infromation: https://flylib.com/books/en/2.44.1/writing_a_method_that_accepts_a_block.html
+        # 
+        # raise WhileTimeout exception if the condition is never false during the timeout period.
+        def while(timeout)
+          # TODO: code me
+        end
+
+      end # class FixedMatching
+
+    end # module RQuery
+=end
     module Multilogin
-      # 
-      @@auth_token = nil
+      VERSION_4 = '4.5.1'
+      VERSION_5 = '5'
+      ALLOWED_VERSIONS = [VERSION_4, VERSION_5]
+
+      #
       @@mla_version = nil
       @@mla_local_port = nil
-  
-      def self.auth_token()
-        @@auth_token
-      end
-  
+      @@mla_app_properties_file = nil
+
       def self.mla_version()
         @@mla_version
       end
@@ -29,11 +211,39 @@ module BlackStack
       end
   
       def self.set(h)
-        @@auth_token = h[:auth_token]
+        raise "Unknown mla_version. Allowed values are #{ALLOWED_VERSIONS.join(', ')}." if !ALLOWED_VERSIONS.include? h[:mla_version]
+
         @@mla_version = h[:mla_version]
-        @@mla_local_port = h[:mla_local_port]
+        x = h[:mla_local_port]
+        port = x.is_a?(Array) ? x[rand(0..x.size-1)] : x
+        @@mla_local_port = port
+        @@mla_app_properties_file = h[:mla_app_properties_file]
       end
-    
+
+      def self.properties_hash()
+        filename = @@mla_app_properties_file
+        key = 'multiloginapp.auth_tkn'
+        h = {}
+        File.foreach(filename).map { |line| 
+          a = line.split('=')
+        }.each { |a|
+          h[ a[0].gsub(/[^0-9a-z\.\_\- ]/i, '').strip ] = a[1].gsub(/[^0-9a-z\.\_\- ]/i, '').strip
+        }
+        h
+      end
+
+      def self.auth_token()
+        self.properties_hash['multiloginapp.auth_tkn']
+      end
+
+      # ---------------------------------------------------------------------------------
+      # ---------------------------------------------------------------------------------
+      # --- LOCAL PROFILES MANAGEMENT
+      # --- TODO: Enable this when develop support for Multilogin Local Profiles
+      # ---------------------------------------------------------------------------------
+      # ---------------------------------------------------------------------------------
+# TODO: Develop this if we start working with local profiles at some point
+=begin
       # returns the profileId of the new Mimic profile
       def self.create_local_profile(data)
         url = "http://127.0.0.1:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port.to_s}/api/v2/localprofile/create"
@@ -84,33 +294,133 @@ module BlackStack
         return nil if h.nil?
         h['sid']
       end # def self.delete_profile
+=end
+
+      # ---------------------------------------------------------------------------------
+      # ---------------------------------------------------------------------------------
+      # --- CLOUD PROFILES MANAGEMENT
+      # --- 
+      # ---------------------------------------------------------------------------------
+      # ---------------------------------------------------------------------------------
+
+      # migrate a profile from Multilogin-4 to Multilogin-5
+      # Multilogin 5 required for upgrading profiles. Therefore, MLS5 is required to run this method
+      def self.upgrade(profile_id)
+        url = nil
+        ssl = nil
+
+        if @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_5
+          url = "http://localhost.multiloginapp.com:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port.to_s}/api/v2/profile/#{profile_id}/migrate"
+          ssl = false
+        else 
+          raise 'Invalid Multilogin Version (Multilogin 5 required for upgrading profiles)'
+        end
+
+        uri = URI(url)
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+          req = Net::HTTP::Post.new(uri)
+          req['Content-Type'] = 'application/json'
+          if http.request(req).body
+            res = JSON.parse(http.request(req).body)
+            if res["status"] == 'ERROR' && res["message"].include?('Update') 
+            	Multilogin::update_profile(profile_id)
+            	upgrade(profile_id)
+            elsif !res.has_key?('uuid')
+              if res.to_s =~ /Profile is already migrated/ # TODO: Do a proper processing of the response json
+                return
+              else
+                raise "Error migrating Multilogin profile: #{res.to_s}"
+              end
+            end
+          end
+        end
+      end # def self.delete_profile
+      
+      #Updates the browser core to the latest version
+      # Multilogin 5 required for upgrading profiles. Therefore, MLS5 is required to run this method
+      def self.update_profile(profile_id)
+        url = nil
+        ssl = nil
+
+        if @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_5
+          url = "http://localhost.multiloginapp.com:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port.to_s}/api/v2/profile/#{profile_id}/update"
+          ssl = false
+        else 
+          raise 'Invalid Multilogin Version (Multilogin 5 required for upgrading profiles)'
+        end
+
+        uri = URI(url)
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+          req = Net::HTTP::Post.new(uri)
+          req['Content-Type'] = 'application/json'
+          if http.request(req).body
+            res = JSON.parse(http.request(req).body)
+            raise "Error updating Multilogin profile: #{res.to_s}" if !res.has_key?('uuid')
+          end
+        end
+      end
 
       # returns the profileId of the new Mimic profile
       def self.create_profile(data)
-        url = "https://api.multiloginapp.com/v2/profile?token=#{BlackStack::StealthBrowserAutomation::Multilogin::auth_token.to_s}&mlaVersion=#{BlackStack::StealthBrowserAutomation::Multilogin::mla_version.to_s}"
+        url = nil
+        ssl = nil
+
+        if @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_4
+#puts
+#puts '4.create'          
+          url = "https://api.multiloginapp.com/v2/profile?token=#{BlackStack::StealthBrowserAutomation::Multilogin::auth_token.to_s}&mlaVersion=#{BlackStack::StealthBrowserAutomation::Multilogin::mla_version.to_s}"
+#puts url
+          ssl = true
+        elsif @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_5
+#puts
+#puts '5.create'
+          url = "http://localhost.multiloginapp.com:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port.to_s}/api/v2/profile"
+          ssl = false
+        else 
+          raise 'Invalid Multilogin Version'
+        end
+
         uri = URI(url)
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => true, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
           req = Net::HTTP::Post.new(uri)
           req['Content-Type'] = 'application/json'
           req.body = data.to_json
           res = JSON.parse(http.request(req).body)
           raise "Error creating Multilogin profile: #{res.to_s}" if !res.has_key?('uuid')
           return res['uuid']
-        end
+        end  
       end
 
       # returns the profileId of the new Mimic profile
       def self.remove_profile(profile_id)
-        url = "https://api.multiloginapp.com/v1/profile/remove?token=#{BlackStack::StealthBrowserAutomation::Multilogin::auth_token.to_s}&profileId=#{profile_id}"
-        uri = URI.parse(url)
-        req = Net::HTTP::Get.new(url)
-        res = Net::HTTP.start(uri.host, uri.port, :use_ssl => true, :verify_mode => OpenSSL::SSL::VERIFY_NONE) {|http|
-          http.request(req)
+        url = nil
+        ssl = nil
+
+        if @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_4
+#puts
+#puts '4.remove'          
+          url = "https://api.multiloginapp.com/v2/profile/#{profile_id}?token=#{BlackStack::StealthBrowserAutomation::Multilogin::auth_token.to_s}"
+          ssl = true
+        elsif @@mla_version == BlackStack::StealthBrowserAutomation::Multilogin::VERSION_5
+#puts
+#puts '5.remove'
+          url = "http://localhost.multiloginapp.com:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port.to_s}/api/v2/profile/#{profile_id}"
+          ssl = false
+        else
+          raise 'Invalid Multilogin Version'
+        end
+
+        uri = URI(url)
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) {|http|
+          req = Net::HTTP::Delete.new(uri)
+          req['accept'] = 'application/json'
+          res = http.request(req)
+          return
+          raise "Error removing Multilogin profile: #{res.to_s}" if !res.has_key?('status')
+          raise "Error removing Multilogin profile: #{res['status'].to_s}" if res['status'] != 'OK'
         }
-        res = JSON.parse(res.body)
-        raise "Error removing Multilogin profile: #{res.to_s}" if !res.has_key?('status')
-        raise "Error removing Multilogin profile: #{res['status'].to_s}" if res['status'] != 'OK'
       end # def self.delete_profile
+
     end # module MultiLogin
 
     #
@@ -118,7 +428,6 @@ module BlackStack
       # You have to load all the Sinatra classes after connect the database.
       require_relative '../lib/proxy.rb'
     end
-
   end # module StealthBrowserAutomation
   
 end # module BlackStack

metadata

@@ -1,15 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: stealth_browser_automation
 version: !ruby/object:Gem::Version
-  version: 1.1.34
+  version: 1.2.38
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.14.1
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +196,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.24
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.24
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.24
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.24
 description: 'THIS GEM IS STILL IN DEVELOPMENT STAGE. Find documentation here: https://github.com/leandrosardi/stealth_browser_automation.'
 email: leandro.sardi@expandedventure.com
 executables: []