mass-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a619577f5edc948803f9f6259ea6f4d73b2dfc10b2edbd2afd416940ce8f6f8e
+  data.tar.gz: f58d14d86a1734b5ff228743edfc19783f644ce728c32279d338372c8edcbda1
+SHA512:
+  metadata.gz: c6fa03f641077d58980e0b19b6cf8140e0883705b255d687ec8a1019b64ef2e8f0474b4d4cfa3b2d9d30b28991328cdd62548b8380786ec313a9563470fb0426
+  data.tar.gz: '096188736400e59e26dc19eef3e6a91436c8da8fc7a24b65a84e67ea3df8504a7973309f1a58a8c2bf359660f88c38dd5dcaeea054680b90372f08cc2462f684'

data/lib/base-line/channel.rb

@@ -0,0 +1,7 @@
+module Mass 
+    class Channel < BlackStack::Base
+        def self.object_name
+            'channel'
+        end
+    end 
+end # module Mass

data/lib/base-line/company.rb

@@ -0,0 +1,7 @@
+module Mass 
+    class Company < BlackStack::Base
+        def self.object_name
+            'company'
+        end
+    end 
+end # module Mass

data/lib/base-line/connectioncheck.rb

@@ -0,0 +1,14 @@
+module Mass
+    class ConnectionCheck < BlackStack::Base
+        attr_accessor :profile
+
+        def self.object_name
+            'connectioncheck'
+        end
+
+        def initialize(h)
+            super(h)
+            self.profile = Mass::Profile.get(h['id_profile']).child_class_instance if h['id_profile']
+        end
+    end # class ConnectionCheck
+end # module Mass

data/lib/base-line/data_type.rb

@@ -0,0 +1,8 @@
+module Mass
+    class DataType < BlackStack::Base
+        def self.object_name
+            'data_type'
+        end
+
+    end # class DataType
+end # module Mass

data/lib/base-line/enrichment.rb

@@ -0,0 +1,51 @@
+module Mass
+    class Enrichment < BlackStack::Base
+        attr_accessor :type, :profile, :lead, :company, :profile_type
+
+        def self.object_name
+            'enrichment'
+        end
+
+        def initialize(h)
+            super(h)
+            self.type = Mass::EnrichmentType.new(h['enrichment_type_desc']) if h['enrichment_type_desc']
+            self.profile = Mass::Profile.new(h['profile']).child_class_instance if h['profile']
+            self.lead = Mass::Lead.new(h['lead']) if h['lead']
+            self.company = Mass::Company.new(h['company']) if h['company']
+            self.profile_type = Mass::ProfileType.page(
+                page: 1,
+                limit: 1,
+                filters: {
+                    name: h['profile_type']
+                }
+            ).first.child_class_instance if h['profile_type']
+        end
+
+        # convert the enrichment_type into the ruby class to create an instance.
+        # example: Apollo --> Mass::ApolloAPI
+        def class_name_from_enrichment_type
+            enrichment_type = self.desc['enrichment_type']
+            "Mass::#{enrichment_type}" 
+        end
+
+        # crate an instance of the profile type using the class defined in the `desc['name']` attribute.
+        # override the base method
+        def child_class_instance
+            enrichment_type = self.desc['enrichment_type']
+            key = self.class_name_from_enrichment_type
+            raise "Source code of enrichment type #{enrichment_type} not found. Create a class #{key} in the folder `/lib` of your mass-sdk." unless Kernel.const_defined?(key)
+            ret = Kernel.const_get(key).new(self.desc)
+            return ret
+        end
+
+        # Update the lead or company with new information.
+        #
+        def do(
+            logger:nil
+        )
+            # TODO: Code Me!
+        end
+
+
+    end # class Enrichment
+end # module Mass

data/lib/base-line/enrichment_type.rb

@@ -0,0 +1,60 @@
+module Mass
+    # Enrichment module.
+    # List of methods you have to overload if you develop a profile type that supports enrichment operations.
+    # 
+    class EnrichmentType < BlackStack::Base
+        def self.object_name
+            'enrichment_type'
+        end # def self.object_name
+
+        # If the profile `access` is not `:rpa`, raise an exception.
+        # Return `true` if the `url` is valid.
+        # Return `false` if the `url` is not valid. 
+        # 
+        # Overload this method in the child class.
+        # 
+        def valid_enrichment_url?(url:)
+            # If the profile `access` is not `:rpa`, raise an exception.
+            raise "The method `valid_enrichment_url?` is not allowed for #{self.access.to_s} access." if self.access != :rpa
+            # Return `true` if the `url` is valid.
+            # Return `false` if the `url` is not valid. 
+            true
+        end # def valid_enrichment_url?
+
+        # Return the same URL in a normalized form:
+        # - remove all GET parameters.
+        # - remove all trailing slashes.
+        #
+        # If the profile `access` is not `:rpa`, raise an exception.
+        # If the `url` is not valid, raise an exception.
+        # Return the normalized URL.
+        # 
+        # Overload this method in the child class.
+        # 
+        def normalized_enrichment_url(url:)
+            # If the profile `access` is not `:rpa`, raise an exception.
+            raise "The method `normalized_enrichment_url` is not allowed for #{self.access.to_s} access." if self.access != :rpa
+            # Return the same URL in a normalized form:
+            # - remove all GET parameters.
+            # - remove all trailing slashes.
+            url = url.gsub(/\?.*$/, '').strip
+            url = ret.gsub(/\/+$/, '')
+            # Return the normalized URL.
+            url
+        end # def normalized_enrichment_url
+
+        # If the profile `access` is not `:api`, raise an exception.
+        # Parameter `params` must be a hash.
+        # Return `true` if the `params` are valid.
+        # Return `false` if the `params` are not valid. 
+        def valid_enrichment_params?(params:)
+            # If the profile `access` is not `:api`, raise an exception.
+            raise "The method `valid_enrichment_params?` is not allowed for #{self.access.to_s} access." if self.access != :api
+            # Parameter `params` must be a hash.
+            raise "The parameter `params` must be a hash." if !params.is_a?(Hash)
+            # Return `true` if the `params` are valid.
+            # Return `false` if the `params` are not valid. 
+            true
+        end # def valid_enrichment_params?
+    end # class EnrichmentType
+end # module Mass

data/lib/base-line/event.rb

@@ -0,0 +1,15 @@
+module Mass
+    class Event < BlackStack::Base
+        attr_accessor :lead, :company
+
+        def self.object_name
+            'event'
+        end
+
+        def initialize(h)
+            super(h)
+            #self.lead = Mass::Lead.new(h['lead_desc']).child_class_instance if h['lead_desc']
+            #self.company = Mass::Company.new(h['company_desc']).child_class_instance if h['company_desc']
+        end
+    end # class Event
+end # module Mass

data/lib/base-line/headcount.rb

@@ -0,0 +1,7 @@
+module Mass
+    class Headcount < BlackStack::Base
+        def self.object_name
+            'headcount'
+        end
+    end # class Headcount
+end # module Mass

data/lib/base-line/inboxcheck.rb

@@ -0,0 +1,14 @@
+module Mass
+    class InboxCheck < BlackStack::Base
+        attr_accessor :profile
+
+        def self.object_name
+            'inboxcheck'
+        end
+
+        def initialize(h)
+            super(h)
+            self.profile = Mass::Profile.get(h['id_profile']).child_class_instance if h['id_profile']
+        end
+    end # class InboxCheck
+end # module Mass

data/lib/base-line/industry.rb

@@ -0,0 +1,7 @@
+module Mass
+    class Industry < BlackStack::Base
+        def self.object_name
+            'industry'
+        end
+    end # class Industry
+end # module Mass

data/lib/base-line/job.rb

@@ -0,0 +1,60 @@
+module Mass
+    class Job < BlackStack::Base
+        attr_accessor :profile, :source
+
+        def self.object_name
+            'job'
+        end
+
+        def initialize(h)
+            super(h)
+            self.profile = Mass::Profile.new(h['profile']).child_class_instance if h['profile']
+            self.source = Mass::Source.new(h['source_desc']).child_class_instance if h['source_desc']
+        end
+
+        # Submit a hash descriptor to the server for an upsert.
+        # Optimizaton: remove the events from the job descriptor, and submit events one by one.
+        def upsert
+            job = self
+            events = job.desc['events'].dup
+            job.desc['events'] = []
+            
+            # cap the number of events to job.desc['max_events']
+            events = events[0..job.desc['max_events']-1] if job.desc['max_events'] && events.size > job.desc['max_events']
+
+            # initialize the id_account and id_job for each event
+            events.each { |e| 
+                e['id_account'] = job.desc['id_account']
+                e['id_job'] = job.desc['id'] 
+            }
+
+            # upsert the events
+            events = events.map { |e| Mass::Event.new(e) }
+            super()
+            #k = 0
+            #puts
+            events.each { |e| 
+                #k += 1
+                #print "k: #{k}... "
+                res = e.upsert 
+                #puts res.nil? ? "nil" : res.desc['id']
+            }
+
+            job.desc['events'] = events.map { |e| e.desc } # setup the events array into the job again
+        end
+
+        def do(logger:nil)
+            self.source.do(
+                job: self,
+                logger: logger,
+            )
+        end
+
+        # return true if the assigned profile can download multiple files (allow_browser_to_download_multiple_files)
+        # and the source can download pictures (download_pictures)
+        def can_download_images?
+            self.profile.desc['allow_browser_to_download_multiple_files'] && self.source.desc['download_pictures']
+        end
+
+    end # class Job
+end # module Mass

data/lib/base-line/lead.rb

@@ -0,0 +1,7 @@
+module Mass 
+    class Lead < BlackStack::Base
+        def self.object_name
+            'lead'
+        end
+    end 
+end # module Mass

data/lib/base-line/location.rb

@@ -0,0 +1,7 @@
+module Mass
+    class Location < BlackStack::Base
+        def self.object_name
+            'location'
+        end
+    end # class Location
+end # module Mass

data/lib/base-line/outreach.rb

@@ -0,0 +1,42 @@
+module Mass
+    class Outreach < BlackStack::Base
+        attr_accessor :type, :profile, :lead, :company, :profile_type
+
+        def self.object_name
+            'outreach'
+        end
+
+        def initialize(h)
+            super(h)
+            self.type = Mass::OutreachType.new(h['outreach_type_desc']) if h['outreach_type_desc']
+            self.profile = Mass::Profile.new(h['profile']).child_class_instance if h['profile']
+            self.lead = Mass::Lead.new(h['lead']) if h['lead']
+            self.company = Mass::Company.new(h['company']) if h['company']
+            self.profile_type = Mass::ProfileType.page(
+                page: 1,
+                limit: 1,
+                filters: {
+                    name: h['profile_type']
+                }
+            ).first.child_class_instance if h['profile_type']
+        end
+
+        # convert the outreach_type into the ruby class to create an instance.
+        # example: Apollo --> Mass::ApolloAPI
+        def class_name_from_outreach_type
+            outreach_type = self.desc['outreach_type']
+            "Mass::#{outreach_type}" 
+        end
+
+        # crate an instance of the profile type using the class defined in the `desc['name']` attribute.
+        # override the base method
+        def child_class_instance
+            outreach_type = self.desc['outreach_type']
+            key = self.class_name_from_outreach_type
+            raise "Source code of outreach type #{outreach_type} not found. Create a class #{key} in the folder `/lib` of your mass-sdk." unless Kernel.const_defined?(key)
+            ret = Kernel.const_get(key).new(self.desc)
+            return ret
+        end
+
+    end # class Outreach
+end # module Mass

data/lib/base-line/outreach_type.rb

@@ -0,0 +1,76 @@
+module Mass
+    # Outreach module.
+    # List of methods you have to overload if you develop a profile type that supports outreach operations.
+    # 
+    class OutreachType < BlackStack::Base
+        def self.object_name
+            'outreach_type'
+        end # def self.object_name
+
+        # If the profile `access` is not `:rpa`, raise an exception.
+        # Return `true` if the `url` is valid.
+        # Return `false` if the `url` is not valid. 
+        #
+        # Overload this method in the child class.
+        #
+        def valid_outreach_url?(url:)
+            # If the profile `access` is not `:rpa`, raise an exception.
+            raise "The method `valid_outreach_url?` is not allowed for #{self.access.to_s} access." if self.access != :rpa
+            # Return `true` if the `url` is valid.
+            # Return `false` if the `url` is not valid. 
+            true
+        end # def valid_outreach_url?
+
+        # Return the same URL in a normalized form:
+        # - remove all GET parameters.
+        # - remove all trailing slashes.
+        #
+        # If the profile `access` is not `:rpa`, raise an exception.
+        # If the `url` is not valid, raise an exception.
+        # Return the normalized URL.
+        #
+        # Overload this method in the child class.
+        #
+        def normalized_outreach_url(url:)
+            # If the profile `access` is not `:rpa`, raise an exception.
+            raise "The method `normalized_outreach_url` is not allowed for #{self.access.to_s} access." if self.access != :rpa
+            # If the `url` is not valid, raise an exception.
+            raise "The URL is not valid." if !self.valid_outreach_url?(url: url)
+            # Return the same URL in a normalized form:
+            # - remove all GET parameters.
+            # - remove all trailing slashes.
+            url = url.gsub(/\?.*$/, '').strip
+            url = ret.gsub(/\/+$/, '')
+            # Return the normalized URL.
+            url
+        end # def normalized_outreach_url
+
+        # If the profile `access` is not `:api`, raise an exception.
+        # Parameter `params` must be a hash.
+        # Return `true` if the `params` are valid.
+        # Return `false` if the `params` are not valid. 
+        def valid_outreach_params?(params:)
+            # If the profile `access` is not `:api`, raise an exception.
+            raise "The method `valid_outreach_params?` is not allowed for #{self.access.to_s} access." if self.access != :api
+            # Parameter `params` must be a hash.
+            raise "The parameter `params` must be a hash." if !params.is_a?(Hash)
+            # Return `true` if the `params` are valid.
+            # Return `false` if the `params` are not valid.
+            true
+        end # def valid_outreach_params?
+
+        # If the profile `access` is not `:mta`, raise an exception.
+        # Parameter `params` must be a hash.
+        # Return `true` if the `params` are valid.
+        # Return `false` if the `params` are not valid. 
+        def valid_outreach_mta?(mta:)
+            # If the profile `access` is not `:api`, raise an exception.
+            raise "The method `valid_outreach_mta?` is not allowed for #{self.access.to_s} access." if self.access != :mta
+            # Parameter `params` must be a hash.
+            raise "The parameter `mta` must be a hash." if !mta.is_a?(Hash)
+            # Return `true` if the `params` are valid.
+            # Return `false` if the `params` are not valid. 
+            true
+        end # def valid_outreach_mta?
+    end # class OutreachType
+end # module Mass

data/lib/base-line/profile.rb

@@ -0,0 +1,108 @@
+module Mass 
+    class Profile < BlackStack::Base
+        attr_accessor :type
+
+        def self.object_name
+            'profile'
+        end
+
+        def initialize(h)
+            super(h)
+            self.type = Mass::ProfileType.new(h['profile_type_desc']).child_class_instance
+        end
+
+        # convert the profile_type into the ruby class to create an instance.
+        # example: Apollo --> Mass::ApolloAPI
+        def class_name_from_profile_type
+            profile_type = self.desc['profile_type']
+            "Mass::#{profile_type}" 
+        end
+
+        # crate an instance of the profile type using the class defined in the `desc['name']` attribute.
+        # override the base method
+        def child_class_instance
+            profile_type = self.desc['profile_type']
+            key = self.class_name_from_profile_type
+binding.pry
+            raise "Source code of profile type #{profile_type} not found. Create a class #{key} in the folder `/lib` of your mass-sdk." unless Kernel.const_defined?(key)
+            ret = Kernel.const_get(key).new(self.desc)
+            return ret
+        end
+        
+        # return true of the profile is running
+        # if its profile type is rpa-access, then it will return true if the browser is running.
+        # else, it will return always true.
+        def running?
+            if self.type.desc['access'].to_sym == :rpa
+                c = AdsPowerClient.new(key: ADSPOWER_API_KEY)
+                return c.check(self.desc['ads_power_id'])
+            end
+            return true
+        end
+        
+        # Scrape the inbox of the profile.
+        # Return a an array of hash descriptors of outreach records.
+        # 
+        # Parameters:
+        # - limit: the maximum number of messages to scrape. Default: 100.
+        # - only_unread: if true, then only the unread messages will be scraped. Default: true.
+        # - logger: a logger object to log the process. Default: nil.
+        #
+        # Example of a hash descritor into the returned array:
+        # ```
+        # {
+        #    # a scraped message is always a :performed message
+        #    'status' => :performed,
+        #    # what is the outreach type?
+        #    # e.g.: :LinkedIn_DirectMessage
+        #    # decide this in the child class.
+        #    'outreach_type' => nil,
+        #    # hash descriptor of the profile who is scraping the inbox
+        #    'profile' => self.desc,
+        #    # hash descriptor of the lead who is the conversation partner
+        #    'lead' => nil,
+        #    # if the message has been sent by the profile, it is :outgoing.
+        #    # if the message has been sent by the lead, it is :incoming.
+        #    'direction' => nil, 
+        #    # the content of the message
+        #    'subject' => nil,
+        #    'body' => nil,
+        # }
+        # ```
+        #
+        def inboxcheck(limit: 100, only_unread:true, logger:nil)
+            []
+        end # def inboxcheck
+
+        # Scrape the inbox of the profile.
+        # Return a an array of hash descriptors of outreach records.
+        # 
+        # Parameters:
+        # - limit: the maximum number of connections to scrape. Default: 100.
+        # - logger: a logger object to log the process. Default: nil.
+        #
+        # Example of a hash descritor into the returned array:
+        # ```
+        # {
+        #    # a scraped message is always a :performed message
+        #    'status' => :performed,
+        #    # what is the outreach type?
+        #    # e.g.: :LinkedIn_ConnectionRequest
+        #    # decide this in the child class.
+        #    'outreach_type' => nil,
+        #    # hash descriptor of the profile who is scraping the inbox
+        #    'profile' => self.desc,
+        #    # hash descriptor of the lead who is the conversation partner
+        #    'lead' => nil,
+        #    # if the message has been sent by the profile, it is :outgoing.
+        #    # if the message has been sent by the lead, it is :incoming.
+        #    'direction' => :accepted, 
+        # }
+        # ```
+        #
+        def connectioncheck(limit: 100, logger:nil)
+            []
+        end # def inboxcheck
+
+    end # class Profile
+end # module Mass

data/lib/base-line/profile_type.rb

@@ -0,0 +1,10 @@
+module Mass 
+    # Base class.
+    # List of methods you have to overload if you develop a profile type.
+    # 
+    class ProfileType < BlackStack::Base
+        def self.object_name
+            'profile_type'
+        end
+    end # class ProfileType
+end # module Mass

data/lib/base-line/request.rb

@@ -0,0 +1,40 @@
+module Mass
+    class Request < BlackStack::Base
+        def self.object_name
+          'request'
+        end
+
+        def perform(l)
+          if self.desc['state'] == 'online'
+            self.start_browser(l)
+          elsif self.desc['state'] == 'idle'
+            self.stop_browser(l)
+          else
+            raise "Unknown or unsupported request state: #{self.desc['state'].to_s}."
+          end
+        end
+  
+        def start_browser(l=nil)
+          l = BlackStack::DummyLogger.new(nil) if l.nil?
+          #raise "Profile is not waiting to start" if self.desc['profile']['state'].to_sym != :starting
+          # start browser
+          p = Mass::ProfileRPA.new(self.desc['profile'])
+          p.driver
+          # update profile state
+          p.desc['state'] = :scraping_inbox
+          p.upsert
+        end
+  
+        def stop_browser(l=nil)
+          l = BlackStack::DummyLogger.new(nil) if l.nil?
+          #raise "Profile is not waiting to stop" if self.desc['profile']['state'].to_sym != :stopping
+          c = AdsPowerClient.new(key: ADSPOWER_API_KEY)
+          c.stop(self.desc['profile']['ads_power_id']) if c.check(self.desc['profile']['ads_power_id'])
+          # get the profile for updating
+          p = Mass::Profile.new(self.desc['profile'])
+          p.desc['state'] = :idle
+          p.upsert
+        end
+
+    end # class Request
+end # module Mass

data/lib/base-line/revenue.rb

@@ -0,0 +1,7 @@
+module Mass
+    class Revenue < BlackStack::Base
+        def self.object_name
+            'revenue'
+        end
+    end # class Revenue
+end # module Mass

data/lib/base-line/rule.rb

@@ -0,0 +1,7 @@
+module Mass
+    class Rule < BlackStack::Base
+        def self.object_name
+            'rule'
+        end
+    end # class Rule
+end # module Mass