fastlane-plugin-instabug_official 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b67c933b4ca9f6d06070466a29dc207339f6b373
-  data.tar.gz: c491ba41bce6070a01f7fcc1548effbd1f380965
+SHA256:
+  metadata.gz: f8e2c6fb0c54f5a02fb6a2ee091935eddd068585e64eda951402464c14f02a0d
+  data.tar.gz: 929cb6261c6567ec406ca6adcc21ef45cabdfa7313e7a2b81e98599576ab89d9
 SHA512:
-  metadata.gz: 600dfd95cc106b92cf41952765fe1bd7b696263219b3d016522f0c456e5c07319f7fb30e767ff1890e1fea950fbd9664fed8590fd640f2a8217e2bb2c7df5a47
-  data.tar.gz: afea82c5cf93fd4ef5a56dba54455cc39eed168a60f3877cbb2a5bf3ca0d4fb7f52303edaaa016f53a22d59e7246c3c49e3eb94601f9cd11366b8607f96f6710
+  metadata.gz: 224029210cc658c7f0ba0fcbb1b18655f5dd9d931504f945906fc0b4484a45b3246ee5f7d507d0976c9e79fef9e080fb9541c9ef8028debebc8d71270c34449f
+  data.tar.gz: 8bda10637b6e27335170c48574526c5762d08497c17951e9203621720f85928196ef198ebedf09b15b5313f0209e728c0329bf6f9bcf8895a35f9e63dad62e30

data/README.md

@@ -12,30 +12,20 @@ fastlane add_plugin instabug_official
 
 ## About instabug_official
 
-upload dsyms to instabug
+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
-```ruby
-instabug_official(api_token: 'INSTABUG_TOKEN',
-# DSYM_OUTPUT_PATH by default (produced by gym command).
-# Should be *.zip-file, if not it will be zipped automatically
-dsym_path: '/path/to/dsym')
-```
-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`.
-
-## 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,69 +1,94 @@
+require 'fileutils'
 require 'fastlane/action'
 require_relative '../helper/instabug_official_helper'
+require 'shellwords'
 
 module Fastlane
   module Actions
     class InstabugOfficialAction < Action
       def self.run(params)
-      api_token = params[:api_token]
+        @instabug_dsyms_directory = 'Instabug_dsym_files_fastlane'
 
-      if params[:dsym_path].end_with?('.zip')
-      dsym_zip_path = params[:dsym_path].shellescape
-      else
-      dsym_path = params[:dsym_path]
-      dsym_zip_path = ZipAction.run(path: dsym_path).shellescape
-    end
+        UI.verbose 'Running Instabug Action'
+        api_token = params[:api_token]
 
-    endpoint = 'https://api.instabug.com/api/sdk/v3/symbols_files'
+        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="
 
-    command =  "curl #{endpoint} --write-out %{http_code} --silent --output /dev/null -F symbols_file=@\"#{dsym_zip_path}\" -F application_token=\"#{api_token}\""
+        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]
 
-    UI.verbose command
+        dsym_paths.uniq!
+        UI.verbose 'dsym_paths: ' + dsym_paths.inspect
 
-    return command if Helper.test?
+        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
 
-    result = Actions.sh(command)
-    if result == "200"
-    UI.success 'dSYM is successfully uploaded to Instabug 🤖'
-    else
-    UI.error "Something went wrong during Instabug dSYM upload. Status code is #{result}"
-  end
+        generate_instabug_directory
+
+        UI.verbose 'Directory name: ' + @instabug_dsyms_directory
+        copy_dsym_paths_into_directory(dsym_paths, @instabug_dsyms_directory)
+
+        command = build_single_file_command(command, @instabug_dsyms_directory)
+
+        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
+
+        # Cleanup zip file and directory
+        cleanup_instabug_directory
       end
 
       def self.description
-        "upload dsyms to instabug"
+        "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
 
       def self.authors
-        ["Karim_Mousa_89"]
+        ['Instabug Inc.']
       end
 
       def self.return_value
         # If your method provides a return value, you can describe here what it does
       end
 
-      def self.details
-        # Optional:
-        "upload dsyms to instabug"
+      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.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_path,
-                                     env_name: 'FL_INSTABUG_DSYM_PATH',
-                                     description: 'Path to *.dSYM file',
-                                     default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH],
-                                     is_string: true,
-                                     optional: true,
-                                     verify_block: proc do |value|
-                                     UI.user_error!("dSYM file doesn't exists") unless File.exist?(value)
-                                     end)
+          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
 
@@ -71,6 +96,40 @@ module Fastlane
         platform == :ios
         true
       end
+
+      def self.generate_instabug_directory
+        cleanup_instabug_directory
+        FileUtils.mkdir_p @instabug_dsyms_directory
+      end
+
+      def self.cleanup_instabug_directory
+        FileUtils.rm_f "#{@instabug_dsyms_directory}.zip"
+        FileUtils.rm_rf @instabug_dsyms_directory
+      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).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.1.0"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-instabug_official
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
-- Karim_Mousa_89
+- Instabug
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.80.0
 description: 
-email: eng.karim.mousa.89@gmail.com
+email: iosteam@instabug.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -148,7 +148,7 @@ files:
 - lib/fastlane/plugin/instabug_official/actions/instabug_official_action.rb
 - lib/fastlane/plugin/instabug_official/helper/instabug_official_helper.rb
 - lib/fastlane/plugin/instabug_official/version.rb
-homepage: https://github.com/K-Mousa/fastlane-plugin-instabug
+homepage: https://github.com/Instabug/fastlane-plugin-instabug-official
 licenses:
 - MIT
 metadata: {}
@@ -167,9 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: upload dsyms to instabug
+summary: Plugin to upload DSYMs to Instabug Dashboard.
 test_files: []