ZReviewTender 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 401f2fc6c474a7a9b49f4e09e9574ec9af12ba4e86666da4a8c51926d1f4dc8e
-  data.tar.gz: 81bcfd837a752fa6efff0f07131d8246eedf9c3feff8b585648a5cd9ba10524c
+  metadata.gz: 3c3ed526dfeec33a979c0c3c5a31d269a68cabe3599ba14c2ad9df35a1667dff
+  data.tar.gz: cc919703c929aee31d1c0a7d59ca528734f66a776e5d530f14da27b28c97b73b
 SHA512:
-  metadata.gz: 211bf7f2044c407689c4b96236b34801fc1c2dafe56fd23fca39accdc5e2d31345109dd2708a5aef246e5c1885542f1b549653357487b644018a8b96640f70ee
-  data.tar.gz: aa679ef890c73f22ee8cc3a143d1c4c6714d549193f763ef5bceb20b32bc788953c92324f0b6a7422eaba8633f2bd3e0b758ca10f1111cdd27d4906168b0841e
+  metadata.gz: 3be31356db49a927bc7e716649e3da90d7868497ed3e5257d86b7f3480fb6591fc3e5eae1a40219988aadd45f137dd58b50bf384b47985d9f8c881c80d6b0f0a
+  data.tar.gz: 1de0cf6339a46f271287e747bf4449905fa4eb1bbe1682294fe9d0f4f5ea8aad95711cd96c51274720a3455152fa5567db43a4011a121e9f85cbbce9ac4eb822

data/.version

@@ -0,0 +1 @@
+1.2.0

data/bin/ZReviewTender

@@ -7,17 +7,19 @@ $LOAD_PATH.unshift($lib)
 require "Models/AppleConfig"
 require "Models/AndroidConfig"
 require "Models/Processor"
+require "Models/Version"
 require "Helper"
 require "ZLogger"
 require "AppleFetcher"
 require "AndroidFetcher"
 require "optparse"
 require "yaml"
+require "fileutils"
 
 class Main
     def initialize
 
-        ARGV << '-r' if ARGV.empty?
+        ARGV << '-h' if ARGV.empty?
 
         OptionParser.new do |opts|
             opts.banner = "Usage: ZReviewTender [options]"
@@ -27,30 +29,41 @@ class Main
             defaultAppleConfigFileName = "apple.yml"
             defaultAndroidConfigFileName = "android.yml"
         
-            opts.on('-a', '--apple[=CONFIGYMLFILEPATH]', 'execute apple platform with config yml file') do |configYMLFilePath|
+            opts.on('-a', '--apple[=CONFIGYMLFILEPATH]', 'execute apple platform, default config yml file path: /config/apple.yml, use --apple=CONFIG_YML_FILE_PATH specify config yml file path') do |configYMLFilePath|
                 if configYMLFilePath.nil?
                     configYMLFilePath = "#{basePath}/#{defaultConfigDirName}/#{defaultAppleConfigFileName}"
                 end
                 configFileCheck(configYMLFilePath, "--apple=CONFIG_YML_FILE_PATH")
 
+                puts "[ZReviewTender] run -a/-apple config yml file path: #{configYMLFilePath}"
+
                 fetcher = parseConfigYMLFile(configYMLFilePath)
                 fetcher.execute()
+
+                checkLatestVersionOfZReviewTender()
             end 
 
-            opts.on('-g', '--googleAndroid[=CONFIGYMLFILEPATH]', 'execute android platform with config yml file') do |configYMLFilePath|
+            opts.on('-g', '--googleAndroid[=CONFIGYMLFILEPATH]', 'execute android platform, default config yml file path: /config/android.yml, use --googleAndroid=CONFIG_YML_FILE_PATH specify config yml file path') do |configYMLFilePath|
                 if configYMLFilePath.nil?
                     configYMLFilePath = "#{basePath}/#{defaultConfigDirName}/#{defaultAndroidConfigFileName}"
                 end
                 configFileCheck(configYMLFilePath, "--googleAndroid=CONFIG_YML_FILE_PATH")
 
+                puts "[ZReviewTender] run -g/-googleAndroid config yml file path: #{configYMLFilePath}"
+
                 fetcher = parseConfigYMLFile(configYMLFilePath)
                 fetcher.execute()
+
+                checkLatestVersionOfZReviewTender()
             end 
             
-            opts.on('-r', '--run=[=CONFIGFOLDERNAME]', 'execute both android and apple, specify an /config folder name') do |configFolderName|
+            opts.on('-r', '--run=[=CONFIGFOLDERNAME]', 'execute both android and apple, specify a /config folder path') do |configFolderName|
                 if configFolderName.nil?
                     configFolderName = defaultConfigDirName
                 end
+
+                puts "[ZReviewTender] run -r/--run config folder path: #{configFolderName}"
+
                 androidConfigFilePath = "#{basePath}/#{configFolderName}/#{defaultAndroidConfigFileName}"
                 configFileCheck(androidConfigFilePath, "--googleAndroid=CONFIG_YML_FILE_PATH")
                 
@@ -64,10 +77,61 @@ class Main
 
                 fetcher = parseConfigYMLFile(appleConfigFilePath)
                 fetcher.execute()
-            end 
+
+                checkLatestVersionOfZReviewTender()
+            end
+
+            opts.on('-i', '--init', 'init config yml file from template.') do
+                configTemplateFolder = "#{File.expand_path("..", __dir__)}/config"
+                appleSourceExampleYML = "#{configTemplateFolder}/apple.example.yml"
+                androidSourceExampleYML = "#{configTemplateFolder}/android.example.yml"
+                appleDestExampleYML = "#{configTemplateFolder}/apple.yml"
+                androidDestExampleYML = "#{configTemplateFolder}/android.yml"
+                
+                if File.exists?(appleSourceExampleYML)
+                    if File.exists?(appleDestExampleYML)
+                        puts "Failed! Config YML File Exists: #{appleDestExampleYML}"
+                    else
+                        FileUtils.cp(appleSourceExampleYML, appleDestExampleYML)
+                        puts "Init Apple Config YML File at:#{appleDestExampleYML} Success!"
+                    end
+                end
+                #
+                if File.exists?(androidSourceExampleYML)
+                    if File.exists?(androidDestExampleYML)
+                        puts "Failed! Config YML File Exists: #{androidDestExampleYML}"
+                    else
+                        FileUtils.cp(androidSourceExampleYML, androidDestExampleYML)
+                        puts "Init Android Config YML File at:#{androidDestExampleYML} Success!"
+                    end
+                end
+
+                checkLatestVersionOfZReviewTender()
+            end
+            
+            opts.on('-n', '--new', 'update to latest version of ZReviewTender by RubyGem') do
+                version = Version.new
+
+                if version.getRemoteVersion() > version.getLocalVersion()
+                    system('gem update ZReviewTender')
+                else
+                    puts "You're using the latest version of ZReviewTender!"
+                end
+            end
         end.parse!
     end
 
+    private
+    def checkLatestVersionOfZReviewTender()
+        version = Version.new
+        if version.getRemoteVersion() > version.getLocalVersion()
+            puts "##########################################################"
+            puts "#####           New Version Available!!!             #####"
+            puts "#####   Please type `ZReviewTender -n` to update!!   #####"
+            puts "##########################################################"
+        end
+    end
+
     private
     def configFileCheck(path, command)
         if !File.exists? path
@@ -120,8 +184,14 @@ class Main
     end
 end
 
-begin 
+begin
+    puts "#https://github.com/ZhgChgLi/ZReviewTender"
+    puts "You have read and agree with the Disclaimer."
     Main.new()
+    puts "Execute Successfully!!!"
+    puts "#https://github.com/ZhgChgLi/ZReviewTender"
+    puts "#Thanks for using this tool."
+    puts "#If this is helpful, please help to star the repo or recommend it to your friends."
 rescue => e
     logger = ZLogger.new(ENV['PWD'] || ::Dir.pwd)
     title = "#Error: #{e.class} #{e.message}"

data/config/android.example.yml

@@ -0,0 +1,26 @@
+platform: 'android'
+packageName: '' # Android App Package Name
+keyFilePath: '' # Google Android Publisher API Credential .json File Path
+playConsoleDeveloperAccountID: '' # Google Console Developer Account ID
+playConsoleAppID: '' # Google Console App ID
+processors:
+    - FilterProcessor:
+        class: "FilterProcessor"
+        enable: true # enable
+        keywordsInclude: [] # keywords you want to filter out
+        ratingsInclude: [] # ratings you want to filter out
+        territoriesInclude: [] # territories you want to filter out(language for android e.g. zh-Hant, en)
+    - GoogleTranslateProcessor: # Google Translate Processor, will translate review text to your language, you can remove whole block if you don't needed it.
+        class: "GoogleTranslateProcessor"
+        enable: false # enable
+        googleTranslateAPIKeyFilePath: '' # Google Translate API Credential .json File Path
+        googleTranslateTargetLang: 'zh-TW' # Translate to what Language
+        googleTranslateTerritoriesExclude: ["zh-Hant","zh-Hans"] # Review origin Territory (language) that you don't want to translate. (language for android e.g. zh-Hant, en)
+    - SlackProcessor: # Slack Processor, resend App Review to Slack.
+        class: "SlackProcessor"
+        enable: true # enable
+        slackTimeZoneOffset: "+08:00" # Review Created Date TimeZone
+        slackAttachmentGroupByNumber: "1" # 1~100, how many review message in 1 slack message.
+        slackBotToken: "" # Slack Bot Token, send slack message throught Slack Bot.
+        slackBotTargetChannel: "" # Slack Bot Token, send slack message throught Slack Bot. (recommended, first priority)
+        slackInCommingWebHookURL: "" # Slack In-Comming WebHook URL, Send slack message throught In-Comming WebHook, not recommended, deprecated.

data/config/apple.example.yml

@@ -0,0 +1,26 @@
+platform: 'apple'
+appStoreConnectP8PrivateKeyFilePath: '' # APPLE STORE CONNECT API PRIVATE .p8 KEY File Path
+appStoreConnectP8PrivateKeyID: '' # APPLE STORE CONNECT API PRIVATE KEY ID
+appStoreConnectIssueID: '' # APPLE STORE CONNECT ISSUE ID
+appID: '' # APP ID
+processors:
+    - FilterProcessor:
+        class: "FilterProcessor"
+        enable: true # enable
+        keywordsInclude: [] # keywords you want to filter out
+        ratingsInclude: [] # ratings you want to filter out
+        territoriesInclude: [] # territories you want to filter out
+    - GoogleTranslateProcessor: # Google Translate Processor, will translate review text to your language, you can remove whole block if you don't needed it.
+        class: "GoogleTranslateProcessor"
+        enable: false # enable
+        googleTranslateAPIKeyFilePath: '' # Google Translate API Credential .json File Path
+        googleTranslateTargetLang: 'zh-TW' # Translate to what Language
+        googleTranslateTerritoriesExclude: ["TWN","CHN"] # Review origin Territory that you don't want to translate.
+    - SlackProcessor: # Slack Processor, resend App Review to Slack.
+        class: "SlackProcessor"
+        enable: true # enable
+        slackTimeZoneOffset: "+08:00" # Review Created Date TimeZone
+        slackAttachmentGroupByNumber: "1" # 1~100, how many review message in 1 slack message.
+        slackBotToken: "" # Slack Bot Token, send slack message throught Slack Bot.
+        slackBotTargetChannel: "" # Slack Bot Token, send slack message throught Slack Bot. (recommended, first priority)
+        slackInCommingWebHookURL: "" # Slack In-Comming WebHook URL, Send slack message throught In-Comming WebHook, not recommended, deprecated.

data/lib/AndroidFetcher.rb

@@ -17,16 +17,21 @@ class AndroidFetcher < ReviewFetcher
 
         @client = Google::Apis::AndroidpublisherV3::AndroidPublisherService.new
         @client.authorization = Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: config.keyContent, scope: 'https://www.googleapis.com/auth/androidpublisher')
+
+        puts "[AndroidFetcher] Init Success."
     end
 
     def execute()
 
         latestCheckTimestamp = getPlatformLatestCheckTimestamp()
 
+        puts "[AndroidFetcher] Start execute(), latestCheckTimestamp: #{latestCheckTimestamp}"
+
         reviews = []
         
         # Google API Bug, couldn't specify limit/offse/pagination, google only return a few recent reviews.
         customerReviews = client.list_reviews(config.packageName).reviews
+        puts "[AndroidFetcher] Fetch reviews in #{config.packageName}, count: #{customerReviews.length}"
         customerReviews.each do |customerReview|
 
             customerReviewID = customerReview.review_id
@@ -53,9 +58,13 @@ class AndroidFetcher < ReviewFetcher
         end
 
         reviews = reviews.reject{ |review| latestCheckTimestamp >= review.createdDateTimestamp }.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
-      
+        
+        puts "[AndroidFetcher] latest reviews count: #{reviews.length}"
+
         if reviews.length > 0
 
+            puts "[AndroidFetcher] latest review: #{reviews.last.body}, #{reviews.last.createdDateTimestamp}"
+            
             setPlatformLatestCheckTimestamp(reviews.last.createdDateTimestamp)
 
             # init first time, send welcome message

data/lib/AppleFetcher.rb

@@ -18,16 +18,22 @@ class AppleFetcher < ReviewFetcher
         @logger = ZLogger.new(config.baseExecutePath)
         @platform = 'Apple'
         @token = generateJWT()
+
+        puts "[AppleFetcher] Init Success."
     end
 
     def execute()
 
         latestCheckTimestamp = getPlatformLatestCheckTimestamp()
 
+        puts "[AppleFetcher] Start execute(), latestCheckTimestamp: #{latestCheckTimestamp}"
+
         reviews = fetchReviews(latestCheckTimestamp)
 
         if reviews.length > 0
             reviews.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
+
+            puts "[AppleFetcher] latest review: #{reviews.last.body}, #{reviews.last.createdDateTimestamp}"
             setPlatformLatestCheckTimestamp(reviews.last.createdDateTimestamp)
 
             # init first time, send welcome message
@@ -46,10 +52,14 @@ class AppleFetcher < ReviewFetcher
         customerReviewsLink = "https://api.appstoreconnect.apple.com/v1/apps/#{config.appID}/customerReviews?sort=-createdDate"
         reviews = []
 
+        puts "[AppleFetcher] Fetch reviews in #{config.appID}"
+
         loop do
             customerReviews = request(customerReviewsLink)
             customerReviewsLink = customerReviews&.dig("links", "next")
 
+            puts "[AppleFetcher] Fetch reviews, page url: #{customerReviewsLink}"
+            puts "[AppleFetcher] Fetch reviews, page's reviews count: #{customerReviews&.dig("data").length}"
             customerReviews&.dig("data").each do |customerReview|
 
                 customerReviewID = customerReview&.dig("id")
@@ -83,11 +93,18 @@ class AppleFetcher < ReviewFetcher
             break if customerReviewsLink.nil?
         end
 
+        puts "[AppleFetcher] Fetch reviews in #{config.appID}, total reviews count: #{reviews.length}"
+
         return reviews
     end
 
+    # because customerReviews, won't give us app version information
+    # so, we need to query it from appStoreVersions api and combine together
     private
     def fullfillAppInfo(reviews)
+
+        puts "[AppleFetcher] Full fill app version information."
+
         customerReviewWhichAppVersionIsNil = reviews.select{ |review| review.appVersion.nil? }.map.with_index { |review, index| {"id":review.id, "index": index} }
 
         appStoreVersionsLink = "https://api.appstoreconnect.apple.com/v1/apps/#{config.appID}/appStoreVersions"
@@ -96,6 +113,8 @@ class AppleFetcher < ReviewFetcher
             appStoreVersions = request(appStoreVersionsLink)
             appStoreVersionsLink = appStoreVersions&.dig("links", "next")
 
+            puts "[AppleFetcher] List app store version, page url: #{appStoreVersionsLink}"
+            puts "[AppleFetcher] List app store version, versions count: #{appStoreVersions&.dig("data").length}"
             appStoreVersions&.dig("data").each do |appStoreVersion|
                 applePlatform = appStoreVersion&.dig("attributes","platform")
                 versionString = appStoreVersion&.dig("attributes","versionString")
@@ -108,6 +127,8 @@ class AppleFetcher < ReviewFetcher
                         customerReviews = request(customerReviewsLink)
                         customerReviewsLink = customerReviews&.dig("links", "next")
 
+                        puts "[AppleFetcher] Fetch version reviews, page url: #{customerReviewsLink}"
+                        puts "[AppleFetcher] Fetch version reviews, reviews count: #{customerReviews&.dig("data").length}"
                         customerReviews&.dig("data").each do |customerReview|
                             customerReviewID = customerReview&.dig("id")
                             if customerReviewID.nil?
@@ -121,6 +142,8 @@ class AppleFetcher < ReviewFetcher
 
                                 customerReviewWhichAppVersionIsNil.delete_at(findIndex)
 
+                                puts "[AppleFetcher] Count of reviews need full fill app version: #{customerReviewWhichAppVersionIsNil.length}"
+
                                 if customerReviewWhichAppVersionIsNil.length < 1
                                     customerReviewsLink = nil
                                     break
@@ -172,7 +195,9 @@ class AppleFetcher < ReviewFetcher
                 raise "Could not connect to api.appstoreconnect.apple.com, error message: #{response}"
             else
                 @token = generateJWT()
-                logger.logWarn("JWT Expired, refresh a new one. (#{retryCount + 1})")
+                message = "JWT Expired, refresh a new one. (#{retryCount + 1})"
+                logger.logWarn(message)
+                puts "[AppleFetcher] #{message}"
                 return request(url, retryCount + 1)
             end
         else

data/lib/Models/Version.rb

@@ -0,0 +1,39 @@
+$lib = File.expand_path('../lib', File.dirname(__FILE__))
+
+require "net/http"
+
+class Version
+    def getLocalVersion()
+        versionFilePath = "#{File.expand_path("../..", __dir__)}/.version"
+        
+        result = nil
+        if File.file?(versionFilePath)
+            result = File.read(versionFilePath).strip
+        else
+            result = Gem.loaded_specs["ZReviewTender"].version.version
+        end
+
+        if !result.nil?
+            Gem::Version.new(result)
+        else
+            nil
+        end
+    end
+
+    def getRemoteVersion()
+        apiPath = 'https://rubygems.org/api/v1/gems/ZReviewTender.json'
+        
+        uri = URI(apiPath)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Get.new(uri)
+        response = https.request(request).read_body
+        result = JSON.parse(response)
+        
+        if !result['version'].nil?
+            Gem::Version.new(result['version'])
+        else
+            nil
+        end
+    end
+end

data/lib/Processors/FilterProcessor.rb

@@ -27,6 +27,8 @@ class FilterProcessor < Processor
         if !config["territoriesInclude"].nil?
             @territoriesInclude = config["territoriesInclude"]
         end
+
+        puts "[FilterProcessor] Init Success."
     end
 
     def processReviews(reviews, platform)
@@ -35,17 +37,23 @@ class FilterProcessor < Processor
         end
         
         if ratingsInclude.length > 0
+            orgReviewsCount = reviews.length
             reviews = reviews.select{ |review| ratingsInclude.map{ |rating| rating.to_i }.include? review.rating }
+            puts "[FilterProcessor] filter out ratings from #{orgReviewsCount} to #{reviews.length}"
         end
 
         if territoriesInclude.length > 0
+            orgReviewsCount = reviews.length
             reviews = reviews.select{ |review| territoriesInclude.map{ |territory| territory.upcase }.include? review.territory.upcase }
+            puts "[FilterProcessor] filter out ratings from #{orgReviewsCount} to #{reviews.length}"
         end
 
         if keywordsInclude.length > 0
+            orgReviewsCount = reviews.length
             keywordsInclude.select{ |keywordsInclude| keywordsInclude != "" }.each do |keywordInclude|
                 reviews = reviews.select{ |review| review.body.include? keywordInclude }
             end
+            puts "[FilterProcessor] filter out ratings from #{orgReviewsCount} to #{reviews.length}"
         end
 
         return reviews

data/lib/Processors/GoogleTranslateProcessor.rb

@@ -30,6 +30,8 @@ class GoogleTranslateProcessor < Processor
         if !config['googleTranslateTerritoriesExclude'].nil? && config['googleTranslateTerritoriesExclude'].length > 0
             @territoriesExclude = config['googleTranslateTerritoriesExclude']
         end
+
+        puts "[GoogleTranslateProcessor] Init Success."
     end
 
     def processReviews(reviews, platform)
@@ -42,6 +44,8 @@ class GoogleTranslateProcessor < Processor
                 next
             end
 
+            puts "[GoogleTranslateProcessor] translate #{reviews[index].body} from #{reviews[index].territory} to #{targetLang}"
+
             if !reviews[index].title.nil?
                 reviews[index].title = "#{client.translate reviews[index].title, to: targetLang} (#{reviews[index].title})"
             end

data/lib/Processors/SlackProcessor.rb

@@ -33,6 +33,8 @@ class SlackProcessor < Processor
         elsif !botToken.nil? && botToken != "" && (targetChannel.nil? || targetChannel == "")
             raise "must specify slackBotTargetChannel in SlackProcessor."
         end
+
+        puts "[SlackProcessor] Init Success."
     end
 
     def processReviews(reviews, platform)
@@ -74,7 +76,7 @@ class SlackProcessor < Processor
 
         loop do
             payload = pendingPayloads.shift
-
+            
             result = request(payload)
             if !result[:ok]
                 logger.logError(payload)
@@ -85,6 +87,7 @@ class SlackProcessor < Processor
                 end
             end
 
+            puts "[SlackProcessor] Send new Review messages, rest: #{pendingPayloads.length}"
             break if pendingPayloads.length < 1
         end
 
@@ -109,6 +112,7 @@ class SlackProcessor < Processor
         
         payload.attachments.append(attachment)
 
+        puts "[SlackProcessor] sendWelcomMessage(#{title})"
         request(payload)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ZReviewTender
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - ZhgChgLi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -73,7 +73,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".version"
 - bin/ZReviewTender
+- config/android.example.yml
+- config/apple.example.yml
 - lib/AndroidFetcher.rb
 - lib/AppleFetcher.rb
 - lib/Helper.rb
@@ -82,6 +85,7 @@ files:
 - lib/Models/Processor.rb
 - lib/Models/Review.rb
 - lib/Models/ReviewFetcher.rb
+- lib/Models/Version.rb
 - lib/Processors/FilterProcessor.rb
 - lib/Processors/GoogleTranslateProcessor.rb
 - lib/Processors/ProcessorTemplate.rb