ZReviewTender 0.0.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2807fe3efdfb17de59b50713359ba58097f36482389f1d4089056103d16be154
-  data.tar.gz: 8366edb466dda73e67a553084b7b96e97f42c03e4cdb8dc2509e2edacd2f1d3b
+  metadata.gz: 7aa2c137be0a68444622a08d3ab704b221900d1b9a7ea924431647f79f4aba13
+  data.tar.gz: 571f7acf138712cf7128565ed6810b0504b39b370009556a25603d963c40a3b4
 SHA512:
-  metadata.gz: 6eb36009c81955c741701b5c57559d67a16c1fd7df2528b2893ceae37f40c00879d81d8a6a65d4eae930d6125b2f33492f966837ed440acd15d56e42a631c378
-  data.tar.gz: 108d45d065e7f045a5bb88c72fe8e8e79b132f5bb42cdb7e9f00191a4b660e3ff726f4027d79889e5b0d0c67975cf56c02494754449641774f5107b2fb1ed96b
+  metadata.gz: ccf6b17d95cca68d1bdd9c6f2f49ce4556a9884eccbd161e0ec9cea2ab5e44360d563d6a40181d4b796cf15e11dd238a8a48cb280291e8a3c192b9e314331ff4
+  data.tar.gz: 8a28b397e178f3ecdc67ee80e01e6e3d405c4d17cf5749ba93898365b51fee7534c8e22d2f5ae2a33df22761240a37524e1618c022dc8dc2f016f146dbbef95a

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,18 +3,20 @@ $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, :attachmentGroupByNumber
+    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"]
@@ -34,6 +36,9 @@ class SlackProcessor < Processor
     end
 
     def processReviews(reviews, platform)
+        if reviews.length < 1
+            return reviews
+        end
 
         pendingPayloads = []
 
@@ -68,14 +73,14 @@ class SlackProcessor < Processor
         end
 
         loop do
-            payload = pendingPayloads.pop
+            payload = pendingPayloads.shift
 
             result = request(payload)
             if !result[:ok]
-                Helper.logError(result)
+                logger.logError(result)
                 if result[:message] == "ratelimited"
                     sleep(1)
-                    pendingPayloads.append(payload)
+                    pendingPayloads.insert(0, payload)
                 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.6
+  version: 1.0.1
 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
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.25.0
-description: ZReviewTender - Monitor your App reviews in your Slack channel
+description: ZReviewTender - App Reviews Automatic Bot
 email: 
 executables:
 - ZReviewTender
@@ -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