ZReviewTender 1.2.5 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c197ecf59b28ef67df11ec8795a6cd740e206211b072325dec5b02b9c1bec232
-  data.tar.gz: bd8ecd956b8e2c528a5a6d19dbf1f6c60be0be6e9fe0ccfeab2a3e6f840b2f2c
+  metadata.gz: 8bcc9b0eab8e7b7c5aacfbc1add9a591e860222656d4097b3184011e41f8d93b
+  data.tar.gz: cf092f42c2d81f62394713040fea08748810c283e4f0540f019b381042cf305b
 SHA512:
-  metadata.gz: 9a761827f14d965bf732955a2df5aad4efc8ab3f6d7a2045c212cbecce8479192415f1f47ef4ffcad306fabc45854ab56eed43422425025ed43cfcd2a2768ee2
-  data.tar.gz: df78adf8c930f754031658063b8f8e8a8d7adb3aa56697c7e8e9fe8e3ea23efc2a12e12f5e05773741e408627d6167740f468399c40b0577a01fb16156703713
+  metadata.gz: 7ddf0c24a5120da15392ca8c2b5053d39b6ae48853ed85e16fb8e445ca76ec3039ff2c97ee02e6015d20641ae697245de715951015397c44de4002d3456494f8
+  data.tar.gz: 03afbee02b7543121a52a645258845780e0fbadf42b7b8ab65f8f9553317447500ee004df953c62735ba82cc584c0e1e3193a07b98f396913ce1217db40eb56b

data/.version

@@ -1 +1 @@
-1.2.5
+1.2.8

data/bin/ZReviewTender

@@ -170,43 +170,38 @@ class Main
     private
     def parseConfigYMLFile(configFilePath)
         configYMLObj = YAML.load_file(configFilePath)
-        begin
-            platform = Helper.unwrapRequiredParameter(configYMLObj, 'platform')
+        platform = Helper.unwrapRequiredParameter(configYMLObj, 'platform')
             
-            fetcher = nil
-            if platform.downcase == "apple"
-                fetcher = AppleFetcher.new(AppleConfig.new(configYMLObj, configFilePath, ENV['PWD'] || ::Dir.pwd))
-            elsif platform.downcase == "android"
-                fetcher = AndroidFetcher.new(AndroidConfig.new(configYMLObj, configFilePath, ENV['PWD'] || ::Dir.pwd))
-            else
-                raise "unknow platform #{platform} in yml file #{configFilePath}."
-            end
+        fetcher = nil
+        if platform.downcase == "apple"
+            fetcher = AppleFetcher.new(AppleConfig.new(configYMLObj, configFilePath, ENV['PWD'] || ::Dir.pwd))
+        elsif platform.downcase == "android"
+            fetcher = AndroidFetcher.new(AndroidConfig.new(configYMLObj, configFilePath, ENV['PWD'] || ::Dir.pwd))
+        else
+            raise "unknow platform #{platform} in yml file #{configFilePath}."
+        end
 
-            processors = Helper.unwrapRequiredParameter(configYMLObj, 'processors')
-            if processors.nil?
-                processors = []
-            end
+        processors = Helper.unwrapRequiredParameter(configYMLObj, 'processors')
+        if processors.nil?
+            processors = []
+        end
 
-            if processors.length < 1
-                raise "must specify/enable at least one processor."
-            end
+        if processors.length < 1
+            raise "must specify/enable at least one processor."
+        end
 
-            processors.each do |processor|
-                processor.each do |key, value|
-                    if value["enable"] != true
-                        next
-                    end
-                    processorClass = Helper.unwrapRequiredParameter(value, "class")
-                    require "Processors/#{processorClass}"
-                    fetcher.registerProcessor(eval("#{processorClass}.new(#{value}, '#{configFilePath}', '#{ENV['PWD'] || ::Dir.pwd}')"))
+        processors.each do |processor|
+            processor.each do |key, value|
+                if value["enable"] != true
+                    next
                 end
+                processorClass = Helper.unwrapRequiredParameter(value, "class")
+                require "Processors/#{processorClass}"
+                fetcher.registerProcessor(eval("#{processorClass}.new(#{value}, '#{configFilePath}', '#{ENV['PWD'] || ::Dir.pwd}')"))
             end
+        end
 
-
-            return fetcher
-        rescue => e
-            raise "#{e.message} in yml file #{configFilePath}."
-        end        
+        return fetcher  
     end
 end
 
@@ -222,14 +217,17 @@ begin
     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}"
-    body = e.backtrace
-    
-    logger.logError("===RUNTIME EXCEPTION START===")
-    logger.logError(title)
-    logger.logError(body)
-    logger.logError("===RUNTIME EXCEPTION END===")
-        
-    puts title
-    puts body
+    errorMessage = "#Error Message:  #{e.message}\n"
+    errorMessage += "#Error Class: #{e.class}\n"
+    errorMessage += "#Backtrace Start#\n#{e.backtrace.join("\n")}\n#Backtrace End#\n"
+    logger.logError(errorMessage)
+
+    puts "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+    puts "XXXXX  Excute Failed, Error Occurred!  XXXXX"
+    puts "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+    puts "X https://github.com/ZhgChgLi/ZReviewTender"
+    puts "X Please create an issue on above repo, and provide error log, thanks!"
+    puts "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+
+    raise e
 end

data/lib/AndroidFetcher.rb

@@ -3,20 +3,19 @@ $lib = File.expand_path('../lib', File.dirname(__FILE__))
 require "Models/Review"
 require "Helper"
 require "Models/ReviewFetcher"
+require "jwt"
 require "time"
-require "google/apis/androidpublisher_v3"
 
 class AndroidFetcher < ReviewFetcher
 
-    attr_accessor :token, :client
+    attr_accessor :token
 
     def initialize(config)
         @processors = []
         @config = config
         @platform = 'Android'
-
-        @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')
+        @logger = ZLogger.new(config.baseExecutePath)
+        @token = generateJWT()
 
         puts "[AndroidFetcher] Init Success."
     end
@@ -28,43 +27,106 @@ class AndroidFetcher < ReviewFetcher
         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
-            customerReviewTitle = nil
-            customerReviewBody = customerReview.comments[0].user_comment.text.strip
-            customerReviewRating = customerReview.comments[0].user_comment.star_rating.to_i
-            customerReviewReviewerNickname = customerReview.author_name
-            customerReviewCreatedDateTimestamp = customerReview.comments[0].user_comment.last_modified.seconds.to_i
-            customerReviewTerritory = customerReview.comments[0].user_comment.reviewer_language
-            customerReviewVersionString = "unknown"
-            if !customerReview.comments[0].user_comment.app_version_name.nil?
-                customerReviewVersionString = "#{customerReview.comments[0].user_comment.app_version_name}"
-                if !customerReview.comments[0].user_comment.app_version_code.nil?
-                    customerReviewVersionString = "#{customerReviewVersionString}(#{customerReview.comments[0].user_comment.app_version_code})"
+
+        reviewsInfoLink = "https://androidpublisher.googleapis.com/androidpublisher/v3/applications/#{config.packageName}/reviews"
+
+        # Note: You can retrieve only the reviews that users have created or modified within the last week. 
+        # https://developers.google.com/android-publisher/reply-to-reviews#retrieving_a_set_of_reviews
+
+        puts "[AndroidFetcher] Fetch reviews in #{config.packageName}"
+
+        loop do
+            reviewsInfo = request(reviewsInfoLink)
+            reviewsInfoLink = reviewsInfo&.dig("tokenPagination", "nextPageToken")
+
+            customerReviews = reviewsInfo["reviews"]
+            puts "[AndroidFetcher] Fetch reviews in #{config.packageName}, count: #{customerReviews.length}"
+            customerReviews.each do |customerReview|
+
+                customerReviewID = customerReview&.dig("reviewId")
+                customerReviewTitle = nil
+                customerReviewReviewerNickname = customerReview&.dig("authorName")
+                customerReviewVersionString = "unknown"
+                customerReviewPlatform = platform
+                customerReviewCreatedDateTimestamp = 0
+                
+                comment = customerReview&.dig("comments", 0, "userComment")
+                if !comment.nil?
+                    customerReviewBody = comment&.dig("text")
+                    customerReviewTerritory = comment&.dig("reviewerLanguage")
+
+                    if !customerReviewBody.nil?
+                        customerReviewBody = customerReviewBody.strip
+                    end
+
+                    customerReviewRating = comment&.dig("starRating")
+                    if !customerReviewRating.nil?
+                        customerReviewRating = customerReviewRating.to_i
+                    end
+
+                    customerReviewCreatedDateTimestamp = comment&.dig("lastModified", "seconds")
+                    if !customerReviewCreatedDateTimestamp.nil?
+                        customerReviewCreatedDateTimestamp = customerReviewCreatedDateTimestamp.to_i
+                    end
+
+                    androidOSVersion = comment&.dig("androidOsVersion")
+                    if !androidOSVersion.nil?
+                        customerReviewPlatform = "#{platform} #{androidOSVersion}"
+                    end
+
+                    versionString = comment&.dig("appVersionName")
+                    if !versionString.nil?
+                        customerReviewVersionString = "#{versionString}"
+
+                        versionCode = comment&.dig("appVersionCode")
+                        if !versionCode.nil?
+                            customerReviewVersionString = "#{customerReviewVersionString}(#{versionCode})"
+                        end
+                    end
+
+                    deviceInfo = []
+                    manufacturer = comment&.dig("deviceMetadata", "manufacturer")
+                    if !manufacturer.nil?
+                        deviceInfo.append(manufacturer)
+                    end
+
+                    productName = comment&.dig("deviceMetadata", "productName")
+                    if !productName.nil?
+                        deviceInfo.append(productName)
+                    end
+
+                    if deviceInfo.length > 0
+                        customerReviewTitle = "#{deviceInfo.join("/")}"
+                    end
+                end
+
+                if latestCheckTimestamp >= customerReviewCreatedDateTimestamp
+                    reviewsInfoLink = nil
+                    break
+                else
+                    url = "https://play.google.com/store/apps/details?id=#{config.packageName}&reviewId=#{customerReviewID}"
+                    if !config.accountID.nil? && !config.appID.nil?
+                        url = "https://play.google.com/console/developers/#{config.accountID}/app/#{config.appID}/user-feedback/review-details?reviewId=#{customerReviewID}"
+                    end
+                    reviews.append(Review.new(customerReviewPlatform, customerReviewID, customerReviewReviewerNickname, customerReviewRating, customerReviewTitle, customerReviewBody, customerReviewCreatedDateTimestamp, url, customerReviewVersionString, customerReviewTerritory))
+                    
+                    # init first time, need first review to set as latestCheckTimestamp
+                    if latestCheckTimestamp == 0
+                        reviewsInfoLink = nil
+                        break
+                    end
                 end
             end
-            customerReviewPlatform = "Android #{customerReview.comments[0].user_comment.android_os_version}"
             
-            url = "https://play.google.com/store/apps/details?id=#{config.packageName}&reviewId=#{customerReviewID}"
-            if !config.accountID.nil? && !config.appID.nil?
-                url = "https://play.google.com/console/developers/#{config.accountID}/app/#{config.appID}/user-feedback/review-details?reviewId=#{customerReviewID}"
-            end
-            reviews.append(Review.new(customerReviewPlatform, customerReviewID, customerReviewReviewerNickname, customerReviewRating, customerReviewTitle, customerReviewBody, customerReviewCreatedDateTimestamp, url, customerReviewVersionString, customerReviewTerritory))
+            break if reviewsInfoLink.nil?
         end
 
-        reviews = reviews.reject{ |review| latestCheckTimestamp >= review.createdDateTimestamp }.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
-        
-        puts "[AndroidFetcher] latest reviews count: #{reviews.length}"
+        puts "[AndroidFetcher] Fetch reviews in #{config.packageName}, total reviews count: #{reviews.length}"
 
         if reviews.length > 0
+            reviews = reviews.sort! { |a, b|  a.createdDateTimestamp <=> b.createdDateTimestamp }
 
             puts "[AndroidFetcher] latest review: #{reviews.last.body}, #{reviews.last.createdDateTimestamp}"
-            
             setPlatformLatestCheckTimestamp(reviews.last.createdDateTimestamp)
 
             # init first time, send welcome message
@@ -76,4 +138,58 @@ class AndroidFetcher < ReviewFetcher
             processReviews(reviews, platform)
         end
     end
+
+    private
+    def generateJWT()
+        payload = {
+            iss: config.clientEmail,
+            sub: config.clientEmail,
+            scope: "https://www.googleapis.com/auth/androidpublisher",
+            aud: config.tokenURI,
+            iat: Time.now.to_i,
+            exp: Time.now.to_i + 60*20
+        }
+
+        rsa_private = OpenSSL::PKey::RSA.new(config.keyContent)
+        token = JWT.encode payload, rsa_private, 'RS256', header_fields = {kid:config.keyID, typ:"JWT"}
+
+        uri = URI(config.tokenURI)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Post.new(uri)
+        request.body = "grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=#{token}"
+
+        response = https.request(request).read_body
+        result = JSON.parse(response)
+        
+        return result["access_token"]
+    end
+
+    private
+    def request(url, retryCount = 0)
+        uri = URI(url)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        
+        request = Net::HTTP::Get.new(uri)
+        request['Authorization'] = "Bearer #{token}";
+        
+        response = https.request(request).read_body
+        
+        result = JSON.parse(response)
+        if result["reviews"].nil?
+            if retryCount >= 10
+                raise "Could not connect to androidpublisher.googleapis.com, error message: #{response}"
+            else
+                @token = generateJWT()
+                message = "JWT Expired, refresh a new one. (#{retryCount + 1})"
+                logger.logWarn(message)
+                puts "[AndroidFetcher] #{message}"
+                return request(url, retryCount + 1)
+            end
+        else
+            return result
+        end
+
+    end
 end

data/lib/AppleFetcher.rb

@@ -79,7 +79,7 @@ class AppleFetcher < ReviewFetcher
                     customerReviewsLink = nil
                     break
                 else
-                    url = "https://appstoreconnect.apple.com/apps/#{config.appID}/appstore/activity/ios/ratingsResponses"
+                    url = "https://appstoreconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app/#{config.appID}/ios/ratingsResponses"
                     reviews.append(Review.new(nil, customerReviewID, customerReviewReviewerNickname, customerReviewRating, customerReviewTitle, customerReviewBody, customerReviewCreatedDateTimestamp, url, nil, customerReviewTerritory))
                     
                     # init first time, need first review to set as latestCheckTimestamp
@@ -175,7 +175,8 @@ class AppleFetcher < ReviewFetcher
             exp: Time.now.to_i + 60*20,
             aud: 'appstoreconnect-v1'
         }
-        token = JWT.encode payload, config.keyContent, 'ES256', header_fields={kid:config.keyID, typ:"JWT"}
+        
+        return JWT.encode payload, config.keyContent, 'ES256', header_fields={kid:config.keyID, typ:"JWT"}
     end
 
     private
@@ -205,4 +206,4 @@ class AppleFetcher < ReviewFetcher
         end
 
     end
-end
+end

data/lib/Models/AndroidConfig.rb

@@ -5,7 +5,7 @@ require "Helper"
 require "time"
 
 class AndroidConfig
-    attr_accessor :keyContent, :packageName, :accountID, :appID, :baseExecutePath
+    attr_accessor :keyContent, :keyID, :tokenURI, :clientEmail, :packageName, :accountID, :appID, :baseExecutePath
     def initialize(configYMLObj, configFilePath, baseExecutePath)
         keyFilePath = Helper.unwrapRequiredParameter(configYMLObj,"keyFilePath")
 
@@ -14,9 +14,14 @@ class AndroidConfig
             keyFilePath = "#{configDir}#{keyFilePath}"
         end
 
+        keyFileContent = JSON.parse(File.read(keyFilePath))
+
         @accountID = configYMLObj["playConsoleDeveloperAccountID"]
         @appID = configYMLObj["playConsoleAppID"]
-        @keyContent = File.open(keyFilePath)
+        @keyContent = Helper.unwrapRequiredParameter(keyFileContent,"private_key")
+        @keyID = Helper.unwrapRequiredParameter(keyFileContent,"private_key_id")
+        @clientEmail = Helper.unwrapRequiredParameter(keyFileContent,"client_email")
+        @tokenURI = Helper.unwrapRequiredParameter(keyFileContent,"token_uri")
         @baseExecutePath = baseExecutePath
         @packageName = Helper.unwrapRequiredParameter(configYMLObj,"packageName")
     end

data/lib/Processors/GoogleTranslateProcessor.rb

@@ -3,18 +3,19 @@ $lib = File.expand_path('../lib', File.dirname(__FILE__))
 require "Models/Review"
 require "Models/Processor"
 require "Helper"
-
 require "pathname"
-require "google/cloud/translate/v2"
+require "jwt"
+require "time"
 
 class GoogleTranslateProcessor < Processor
 
-    attr_accessor :client, :targetLang, :territoriesExclude
+    attr_accessor :keyContent, :keyID, :tokenURI, :clientEmail, :targetLang, :territoriesExclude, :token, :logger
 
     def initialize(config, configFilePath, baseExecutePath)
         @config = config
         @configFilePath = configFilePath
         @baseExecutePath = baseExecutePath
+        @logger = ZLogger.new(baseExecutePath)
 
         keyFilePath = Helper.unwrapRequiredParameter(config, "googleTranslateAPIKeyFilePath")
 
@@ -23,14 +24,21 @@ class GoogleTranslateProcessor < Processor
             keyFilePath = "#{configDir}#{keyFilePath}"
         end
 
-        ENV["TRANSLATE_CREDENTIALS"] = keyFilePath
-        @client = Google::Cloud::Translate::V2.new
+        keyFileContent = JSON.parse(File.read(keyFilePath))
+
+        @keyContent = Helper.unwrapRequiredParameter(keyFileContent,"private_key")
+        @keyID = Helper.unwrapRequiredParameter(keyFileContent,"private_key_id")
+        @clientEmail = Helper.unwrapRequiredParameter(keyFileContent,"client_email")
+        @tokenURI = Helper.unwrapRequiredParameter(keyFileContent,"token_uri")
+
         @targetLang = Helper.unwrapRequiredParameter(config, "googleTranslateTargetLang")
         @territoriesExclude = []
         if !config['googleTranslateTerritoriesExclude'].nil? && config['googleTranslateTerritoriesExclude'].length > 0
             @territoriesExclude = config['googleTranslateTerritoriesExclude']
         end
 
+        @token = generateJWT()
+
         puts "[GoogleTranslateProcessor] Init Success."
     end
 
@@ -41,21 +49,85 @@ class GoogleTranslateProcessor < Processor
         
         reviews.each_index do |index|
             if territoriesExclude.include? reviews[index].territory
-                next
+                #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})"
+                translateTitle = translate(reviews[index].title)
+                if !translateTitle.nil? && translateTitle != reviews[index].title
+                    reviews[index].title = "#{translateTitle} (#{reviews[index].title})"
+                end
+            end
+
+            if !reviews[index].body.nil?
+                translateBody = translate(reviews[index].body)
+                if !translateBody.nil? && translateBody != reviews[index].body
+                    body = "#{translateBody}"
+                    body += "\r\n===== Translate by Google =====\r\n"
+                    body += reviews[index].body
+                    reviews[index].body = body
+                end
             end
-            body = "#{client.translate reviews[index].body, to: targetLang}"
-            body += "\r\n===== Translate by Google =====\r\n"
-            body += reviews[index].body
-            reviews[index].body = body
         end
 
         return reviews
     end
 
+    private
+    def generateJWT()
+        payload = {
+            iss: clientEmail,
+            sub: clientEmail,
+            scope: ["https://www.googleapis.com/auth/cloud-translation","https://www.googleapis.com/auth/cloud-platform"].join(' '),
+            aud: tokenURI,
+            iat: Time.now.to_i,
+            exp: Time.now.to_i + 60*20
+        }
+
+        rsa_private = OpenSSL::PKey::RSA.new(keyContent)
+        token = JWT.encode payload, rsa_private, 'RS256', header_fields = {kid:keyID, typ:"JWT"}
+
+        uri = URI(tokenURI)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Post.new(uri)
+        request.body = "grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=#{token}"
+
+        response = https.request(request).read_body
+        result = JSON.parse(response)
+        
+        return result["access_token"]
+    end
+
+    private
+    def translate(text, retryCount = 0)
+        uri = URI("https://translation.googleapis.com/language/translate/v2")
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        
+        request = Net::HTTP::Post.new(uri)
+        request.body = "q=#{text}&target=#{targetLang}"
+        request['Authorization'] = "Bearer #{token}";
+        
+        response = https.request(request).read_body
+        
+        result = JSON.parse(response)
+        translate = result&.dig("data", "translations", 0, "translatedText")
+        if translate.nil?
+            if retryCount >= 10
+                raise "Could not connect to translation.googleapis.com, error message: #{response}"
+            else
+                @token = generateJWT()
+                message = "JWT Expired, refresh a new one. (#{retryCount + 1})"
+                logger.logWarn(message)
+                puts "[GoogleTranslateProcessor] #{message}"
+                return request(text, retryCount + 1)
+            end
+        else
+            return translate
+        end
+
+    end
 end

data/lib/ZLogger.rb

@@ -12,22 +12,16 @@ class ZLogger
 
     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: 1.2.5
+  version: 1.2.8
 platform: ruby
 authors:
 - ZhgChgLi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http