fastlane-plugin-clean_testflight_testers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 079d6ebd3b925a1a16f1a3deb2feb1b1f99d8ffe
+  data.tar.gz: 63d3d0d9f7c6ad2fe306892579796cb00339f929
+SHA512:
+  metadata.gz: 40a58312425ba5f38209fe8e0aec998b8354feeaffa052e6331187693b20ab0d9e9df202b222ba5bac99038db2570050e6fa6401c8efb0dc8b8a596ef0d8ed41
+  data.tar.gz: 643924bf6c1daae84efac0126b398d821b8e7b0d2e05adfa748a5d2416b62e9a8c31c1a7b77909818ef18cdc004c590d24c580dafb7385e4b378e98cd583f666

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Felix Krause <krausefx@gmail.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,72 @@
+# clean_testflight_testers plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-clean_testflight_testers)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-clean_testflight_testers`, add it to your project by running:
+
+```bash
+fastlane add_plugin clean_testflight_testers
+```
+
+## About clean_testflight_testers
+
+#### Note: This plugin isn't available to use yet
+
+Please wait until https://github.com/fastlane/fastlane/pull/10186 is merged and shipped, which should be in a few days or so.
+
+![screenshot.png](screenshot.png)
+
+> Automatically remove TestFlight testers that are not actually testing your app
+
+Just add the following to your `fastlane/Fastfile`
+
+```ruby
+# Default setup
+lane :clean do
+  clean_testflight_testers
+end
+
+# This won't delete out inactive testers, but just print them
+lane :clean do
+  clean_testflight_testers(dry_run: true)
+end
+
+# Specify a custom number for what's "inactive"
+lane :clean do
+  clean_testflight_testers(days_of_inactivity: 120) # 120 days, so about 4 months
+end
+
+# Provide custom app identifier / username
+lane :clean do
+  clean_testflight_testers(username: "apple@krausefx.com", app_identifier: "best.lane"")
+end
+```
+
+The plugin will remove all testers that either:
+
+- Received a TestFlight email, but didn't accept the invite within the last 30 days
+- Installed the app within the last 30 days, but didn't launch it once
+
+Unfortunately the iTunes Connect UI/API doesn't expose the timestamp of the last user session, so we can't really detect the last time someone used the app. The above rules will still help you, remove a big part of inactive testers. 
+
+This plugin could also be smarter, and compare the time stamp of the last build, and compare it with the latest tester activity, feel free to submit a PR for this feature 👍
+
+## Issues and Feedback
+
+Make sure to update to the latest _fastlane_.
+
+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/clean_testflight_testers.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/clean_testflight_testers/version'
+
+module Fastlane
+  module CleanTestflightTesters
+    # 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::CleanTestflightTesters.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb

@@ -0,0 +1,129 @@
+module Fastlane
+  module Actions
+    class CleanTestflightTestersAction < Action
+      def self.run(params)
+        ENV["SPACESHIP_DEBUG"] = 1.to_s
+        require 'spaceship'
+
+        UI.message("Login to iTunes Connect (#{params[:username]})")
+        Spaceship::Tunes.login(params[:username])
+        Spaceship::Tunes.select_team
+        UI.message("Login successful")
+
+        UI.message("Fetching all TestFlight testers, this might take a few minutes, depending on the number of testers")
+
+        # Convert from bundle identifier to app ID
+        spaceship_app ||= Spaceship::Application.find(params[:app_identifier])
+        UI.user_error!("Couldn't find app '#{params[:app_identifier]}' on the account of '#{params[:username]}' on iTunes Connect") unless spaceship_app
+        app_id = spaceship_app.apple_id
+
+        all_testers = Spaceship::TestFlight::Tester.all(app_id: app_id)
+        counter = 0
+
+        all_testers.each do |current_tester|
+          days_since_status_change = (Time.now - current_tester.status_mod_time) / 60.0 / 60.0 / 24.0
+
+          if current_tester.status == "invited"
+            if days_since_status_change > params[:days_of_inactivity]
+              remove_tester(current_tester, app_id, params[:dry_run]) # user got invited, but never installed a build... why would you do that?
+              counter += 1
+            end
+          else
+            # We don't really have a good way to detect whether the user is active unfortunately
+            # So we can just delete users that had no sessions
+            if days_since_status_change > params[:days_of_inactivity] && current_tester.session_count == 0
+              # User had no sessions in the last e.g. 30 days, let's get rid of them
+              remove_tester(current_tester, app_id, params[:dry_run])
+              counter += 1
+            end
+          end
+        end
+
+        if params[:dry_run]
+          UI.success("Didn't delete any testers, but instead only printed them out (#{counter}), disable `dry_run` to actually delete them 🦋")
+        else
+          UI.success("Successfully removed #{counter} testers 🦋")
+        end
+      end
+
+      def self.remove_tester(tester, app_id, dry_run)
+        if dry_run
+          UI.message("TestFlight tester #{tester.email} seems to be inactive for app ID #{app_id}")
+        else
+          UI.message("Removing tester #{tester.email} due to inactivity from app ID #{app_id}...")
+          tester.remove_from_app!(app_id: app_id)
+          raise 'yolo'
+        end
+      end
+
+      def self.description
+        "Automatically remove TestFlight testers that are not actually testing your app"
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.details
+        "Automatically remove TestFlight testers that are not actually testing your app"
+      end
+
+      def self.available_options
+        user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
+        user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "CLEAN_TESTFLIGHT_TESTERS_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user),
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       short_option: "-a",
+                                       env_name: "CLEAN_TESTFLIGHT_TESTERS_APP_IDENTIFIER",
+                                       description: "The bundle identifier of the app to upload or manage testers (optional)",
+                                       optional: true,
+                                       default_value: ENV["TESTFLIGHT_APP_IDENTITIFER"] || CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       short_option: "-q",
+                                       env_name: "CLEAN_TESTFLIGHT_TESTERS_TEAM_ID",
+                                       description: "The ID of your iTunes Connect team if you're in multiple teams",
+                                       optional: true,
+                                       is_string: false, # as we also allow integers, which we convert to strings anyway
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
+                                       verify_block: proc do |value|
+                                         ENV["FASTLANE_ITC_TEAM_ID"] = value.to_s
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :team_name,
+                                       short_option: "-r",
+                                       env_name: "CLEAN_TESTFLIGHT_TESTERS_TEAM_NAME",
+                                       description: "The name of your iTunes Connect team if you're in multiple teams",
+                                       optional: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
+                                       verify_block: proc do |value|
+                                         ENV["FASTLANE_ITC_TEAM_NAME"] = value.to_s
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :days_of_inactivity,
+                                     short_option: "-k",
+                                     env_name: "CLEAN_TESTFLIGHT_TESTERS_WAIT_PROCESSING_INTERVAL",
+                                     description: "Numbers of days a tester has to be inactive for (no build uses) for them to be removed",
+                                     default_value: 30,
+                                     type: Integer,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Please enter a valid positive number of days") unless value.to_i > 0
+                                     end),
+          FastlaneCore::ConfigItem.new(key: :dry_run,
+                                     short_option: "-d",
+                                     env_name: "CLEAN_TESTFLIGHT_TESTERS_DRY_RUN",
+                                     description: "Only print inactive users, don't delete them",
+                                     default_value: false,
+                                     is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/clean_testflight_testers/helper/clean_testflight_testers_helper.rb

@@ -0,0 +1,6 @@
+module Fastlane
+  module Helper
+    class CleanTestflightTestersHelper
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-clean_testflight_testers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Krause
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.56.0
+description: 
+email: krausefx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/clean_testflight_testers.rb
+- lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb
+- lib/fastlane/plugin/clean_testflight_testers/helper/clean_testflight_testers_helper.rb
+- lib/fastlane/plugin/clean_testflight_testers/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Automatically remove TestFlight testers that are not actually testing your
+  app
+test_files: []
+has_rdoc: