ZReviewTender 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4905d8141a111bf59431bb91ae97e09b7a1b1d55c311c0ccda08b3ef0c9b6fc8
-  data.tar.gz: 346a8c5be0271f0be78bcfa0947333f7e2283988785d3ade883799fae38ed205
+  metadata.gz: 1d3c0a75805d2e7892786cf8a8fdc2269368f1156cdaa56c1ae514d5186725f8
+  data.tar.gz: 41ddf4524efab2749f8abf247eb6e919bf45861b01f36c0c3c8cab82fff86762
 SHA512:
-  metadata.gz: b4a3eba5f67873c14d40bf96ec20820a2ba4e985722f42132b1983bfa60b40eb475088be78c958d13e2c1be43bd03b8965509efcafb5adc01757333d0d44720a
-  data.tar.gz: db5d1acb0233c84fe06dbcb654dbda40ee97b25eb85f52d74dfd77ea7f34779f072ca25c4d2367b5500bf780a0ffbc5e49d7b8b592012e9f92387b96d032acc8
+  metadata.gz: c39778deb56d17742a16a6af0e00fb33505b15fb93df6dd8b57179c7fec459da55e73c5bbcddd732d10d556a729f654302abb93ff595cc8518405e807d729902
+  data.tar.gz: be8acddbf10119a6f35b4dc2adde623be8f176b623bd4a391fe5eec8ab616a55055429feb2a0105c73b1e76e3d70f5e4a22c47d7e448d720e54968b3aaab5d96

data/lib/AndroidFetcher.rb

@@ -26,7 +26,7 @@ class AndroidFetcher < ReviewFetcher
         # init first time, send welcome message
         if latestCheckTimestamp == 0 
             sendWelcomMessage()
-            setPlatformLatestCheckTimestamp()
+            setPlatformLatestCheckTimestamp(Time.now().to_i)
             return
         end
 
@@ -52,7 +52,7 @@ class AndroidFetcher < ReviewFetcher
             end
             customerReviewPlatform = "Android #{customerReview.comments[0].user_comment.android_os_version}"
             
-            if latestCheckTimestamp > customerReviewCreatedDateTimestamp
+            if latestCheckTimestamp >= customerReviewCreatedDateTimestamp
                 break
             else
                 url = "https://play.google.com/store/apps/details?id=#{config.packageName}&reviewId=#{customerReviewID}"
@@ -66,9 +66,9 @@ class AndroidFetcher < ReviewFetcher
       
         if reviews.length > 0
             reviews.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
+            setPlatformLatestCheckTimestamp(reviews.last.createdDateTimestamp)
+
             processReviews(reviews, platform)
         end
-
-        setPlatformLatestCheckTimestamp()
     end
 end

data/lib/AppleFetcher.rb

@@ -2,6 +2,7 @@ $lib = File.expand_path('../lib', File.dirname(__FILE__))
 
 require "Models/Review"
 require "Helper"
+require "ZLogger"
 require "Models/ReviewFetcher"
 require "jwt"
 require "time"
@@ -14,6 +15,7 @@ class AppleFetcher < ReviewFetcher
     def initialize(config)
         @processors = []
         @config = config
+        @logger = ZLogger.new(config.baseExecutePath)
         @platform = 'Apple'
         @token = generateJWT()
     end
@@ -26,7 +28,7 @@ class AppleFetcher < ReviewFetcher
         # init first time, send welcome message
         if latestCheckTimestamp == 0 
             sendWelcomMessage()
-            setPlatformLatestCheckTimestamp()
+            setPlatformLatestCheckTimestamp(Time.now().to_i)
             return;
         end
 
@@ -34,12 +36,11 @@ class AppleFetcher < ReviewFetcher
 
         if reviews.length > 0
             reviews.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
-            reviews = fullfillAppInfo(reviews)
+            setPlatformLatestCheckTimestamp(reviews.last.createdDateTimestamp)
 
+            reviews = fullfillAppInfo(reviews)
             processReviews(reviews, platform)
         end
-
-        setPlatformLatestCheckTimestamp()
     end
 
     private
@@ -66,7 +67,7 @@ class AppleFetcher < ReviewFetcher
                     customerReviewCreatedDateTimestamp = Time.parse(customerReviewCreatedDate).to_i
                 end
 
-                if latestCheckTimestamp > customerReviewCreatedDateTimestamp
+                if latestCheckTimestamp >= customerReviewCreatedDateTimestamp
                     customerReviewsLink = nil
                     break
                 else
@@ -167,7 +168,7 @@ class AppleFetcher < ReviewFetcher
                 raise "Could not connect to api.appstoreconnect.apple.com, error message: #{response}"
             else
                 @token = generateJWT()
-                Helper.logWarn("JWT Expired, refresh a new one. (#{retryCount + 1})")
+                logger.logWarn("JWT Expired, refresh a new one. (#{retryCount + 1})")
                 return request(url, retryCount + 1)
             end
         else

data/lib/Helper.rb

@@ -1,7 +1,5 @@
 $lib = File.expand_path('../', File.dirname(__FILE__))
 
-require "logger"
-
 class Helper
     def self.unwrapRequiredParameter(obj, key)
         if obj[key].nil?
@@ -24,19 +22,4 @@ class Helper
             Dir.mkdir(currentDir) unless File.exists?(currentDir)
         end while dirs.length > 0
     end
-
-    def self.logError(message)
-        logger = Logger.new(STDOUT)
-        logger.error("#{caller[0]}: #{message}")
-    end
-
-    def self.logWarn(message)
-        logger = Logger.new(STDOUT)
-        logger.warning("#{caller[0]}: #{message}")
-    end
-
-    def self.logInfo(message)
-        logger = Logger.new(STDOUT)
-        logger.info("#{caller[0]}: #{message}")
-    end
 end

data/lib/Models/ReviewFetcher.rb

@@ -8,7 +8,7 @@ require "time"
 
 class ReviewFetcher
 
-    attr_accessor :config, :platform, :processors
+    attr_accessor :config, :platform, :processors, :logger
 
     def execute()
 
@@ -31,14 +31,14 @@ class ReviewFetcher
         end
     end
 
-    def setPlatformLatestCheckTimestamp()
-        basePath = "#{config.baseExecutePath}/.cache"
+    def setPlatformLatestCheckTimestamp(timestamp)
+        basePath = "#{config.baseExecutePath}/latestCheckTimestamp/"
         Helper.createDirIfNotExist(basePath)
-        File.open("#{basePath}/#{platform}-latestCheckTimestamp", 'w') { |file| file.write(Time.now().to_i) }
+        File.open("#{basePath}/#{platform}", 'w') { |file| file.write(timestamp) }
     end
 
     def getPlatformLatestCheckTimestamp()
-        filePath = "#{config.baseExecutePath}/.cache/#{platform}-latestCheckTimestamp"
+        filePath = "#{config.baseExecutePath}/latestCheckTimestamp/#{platform}"
         if File.exists?(filePath)
             return File.read(filePath).to_i
         else

data/lib/Processors/FilterProcessor.rb

@@ -0,0 +1,54 @@
+$lib = File.expand_path('../lib', File.dirname(__FILE__))
+
+require "Models/Review"
+require "Models/Processor"
+require "Helper"
+
+class FilterProcessor < Processor
+
+    attr_accessor :keywordsInclude, :ratingsInclude, :territoriesInclude
+
+    def initialize(config, configFilePath, baseExecutePath)
+        @config = config
+        @configFilePath = configFilePath
+        @baseExecutePath = baseExecutePath
+
+        @keywordsInclude = []
+        if !config["keywordsInclude"].nil?
+            @keywordsInclude = config["keywordsInclude"]
+        end
+
+        @ratingsInclude = []
+        if !config["ratingsInclude"].nil?
+            @ratingsInclude = config["ratingsInclude"]
+        end
+
+        @territoriesInclude = []
+        if !config["territoriesInclude"].nil?
+            @territoriesInclude = config["territoriesInclude"]
+        end
+    end
+
+    def processReviews(reviews, platform)
+        if reviews.length < 1
+            return reviews
+        end
+        
+        if ratingsInclude.length > 0
+            reviews = reviews.select{ |review| ratingsInclude.map{ |rating| rating.to_i }.include? review.rating }
+        end
+
+        if territoriesInclude.length > 0
+            reviews = reviews.select{ |review| territoriesInclude.map{ |territory| territory.upcase }.include? review.territory.upcase }
+        end
+
+        if keywordsInclude.length > 0
+            keywordsInclude.select{ |keywordsInclude| keywordsInclude != "" }.each do |keywordInclude|
+                reviews = reviews.select{ |review| review.body.include? keywordInclude }
+            end
+        end
+
+        return reviews
+    end
+
+end

data/lib/Processors/GoogleTranslateProcessor.rb

@@ -9,7 +9,7 @@ require "google/cloud/translate/v2"
 
 class GoogleTranslateProcessor < Processor
 
-    attr_accessor :client, :targetLang, :whiteListTerritories
+    attr_accessor :client, :targetLang, :territoriesExclude
 
     def initialize(config, configFilePath, baseExecutePath)
         @config = config
@@ -26,15 +26,19 @@ class GoogleTranslateProcessor < Processor
         ENV["TRANSLATE_CREDENTIALS"] = keyFilePath
         @client = Google::Cloud::Translate::V2.new
         @targetLang = Helper.unwrapRequiredParameter(config, "googleTranslateTargetLang")
-        @whiteListTerritories = []
-        if !config['googleTranslateWhiteListTerritories'].nil? && config['googleTranslateWhiteListTerritories'].length > 0
-            @whiteListTerritories = config['googleTranslateWhiteListTerritories']
+        @territoriesExclude = []
+        if !config['googleTranslateTerritoriesExclude'].nil? && config['googleTranslateTerritoriesExclude'].length > 0
+            @territoriesExclude = config['googleTranslateTerritoriesExclude']
         end
     end
 
     def processReviews(reviews, platform)
+        if reviews.length < 1
+            return reviews
+        end
+        
         reviews.each_index do |index|
-            if whiteListTerritories.include? reviews[index].territory
+            if territoriesExclude.include? reviews[index].territory
                 next
             end
 

data/lib/Processors/ProcessorTemplate.rb

@@ -0,0 +1,38 @@
+$lib = File.expand_path('../lib', File.dirname(__FILE__))
+
+require "Models/Review"
+require "Models/Processor"
+require "Helper"
+require "ZLogger"
+
+# Add to config.yml:
+#
+# processors:
+#   - ProcessorTemplate:
+#       class: "ProcessorTemplate"
+#       parameter1: "value"
+#       parameter2: "value"
+#       parameter3: "value"
+#       ...
+#
+
+class ProcessorTemplate < Processor
+
+    def initialize(config, configFilePath, baseExecutePath)
+        # init Processor
+        # get paraemter from config e.g. config["parameter1"]
+        # configFilePath: file path of config file (apple.yml/android.yml)
+        # baseExecutePath: user excute path
+    end
+
+    def processReviews(reviews, platform)
+        if reviews.length < 1
+            return reviews
+        end
+
+        ## do what your want to do with reviews...
+        
+        ## return result reviews
+        return reviews
+    end
+end

data/lib/Processors/SlackProcessor.rb

@@ -3,23 +3,30 @@ $lib = File.expand_path('../lib', File.dirname(__FILE__))
 require "Models/Review"
 require "Models/Processor"
 require "Helper"
+require "ZLogger"
 require "net/http"
 require "json"
 require "time"
 
 class SlackProcessor < Processor
 
-    attr_accessor :botToken, :inCommingWebHookURL, :targetChannel, :timeZoneOffset
+    attr_accessor :botToken, :inCommingWebHookURL, :targetChannel, :timeZoneOffset, :attachmentGroupByNumber, :logger
 
     def initialize(config, configFilePath, baseExecutePath)
         @config = config
         @configFilePath = configFilePath
         @baseExecutePath = baseExecutePath
+        @logger = ZLogger.new(baseExecutePath)
 
         @botToken = config["slackBotToken"]
         @inCommingWebHookURL = config["slackInCommingWebHookURL"]
         @targetChannel = config["slackBotTargetChannel"]
         @timeZoneOffset = Helper.unwrapRequiredParameter(config, "slackTimeZoneOffset")
+        @attachmentGroupByNumber = 1
+
+        if !config['slackAttachmentGroupByNumber'].nil? && config['slackAttachmentGroupByNumber'] != "" && config['slackAttachmentGroupByNumber'].to_i > 0  && config['slackAttachmentGroupByNumber'].to_i < 100
+            @attachmentGroupByNumber = config['slackAttachmentGroupByNumber'].to_i
+        end
 
         if (botToken.nil? && inCommingWebHookURL.nil?) || (botToken == "" && inCommingWebHookURL == "")
             raise "must specify slackBotToken or slackInCommingWebHookURL in SlackProcessor."
@@ -29,36 +36,55 @@ class SlackProcessor < Processor
     end
 
     def processReviews(reviews, platform)
+        if reviews.length < 1
+            return reviews
+        end
+
+        pendingPayloads = []
 
-        # 1 review 1 message
-        reviews.each do |review|
+        # Slack Message Limit: posting one message per second per channel
+        reviews.each_slice(attachmentGroupByNumber) do |reviewGroup|
             payload = Payload.new()
             payload.attachments = []
-            
-            attachment = Payload::Attachment.new()
 
-            stars = "★" * review.rating + "☆" * (5 - review.rating)
-            color = review.rating >= 4 ? "good" : (review.rating > 2 ? "warning" : "danger")
-            date = Time.at(review.createdDateTimestamp).getlocal(timeZoneOffset)
-            
-            title = "#{stars}"
-            if !review.title.nil?
-                title = "#{review.title} - #{stars}"
-            end
+            reviewGroup.each do |review|
+                attachment = Payload::Attachment.new()
+
+                stars = "★" * review.rating + "☆" * (5 - review.rating)
+                color = review.rating >= 4 ? "good" : (review.rating > 2 ? "warning" : "danger")
+                date = Time.at(review.createdDateTimestamp).getlocal(timeZoneOffset)
                 
-            attachment.color = color
-            attachment.author_name = review.userName
-            attachment.fallback = title
-            attachment.title = title
-            attachment.text = review.body
-            attachment.footer = "#{platform} - #{review.platform} - #{review.appVersion} - #{review.territory} - <#{review.url}|#{date}>"
-            
-            payload.attachments.append(attachment)
+                title = "#{stars}"
+                if !review.title.nil?
+                    title = "#{review.title} - #{stars}"
+                end
+                    
+                attachment.color = color
+                attachment.author_name = review.userName
+                attachment.fallback = title
+                attachment.title = title
+                attachment.text = review.body
+                attachment.footer = "#{platform} - #{review.platform} - #{review.appVersion} - #{review.territory} - <#{review.url}|#{date}>"
+                
+                payload.attachments.append(attachment)
+            end
+
+            pendingPayloads.append(payload)
+        end
+
+        loop do
+            payload = pendingPayloads.shift
 
             result = request(payload)
-            if !result
-                Helper.logError(result)
+            if !result[:ok]
+                logger.logError(result)
+                if result[:message] == "ratelimited"
+                    sleep(1)
+                    pendingPayloads.insert(0, payload)
+                end
             end
+
+            break if pendingPayloads.length < 1
         end
 
         return reviews
@@ -108,10 +134,10 @@ class SlackProcessor < Processor
         res = http.request(req)
 
         if isInCommingWebHook
-            return res.body == "ok"
+            return {"ok":res.body == "ok", "message":nil}
         else
             result = JSON.parse(res.body)
-            return result["ok"] == true
+            return {"ok":result["ok"] == true, "message":result['error']}
         end
         
     end

data/lib/ZLogger.rb

@@ -0,0 +1,33 @@
+$lib = File.expand_path('../', File.dirname(__FILE__))
+
+require "logger"
+
+class ZLogger
+    
+    attr_accessor :logger
+
+    def initialize(baseExecutePath)
+        @logger = Logger.new("#{baseExecutePath}/execute.log")
+    end
+
+    def logError(message)
+        result = "#{caller[0]}: #{message}"
+
+        puts "Error: #{result}"
+        logger.error(result)
+    end
+
+    def logWarn(message)
+        result = "#{caller[0]}: #{message}"
+        
+        puts "Warning: #{result}"
+        logger.warn(result)
+    end
+
+    def logInfo(message)
+        result = "#{caller[0]}: #{message}"
+        
+        puts "Info: #{result}"
+        logger.info(result)
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ZReviewTender
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - ZhgChgLi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -82,8 +82,11 @@ files:
 - lib/Models/Processor.rb
 - lib/Models/Review.rb
 - lib/Models/ReviewFetcher.rb
+- lib/Processors/FilterProcessor.rb
 - lib/Processors/GoogleTranslateProcessor.rb
+- lib/Processors/ProcessorTemplate.rb
 - lib/Processors/SlackProcessor.rb
+- lib/ZLogger.rb
 homepage: https://github.com/ZhgChgLi/ZReviewTender
 licenses:
 - MIT