fastlane-plugin-instabug_official 0.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29ff81468754f432fd52be59fb0fc1da822b3388
-  data.tar.gz: 7be9f7181f91b24d09f525135b02372f851a756f
+SHA256:
+  metadata.gz: f4cd31e00ccf7d08eb06dae94763d037fa565f15a3a8bf511e2cddaefa0b8853
+  data.tar.gz: '09535c86b470bfc082c194e598a80dd1e4fa4f4c7154c29e6b839ea9bfe1888d'
 SHA512:
-  metadata.gz: 4cfd391852f4d6fac882fbc28fca509f2f8616394736224d5759312548adbaae6973e37cc1e049639c7ff4e84ed63a47788166654fa1e3b70dfda8cd5e31a81c
-  data.tar.gz: 2e006fb4fffcc7802a734e4bd9acad7455789538e94f074cba4aab2bef046603cac76a9ee3d906daba5b0512feb223ec868369b544422a3edad8ea821d651030
+  metadata.gz: 9946522486b66f56471c30f08e9ed26826b4dc37295f8f6e9ba03cd6e85a71f46541ef0f6473b7dd322a6eea0016e5168340da2b194c5f2d32cb8bf949e933cc
+  data.tar.gz: dd9f90f660184d212193d161d231e32e8b538b2282f91933b1393bcccdae9c01e8a35068f7e83fb2e4aba4ba7b0a2e07bb8da27b5bab9b1b1d5f43a7ec96628a

data/README.md

@@ -12,27 +12,20 @@ fastlane add_plugin instabug_official
 
 ## About instabug_official
 
-upload dsyms to fastlane
+Upload dSYM files to Instabug
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This action is used to upload symbolication files to Instabug. Incase you are not using bitcode, you can use this plug-in
+with `gym` to upload dSYMs generated from your builds. If bitcode is enabled, you can use it with `download_dsyms` to upload dSYMs
+from iTunes connect
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
-
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
-## Run tests for this plugin
-
-To run both the tests, and code style validation, run
-
 ```
-rake
+instabug_official(api_token: "<Instabug token>")
 ```
 
-To automatically fix many of the styling issues, use
 ```
-rubocop -a
+instabug_official(api_token: "<Instabug token>", dsym_array_paths: ["./App1.dSYM.zip", "./App2.dSYM.zip"])
 ```
 
 ## Issues and Feedback

data/lib/fastlane/plugin/instabug_official/actions/instabug_official_action.rb

@@ -1,127 +1,135 @@
 require 'fileutils'
 require 'fastlane/action'
 require_relative '../helper/instabug_official_helper'
+require 'shellwords'
 
 module Fastlane
-    module Actions
-        class InstabugOfficialAction < Action
-            def self.run(params)
-            UI.verbose "Running Instabug Action"
-            api_token = params[:api_token]
-            
-            endpoint = 'https://api.instabug.com/api/sdk/v3/symbols_files'
-            command = "curl #{endpoint} --write-out %{http_code} --silent --output /dev/null -F os=\"ios\" -F application_token=\"#{api_token}\" -F symbols_file="
-            
-            dsym_paths = (params[:dsym_array_paths] || []).uniq
-            UI.verbose "dsym_paths: " + dsym_paths.inspect
-            
-            
-            if dsym_paths.empty?
-                directory_name = fastlane_dsyms_filename
-                if directory_name.empty?
-                UI.error "Fastlane dSYMs file is not found! make sure you're using Fastlane action [download_dsyms] to download your dSYMs from App Store Connect"
-                return
-                end
-            else
-                directory_name = generate_directory_name
-                UI.verbose "Directory name: " + directory_name
-                copy_dsym_paths_into_directory(dsym_paths, directory_name)
-            end
-        
-            command = build_single_file_command(command, directory_name)
-            
-            puts command
-            
-            result = Actions.sh(command)
-            if result == '200'
-            UI.success 'dSYM is successfully uploaded to Instabug 🤖'
-            UI.verbose 'Removing The directory'
-            remove_directory(directory_name)
-            else
-            UI.error "Something went wrong during Instabug dSYM upload. Status code is #{result}"
+  module Actions
+    class InstabugOfficialAction < Action
+      def self.run(params)
+        @instabug_dsyms_directory = 'Instabug_dsym_files_fastlane'
+
+        UI.verbose 'Running Instabug Action'
+        api_token = params[:api_token]
+
+        endpoint = 'https://api.instabug.com/api/sdk/v3/symbols_files'
+        command = "curl #{endpoint} --write-out %{http_code} --silent --output /dev/null -F os=\"ios\" -F application_token=\"#{api_token}\" -F symbols_file="
+
+        dsym_paths = []
+        # Add paths provided by the user
+        dsym_paths += (params[:dsym_array_paths] || [])
+        # Add dSYMs generaed by `gym`
+        dsym_paths += [Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]] if Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]
+        # Add dSYMs downloaded from iTC
+        dsym_paths += Actions.lane_context[SharedValues::DSYM_PATHS] if Actions.lane_context[SharedValues::DSYM_PATHS]
+
+        dsym_paths.uniq!
+        UI.verbose 'dsym_paths: ' + dsym_paths.inspect
+
+        if dsym_paths.empty?
+          UI.error "Fastlane dSYMs file is not found! make sure you're using Fastlane action [download_dsyms] to download your dSYMs from App Store Connect"
+          return
         end
-    end
-    
-    def self.description
-    'upload dsyms to fastlane'
-end
 
-def self.authors
-['Instabug Inc.']
-end
+        generate_instabug_directory
 
-def self.return_value
-# If your method provides a return value, you can describe here what it does
-end
+        UI.verbose 'Directory name: ' + @instabug_dsyms_directory
+        copy_dsym_paths_into_directory(dsym_paths, @instabug_dsyms_directory)
 
-def self.details
-# Optional:
-'upload dsyms to fastlane'
-end
+        command = build_single_file_command(command, @instabug_dsyms_directory)
 
-def self.available_options
-[
-FastlaneCore::ConfigItem.new(key: :api_token,
-                             env_name: 'FL_INSTABUG_API_TOKEN', # The name of the environment variable
-                             description: 'API Token for Instabug', # a short description of this parameter
-                             verify_block: proc do |value|
-                             UI.user_error!("No API token for InstabugAction given, pass using `api_token: 'token'`") unless value && !value.empty?
-                             end),
-FastlaneCore::ConfigItem.new(key: :dsym_array_paths,
-                             type: Array,
-                             optional: true,
-                             description: 'Array of paths to *.dSYM files')
-]
-end
+        result = Actions.sh(command)
+        if result == '200'
+          UI.success 'dSYM is successfully uploaded to Instabug 🤖'
+          UI.verbose 'Removing The directory'
+        else
+          UI.error "Something went wrong during Instabug dSYM upload. Status code is #{result}"
+        end
 
-def self.is_supported?(platform)
-platform == :ios
-true
-end
+        # Cleanup zip file and directory
+        cleanup_instabug_directory
+      end
+
+      def self.description
+        "Upload dSYM files to Instabug"
+      end
+    
+      def self.details
+        "This action is used to upload symbolication files to Instabug. Incase you are not using bitcode, you can use this plug-in
+        with `gym` to upload dSYMs generated from your builds. If bitcode is enabled, you can use it with `download_dsyms` to upload dSYMs
+        from iTunes connect"
+      end
 
-private
+      def self.authors
+        ['Instabug Inc.']
+      end
 
-def self.generate_directory_name
-"Instabug_dsym_files_fastlane"
-end
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
 
-def self.remove_directory(directory_path)
-FileUtils.rm_rf directory_path
-end
+      def self.example_code
+        [
+          'instabug_official(api_token: "<Instabug token>")',
+          'instabug_official(api_token: "<Instabug token>", dsym_array_paths: ["./App1.dSYM.zip", "./App2.dSYM.zip"])'
+        ]
+      end
 
-def self.copy_dsym_paths_into_directory(dsym_paths, directory_path)
-FileUtils.rm "Instabug_dsym_files_fastlane.zip", :force => true
-FileUtils.mkdir_p directory_path
-dsym_paths.each do |path|
-    FileUtils.copy_entry(path, "#{directory_path}/#{File.basename(path)}") if File.exist?(path)
-end
-end
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: 'FL_INSTABUG_API_TOKEN', # The name of the environment variable
+                                       description: 'API Token for Instabug', # a short description of this parameter
+                                       verify_block: proc do |value|
+                                                       unless value && !value.empty?
+                                                         UI.user_error!("No API token for InstabugAction given, pass using `api_token: 'token'`")
+                                                       end
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :dsym_array_paths,
+                                       type: Array,
+                                       optional: true,
+                                       description: 'Array of paths to *.dSYM files')
+        ]
+      end
 
-def self.build_single_file_command(command, dsym_path)
-file_path = if dsym_path.end_with?('.zip')
-dsym_path.shellescape
-else
-ZipAction.run(path: dsym_path).shellescape
-end
-command + "@\"#{file_path}\""
-end
+      def self.is_supported?(platform)
+        platform == :ios
+        true
+      end
 
-# this is a fallback scenario incase of dSYM paths are not provided.
-# We use the dSYMs  folder from iTC
-def self.fastlane_dsyms_filename
-paths = Dir["./**/*.dSYM.zip"]
-if paths.empty?
-return ""
-end
+      def self.generate_instabug_directory
+        cleanup_instabug_directory
+        FileUtils.mkdir_p @instabug_dsyms_directory
+      end
 
-iTunesConnectdSYMs = paths[0]
-iTunesConnectdSYMs ["./"] = ""
-renamediTunesConnectdSYMs = iTunesConnectdSYMs.clone
-renamediTunesConnectdSYMs [".dSYM"] = "-iTC"
-File.rename(iTunesConnectdSYMs, renamediTunesConnectdSYMs)
-default_value = renamediTunesConnectdSYMs
-end
+      def self.cleanup_instabug_directory
+        FileUtils.rm_f "#{@instabug_dsyms_directory}.zip"
+        FileUtils.rm_rf @instabug_dsyms_directory
+      end
 
-end
-end
+      def self.remove_directory(directory_path)
+        FileUtils.rm_rf directory_path
+      end
+
+      def self.copy_dsym_paths_into_directory(dsym_paths, directory_path)
+        dsym_paths.each do |path|
+          if File.extname(path) == '.dSYM'
+            destination_path = "#{directory_path}/#{File.basename(path)}"
+            FileUtils.copy_entry(path, destination_path) if File.exist?(path)
+          else
+            Actions.sh("unzip -n #{Shellwords.shellescape(path)} -d #{Shellwords.shellescape(directory_path)}")
+          end
+        end
+      end
+
+      def self.build_single_file_command(command, dsym_path)
+        file_path = if dsym_path.end_with?('.zip')
+                      dsym_path.shellescape
+                    else
+                      ZipAction.run(path: dsym_path, include: [], exclude: []).shellescape
+                    end
+        command + "@\"#{Shellwords.shellescape(file_path)}\""
+      end
+    end
+  end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module InstabugOfficial
-    VERSION = "0.2.1"
+    VERSION = "0.3.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-instabug_official
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Instabug
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -167,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Plugin to upload DSYMs to Instabug Dashboard.