fastlane-plugin-aws_s3 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 594f0be26c1299aa2e30916f9cd14fa27f0018577ed7f1a57bc85c925c265e09
-  data.tar.gz: aac3d5fcd0522cf8c1a92b6ef31cfed1183b915eb06f3ff193b41ac1187c8f23
+  metadata.gz: fa270593b8070859b409a3123921341f44e46a750aadd42df7c958c3946529b5
+  data.tar.gz: 3e37babdac81f10057af2d113423351332fcfe34406b78dd7ffce249ac9bbfd3
 SHA512:
-  metadata.gz: a125b9f244360d5ffecc66121765a2e764c02af654de7237260ca6ae1a5d8322decec7cfd77543135ca90d661efeb67e9e49b212d19889cb612903dba3794b9f
-  data.tar.gz: 47cd761ae03280ad801e95f30b3aeefc40d7e27593d10ec561b38a7e5f49f7b1a9f793515db2789cfdfecf2619663143300733b47f40127cbfea15fc6360a383
+  metadata.gz: 944b7f4fda0f8963f5896f4edcb973bbd6d8ef2a3931268455404fcd3696897339f3daa6c810b8a3d3a4e2ef35ee909f6b5441547b7a06d26439946b62131a4d
+  data.tar.gz: 537580be8d808a2458ca5df1209406b8b01ba1855e30ded8d10c42897e79f791fa18389cff8d15e3cadcf486c034160421fc61dda7b86f5c5d6ad0459eb2927b

data/lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb

@@ -35,6 +35,8 @@ module Fastlane
         params[:aws_profile] = config[:aws_profile]
         params[:bucket] = config[:bucket]
         params[:endpoint] = config[:endpoint]
+        params[:download_endpoint] = config[:download_endpoint]
+        params[:download_endpoint_replacement_regex] = config[:download_endpoint_replacement_regex]
         params[:region] = config[:region]
         params[:app_directory] = config[:app_directory]
         params[:acl] = config[:acl]
@@ -49,6 +51,9 @@ module Fastlane
         params[:html_file_name] = config[:html_file_name]
         params[:skip_html_upload] = config[:skip_html_upload]
         params[:html_in_folder] = config[:html_in_folder]
+        params[:html_in_root] = config[:html_in_root]
+        params[:version_in_folder] = config[:version_in_folder]
+        params[:version_in_root] = config[:version_in_root]
         params[:version_template_path] = config[:version_template_path]
         params[:version_file_name] = config[:version_file_name]
         params[:version_template_params] = config[:version_template_params]
@@ -79,25 +84,14 @@ module Fastlane
         UI.user_error!("Please only give IPA path or APK path (not both)") if ipa_file.to_s.length > 0 && apk_file.to_s.length > 0
 
         require 'aws-sdk-s3'
-        if s3_profile
-          creds = Aws::SharedCredentials.new(profile_name: s3_profile);
-        elsif s3_access_key.to_s.length > 0 && s3_secret_access_key.to_s.length > 0
-          creds = Aws::Credentials.new(s3_access_key, s3_secret_access_key)
-        else
-          UI.important("No S3 access key or S3 secret access key given, using S3 instance profile by default.")
-          UI.important("If you want to use specific creds to S3 access, you can pass using `access_key: 'key'` and `secret_access_key: 'secret key'` (or use `aws_profile: 'profile'`)")
-          creds = Aws::InstanceProfileCredentials.new()
-        end
-        Aws.config.update({
-                            region: s3_region,
-                            credentials: creds
-        })
 
-        s3_client = if s3_endpoint
-          Aws::S3::Client.new(endpoint: s3_endpoint)
-        else
-          Aws::S3::Client.new
-        end
+        client_cfg = {}
+        client_cfg[:region] = s3_region if s3_region
+        client_cfg[:endpoint] = s3_endpoint if s3_endpoint
+        client_cfg[:profile] = s3_profile if s3_profile
+        client_cfg[:credentials] = Aws::Credentials.new(s3_access_key, s3_secret_access_key) if s3_access_key && s3_secret_access_key
+
+        s3_client = Aws::S3::Client.new(client_cfg)
 
         if xcarchive_file.nil?
           xcarchive_file = Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE]
@@ -124,18 +118,22 @@ module Fastlane
         html_template_params = params[:html_template_params] || {}
         html_file_name = params[:html_file_name]
         generate_html_in_folder = params[:html_in_folder]
+        generate_html_in_root = params[:html_in_root]
+        generate_version_in_folder = params[:version_in_folder]
+        generate_version_in_root = params[:version_in_root]
         version_template_path = params[:version_template_path]
         version_template_params = params[:version_template_params] || {}
         version_file_name = params[:version_file_name]
         override_file_name = params[:override_file_name]
-
+        download_endpoint = params[:download_endpoint]
+        download_endpoint_replacement_regex = params[:download_endpoint_replacement_regex]
         url_part = self.expand_path_with_substitutions_from_ipa_plist(ipa_file, s3_path)
 
         ipa_file_basename = File.basename(ipa_file)
         ipa_file_name = "#{url_part}#{override_file_name ? override_file_name : ipa_file_basename}"
         ipa_file_data = File.open(ipa_file, 'rb')
 
-        ipa_url = self.upload_file(s3_client, s3_bucket, app_directory, ipa_file_name, ipa_file_data, acl, server_side_encryption)
+        ipa_url = self.upload_file(s3_client, s3_bucket, app_directory, ipa_file_name, ipa_file_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH] = ipa_url
@@ -146,7 +144,7 @@ module Fastlane
           dsym_file_name = "#{url_part}#{dsym_file_basename}"
           dsym_file_data = File.open(dsym_file, 'rb')
 
-          dsym_url = self.upload_file(s3_client, s3_bucket, app_directory, dsym_file_name, dsym_file_data, acl, server_side_encryption)
+          dsym_url = self.upload_file(s3_client, s3_bucket, app_directory, dsym_file_name, dsym_file_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
           # Setting action and environment variables
           Actions.lane_context[SharedValues::S3_DSYM_OUTPUT_PATH] = dsym_url
@@ -207,7 +205,7 @@ module Fastlane
         # plist uploading
         #
         #####################################
-        plist_url = self.upload_file(s3_client, s3_bucket, app_directory, plist_file_name, plist_render, acl, server_side_encryption)
+        plist_url = self.upload_file(s3_client, s3_bucket, app_directory, plist_file_name, plist_render, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
         # Creates html from template
         if html_template_path && File.exist?(html_template_path)
@@ -249,9 +247,34 @@ module Fastlane
         #####################################
 
         skip_html = params[:skip_html_upload]
-        html_file_name = "#{url_part}#{html_file_name}" if generate_html_in_folder
-        html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl, server_side_encryption) unless skip_html
-        version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl, server_side_encryption)
+
+        html_file_names = []
+        version_file_names = []
+
+        unless skip_html
+          if generate_html_in_root
+            html_file_names << html_file_name
+          end
+          if generate_html_in_folder
+            html_file_names << "#{url_part}#{html_file_name}"
+          end
+        end
+        if generate_version_in_root
+          version_file_names << version_file_name
+        end
+        if generate_version_in_folder
+          version_file_names << "#{url_part}#{version_file_name}"
+        end
+
+        html_url = nil
+        version_url = nil
+
+        html_file_names.each do |html_file_name|
+          html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
+        end
+        version_file_names.each do |version_file_name|
+          version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
+        end
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_PLIST_OUTPUT_PATH] = plist_url
@@ -283,8 +306,10 @@ module Fastlane
         sh("zip -r '#{archive_zip}' '#{archive}'")
         full_archive_zip_name = "#{url_part}#{archive_zip_name}"
         archive_zip_data = File.open(archive_zip, 'rb')
+        download_endpoint = params[:download_endpoint]
+        download_endpoint_replacement_regex = params[:download_endpoint_replacement_regex]
 
-        archive_url = self.upload_file(s3_client, s3_bucket, app_directory, full_archive_zip_name, archive_zip_data, acl, server_side_encryption)
+        archive_url = self.upload_file(s3_client, s3_bucket, app_directory, full_archive_zip_name, archive_zip_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
         Actions.lane_context[SharedValues::S3_XCARCHIVE_OUTPUT_PATH] = archive_url
         ENV[SharedValues::S3_XCARCHIVE_OUTPUT_PATH.to_s] = archive_url
@@ -299,7 +324,7 @@ module Fastlane
         version_name = version[1]
         title = version[2]
 
-        s3_path = "#{version_code}_#{version_name}/" unless s3_path
+        s3_path = "v{version_name}_b{version_code}/" unless s3_path
 
         app_directory = params[:app_directory]
 
@@ -307,18 +332,23 @@ module Fastlane
         html_template_params = params[:html_template_params] || {}
         html_file_name = params[:html_file_name]
         generate_html_in_folder = params[:html_in_folder]
+        generate_html_in_root = params[:html_in_root]
+        generate_version_in_folder = params[:version_in_folder]
+        generate_version_in_root = params[:version_in_root]
         version_template_path = params[:version_template_path]
         version_template_params = params[:version_template_params] || {}
         version_file_name = params[:version_file_name]
         override_file_name = params[:override_file_name]
+        download_endpoint = params[:download_endpoint]
+        download_endpoint_replacement_regex = params[:download_endpoint_replacement_regex]
 
-        url_part = s3_path
+        url_part = self.expand_path_with_substitutions_with_versions(version_code, version_name, s3_path)
 
         apk_file_basename = File.basename(apk_file)
         apk_file_name = "#{url_part}#{override_file_name ? override_file_name : apk_file_basename}"
         apk_file_data = File.open(apk_file, 'rb')
 
-        apk_url = self.upload_file(s3_client, s3_bucket, app_directory, apk_file_name, apk_file_data, acl, server_side_encryption)
+        apk_url = self.upload_file(s3_client, s3_bucket, app_directory, apk_file_name, apk_file_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_APK_OUTPUT_PATH] = apk_url
@@ -376,9 +406,35 @@ module Fastlane
         #####################################
 
         skip_html = params[:skip_html_upload]
-        html_file_name = "#{url_part}#{html_file_name}" if generate_html_in_folder
-        html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl, server_side_encryption) unless skip_html
-        version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl, server_side_encryption)
+
+        html_file_names = []
+        version_file_names = []
+
+        unless skip_html
+          if generate_html_in_root
+            html_file_names << html_file_name
+          end
+          if generate_html_in_folder
+            html_file_names << "#{url_part}#{html_file_name}"
+          end
+        end
+        if generate_version_in_root
+          version_file_names << version_file_name
+        end
+        if generate_version_in_folder
+          version_file_names << "#{url_part}#{version_file_name}"
+        end
+
+        html_url = nil
+        version_url = nil
+
+        html_file_names.each do |html_file_name|
+          html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
+        end
+
+        version_file_names do |version_file_name|
+          version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
+        end
 
         Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH] = html_url unless skip_html
         ENV[SharedValues::S3_HTML_OUTPUT_PATH.to_s] = html_url unless skip_html
@@ -408,7 +464,9 @@ module Fastlane
           zip_file_name = "#{url_part}source.zip"
 
           output_path_data = File.open("#{output_file_path}", 'rb')
-          source_url = self.upload_file(s3_client, s3_bucket, app_directory, zip_file_name, output_path_data, acl, server_side_encryption)
+          download_endpoint = params[:download_endpoint]
+          download_endpoint_replacement_regex = params[:download_endpoint_replacement_regex]
+          source_url = self.upload_file(s3_client, s3_bucket, app_directory, zip_file_name, output_path_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
           Actions.lane_context[SharedValues::S3_SOURCE_OUTPUT_PATH] = source_url
           ENV[SharedValues::S3_SOURCE_OUTPUT_PATH.to_s] = source_url
@@ -494,13 +552,11 @@ module Fastlane
           file_name = url_part + '/' + file_relative_path_to_folder
 
           file_url = self.upload_file(s3_client, s3_bucket, app_directory, file_name, file_data, acl, server_side_encryption)
-          Actions.lane_context[SharedValues::S3_FOLDER_OUTPUT_PATH] = file_url.gsub('/' + file_relative_path_to_folder, '')
+          Actions.lane_context[SharedValues::S3_FOLDER_OUTPUT_PATH] = CGI.unescape(file_url).gsub('/' + file_relative_path_to_folder, '')
         end
       end
 
-
-
-      def self.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl, server_side_encryption)
+      def self.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl, server_side_encryption, download_endpoint, download_endpoint_replacement_regex)
 
         if app_directory
           file_name = "#{app_directory}/#{file_name}"
@@ -525,7 +581,14 @@ module Fastlane
         end
 
         # Return public url
-        obj.public_url.to_s
+        url = obj.public_url.to_s
+
+        # if a download endpoint is provided, then swap it in before returning
+        if download_endpoint
+          url = url.gsub(Regexp.new(download_endpoint_replacement_regex), download_endpoint)
+        end
+
+        return url
       end
 
       #
@@ -551,6 +614,12 @@ module Fastlane
         return path
       end
 
+      def self.expand_path_with_substitutions_with_versions(version_code, version_name, path)
+        path.gsub!(/\{version_code\}/, version_code.to_s) if version_code
+        path.gsub!(/\{version_name\}/, version_name) if version_name
+        return path
+      end
+
       def self.description
         "Generates a plist file and uploads all to AWS S3"
       end
@@ -616,10 +685,28 @@ module Fastlane
                                        is_string: false),
           FastlaneCore::ConfigItem.new(key: :html_in_folder,
                                        env_name: "",
-                                       description: "move the uploaded html file into the version folder",
+                                       description: "upload the html file into the version folder",
                                        optional: true,
                                        default_value: false,
                                        is_string: false),
+          FastlaneCore::ConfigItem.new(key: :html_in_root,
+                                       env_name: "",
+                                       description: "upload the html file into the 'root' folder",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :version_in_folder,
+                                       env_name: "",
+                                       description: "upload the version file into the version folder",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :version_in_root,
+                                       env_name: "",
+                                       description: "upload the html file into the 'root' folder",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
           FastlaneCore::ConfigItem.new(key: :version_template_path,
                                        env_name: "",
                                        description: "version erb template path",
@@ -685,6 +772,16 @@ module Fastlane
                                        description: "The base endpoint for your S3 bucket",
                                        optional: true,
                                        default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :download_endpoint,
+                                       env_name: "S3_DOWNLOAD_ENDPOINT",
+                                       description: "The endpoint for downloads from your S3 bucket",
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :download_endpoint_replacement_regex,
+                                       env_name: "S3_DOWNLOAD_ENDPOINT_REPLACEMENT_REGEX",
+                                       description: "A regex used to determine which part of the S3 URL to replace with S3_DOWNLOAD_ENDPOINT",
+                                       optional: true,
+                                       default_value: '^https?://[^/]*'),
           FastlaneCore::ConfigItem.new(key: :override_file_name,
                                        env_name: "",
                                        description: "Optional override ipa/apk uploaded file name",

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AwsS3
-    VERSION = "1.8.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-aws_s3
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Josh Holtz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.144.0
-description: 
+description:
 email: josh@rokkincat.com
 executables: []
 extensions: []
@@ -129,7 +129,7 @@ homepage: https://github.com/fastlane-community/fastlane-plugin-s3
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Upload IPA and APK to S3
 test_files: []