fastlane-plugin-schindler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 016b39bfe8f3c4baa2539ac31fca66de42f6dc9185e3cefe87ef9673a7084146
+  data.tar.gz: 5a7693adb3c46632c26c34714750592923f0adb4b3d811af63f1a107fdc3dc69
+SHA512:
+  metadata.gz: 6a3cee2a5eaaf58b3217d302e50062c08739fd2123a821a25d80ff3e88bfc5776735e8859668a5c6b0e3300d241c37bbeeebeec61f6c2c660f3b3988032a1e23
+  data.tar.gz: 2b47919e6b1013f93737c16de3cf8ab29c3335eca6f9b1b788fac85e8523ce672a80f727e9f58c7b03be2c817b136bf06d05b8c92d89c38680404e531ec0fb84

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 泊涛 <hongtao.ht@alibaba-inc.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# schindler plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-schindler)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-schindler`, add it to your project by running:
+
+```bash
+fastlane add_plugin schindler
+```
+
+## About schindler
+
+Schindler is a TestFlight automatic processing tool, which is used to maintain the number of TestFlight quota, eliminate useless testers, and improve the external gray effect of iOS.
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/schindler/actions/schindler_action.rb

@@ -0,0 +1,235 @@
+require 'fastlane/action'
+require_relative '../helper/schindler_helper'
+require 'spaceship'
+require 'json'
+
+module Fastlane
+  module Actions
+    class SchindlerAction < Action
+      Filter_Uninstall = 1 << 0
+      Filter_Expire = 1 << 1
+      Filter_UnUse = 1 << 2
+
+      def self.run(params)
+        UI.message("The schindler plugin is working!")
+
+        ARGV.clear
+
+        filter_type = params[:filter_type].to_i
+        auto_confirm = params[:auto_confirm].to_s == 'auto'
+        user_id = params[:user_id].to_s
+        user_password = params[:user_password].to_s
+        ios_app_id = params[:ios_app_id].to_s
+        puts "================================\n新建名单，初始化参数信息：\n筛选类型(位运算)：#{filter_type}  (#{Filter_Uninstall}-未安装，#{Filter_Expire}-已过期，#{Filter_UnUse}-未使用)\n跳过二次确认：#{auto_confirm}\n账号：#{user_id}\n密码：******\n应用ID：#{ios_app_id}\n================================"
+
+        # 先扫描未安装、已过期
+        if ((filter_type & Filter_Uninstall > 0) || (filter_type & Filter_Expire > 0))
+          add_process_uninstall_expired(filter_type: filter_type, auto_confirm: auto_confirm, ios_app_id: ios_app_id, user_id: user_id, user_password: user_password)
+        end
+        # 再扫描未使用，因为未使用需要全量查询，耗时1小时起步，容易超时
+        if (filter_type & Filter_UnUse > 0)
+          add_process_unused(auto_confirm: auto_confirm, ios_app_id: ios_app_id, user_id: user_id, user_password: user_password)
+        end
+      end
+
+      def self.exec_process (testers, filter_type, auto_confirm)
+        return [] if testers.nil?
+
+        ids = Array.new();
+        # 90天前的安装
+        currentDate = DateTime.now.to_time
+        expiredtime =(currentDate - 60*60*24*90).to_i
+        # 7天内更新的，不统计打开次数
+        sevendaytime = (currentDate - 60*60*24*7).to_i
+
+        testers.each do |tester|
+          # puts "测试员信息：#{tester.to_json}"
+          
+          if (!tester.respond_to?(:beta_tester_metrics))
+            puts "\n\n~~~~~~~~~~ 异常跳过：不合法的BetaTester数据 ~~~~~~~~~~"
+            next
+          end
+          
+          id = tester.id.to_s;
+          metric = (tester.beta_tester_metrics || []).first
+          tester_state = metric.beta_tester_state
+          puts "测试员：#{tester.id.to_s} 状态-#{tester_state}"
+          
+          if metric.installed?
+            # 在removeAfterDate支持前，暂时用lastModifiedDate. "last_modified_date":"2022-09-02T07:05:44.414-07:00"
+            modified_date_string = metric.last_modified_date
+            modified_date = nil
+            # 兼容没有毫秒的数据，苹果也不标准啊！
+            if modified_date_string.length == 29
+              modified_date = DateTime.strptime(modified_date_string, '%Y-%m-%dT%H:%M:%S.%L%z').to_time
+            elsif modified_date_string.length == 25
+              modified_date = DateTime.strptime(modified_date_string, '%Y-%m-%dT%H:%M:%S%z').to_time
+            else
+              puts "不合法的lastModifiedDate： #{modified_date_string}"
+              next
+            end
+            
+            last_date = modified_date.getlocal.to_i
+            puts "最后更新时间：#{modified_date}"
+            # 在sevenDaySessionCount支持前，暂时用session_count + lastModifiedDate
+            count = metric.session_count.to_i
+
+            if ((filter_type & Filter_Expire) > 0 && last_date < expiredtime)
+              # 过期
+              ids << id;
+
+              puts "===== 已过期 +1 ====="
+            elsif ((filter_type & Filter_UnUse) > 0 && count < 1 && last_date < sevendaytime)
+              # 超过7天未使用
+              ids << id;
+
+              puts "===== 未使用 +1 ====="
+            end
+          elsif (filter_type & Filter_Uninstall > 0)
+            ids << id;
+
+            puts "===== 未安装 +1 ====="
+          end
+        end
+        
+        puts "\n测试员筛选完成\n================================"
+        if ids.size < 1
+          puts "当前规则下，测试员已经删完干净了\n================================"
+          return []
+        end
+        
+        if !auto_confirm
+          puts "删除TestFlight测试员：#{ids.size}个？ (Y/n)"
+          if (gets.chomp != 'Y')
+            puts "Cancel，任务取消，此次任务结束\n================================"
+            return []
+          end
+        end
+
+        return ids
+      end
+
+      def self.add_process_unused (auto_confirm: false, ios_app_id: nil, user_id: nil, user_password: nil)
+        # 查询全量数据，但容易超时，未使用的用户只能全量查询
+        puts "#{DateTime.now.to_time} 开始获取App数据……"
+        app = Spaceship::ConnectAPI::App.get(app_id: ios_app_id)
+
+        puts "#{DateTime.now.to_time} 开始获取测试人员列表，带薪喝茶时间……"
+        testers = nil
+        if app
+          puts "App get_beta_testers"
+          testers = app.get_beta_testers(filter: {apps: ios_app_id, isDeleted: false}, includes: "betaTesterMetrics", sort: "betaTesterMetrics.betaTesterState", limit:20)
+        else
+          puts "Spaceship::ConnectAPI::BetaTester"
+          testers = Spaceship::ConnectAPI::BetaTester.all(filter: {apps: ios_app_id, isDeleted: false}, includes: "betaTesterMetrics", sort: "betaTesterMetrics.betaTesterState", limit:20)
+        end
+        puts "#{DateTime.now.to_time} 获取测试人员列表成功，共#{testers.count}个"
+
+        ids = exec_process(testers, Filter_UnUse, auto_confirm)
+        if (ids.size < 1)
+            return
+        end
+
+        client = Spaceship::ConnectAPI::Client.login(user_id, user_password)
+        puts "登录成功"
+        client.delete_beta_testers_from_app(beta_tester_ids: ids, app_id: ios_app_id)
+        puts "Success，删除#{ids.size}个测试人员成功\n================================"
+      end
+
+      def self.add_process_uninstall_expired (filter_type: (Filter_Uninstall | Filter_Expire), auto_confirm: false, ios_app_id: nil, user_id: nil, user_password: nil)
+        # 每次查询Top 50，直到没有符合的记录，适合按状态排序后的扫描
+        client = Spaceship::ConnectAPI::Client.login(user_id, user_password)
+        puts "登录成功"
+
+        while true do
+          puts "#{DateTime.now.to_time} 开始获取测试人员列表，带薪喝茶时间……"
+          testers = client.get_beta_testers(filter: {apps: ios_app_id, isDeleted: false}, includes: "betaTesterMetrics", sort: "betaTesterMetrics.betaTesterState")
+
+          puts "#{DateTime.now.to_time} 获取测试人员列表成功，共#{testers.count}个"
+
+          ids = exec_process(testers, filter_type, auto_confirm)
+          if ids.size < 1
+              puts "未安装 or 已过期 测试员清除完毕\n================================"
+              return
+          end
+
+          client.delete_beta_testers_from_app(beta_tester_ids: ids, app_id: ios_app_id)
+          puts "Success，删除#{ids.size}个测试人员成功\n================================"
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Schindler is a TestFlight tool for release useless quota."
+      end
+
+      def self.authors
+        ["xjk_001@163.com"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Schindler is a TestFlight automatic processing tool, which is used to maintain the number of TestFlight quota, eliminate useless testers, and improve the external gray effect of iOS."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :filter_type,
+                                  env_name: "SCHINDLER_FILTER_TYPE",
+                               description: "'1'-Not installed, '2'-Expired, '4'-Unused, '7'-All(1 | 2 | 4), default 7",
+                                  optional: true,
+                             default_value: "7",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :auto_confirm,
+                                  env_name: "SCHINDLER_AUTO_CONFIRM",
+                               description: "'auto'-skip, default no. Skip the second confirmation, or wait for user confirmation before deleting after scanning",
+                                  optional: true,
+                             default_value: "none",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :user_id,
+                                  env_name: "SCHINDLER_USER_ID",
+                               description: "Your AppID for login Connect",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :user_password,
+                                  env_name: "SCHINDLER_PASSWORD",
+                               description: "AppID password, support App private password",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :ios_app_id,
+                                  env_name: "SCHINDLER_APP_ID",
+                               description: "The ID of the app in the Apple Store",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        [:ios, :mac].include?(platform)
+        # true
+      end
+
+      def self.example_code
+        [
+          'schindler(
+            filter_type: "7",               # Optional, eliminate useless testers
+            auto_confirm: "auto",           # Optional, Skip the second confirmation
+            user_id: "my_username",         # My AppID
+            user_password: "my_password",   # My password
+            ios_app_id: "my_ios_app"        # The App which to be eliminated
+          )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/schindler/helper/schindler_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SchindlerHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SchindlerHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the schindler plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/schindler/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Schindler
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/schindler.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/schindler/version'
+
+module Fastlane
+  module Schindler
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Schindler.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-schindler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xjkstar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.209.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.209.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: xjk_001@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/schindler.rb
+- lib/fastlane/plugin/schindler/actions/schindler_action.rb
+- lib/fastlane/plugin/schindler/helper/schindler_helper.rb
+- lib/fastlane/plugin/schindler/version.rb
+homepage: https://github.com/Xjkstar/fastlane-plugin-schindler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Schindler is a TestFlight automatic processing tool, which is used to maintain
+  the number of TestFlight quota, eliminate useless testers, and improve the external
+  gray effect of iOS.
+test_files: []