ZReviewTender 1.3.5 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa2d4d55b850012e36f3368bfdf84e301acb719914bdfe9873af9bd5ab6ab2ee
-  data.tar.gz: b101d60289e1bea2f5d02f77ae1dda04d5faaec33289a72aa3c0b661d4858c58
+  metadata.gz: 77c4a5c74b6076acbf3ec3ea98046ab703f1df3485c4590c9f1de62bda77fad9
+  data.tar.gz: 1b8bc52b07eac4add166d360b648fa5991264d501b72a39c1dc7a412da51413c
 SHA512:
-  metadata.gz: d9b16dd294304c8e220ddaa07933ddb0b135965030ac72fd6669e02d675ab117e93759c28e456e29ccd50c99f65fde9615bb3a6ecc598bb8eb5a0c50f8ea4ddd
-  data.tar.gz: 72c179f0bf24134eec589857c59f29c23f8b621683a808564e5fc49c0f65ac9463ca4c184fb91d62aeca1adfe11f8ce1a93f1774b423155f88720d71592e6260
+  metadata.gz: 8bba8ffe64bb4342689ade1b868a4a369e7879641c927466792cfef62f1860b3508efb1d289c5fea8c0bb6741780e2ce491c063814b327e4b85c2b699851dff7
+  data.tar.gz: 5cea45b9203f52e95ff67169fec881981e501e68b8e7cbc2298798e483963a44684d17e0337a7536b99ed2ba6f08f99bf531b762cf0848d8326c4864ba5bdc99

data/.version

@@ -1 +1 @@
-1.3.5
+1.3.7

data/config/android.example.yml

@@ -29,8 +29,11 @@ processors:
         enable: false # enable
         googleSheetAPIKeyFilePath: "" # Google Translate API Service Account Credential .json File Path
         googleSheetTimeZoneOffset: "+08:00" # Review Created Date TimeZone
-        googleSheetID: "" # Google Sheet ID, you can get it on google sheet url: e.g. https://docs.google.com/spreadsheets/d/googleSheetID/
-        googleSheetName: "Sheet1" # Sheet Name
+        googleSheetInsertStyle:
+            - type: "append" # Google Sheet Insert type, append or insert
+            - at: 0 # required if type is insert, where index should insert at
+            - sheetID: null # required if type is insert, the sheet ID, you can get it on google sheet url: e.g. https://docs.google.com/spreadsheets/d/googleSpreadsheetID/edit#gid=sheetID
+            - sheetName: "Sheet1" # required if type is append, a.k.a google sheet tab name
         values: ["%RATING%","%TITLE%\n%BODY%","%APPVERSION%","%CREATEDDATE%"] # Columns Data, you can uses magic variable below to compose string.
         # %TITLE% for review's title
         # %BODY% for review's content
@@ -43,6 +46,30 @@ processors:
         # %APPVERSION% for review's reviewer app version
         # %CREATEDDATE% for review's created date
         
+        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)
+    - AsanaProcessor:
+        class: "AsanaProcessor"
+        enable: false # enable
+        asanaTimeZoneOffset: "+08:00"
+        asanaToken: "" # Asana Personal Access Token, get it here -> https://app.asana.com/0/my-apps
+        asanaProjectID: "" # Asana Project ID, get it in project url -> https://app.asana.com/0/asanaProjectID/list
+        asanaSectionName: "" # Task Target Project - Section Name, optional
+        asanaTaskTitleTemplate: "%PLATFORM% - %RATING% ⭐️ - %TITLE%" # Asana Task Title Template
+        asanaTaskBodyTemplate: "Title: %TITLE%\n---\nBody:\n%BODY%\n---\n- UserName: %USERNAME%\n- App Version:  %APPVERSION%\n- Date:%CREATEDDATE%" # Asana Task Body Template
+        # you can uses magic variable below to compose string.
+        # %TITLE% for review's title
+        # %BODY% for review's content
+        # %RATING% for review's rating 1~5
+        # %PLATFORM% for review's platform Apple or Android
+        # %ID% for review's ID
+        # %USERNAME% for review's reviewer username
+        # %URL% for link to review
+        # %TERRITORY% for review's territory (territory for Apple e.g. TWN)
+        # %APPVERSION% for review's reviewer app version
+        # %CREATEDDATE% for review's created date
+
         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)

data/config/apple.example.yml

@@ -29,8 +29,12 @@ processors:
         enable: false # enable
         googleSheetAPIKeyFilePath: "" # Google Translate API Service Account Credential .json File Path
         googleSheetTimeZoneOffset: "+08:00" # Review Created Date TimeZone
-        googleSheetID: "" # Google Sheet ID, you can get it on google sheet url: e.g. https://docs.google.com/spreadsheets/d/googleSheetID/
-        googleSheetName: "Sheet1" # Sheet Name
+        googleSpreadsheetID: "1_lc82p-epecVKwpUWlXh1yyNWaSrygzDb8I0QH2xkTI" # Google Sheet SpreadSheet ID, you can get it on google sheet url: e.g. https://docs.google.com/spreadsheets/d/googleSpreadsheetID/
+        googleSheetInsertStyle:
+            - type: "append" # Google Sheet Insert type, append or insert
+            - at: 0 # required if type is insert, where index should insert at
+            - sheetID: null # required if type is insert, the sheet ID, you can get it on google sheet url: e.g. https://docs.google.com/spreadsheets/d/googleSpreadsheetID/edit#gid=sheetID
+            - sheetName: "Sheet1" # required if type is append, a.k.a google sheet tab name
         values: ["%RATING%","%TITLE%\n%BODY%","%APPVERSION%","%CREATEDDATE%"] # Columns Data, you can uses magic variable below to compose string.
         # %TITLE% for review's title
         # %BODY% for review's content
@@ -43,6 +47,30 @@ processors:
         # %APPVERSION% for review's reviewer app version
         # %CREATEDDATE% for review's created date
         
+        keywordsInclude: [] # keywords you want to filter out
+        ratingsInclude: [] # ratings you want to filter out
+        territoriesInclude: [] # territories you want to filter out (territory for Apple e.g. TWN)
+    - AsanaProcessor:
+        class: "AsanaProcessor"
+        enable: false # enable
+        asanaTimeZoneOffset: "+08:00"
+        asanaToken: "" # Asana Personal Access Token, get it here -> https://app.asana.com/0/my-apps
+        asanaProjectID: "" # Asana Project ID, get it in project url -> https://app.asana.com/0/asanaProjectID/list
+        asanaSectionName: "" # Task Target Project - Section Name, optional
+        asanaTaskTitleTemplate: "%PLATFORM% - %RATING% ⭐️ - %TITLE%" # Asana Task Title Template
+        asanaTaskBodyTemplate: "Title: %TITLE%\n---\nBody:\n%BODY%\n---\n- UserName: %USERNAME%\n- App Version:  %APPVERSION%\n- Date:%CREATEDDATE%" # Asana Task Body Template
+        # you can uses magic variable below to compose string.
+        # %TITLE% for review's title
+        # %BODY% for review's content
+        # %RATING% for review's rating 1~5
+        # %PLATFORM% for review's platform Apple or Android
+        # %ID% for review's ID
+        # %USERNAME% for review's reviewer username
+        # %URL% for link to review
+        # %TERRITORY% for review's territory (territory for Apple e.g. TWN)
+        # %APPVERSION% for review's reviewer app version
+        # %CREATEDDATE% for review's created date
+
         keywordsInclude: [] # keywords you want to filter out
         ratingsInclude: [] # ratings you want to filter out
         territoriesInclude: [] # territories you want to filter out (territory for Apple e.g. TWN)

data/lib/Models/Processor.rb

@@ -13,4 +13,19 @@ class Processor
     def processReviews(reviews, platform)
 
     end
+
+    def renderReview(templateText, review, timeZoneOffset)
+        templateText = templateText.gsub("%TITLE%", review.title || "")
+        templateText = templateText.gsub("%BODY%", review.body || "")
+        templateText = templateText.gsub("%RATING%", review.rating.nil? ? "" :review.rating.to_s)
+        templateText = templateText.gsub("%PLATFORM%", review.platform || "")
+        templateText = templateText.gsub("%ID%", review.id || "")
+        templateText = templateText.gsub("%USERNAME%", review.userName || "")
+        templateText = templateText.gsub("%URL%", review.url || "")
+        templateText = templateText.gsub("%TERRITORY%", review.territory || "")
+        templateText = templateText.gsub("%APPVERSION%", review.appVersion || "")
+        templateText = templateText.gsub("%CREATEDDATE%", review.createdDateTimestamp.nil? ? "" : Time.at(review.createdDateTimestamp).getlocal(timeZoneOffset).to_s)
+
+        return templateText
+    end
 end

data/lib/Models/ReviewFetcher.rb

@@ -20,7 +20,15 @@ class ReviewFetcher
 
     def processReviews(reviews, platform)
         processors.each do |processor|
-            reviews = processor.processReviews(reviews, platform)
+            begin
+                reviews = processor.processReviews(reviews, platform)
+            rescue => e
+                errorMessage = "# Processor Error"
+                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)
+            end
         end
     end
 

data/lib/Processors/AsanaProcessor.rb

@@ -0,0 +1,131 @@
+$lib = File.expand_path('../lib', File.dirname(__FILE__))
+
+require "Models/Review"
+require "Models/Processor"
+require "Helper"
+require "pathname"
+require "GoogleAPI"
+
+class AsanaProcessor < Processor
+
+    attr_accessor :keywordsInclude, :ratingsInclude, :territoriesInclude, :logger, :timeZoneOffset, :token, :projectID, :sectionName, :taskTitleTemplate, :taskBodyTemplate, :asanaAPIURL
+
+    def initialize(config, configFilePath, baseExecutePath)
+        @config = config
+        @configFilePath = configFilePath
+        @baseExecutePath = baseExecutePath
+        @logger = ZLogger.new(baseExecutePath)
+
+        @asanaAPIURL = "https://app.asana.com/api/1.0"
+        @token = Helper.unwrapRequiredParameter(config, "asanaToken")
+        @projectID = Helper.unwrapRequiredParameter(config, "asanaProjectID")
+        @taskTitleTemplate = Helper.unwrapRequiredParameter(config, "asanaTaskTitleTemplate")
+        @taskBodyTemplate = Helper.unwrapRequiredParameter(config, "asanaTaskBodyTemplate")
+        @timeZoneOffset = Helper.unwrapRequiredParameter(config, "asanaTimeZoneOffset")
+        @sectionName = nil
+        if !config["asanaSectionName"].nil? && config["asanaSectionName"] != ""
+            @sectionName = config["asanaSectionName"].strip
+        end
+
+        @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
+
+        puts "[AsanaProcessor] Init Success."
+    end
+
+    def processReviews(reviews, platform)        
+        if reviews.length < 1
+            return reviews
+        end
+
+        sectionID = findSectionIDFromSectionName(sectionName)
+
+        filterReviews = reviews
+        
+        if ratingsInclude.length > 0
+            filterReviews = filterReviews.select{ |review| ratingsInclude.map{ |rating| rating.to_i }.include? review.rating }
+        end
+
+        if territoriesInclude.length > 0
+            filterReviews = filterReviews.select{ |review| territoriesInclude.map{ |territory| territory.upcase }.include? review.territory.upcase }
+        end
+
+        if keywordsInclude.length > 0
+            keywordsInclude.select{ |keywordsInclude| keywordsInclude != "" }.each do |keywordInclude|
+                filterReviews = filterReviews.select{ |review| review.body.include? keywordInclude }
+            end
+        end
+
+        filterReviews.each do |review|
+            title = renderReview(taskTitleTemplate, review, timeZoneOffset)
+            body = renderReview(taskBodyTemplate, review, timeZoneOffset)
+            
+            requestTaskData = {
+                "name": title,
+                "notes": body,
+                "projects": [projectID.to_s]
+            }
+
+            if !review.createdDateTimestamp.nil?
+                requestTaskData['due_at'] = Time.at(review.createdDateTimestamp).iso8601
+            end
+
+            taskData = asanaAPI("/tasks", "POST", requestTaskData)
+            taskData = taskData["data"]
+            
+            if !sectionID.nil? && !taskData.nil?
+                asanaAPI("/sections/#{sectionID}/addTask", "POST", {"task": taskData["gid"]})
+            end
+
+            puts "[AsanaProcessor] Insert Review #{title} as a task to asana project."
+        end
+
+        return reviews
+    end
+
+    private
+    def findSectionIDFromSectionName(sectionName)
+        if !sectionName.nil?
+            sections = asanaAPI("/projects/#{projectID}/sections")["data"]
+            section = sections.find{ |section| section["name"].strip == sectionName }
+            if !section.nil?
+                return section["gid"]
+            end
+        end
+
+        return nil
+    end
+
+    private
+    def asanaAPI(path, method = "GET", data = nil)
+        uri = URI(asanaAPIURL+path)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        
+        request = Net::HTTP::Get.new(uri)
+        if method.upcase == "POST"
+            request = Net::HTTP::Post.new(uri)
+            if !data.nil?
+                request['Content-Type'] = 'application/json'
+                request.body = JSON.dump({"data": data})
+            end
+        end
+        
+        request['Authorization'] = "Bearer #{token}";
+        
+        response = https.request(request).read_body
+        result = JSON.parse(response)
+    end
+end

data/lib/Processors/GoogleSheetProcessor.rb

@@ -8,7 +8,7 @@ require "GoogleAPI"
 
 class GoogleSheetProcessor < Processor
 
-    attr_accessor :keywordsInclude, :ratingsInclude, :territoriesInclude, :logger, :googleAPI, :sheetID, :sheetName, :formatValues, :timeZoneOffset
+    attr_accessor :keywordsInclude, :ratingsInclude, :territoriesInclude, :logger, :googleAPI, :spreadsheetID, :sheetInsertType, :sheetId, :sheetName, :sheetInsertAt, :formatValues, :timeZoneOffset
 
     def initialize(config, configFilePath, baseExecutePath)
         @config = config
@@ -41,8 +41,31 @@ class GoogleSheetProcessor < Processor
         end
 
         @timeZoneOffset = Helper.unwrapRequiredParameter(config, "googleSheetTimeZoneOffset")
-        @sheetID = Helper.unwrapRequiredParameter(config, "googleSheetID")
-        @sheetName = Helper.unwrapRequiredParameter(config, "googleSheetName")
+        @spreadsheetID = Helper.unwrapRequiredParameter(config, "googleSpreadsheetID")
+        
+        sheetInsertStyle = Helper.unwrapRequiredParameter(config, "googleSheetInsertStyle")
+        if !sheetInsertStyle.is_a? Array
+            raise "googleSheetInsertStyle must specify as Array in GoogleSheetProcessor."
+        end
+
+        sheetInsertStyles = {}
+        sheetInsertStyle.each do |value|
+            value.keys.each do |key|
+                sheetInsertStyles[key] = value[key]
+            end
+        end
+
+        @sheetInsertType = Helper.unwrapRequiredParameter(sheetInsertStyles, "type")
+
+        if sheetInsertType != "insert" && sheetInsertType != "append"
+            raise "googleSheetInsertStyle.type only accept insert or append in GoogleSheetProcessor."
+        elsif sheetInsertType == "insert"
+            @sheetInsertAt = Helper.unwrapRequiredParameter(sheetInsertStyles, "at").to_i
+            @sheetId = Helper.unwrapRequiredParameter(sheetInsertStyles, "sheetID")
+        elsif sheetInsertType == "append"
+            @sheetName = Helper.unwrapRequiredParameter(sheetInsertStyles, "sheetName")
+        end
+        
         @formatValues = []
         if !config["values"].nil?
             @formatValues = config["values"]
@@ -74,33 +97,68 @@ class GoogleSheetProcessor < Processor
         end
 
         values = []
-        filterReviews.each do |review|
+        sortedFilterReviews = filterReviews
+        if sheetInsertType == "insert"
+            sortedFilterReviews = sortedFilterReviews.sort! { |a, b|  b.createdDateTimestamp <=> a.createdDateTimestamp }
+        end
+
+        sortedFilterReviews.each do |review|
             cols = []
             formatValues.each do |formatValue|
-                formatValue = formatValue.gsub("%TITLE%", review.title || "")
-                formatValue = formatValue.gsub("%BODY%", review.body || "")
-                formatValue = formatValue.gsub("%RATING%", review.rating.nil? ? "" :review.rating.to_s)
-                formatValue = formatValue.gsub("%PLATFORM%", review.platform || "")
-                formatValue = formatValue.gsub("%ID%", review.id || "")
-                formatValue = formatValue.gsub("%USERNAME%", review.userName || "")
-                formatValue = formatValue.gsub("%URL%", review.url || "")
-                formatValue = formatValue.gsub("%TERRITORY%", review.territory || "")
-                formatValue = formatValue.gsub("%APPVERSION%", review.appVersion || "")
-                formatValue = formatValue.gsub("%CREATEDDATE%", review.createdDateTimestamp.nil? ? "" : Time.at(review.createdDateTimestamp).getlocal(timeZoneOffset).to_s)
-
+                formatValue = renderReview(formatValue, review, timeZoneOffset)
                 cols.append(formatValue)
             end
             values.append(cols)
         end
 
         page = 1
-        limit = 500
+        limit = 100
         values.each_slice(limit) do |value|
-            puts "[GoogleSheetProcessor] Insert rows(#{page}/#{(values.length/limit).ceil + 1}) to #{sheetID}-#{sheetName}"
+            puts "[GoogleSheetProcessor] Insert rows page:(#{page}/#{(values.length/limit).ceil + 1}) #{sheetInsertType} to #{spreadsheetID}"
             page += 1
-            googleAPI.request("https://sheets.googleapis.com/v4/spreadsheets/#{sheetID}/values/#{sheetName}!A1:append?valueInputOption=RAW", "POST", {:values => value})
+            if sheetInsertType == "insert"
+                googleAPI.request("https://sheets.googleapis.com/v4/spreadsheets/#{spreadsheetID}:batchUpdate", "POST", {
+                    "requests": [
+                        {
+                            "insertRange": {
+                                "range": {
+                                    "sheetId": sheetId,
+                                    "startRowIndex": sheetInsertAt,
+                                    "endRowIndex": sheetInsertAt + value.length
+                                },
+                                "shiftDimension": "ROWS"
+                            }
+                        },
+                        {
+                            "pasteData": {
+                                "data": rowsToString(value),
+                                "type": "PASTE_NORMAL",
+                                "delimiter": ",",
+                                "coordinate": {
+                                    "sheetId": sheetId,
+                                    "rowIndex": sheetInsertAt,
+                                }
+                            }
+                        }
+                    ]
+                })
+            elsif sheetInsertType == "append"
+                googleAPI.request("https://sheets.googleapis.com/v4/spreadsheets/#{spreadsheetID}/values/#{sheetName}!A1:append?valueInputOption=RAW", "POST", {:values => value})
+            end
         end
 
         return reviews
     end
+
+    private
+    def rowsToString(rows)
+        string = ""
+        rows.each do |row|
+            if string != "" 
+                string += "\n"
+            end
+            string += "\"#{row.map{ |v| v.gsub('"','\"') }.join('","')}\""
+        end
+        return string
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ZReviewTender
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.7
 platform: ruby
 authors:
 - ZhgChgLi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -59,6 +59,7 @@ files:
 - lib/Models/Review.rb
 - lib/Models/ReviewFetcher.rb
 - lib/Models/Version.rb
+- lib/Processors/AsanaProcessor.rb
 - lib/Processors/FilterProcessor.rb
 - lib/Processors/GoogleSheetProcessor.rb
 - lib/Processors/GoogleTranslateProcessor.rb