fastlane-plugin-taiwan_number_one 0.1.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb753f703cb1ca29144e73ab02075eef0ba777a23005447ae29b71b7851c5469
-  data.tar.gz: 8d62b2ac64f6ff3b45adeec927f060e0785ee75f9c0ecb7ca70ac3e7217abc10
+  metadata.gz: 3f6eb09f64dd7bf6465761f674f378f6ea3d4a912976cd38f600a29a6a4752f1
+  data.tar.gz: b033ac75e5eb986c6902c857c9ea9fcfd125bb8513616f3a39100d1b8f5188ad
 SHA512:
-  metadata.gz: 8ab1d0603fcb11a782a795a50d2c8624428215b16d5132bf1658657ffc0c8eff78c51c19a6e21ae870d6040444f24085a914116c52c1c72e82eab623dced7f9d
-  data.tar.gz: 5f947b531a3e54378f787addf6b12af3882d84fcb9b935f9f3d97b0105de5dac820bddfcb5208f100aa5b3319cd27e6e1fcf4b0487eb925c136915ceeac5ca87
+  metadata.gz: fe2c9f523df133975f0bcca2b00a8f099b984add55edade12febf3dffd0227ee54fb080b46e50b0708f1b378f34561c99b93b8334d76d84752882797ea15cd7f
+  data.tar.gz: 15e3641963bb2568d9b0853dc24704450d04c797e405c2ff0137135e7501a97867a485c2446cb5e96752a7530ea15bb3dc5a66cdb760af38f7423a7df60370d3

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,10 +33,10 @@ https://github.com/fastlane/fastlane/issues/17539
 
 ## Usage
 
-##### install plugin for fastlane
+##### Install plugin for fastlane
 [install instructions](https://docs.fastlane.tools/plugins/using-plugins/)
 ```
-bundle exce fastlane add_plugin taiwan_number_one
+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
 
@@ -59,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:
@@ -105,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"
 require_relative "../helper/taiwan_number_one_helper"
 
 module Fastlane
@@ -10,76 +9,98 @@ module Fastlane
         REJECT = "reject"
       end
 
-      def self.run(params)
-        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
+      module ActionResult
+        SUCCESS = "Success"
+        DO_NOTHING = "Nothing has changed"
+      end
 
-        # 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
+      def self.run(params)
+        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}")
-        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")
+          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 ||= fetch_decision
-          case decision
-          when DicisionType::RELEASE
-            UI.message("decision is release")
-            release_version_if_possible(app: application, app_store_version: app_store_version)
-          when DicisionType::REJECT
-            UI.message("decision is reject")
-            reject_version_if_possible(app: app, app_store_version: app_store_version)
+
+          token = self.api_token(params)
+          if token
+            UI.message("Using App Store Connect API token...")
+            Spaceship::ConnectAPI.token = token
           else
-            decision ||= fetch_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
-        else
-          UI.message("no pending release version exist.")
+
+          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 ||= fetch_decision(param)
+
+            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
-        UI.message("The taiwan_number_one plugin action is finished!")
       end
 
-      def self.fetch_decision
-        decision = nil
+      def self.fetch_decision(param)
+        decision = params[:app_decision]
         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}")
@@ -89,33 +110,45 @@ module Fastlane
           return DicisionType::REJECT
         end
       end
-      
+
       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
 
         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}")
-          UI.error("#{e.message}\n#{e.backtrace.join("\n")}") if FastlaneCore::Globals.verbose?
+          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.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
-        
+
         if app_store_version.reject!
-          UI.success("rejected version #{app_store_version} Successfully!")
+          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
         "release or reject if status is Pending Developer Release."
       end
@@ -125,14 +158,20 @@ 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)
@@ -180,7 +219,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
 
@@ -194,7 +248,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.2"
+    VERSION = "0.2.4"
   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.2
+  version: 0.2.4
 platform: ruby
 authors:
 - andrew54068
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry