fastlane-plugin-taiwan_number_one 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1747d4598e6ab056cc1250a135c930e0f551e990c2d9c700a64ec920c393fcd
-  data.tar.gz: 8cf6b8d22266a4a98cee49e9dce576a9667bb8417b6858adc2be0aead9378651
+  metadata.gz: 359821e6b701c5b2dab9f8da4638677242b7291a16f00f4746ce61e06c8c1af6
+  data.tar.gz: 1064960c97b3c0f4b1b41bf73151b87dccbaace13a85de31fabdda343a455ba1
 SHA512:
-  metadata.gz: 8727b5bf9b93db5fc8315a7106a32f190c2a55076e853f9031dd2dba293d53bc08b64a4a8224482bcb604a82a7aff190282e8b4cda79ab68e4e8d3653a3777e4
-  data.tar.gz: fe1b47c93f05c3e0427c8342233626d62a6a0224330d5662f0f3d6d737f986ab3f614f7560ba08daa14fc078fe236069ca4a8fcb2c770e7106dc11ef4dc87b44
+  metadata.gz: e97f0c3d12f350869f175f728e05dcc1b2ebedf7b91ad2898543415b26ebf0fb538eafea889b6959982825d3bf34aa0be39362bb57e6045add9f5a55a924a3c8
+  data.tar.gz: a26924113675bea5bfae2d7cf683e50e2f4e849dcbd8ccb894361b8a8bdc9cd2edfde5ae9bb2513ef47bb6ef3db11543504dfe8ac58c5aa94dc69d61aa562fd9

data/README.md

@@ -12,7 +12,7 @@ fastlane add_plugin taiwan_number_one
 
 ## About taiwan_number_one
 
-To approve or reject if status is Pending Developer Release.
+To approve or reject if status is `Pending Developer Release`, otherwise do nothing.
 
 #### This feature is requsted for a while:
 
@@ -33,6 +33,17 @@ https://github.com/fastlane/fastlane/issues/17539
 
 ## Usage
 
+##### Install plugin for fastlane
+[install instructions](https://docs.fastlane.tools/plugins/using-plugins/)
+```
+bundle exec fastlane add_plugin taiwan_number_one
+```
+but I personally prefer adding plugin in `Gemfile` like this to avoid additional `Pluginfile` in ~'your_ios_project_dir'/fastlane
+
+```
+bundle add fastlane-plugin-taiwan_number_one
+```
+
 ##### Show info
 
 ```
@@ -48,11 +59,38 @@ lane :release_decision do |options|
   taiwan_number_one(
     username: username,
     app_identifier: app_identifier,
-    app_decision: options[:app_decision]
+    app_decision: options[:app_decision],
+    api_key: api_key
+  )
+end
+```
+
+and this:
+```
+desc "release App store version"
+lane :release_app do
+  result = release_decision(app_decision: Fastlane::Actions::TaiwanNumberOneAction::DicisionType::RELEASE)
+  if result == Fastlane::Actions::TaiwanNumberOneAction::ActionResult::SUCCESS
+    # do your thing here!
+  end
+end
+```
+
+or this:
+```
+desc "reject App store version"
+lane :reject_app do
+  api_key = app_store_connect_api_key(
+    key_id: ENV["ASC_API_KEY_ID"],
+    issuer_id: ENV["ISSUER_ID"],
+    key_content: ENV["ASC_API_KEY"]
   )
+  release_decision(app_decision: Fastlane::Actions::TaiwanNumberOneAction::DicisionType::REJECT)
 end
 ```
 
+*for more info about app_store_connect_api_key, please refer to [here](http://docs.fastlane.tools/actions/app_store_connect_api_key/#app_store_connect_api_key) and [here](http://docs.fastlane.tools/app-store-connect-api/#using-an-app-store-connect-api-key)
+
 Since there might have some problem in `reject_if_possible` of `Deliver`, so it's better to call this Action before `Deliver` everytime.
 
 something like this:
@@ -94,6 +132,13 @@ username      |Your Apple ID Username                                       |
 app_identifier|The bundle identifier of your app                            |
 team_id       |The ID of your App Store Connect team if you're in multiple teams. (optional)|
 team_name     |The name of your App Store Connect team if you're in multiple teams. (optional)|
+api_key_path	|Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)	|
+api_key	      |Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) |
+
+## Action Return
+`Fastlane::Actions::TaiwanNumberOneAction::ActionResult::SUCCESS`
+or 
+`Fastlane::Actions::TaiwanNumberOneAction::ActionResult::DO_NOTHING`
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/taiwan_number_one/actions/taiwan_number_one_action.rb

@@ -1,5 +1,4 @@
 require "fastlane/action"
-require "Spaceship/client"
 require_relative "../helper/taiwan_number_one_helper"
 
 module Fastlane
@@ -10,111 +9,145 @@ module Fastlane
         REJECT = "reject"
       end
 
+      module ActionResult
+        SUCCESS = "Success"
+        DO_NOTHING = "Nothing has changed"
+      end
+
       def self.run(params)
-        require "spaceship"
-
-        app_id = params[:app_identifier]
-
-        # Prompts select team if multiple teams and none specified
-        UI.message("Login to App Store Connect (#{params[:username]})")
-        Spaceship::ConnectAPI.login(
-          params[:username],
-          use_portal: false,
-          use_tunes: true,
-          tunes_team_id: params[:team_id],
-          team_name: params[:team_name]
-        )
-        UI.message("Login successful")
-
-        # Get App
-        application = Spaceship::Application.find(app_id)
-        unless application
-          UI.user_error!("Could not find app with bundle identifier '#{app_id}' on account #{params[:username]}")
-        end
+        require 'spaceship'
+        begin
+          params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
 
-        app = Spaceship::ConnectAPI::App.find(app_id)
-        version = app.get_app_store_versions.first
-        UI.message("app_store_state is #{version.app_store_state}")
-        UI.message("version string is #{version.version_string}")
-        UI.message("pending version is #{version}")
-        client ||= Spaceship::ConnectAPI
-        platform ||= Spaceship::ConnectAPI::Platform::IOS
-        filter = {
-          appStoreState: [
-            Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE
-          ].join(","),
-          platform: platform
-        }
-        app_store_version = app.get_app_store_versions(client: client, filter: filter, includes: "appStoreVersionSubmission")
-                               .sort_by { |v| Gem::Version.new(v.version_string) }
-                               .last
-        if app_store_version
-          UI.message("app_store_version is #{app_store_version}")
-          state = app_store_version.app_store_state
-          UI.message("state is #{state}")
-  
-          version_string = app_store_version.version_string
-          UI.message("version_string is #{version_string}")
-          unless state == Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE
-            UI.message("AppStoreState is not PENDING_DEVELOPER_RELEASE")
+          app_id = params.fetch(:app_identifier)
+          username = params.fetch(:username)
+          unless app_id && username
+            UI.message("Could not find app_id and username.")
             return
           end
-          decision = params[:app_decision]
-          decision ||= get_decision
-          case decision
-          when DicisionType::RELEASE
-            UI.message("decision is release")
-          when DicisionType::REJECT
-            UI.message("decision is reject")
+
+          token = self.api_token(params)
+          if token
+            UI.message("Using App Store Connect API token...")
+            Spaceship::ConnectAPI.token = token
           else
-            decision ||= get_decision
+            UI.message("Login to App Store Connect (#{params[:username]})")
+            Spaceship::ConnectAPI.login(
+              params[:username],
+              use_portal: false,
+              use_tunes: true,
+              tunes_team_id: params[:team_id],
+              team_name: params[:team_name]
+            )
+            UI.message("Login successful")
           end
-          release_version_if_possible(app: application, app_store_version: app_store_version) if decision == "release"
-          reject_version_if_possible(app: application) if decision == "reject"
-  
-          UI.message("The taiwan_number_one plugin is finished!")
-        else
-          UI.message("no pending release version exist.")
-        end
 
+          app = Spaceship::ConnectAPI::App.find(app_id)
+          version = app.get_app_store_versions.first
+          UI.message("app_store_state is #{version.app_store_state}")
+          client ||= Spaceship::ConnectAPI
+          platform ||= Spaceship::ConnectAPI::Platform::IOS
+          filter = {
+            appStoreState: [
+              Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE
+            ].join(","),
+            platform: platform
+          }
+          app_store_version = app.get_app_store_versions(client: client, filter: filter, includes: "appStoreVersionSubmission")
+                                 .sort_by { |v| Gem::Version.new(v.version_string) }
+                                 .last
+          if app_store_version
+            version_string = app_store_version.version_string
+            state = app_store_version.app_store_state
+            UI.message("version #{version_string} is #{state}")
+            unless state == Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE
+              UI.message("AppStoreState is not PENDING_DEVELOPER_RELEASE")
+              UI.message("🇹🇼 Taiwan helps you do nothing!")
+              return
+            end
+            decision = params[:app_decision]
+            decision ||= fetch_decision
+
+            result = ActionResult::DO_NOTHING
+            case decision
+            when DicisionType::RELEASE
+              UI.message("decision is release")
+              result = release_version_if_possible(app: app, app_store_version: app_store_version)
+            when DicisionType::REJECT
+              UI.message("decision is reject")
+              result = reject_version_if_possible(app: app, app_store_version: app_store_version)
+            else
+              UI.user_error!("App's decision must be release or reject")
+              result = ActionResult::DO_NOTHING
+            end
+
+            UI.message("The taiwan_number_one plugin action is finished!")
+            UI.message("🇹🇼 Taiwan can help!")
+            return result
+          else
+            UI.message("no pending release version exist.")
+            UI.message("The taiwan_number_one plugin action is finished!")
+            UI.message("🇹🇼 Taiwan can help!")
+            return ActionResult::DO_NOTHING
+          end
+        rescue => error
+          UI.message("🇹🇼 Taiwan might not be able to help you with this...")
+          UI.user_error!("The taiwan_number_one plugin action is finished with error: #{error.message}!")
+          return ActionResult::DO_NOTHING
+        end
       end
 
-      def self.get_decision()
+      def self.fetch_decision
         decision = nil
         until ["release", "reject"].include?(decision)
-          decision = UI.input("Please enter the app's release decision (release, reject): ")
-          UI.message("App's decision must be release or reject")
+          UI.user_error!("App's decision must be release or reject")
+          return
         end
         # return decision
+        UI.message("return type #{decision}")
         if decision == DicisionType::RELEASE
-          UI.message("return type #{decision}")
           return DicisionType::RELEASE
         else
-          UI.message("return type #{decision}")
           return DicisionType::REJECT
         end
       end
 
-      def self.reject_version_if_possible(app: nil)
+      def self.release_version_if_possible(app: nil, app_store_version: Spaceship::ConnectAPI::AppStoreVersion)
         unless app
           UI.user_error!("Could not find app with bundle identifier '#{params[:app_identifier]}' on account #{params[:username]}")
+          return ActionResult::DO_NOTHING
         end
-        if app.reject_version_if_possible!
-          UI.success("Successfully rejected previous version!")
+
+        begin
+          app_store_version.create_app_store_version_release_request
+          UI.message("release version #{app_store_version.version_string} successfully!")
+          return ActionResult::SUCCESS
+        rescue => e
+          UI.user_error!("An error occurred while releasing version #{app_store_version}, #{e.message}\n#{e.backtrace.join("\n")}")
+          return ActionResult::DO_NOTHING
         end
       end
 
-      def self.release_version_if_possible(app: nil, app_store_version: Spaceship::ConnectAPI::AppStoreVersion)
+      def self.reject_version_if_possible(app: nil, app_store_version: Spaceship::ConnectAPI::AppStoreVersion)
         unless app
           UI.user_error!("Could not find app with bundle identifier '#{params[:app_identifier]}' on account #{params[:username]}")
+          return ActionResult::DO_NOTHING
         end
-        model = app_store_version.create_app_store_version_release_request
-        UI.success("response model is #{model}")
 
-        # release(version_id: version_id)
-        # if
-        UI.success("Successfully released previous version!")
-        # end
+        if app_store_version.reject!
+          UI.success("rejected version #{app_store_version.version_string} Successfully!")
+          return ActionResult::SUCCESS
+        else
+          UI.user_error!("An error occurred while rejected version #{app_store_version}")
+          return ActionResult::DO_NOTHING
+        end
+      end
+
+      def self.api_token(params)
+        params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
+        api_token ||= Spaceship::ConnectAPI::Token.create(params[:api_key]) if params[:api_key]
+        api_token ||= Spaceship::ConnectAPI::Token.from_json_file(params[:api_key_path]) if params[:api_key_path]
+        return api_token
       end
 
       def self.description
@@ -126,20 +159,25 @@ module Fastlane
       end
 
       def self.return_value
-        # If your method provides a return value, you can describe here what it does
+        return "'Success' if action passes, else, 'Nothing has changed'"
       end
 
       def self.details
-        # Optional:
         "use fastlane to release or reject reviewed version"
       end
 
+      def self.output
+        [
+          [ActionResult::SUCCESS, 'Successfully release or reject.'],
+          [ActionResult::DO_NOTHING, 'Do nothing.']
+        ]
+      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: :app_decision,
-                                       short_option: "-d",
                                        env_name: "app_decision",
                                        description: "A description of your decision, should be release or reject",
                                        optional: false,
@@ -182,7 +220,22 @@ module Fastlane
                                        default_value_dynamic: true,
                                        verify_block: proc do |value|
                                          ENV["FASTLANE_ITC_TEAM_NAME"] = value.to_s
-                                       end)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key_path,
+                                       env_name: "FL_REGISTER_DEVICE_API_KEY_PATH",
+                                       description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
+                                       optional: true,
+                                       conflicting_options: [:api_key],
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "FL_REGISTER_DEVICE_API_KEY",
+                                       description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
+                                       type: Hash,
+                                       optional: true,
+                                       sensitive: true,
+                                       conflicting_options: [:api_key_path])
         ]
       end
 
@@ -196,7 +249,8 @@ module Fastlane
       def self.example_code
         [
           'taiwan_number_one(
-            app_decision: "release", # Set to true to skip verification of HTML preview
+            app_decision: "release",
+            api_key: "api_key" # your app_store_connect_api_key 
           )'
         ]
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TaiwanNumberOne
-    VERSION = "0.1.0"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-taiwan_number_one
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - andrew54068
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry