fastlane-plugin-aws_s3 0.2.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a564357e8a8e019e078f37befa103359e490e6dd
-  data.tar.gz: c2d966375d9b81c60809a2e3dad7e701265e3d13
+  metadata.gz: a0b71d17903f7045ded444288ab4d579f658b6ae
+  data.tar.gz: 9e8cc661d91204fcdbdffbbed76d08c68ae4d49d
 SHA512:
-  metadata.gz: 6193e0f2667f0a03e8c85ffb63bd502f8c4fdbaeb48f017f95b484a9915d1f012f54a53fbdc94035ec704b41ec39ed7f6258ba6a599a433d1012405bb71303e1
-  data.tar.gz: eba0b2bb6dd4d989308ab957a7663e654da84432a80daa408d5dba9fd0600097d4a03238b941c8ab9cf56b79da3604657be2f532b5883dd2dea79e5cd6b3f805
+  metadata.gz: 31ee79f8b36a294738077cfca68ff75057065b9cfe134651dbd54df2683d5fa9281ebdef51ac2a4f7058b3b5d134e8a3d2840e282956605491c61a54e3b9d314
+  data.tar.gz: 40d0bd830b8c6c34d152fe5016137a82b19e4866035f77e30b5d04f07f90f7702a0ae3139ecc787e0bd12fe4a6b37af1b99f3b6862d51d0c9af70936f89e43bf

data/README.md

@@ -32,10 +32,13 @@ You can also customize a lot of options:
 ```ruby
 aws_s3(
   # All of these are used to make Shenzhen's `ipa distribute:s3` command
-  access_key: ENV['S3_ACCESS_KEY'],               # Required from user.
-  secret_access_key: ENV['S3_SECRET_ACCESS_KEY'], # Required from user.
+  access_key: ENV['S3_ACCESS_KEY'],               # Required from user (unless using aws_profile).
+  secret_access_key: ENV['S3_SECRET_ACCESS_KEY'], # Required from user (unless using aws_profile).
+  aws_profile: ENV['AWS_PROFILE']                 # Required from user (unless using access_key and secret_access_key)
   bucket: ENV['S3_BUCKET'],                       # Required from user.
   region: ENV['S3_REGION'],                       # Required from user.
+  acl: ENV['S3_ACL'],                             # Optional - defaults to 'public-read'
+  server_side_encryption: ENV['S3_SERVER_SIDE_ENCRYPTION'] # Optional
 
   endpoint: 'https://s3-us-west-1.amazonaws.com', # Optional, for buckets that require a specific endpoint
   ipa: 'AppName.ipa',                             # Required (if not uploading an APK).

data/lib/assets/s3_android_html_template.erb

@@ -57,6 +57,8 @@
         <a href="<%= apk_url %>" id="text" class="btn btn-lg btn-default" onclick="document.getElementById('finished').id = '';">
           Install <%= title %> <%= version_name %> (<%= version_code %>)
         </a>
+        <br>
+        <p>Built on <%= Date.today.strftime('%a, %e %b %Y %H:%M %p') %></p>
       </span>
 
       <!-- <span class="download" id="android">

data/lib/assets/s3_ios_html_template.erb

@@ -57,6 +57,8 @@
         <a href="itms-services://?action=download-manifest&url=<%= url_encode(plist_url) %>" id="text" class="btn btn-lg btn-default" onclick="document.getElementById('finished').id = '';">
           Install <%= title %> <%= bundle_version %> (<%= build_num %>)
         </a>
+        <br>
+        <p>Built on <%= Date.today.strftime('%a, %e %b %Y %H:%M %p') %></p>
       </span>
 
       <!-- <span class="download" id="android">

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

@@ -3,6 +3,7 @@ require 'fastlane/erb_template_helper'
 include ERB::Util
 require 'ostruct'
 require 'cgi'
+require 'mime-types'
 
 module Fastlane
   module Actions
@@ -25,11 +26,13 @@ module Fastlane
         params[:dsym] = config[:dsym]
         params[:access_key] = config[:access_key]
         params[:secret_access_key] = config[:secret_access_key]
+        params[:aws_profile] = config[:aws_profile]
         params[:bucket] = config[:bucket]
         params[:endpoint] = config[:endpoint]
         params[:region] = config[:region]
         params[:app_directory] = config[:app_directory]
         params[:acl] = config[:acl]
+        params[:server_side_encryption] = config[:server_side_encryption]
         params[:source] = config[:source]
         params[:path] = config[:path]
         params[:upload_metadata] = config[:upload_metadata]
@@ -38,6 +41,7 @@ module Fastlane
         params[:html_template_path] = config[:html_template_path]
         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[:version_template_path] = config[:version_template_path]
         params[:version_file_name] = config[:version_file_name]
 
@@ -45,6 +49,7 @@ module Fastlane
         s3_region = params[:region]
         s3_access_key = params[:access_key]
         s3_secret_access_key = params[:secret_access_key]
+        s3_profile = params[:aws_profile]
         s3_bucket = params[:bucket]
         s3_endpoint = params[:endpoint]
         apk_file = params[:apk]
@@ -52,17 +57,25 @@ module Fastlane
         dsym_file = params[:dsym]
         s3_path = params[:path]
         acl     = params[:acl].to_sym
+        server_side_encryption = params[:server_side_encryption]
 
-        UI.user_error!("No S3 access key given, pass using `access_key: 'key'`") unless s3_access_key.to_s.length > 0
-        UI.user_error!("No S3 secret access key given, pass using `secret_access_key: 'secret key'`") unless s3_secret_access_key.to_s.length > 0
+        unless s3_profile
+          UI.user_error!("No S3 access key given, pass using `access_key: 'key'` (or use `aws_profile: 'profile'`)") unless s3_access_key.to_s.length > 0
+          UI.user_error!("No S3 secret access key given, pass using `secret_access_key: 'secret key'` (or use `aws_profile: 'profile'`)") unless s3_secret_access_key.to_s.length > 0
+        end
         UI.user_error!("No S3 bucket given, pass using `bucket: 'bucket'`") unless s3_bucket.to_s.length > 0
         UI.user_error!("No IPA or APK file path given, pass using `ipa: 'ipa path'` or `apk: 'apk path'`") if ipa_file.to_s.length == 0 && apk_file.to_s.length == 0
         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'
+        if s3_profile
+          creds = Aws::SharedCredentials.new(profile_name: s3_profile);
+        else
+          creds = Aws::Credentials.new(s3_access_key, s3_secret_access_key)
+        end
         Aws.config.update({
           region: s3_region,
-          credentials: Aws::Credentials.new(s3_access_key, s3_secret_access_key)
+          credentials: creds
         })
 
         s3_client = if s3_endpoint
@@ -71,13 +84,13 @@ module Fastlane
                       Aws::S3::Client.new
                     end
 
-        upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl) if ipa_file.to_s.length > 0
-        upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl) if apk_file.to_s.length > 0
+        upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl, server_side_encryption) if ipa_file.to_s.length > 0
+        upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl, server_side_encryption) if apk_file.to_s.length > 0
 
         return true
       end
 
-      def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl)
+      def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl, server_side_encryption)
 
         s3_path = "v{CFBundleShortVersionString}_b{CFBundleVersion}/" unless s3_path
 
@@ -87,6 +100,7 @@ module Fastlane
         plist_file_name = params[:plist_file_name]
         html_template_path = params[:html_template_path]
         html_file_name = params[:html_file_name]
+        generate_html_in_folder = params[:html_in_folder]
         version_template_path = params[:version_template_path]
         version_file_name = params[:version_file_name]
 
@@ -96,7 +110,7 @@ module Fastlane
         ipa_file_name = "#{url_part}#{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)
+        ipa_url = self.upload_file(s3_client, s3_bucket, app_directory, ipa_file_name, ipa_file_data, acl, server_side_encryption)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH] = ipa_url
@@ -107,7 +121,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)
+          dsym_url = self.upload_file(s3_client, s3_bucket, app_directory, dsym_file_name, dsym_file_data, acl, server_side_encryption)
 
           # Setting action and environment variables
           Actions.lane_context[SharedValues::S3_DSYM_OUTPUT_PATH] = dsym_url
@@ -164,7 +178,7 @@ module Fastlane
         # plist uploading
         #
         #####################################
-        plist_url = self.upload_file(s3_client, s3_bucket, app_directory, plist_file_name, plist_render, acl)
+        plist_url = self.upload_file(s3_client, s3_bucket, app_directory, plist_file_name, plist_render, acl, server_side_encryption)
 
         # Creates html from template
         if html_template_path && File.exist?(html_template_path)
@@ -202,11 +216,11 @@ module Fastlane
         # html uploading
         #
         #####################################
-        
+
         skip_html = params[:skip_html_upload]
-        
-        html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl) unless skip_html
-        version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl)
+        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)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_PLIST_OUTPUT_PATH] = plist_url
@@ -217,14 +231,14 @@ module Fastlane
 
         Actions.lane_context[SharedValues::S3_VERSION_OUTPUT_PATH] = version_url
         ENV[SharedValues::S3_VERSION_OUTPUT_PATH.to_s] = version_url
-        
-        self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl)
+
+        self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl, server_side_encryption)
 
         UI.success("Successfully uploaded ipa file to '#{Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH]}'")
         UI.success("iOS app can be downloaded at '#{Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH]}'") unless skip_html
       end
 
-      def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl)
+      def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl, server_side_encryption)
         version = get_apk_version(apk_file)
 
         version_code = version[0]
@@ -237,6 +251,7 @@ module Fastlane
 
         html_template_path = params[:html_template_path]
         html_file_name = params[:html_file_name]
+        generate_html_in_folder = params[:html_in_folder]
         version_template_path = params[:version_template_path]
         version_file_name = params[:version_file_name]
 
@@ -246,7 +261,7 @@ module Fastlane
         apk_file_name = "#{url_part}#{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)
+        apk_url = self.upload_file(s3_client, s3_bucket, app_directory, apk_file_name, apk_file_data, acl, server_side_encryption)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::S3_APK_OUTPUT_PATH] = apk_url
@@ -300,11 +315,11 @@ module Fastlane
         # html and plist uploading
         #
         #####################################
-        
-        skip_html = params[:skip_html_upload]
 
-        html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl) unless skip_html
-        version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl)
+        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)
 
         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
@@ -312,33 +327,33 @@ module Fastlane
         Actions.lane_context[SharedValues::S3_VERSION_OUTPUT_PATH] = version_url
         ENV[SharedValues::S3_VERSION_OUTPUT_PATH.to_s] = version_url
 
-        self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl)
-        
+        self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl, server_side_encryption)
+
         UI.success("Successfully uploaded apk file to '#{Actions.lane_context[SharedValues::S3_APK_OUTPUT_PATH]}'")
         UI.success("Android app can be downloaded at '#{Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH]}'") unless skip_html
       end
-      
-      def self.upload_source(s3_client, params, s3_bucket, source_directory, s3_path, acl)
+
+      def self.upload_source(s3_client, params, s3_bucket, source_directory, s3_path, acl, server_side_encryption)
         if source_directory && File.directory?(source_directory)
           source_directory = File.absolute_path source_directory
           output_file_path = Tempfile.new('aws_s3_source').path
-          
+
           output_file_path = other_action.zip(
             path: source_directory,
             output_path: output_file_path.gsub(/(?<!.zip)$/, ".zip")
           )
-          
+
           s3_path = "#{version_code}_#{version_name}/" unless s3_path
           app_directory = params[:app_directory]
           url_part = s3_path
           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)
-          
+          source_url = self.upload_file(s3_client, s3_bucket, app_directory, zip_file_name, output_path_data, acl, server_side_encryption)
+
           Actions.lane_context[SharedValues::S3_SOURCE_OUTPUT_PATH] = source_url
           ENV[SharedValues::S3_SOURCE_OUTPUT_PATH.to_s] = source_url
-          
+
           UI.success("Source can be downloaded at '#{Actions.lane_context[SharedValues::S3_SOURCE_OUTPUT_PATH]}'")
         end
       end
@@ -381,18 +396,21 @@ module Fastlane
         [versionCode, versionName, name]
       end
 
-      def self.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl)
+      def self.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl, server_side_encryption)
 
         if app_directory
           file_name = "#{app_directory}/#{file_name}"
         end
 
         bucket = Aws::S3::Bucket.new(bucket_name, client: s3_client)
-        obj = bucket.put_object({
+        details = {
           acl: acl,
           key: file_name,
-          body: file_data
-        })
+          body: file_data,
+          content_type: MIME::Types.type_for(File.extname(file_name)).first.to_s
+        }
+        details = details.merge(server_side_encryption: server_side_encryption) if server_side_encryption.length > 0
+        obj = bucket.put_object(details)
 
         # When you enable versioning on a S3 bucket,
         # writing to an object will create an object version
@@ -478,6 +496,12 @@ module Fastlane
                                        optional: true,
                                        default_value: false,
                                        is_string: false),
+          FastlaneCore::ConfigItem.new(key: :html_in_folder,
+                                       env_name: "",
+                                       description: "move the uploaded html file into the version folder",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
           FastlaneCore::ConfigItem.new(key: :version_template_path,
                                        env_name: "",
                                        description: "version erb template path",
@@ -496,12 +520,17 @@ module Fastlane
                                        description: "AWS Secret Access Key ",
                                        optional: true,
                                        default_value: ENV['AWS_SECRET_ACCESS_KEY']),
+          FastlaneCore::ConfigItem.new(key: :aws_profile,
+                                       env_name: "S3_PROFILE",
+                                       description: "AWS profile to use for credentials",
+                                       optional: true,
+                                       default_value: ENV['AWS_PROFILE']),
           FastlaneCore::ConfigItem.new(key: :bucket,
                                        env_name: "S3_BUCKET",
                                        description: "AWS bucket name",
                                        optional: true,
                                        default_value: ENV['AWS_BUCKET_NAME']),
-         FastlaneCore::ConfigItem.new(key: :region,
+          FastlaneCore::ConfigItem.new(key: :region,
                                        env_name: "S3_REGION",
                                        description: "AWS region (for bucket creation) ",
                                        optional: true,
@@ -522,14 +551,18 @@ module Fastlane
                                        env_name: "S3_ACL",
                                        description: "Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read ",
                                        optional: true,
-                                       default_value: "public-read"
-                                      ),
+                                       default_value: "public-read"),
+          FastlaneCore::ConfigItem.new(key: :server_side_encryption,
+                                       env_name: "S3_SERVER_SIDE_ENCRYPTION",
+                                       description: "Enable encryption of the uploaded S3 object (set it to 'AES256' for example)",
+                                       optional: true,
+                                       default_value: ""),
           FastlaneCore::ConfigItem.new(key: :endpoint,
                                        env_name: "S3_ENDPOINT",
                                        description: "The base endpoint for your S3 bucket",
                                        optional: true,
                                        default_value: nil
-                                      ),
+            ),
         ]
       end
 

data/lib/fastlane/plugin/aws_s3/helper/aws_s3_helper.rb

@@ -14,8 +14,7 @@ module Fastlane
       #
       require "erb"
       def self.load(template_name)
-        path = "#{Helper.gem_path('fastlane-plugin-aws_s3')}/lib/assets/#{template_name}.erb"
-        puts "path #{path}"
+        path = "#{gem_path('fastlane-plugin-aws_s3')}/lib/assets/#{template_name}.erb"
         load_from_path(path)
       end
 
@@ -29,6 +28,19 @@ module Fastlane
       def self.render(template, template_vars_hash)
         Fastlane::ErbalT.new(template_vars_hash).render(template)
       end
+      
+      #
+      # Taken from https://github.com/fastlane/fastlane/blob/f0dd4d0f4ecc74d9f7f62e0efc33091d975f2043/fastlane_core/lib/fastlane_core/helper.rb#L248-L259
+      # Unsure best other way to do this so using this logic for now since its deprecated in fastlane proper
+      #
+      def self.gem_path(gem_name)
+        if !Helper.is_test? and Gem::Specification.find_all_by_name(gem_name).any?
+          return Gem::Specification.find_by_name(gem_name).gem_dir
+        else
+          return './'
+        end
+      end
+      
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AwsS3
-    VERSION = "0.2.8"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-aws_s3
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Josh Holtz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -131,9 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Upload IPA and APK to S3
 test_files: []
-has_rdoc: