ZReviewTender 1.3.7 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c4a5c74b6076acbf3ec3ea98046ab703f1df3485c4590c9f1de62bda77fad9
-  data.tar.gz: 1b8bc52b07eac4add166d360b648fa5991264d501b72a39c1dc7a412da51413c
+  metadata.gz: 767abeb4f548e38a266911a20c15a6307b756542db7317e444e2755c704e437c
+  data.tar.gz: 1d15d46a181b16e6ed3969e10e8925e139fe67b20437a6bd82eff34869e147cb
 SHA512:
-  metadata.gz: 8bba8ffe64bb4342689ade1b868a4a369e7879641c927466792cfef62f1860b3508efb1d289c5fea8c0bb6741780e2ce491c063814b327e4b85c2b699851dff7
-  data.tar.gz: 5cea45b9203f52e95ff67169fec881981e501e68b8e7cbc2298798e483963a44684d17e0337a7536b99ed2ba6f08f99bf531b762cf0848d8326c4864ba5bdc99
+  metadata.gz: b45ed4176179853c79686f0baa46ba70f8c76d8ed8f340403d27183f7435d9905fcac484965d01690c49005e7b9232ea62e971fc3ca96c9c317702cc508698af
+  data.tar.gz: 2835f394a70693c454bd4ce73acd161f7e636f9f62f7b78e340bbcc59197dc5ac21b58854abcc3f639fa60c60ff923b134d4ff81459dbfea0a0dd1272003564d

data/.version

@@ -1 +1 @@
-1.3.7
+1.4.0

data/bin/ZReviewTender

@@ -91,12 +91,12 @@ class Main
                 appleDestExampleYML = "#{basePath}/#{defaultConfigDirName}/#{defaultAppleConfigFileName}"
                 androidDestExampleYML = "#{basePath}/#{defaultConfigDirName}/#{defaultAndroidConfigFileName}"
                 
-                if !File.exists?("#{basePath}/latestCheckTimestamp/.keep")
+                if !File.exist?("#{basePath}/latestCheckTimestamp/.keep")
                     File.open("#{basePath}/latestCheckTimestamp/.keep", 'w') { |file| file.write("") }
                 end
                 #
-                if File.exists?(appleSourceExampleYML)
-                    if File.exists?(appleDestExampleYML)
+                if File.exist?(appleSourceExampleYML)
+                    if File.exist?(appleDestExampleYML)
                         puts "Failed! Config YML File Exists: #{appleDestExampleYML}"
                     else
                         FileUtils.cp(appleSourceExampleYML, appleDestExampleYML)
@@ -104,8 +104,8 @@ class Main
                     end
                 end
                 #
-                if File.exists?(androidSourceExampleYML)
-                    if File.exists?(androidDestExampleYML)
+                if File.exist?(androidSourceExampleYML)
+                    if File.exist?(androidDestExampleYML)
                         puts "Failed! Config YML File Exists: #{androidDestExampleYML}"
                     else
                         FileUtils.cp(androidSourceExampleYML, androidDestExampleYML)
@@ -129,7 +129,7 @@ class Main
             opts.on('-d', '--delete', 'delete latest check timestamp log file.(factory reset)') do
                 FileUtils.rm_rf("#{basePath}/latestCheckTimestamp/")
                 Helper.createDirIfNotExist("#{basePath}/latestCheckTimestamp/")
-                if !File.exists?("#{basePath}/latestCheckTimestamp/.keep")
+                if !File.exist?("#{basePath}/latestCheckTimestamp/.keep")
                     File.open("#{basePath}/latestCheckTimestamp/.keep", 'w') { |file| file.write("") }
                 end
 
@@ -160,7 +160,7 @@ class Main
 
     private
     def configFileCheck(path, command)
-        if !File.exists? path
+        if !File.exist? 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}"

data/lib/AndroidFetcher.rb

@@ -112,7 +112,7 @@ class AndroidFetcher < ReviewFetcher
                     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))
+                    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

data/lib/AppleFetcher.rb

@@ -80,7 +80,7 @@ class AppleFetcher < ReviewFetcher
                     break
                 else
                     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))
+                    reviews.append(Review.new(nil, customerReviewID, customerReviewReviewerNickname, customerReviewRating, customerReviewTitle, customerReviewBody, customerReviewCreatedDateTimestamp, url, nil, customerReviewTerritory, {}))
                     
                     # init first time, need first review to set as latestCheckTimestamp
                     if latestCheckTimestamp == 0

data/lib/Helper.rb

@@ -19,7 +19,7 @@ class Helper
         begin
             dir = dirs.shift
             currentDir = "#{currentDir}/#{dir}"
-            Dir.mkdir(currentDir) unless File.exists?(currentDir)
+            Dir.mkdir(currentDir) unless File.exist?(currentDir)
         end while dirs.length > 0
     end
 end

data/lib/Models/Review.rb

@@ -1,8 +1,8 @@
 $lib = File.expand_path('../', File.dirname(__FILE__))
 
 class Review
-    attr_accessor :platform, :id, :userName, :rating, :title, :body, :createdDateTimestamp, :url, :appVersion, :territory
-    def initialize(platform, id, userName, rating, title, body, createdDateTimestamp, url, appVersion, territory)
+    attr_accessor :platform, :id, :userName, :rating, :title, :body, :createdDateTimestamp, :url, :appVersion, :territory, :tempData
+    def initialize(platform, id, userName, rating, title, body, createdDateTimestamp, url, appVersion, territory, tempData)
         @platform = platform # 來源平台 android or apple
         @id = id # review id
         @userName = userName # reviewer
@@ -13,5 +13,6 @@ class Review
         @url = url # 前往 review 的連結 (apple 不提供後台指定到某個 review 的連結)
         @appVersion = appVersion # app 版本號
         @territory = territory # apple: 地區(TWN/JPN...), android: 語系(zh-tw/en...)
+        @tempData = tempData # 程式內部傳遞使用
     end
 end

data/lib/Models/ReviewFetcher.rb

@@ -47,7 +47,7 @@ class ReviewFetcher
 
     def isSentWelcomeMessage()
         filePath = "#{config.baseExecutePath}/latestCheckTimestamp/#{platform}Welcome"
-        return File.exists?(filePath)
+        return File.exist?(filePath)
     end
 
     def setPlatformLatestCheckTimestamp(timestamp)
@@ -58,7 +58,7 @@ class ReviewFetcher
 
     def getPlatformLatestCheckTimestamp()
         filePath = "#{config.baseExecutePath}/latestCheckTimestamp/#{platform}"
-        if File.exists?(filePath)
+        if File.exist?(filePath)
             return File.read(filePath).to_i
         else
             return 0

data/lib/Processors/AsanaProcessor.rb

@@ -84,6 +84,8 @@ class AsanaProcessor < Processor
 
             taskData = asanaAPI("/tasks", "POST", requestTaskData)
             taskData = taskData["data"]
+
+            review.tempData["asanaTaskGID"] = taskData["gid"]
             
             if !sectionID.nil? && !taskData.nil?
                 asanaAPI("/sections/#{sectionID}/addTask", "POST", {"task": taskData["gid"]})

data/lib/Processors/SlackAndAsanaConnector.rb

@@ -0,0 +1,159 @@
+$lib = File.expand_path('../lib', File.dirname(__FILE__))
+
+require "Models/Review"
+require "Models/Processor"
+require "Helper"
+require "pathname"
+require "GoogleAPI"
+
+class SlackAndAsanaConnector < Processor
+
+    attr_accessor :logger, :slackBotToken, :asanaToken, :projectID, :asanaAPIURL
+
+    def initialize(config, configFilePath, baseExecutePath)
+        @config = config
+        @configFilePath = configFilePath
+        @baseExecutePath = baseExecutePath
+        @logger = ZLogger.new(baseExecutePath)
+
+        @asanaAPIURL = "https://app.asana.com/api/1.0"
+        @asanaToken = Helper.unwrapRequiredParameter(config, "asanaToken")
+        @slackBotToken = Helper.unwrapRequiredParameter(config, "slackBotToken")
+
+        puts "[SlackAndAsanaConnector] Init Success."
+    end
+
+    def processReviews(reviews, platform)        
+        if reviews.length < 1
+            return reviews
+        end
+
+        pendingReviews = reviews.dup
+
+        loop do
+            review = pendingReviews.shift
+
+            result =  retrieveSlackMessage(review)
+            if !result["ok"]
+                if result["error"] == "ratelimited"
+                    puts "[SlackAndAsanaConnector] Reached Rate Limited, sleep 1 sec..."
+                    sleep(1)
+                    pendingReviews.insert(0, review)
+                end
+            else
+                sendAsanaCommentMessage(review, "ref: #{result["permalink"]}")
+            end
+
+            puts "[SlackAndAsanaConnector] Connect Slack Message to Asana Task, rest: #{pendingReviews.length}"
+            break if pendingReviews.length < 1
+        end
+
+        pendingReviews = reviews.dup
+
+        loop do
+            review = pendingReviews.shift
+            asanaTaskURL = retrieveAsanaTaskURL(review)
+            if !asanaTaskURL.nil?
+                result =  sendSlackCommnetMessage(review, "<#{asanaTaskURL}| Go To *Asana Task*>")
+                if !result["ok"]
+                    if result["error"] == "ratelimited"
+                        puts "[SlackAndAsanaConnector] Reached Rate Limited, sleep 1 sec..."
+                        sleep(1)
+                        pendingReviews.insert(0, review)
+                    end
+                end
+            end
+
+            puts "[SlackAndAsanaConnector] Connect Asana Task to Slack Message, rest: #{pendingReviews.length}"
+            break if pendingReviews.length < 1
+        end
+
+        return reviews
+    end
+
+    private
+    def retrieveSlackMessage(review)
+        uri = URI("https://slack.com/api/chat.getPermalink?channel=#{review.tempData["slackChannelID"]}&message_ts=#{review.tempData["slackTS"]}")
+        headers = {'Content-Type': 'application/json; charset=utf-8', 'Authorization': "Bearer #{slackBotToken}"}
+        
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Get.new(uri.request_uri, headers)
+        res = http.request(req)
+
+        result = JSON.parse(res.body)
+        return result
+    end
+
+    private
+    def sendSlackCommnetMessage(review, message)
+        payload = Payload.new()
+        payload.text = message
+        payload.channel = review.tempData["slackChannelID"]
+        payload.thread_ts = review.tempData["slackTS"]
+        payload.unfurl_links = true
+        payload.unfurl_media = true
+        uri = URI("https://slack.com/api/chat.postMessage")
+        headers = {'Content-Type': 'application/json; charset=utf-8', 'Authorization': "Bearer #{slackBotToken}"}
+        
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Post.new(uri.request_uri, headers)
+        req.body = payload.to_json
+        res = http.request(req)
+
+        result = JSON.parse(res.body)
+        return result
+    end
+
+
+    private
+    def retrieveAsanaTaskURL(review)
+        if review.tempData["asanaTaskGID"].nil? || review.tempData["asanaTaskGID"] == ""
+            return nil
+        end
+
+        return "https://app.asana.com/0/0/#{review.tempData["asanaTaskGID"]}/f"
+    end
+
+    private
+    def sendAsanaCommentMessage(review, message)
+        if review.tempData["asanaTaskGID"].nil? || review.tempData["asanaTaskGID"] == ""
+            return nil
+        end
+
+        path = "/tasks/#{review.tempData["asanaTaskGID"]}/stories"
+        uri = URI(asanaAPIURL+path)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request.body = JSON.dump({"data": {"text": message}})
+        
+        request['Authorization'] = "Bearer #{asanaToken}"
+        
+        response = https.request(request).read_body
+
+        return result = JSON.parse(response)
+    end
+
+    private
+    class Payload
+        attr_accessor :channel, :thread_ts, :text, :unfurl_links, :unfurl_media
+
+        def as_json(options={})
+        {
+            channel: @channel,
+            thread_ts: @thread_ts,
+            text: @text,
+            unfurl_links: @unfurl_links,
+            unfurl_media: @unfurl_media
+        }
+        end
+
+        def to_json(*options)
+            as_json(*options).to_json(*options)
+        end
+    end
+end

data/lib/Processors/SlackProcessor.rb

@@ -42,7 +42,7 @@ class SlackProcessor < Processor
             return reviews
         end
 
-        pendingPayloads = []
+        pendingRequests = []
 
         # Slack Message Limit: posting one message per second per channel
         reviews.each_slice(attachmentGroupByNumber) do |reviewGroup|
@@ -71,12 +71,16 @@ class SlackProcessor < Processor
                 payload.attachments.append(attachment)
             end
 
-            pendingPayloads.append(payload)
+            pendingRequests.append({"payload" => payload, "reviewGroup" => reviewGroup})
         end
+        
+        resultReviews = []
 
         loop do
-            payload = pendingPayloads.shift
-            
+            pendingRequest = pendingRequests.shift
+            payload = pendingRequest["payload"]
+            reviewGroup = pendingRequest["reviewGroup"]
+
             result = request(payload)
             if !result[:ok]
                 logger.logError(payload)
@@ -84,12 +88,17 @@ class SlackProcessor < Processor
                 if result[:message] == "ratelimited"
                     puts "[SlackProcessor] Reached Rate Limited, sleep 1 sec..."
                     sleep(1)
-                    pendingPayloads.insert(0, payload)
+                    pendingRequests.insert(0, pendingRequest)
+                end
+            elsif !result[:ts].nil?
+                reviewGroup.each do |review|
+                    review.tempData["slackTS"] = result[:ts]
+                    review.tempData["slackChannelID"] = targetChannel
                 end
             end
 
-            puts "[SlackProcessor] Send new Review messages, rest: #{pendingPayloads.length}"
-            break if pendingPayloads.length < 1
+            puts "[SlackProcessor] Send new Review messages, rest: #{pendingRequests.length}"
+            break if pendingRequests.length < 1
         end
 
         return reviews
@@ -140,10 +149,10 @@ class SlackProcessor < Processor
         res = http.request(req)
 
         if isInCommingWebHook
-            return {"ok":res.body == "ok", "message":nil}
+            return {"ok":res.body == "ok", "message":nil, "ts": res['ts']}
         else
             result = JSON.parse(res.body)
-            return {"ok":result["ok"] == true, "message":result['error']}
+            return {"ok":result["ok"] == true, "message":result['error'], "ts": result['ts']}
         end
         
     end
@@ -182,4 +191,4 @@ class SlackProcessor < Processor
             as_json(*options).to_json(*options)
         end
     end
-end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ZReviewTender
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.4.0
 platform: ruby
 authors:
 - ZhgChgLi
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2025-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -30,16 +29,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.10.0
 description: ZReviewTender - App Reviews Automatic Bot
-email: 
 executables:
 - ZReviewTender
 extensions: []
@@ -64,13 +62,13 @@ files:
 - lib/Processors/GoogleSheetProcessor.rb
 - lib/Processors/GoogleTranslateProcessor.rb
 - lib/Processors/ProcessorTemplate.rb
+- lib/Processors/SlackAndAsanaConnector.rb
 - lib/Processors/SlackProcessor.rb
 - lib/ZLogger.rb
 homepage: https://github.com/ZhgChgLi/ZReviewTender
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ZReviewTender uses brand new App Store & Google Play API to fetch App reviews
   and integration your workflow.