ZReviewTender 0.0.7 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 556b1175c3cb37d22d19f7ad2f8efdcd029cebb30cee4dcec2f98bff1f6b9a5b
-  data.tar.gz: 17c67831cb8bbafb89c51c1c551f778a18f8d5f595ec5ed6fcff3c029657fd0c
+  metadata.gz: d7424669fd10f388ab510a8e2dd5883fcf1341d008d3eb373935354f401bb02a
+  data.tar.gz: c71871531e5e011ae609b6fd42220a25350e7791882862f2c52329f8e3c9169e
 SHA512:
-  metadata.gz: a42d994b153e45fae773118eb29320339d2e9c49d52d865dd60bb62fb23c0aa5c566386cbfeebd0608bc56ab6b5affcf4782de89451f29b7dcb61276208cfc37
-  data.tar.gz: 1d1b1186d77d05e9de46dfeceb38adb9d538a297c3e2a1c0803099b9266ed414c2e9b3854eaf44ec49c3685ad4d03f6222622a18b94e764a71e8cfa79a88dd12
+  metadata.gz: 7306096441bcf8f3bdd47f4b00a5449ff3a1baaaf045159699eff5bfcde01d9876b333ca55894b976e0919061c678df3453e463f9e7a5d6fe7242f242bdaa561
+  data.tar.gz: 2f0544786b27029a3a745553a729e1f65aa7758f69cf8a917e0da26e6c7f15d96fd22039e195c09f765a4093f54f2bbd193b997a6d37af2d2ca80bac1fa080a4

data/bin/ZReviewTender

@@ -27,6 +27,8 @@ class Main
                 if configYMLFilePath.nil?
                     configYMLFilePath = "#{basePath}/config/apple.yml"
                 end
+                configFileCheck(configYMLFilePath, "--apple=CONFIG_YML_FILE_PATH")
+
                 fetcher = parseConfigYMLFile(configYMLFilePath)
                 fetcher.execute()
             end 
@@ -35,22 +37,39 @@ class Main
                 if configYMLFilePath.nil?
                     configYMLFilePath = "#{basePath}/config/android.yml"
                 end
+                configFileCheck(configYMLFilePath, "--googleAndroid=CONFIG_YML_FILE_PATH")
+
                 fetcher = parseConfigYMLFile(configYMLFilePath)
                 fetcher.execute()
             end 
             
             opts.on('-r', '--run', 'execute with config yml file') do
-                appleConfigFilePath = "#{basePath}/config/android.yml"
-                fetcher = parseConfigYMLFile(appleConfigFilePath)
+                androidConfigFilePath = "#{basePath}/config/android.yml"
+                configFileCheck(androidConfigFilePath, "--googleAndroid=CONFIG_YML_FILE_PATH")
+                
+                fetcher = parseConfigYMLFile(androidConfigFilePath)
                 fetcher.execute()
-
+                
+                #
+                
                 appleConfigFilePath = "#{basePath}/config/apple.yml"
+                configFileCheck(appleConfigFilePath, "--apple=CONFIG_YML_FILE_PATH")
+
                 fetcher = parseConfigYMLFile(appleConfigFilePath)
                 fetcher.execute()
             end 
         end.parse!
     end
 
+    private
+    def configFileCheck(path, command)
+        if !File.exists? path
+            puts "Make sure you have vaild config file at #{path}"
+            puts "Or use ZReviewTender #{command} specify config.yml file path"
+            raise "Config file not found: #{path}"
+        end
+    end
+
     private
     def parseConfigYMLFile(configFilePath)
         configYMLObj = YAML.load_file(configFilePath)

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 = []
 
@@ -72,7 +77,7 @@ class SlackProcessor < Processor
 
             result = request(payload)
             if !result[:ok]
-                Helper.logError(result)
+                logger.logError(result)
                 if result[:message] == "ratelimited"
                     sleep(1)
                     pendingPayloads.insert(0, payload)

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.7
+  version: 1.0.5
 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