fastlane-plugin-diawireborn 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f8fed09690ad2eac425ae146ca5e56719230c5cd59706e3f10efdcf5aae49a9
+  data.tar.gz: 5560239105a727d4cec6473c74eb8559901f9dffc386476800390d07cc6bdabd
+SHA512:
+  metadata.gz: 76dbe8a063159cc2e4c844b39f8805c16700434f684cdd1dfcdfd96ad07654cf09c73aee2011bd3213fde427cf0f664c9dfaabf77626f7c5f9f51616d8152c4c
+  data.tar.gz: daf7ffec319e121a0f21d2e2dec79d96fb5fd59fa2a7a5fcc2be7cb38488fa9b98075b48067ab9014275415d444bfc2cfffd29f397b8e98af226711ef6f9e553

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 iMokhles <mokhlashussein@aol.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# diawi plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-diawi)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-diawireborn`, add it to your project by running:
+
+```bash
+fastlane add_plugin diawireborn
+```
+
+## About diawi
+
+Diawi is a tool for developers to deploy Development and In-house applications directly to the devices.
+This plugin can upload .ipa and .apk file to diawi.
+
+## Available options
+
+Key | Required | Type | Description
+--- | --- | --- | ---
+**token** | **`true`** | `String` | [API access token](https://dashboard.diawi.io)
+**file** | `false` | `String` | Path to .ipa or .apk file.<br>**Default**: `IPA_OUTPUT_PATH` or `GRADLE_APK_OUTPUT_PATH` based on platform
+**find_by_udid** | `false` | `Boolean` | Allow your testers to find the app on diawi's mobile web app using their UDID (**iOS only**)
+**wall_of_apps** | `false` | `Boolean` | Allow diawi to display the app's icon on the wall of apps
+**password** | `false` | `String` | Protect your app with a password: it will be required to access the installation page
+**comment** | `false` | `String` | Additional information to your users on this build: the comment will be displayed on the installation page
+**callback_url** | `false` | `String` | The URL diawi should call with the result
+**callback_emails** | `false` | `String` | The email addresses diawi will send the result to (up to 5 separated by commas for starter/premium/enterprise accounts, 1 for free accounts). Emails should be a string. Ex: "example@test.com,example1@test.com"
+**installation_notifications** | `false` | `Boolean` | Receive notifications each time someone installs the app (only starter/premium/enterprise accounts)
+**timeout** | `false` | `Int` | Timeout for checking upload status in seconds.<br>**Default**: 60<br>**Range**: (5, 1800)
+**check_status_delay** | `false` | `Int` | Number of seconds to wait between repeated attempts at checking upload status.<br>**Default**: 3<br>**Range**: (1, 30)
+
+## Result link
+
+If file upload successfully, you can access result link by:  
+
+`lane_context[SharedValues::UPLOADED_FILE_LINK_TO_DIAWI]`
+
+## Example
+
+Minimal plugin configuration is:  
+```ruby
+diawireborn(
+    token: "your_api_token"
+)
+```
+
+For more options see [**Available options**](#available-options) section.
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/diawireborn/actions/diawireborn_action.rb

@@ -0,0 +1,221 @@
+# based on https://dashboard.diawi.com/docs/apis/upload
+
+module Fastlane
+    module Actions
+
+        module SharedValues
+            UPLOADED_FILE_LINK_TO_DIAWI = :UPLOADED_FILE_LINK_TO_DIAWI
+        end
+
+        class DiawirebornAction < Action
+
+            UPLOAD_URL = "https://upload.diawi.com/"
+            STATUS_CHECK_URL = "https://upload.diawi.com/status"
+            DIAWI_FILE_LINK = "https://i.diawi.com"
+
+            def self.run(options)
+                Actions.verify_gem!('rest-client')
+                require 'rest-client'
+                require 'json'
+
+                if options[:file].nil?
+                    UI.important("File didn't come to diawi_plugin. Uploading is unavailable.")
+                    return
+                end
+
+                if options[:token].nil?
+                    UI.important("Diawi token is nil - uploading is unavailable.")
+                    UI.important("Try to upload file by yourself. Path: #{options[:file]}")
+                    return
+                end
+
+                upload_options = options.values.select do |key, value|
+                    [:password, :comment, :callback_url, :callback_emails].include? key unless value.nil?
+                end
+
+                options.values.each do |key, value|
+                    if [:find_by_udid, :wall_of_apps, :installation_notifications].include? key
+                        upload_options[key] = value ? 1 : 0 unless value.nil?
+                    end
+                end
+
+                upload_options[:token] = options[:token]
+                upload_options[:file] = File.new(options[:file], 'rb')
+
+                UI.success("Start uploading file to diawi. Please, be patient. This could take some time.")
+
+                response = RestClient.post(UPLOAD_URL, upload_options)
+
+                begin
+                    response
+                rescue RestClient::ExceptionWithResponse => error
+                    UI.important("Faild to upload file to diawi, because of:")
+                    UI.important(error)
+                    UI.important("Try to upload file by yourself. Path: #{options[:file]}")
+                    return
+                end
+
+                job = JSON.parse(response.body)['job']
+                
+                if job
+                    timeout = options[:timeout].clamp(5, 1800)
+                    check_status_delay = options[:check_status_delay].clamp(1, 30)
+
+                    if check_status_delay > timeout
+                        UI.important("`check_status_delay` is greater than `timeout`")
+                    end
+
+                    UI.success("Upload completed successfully.")
+                    UI.success("\n\nProcessing started with params:\n\njob: #{job}\ntimeout: #{timeout},\ncheck_status_delay: #{check_status_delay}\n")
+                    return self.check_status(options[:token], options[:file], job, options[:timeout], options[:check_status_delay])
+                end
+
+                UI.important("Something went wrong and `job` value didn't come from uploading request. Check out your dashboard: https://dashboard.diawi.com/. Maybe your file already has been uploaded successfully.")
+                UI.important("If not, try to upload file by yourself. Path: #{options[:file]}")
+            end
+
+            def self.check_status(token, file, job, timeout, check_status_delay)
+                status_ok = 2000
+                status_in_progress = 2001
+                status_error = 4000
+
+                timeout_time = Time.now + timeout
+                current_time = Time.now
+
+                while timeout_time > current_time  do
+                    response = RestClient.get STATUS_CHECK_URL, {params: {token: token, job: job}}
+
+                    begin
+                        response
+                    rescue RestClient::ExceptionWithResponse => error
+                        UI.important("Check file status request error:")
+                        UI.important(error)
+                        sleep(check_status_delay)
+                        current_time = Time.now
+                        next
+                    end
+
+                    json = JSON.parse(response.body)
+
+                    case json['status']
+                    when status_ok
+                        link = "#{DIAWI_FILE_LINK}/#{json['hash']}"
+                        UI.success("File successfully uploaded to diawi. Link: #{link}")
+                        Actions.lane_context[SharedValues::UPLOADED_FILE_LINK_TO_DIAWI] = link
+                        return
+
+                    when status_in_progress
+                        UI.message("Processing file...")
+
+                    when status_error
+                        UI.important("Error uploading file to diawi.")
+                        UI.important(json['message'])
+                    else
+                        UI.important("Unknown error uploading file to diawi.")
+                    end
+
+                    sleep(check_status_delay)
+                    current_time = Time.now
+                end
+
+                UI.important("File is not processed.")
+                UI.important("Try to upload file by yourself: #{file}")
+            end
+
+            def self.default_file_path
+                platform = Actions.lane_context[SharedValues::PLATFORM_NAME]
+                ios_path = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+                android_path = Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH]
+                return platform == :ios ? ios_path : android_path 
+            end
+
+            #####################################################
+            # @!group Documentation
+            #####################################################
+
+            def self.available_options
+                [
+                    FastlaneCore::ConfigItem.new(key: :token,
+                                            env_name: "DIAWI_TOKEN",
+                                         description: "API access token",
+                                            optional: false),
+                    FastlaneCore::ConfigItem.new(key: :file,
+                                            env_name: "DIAWI_FILE",
+                                         description: "Path to .ipa or .apk file. Default - `IPA_OUTPUT_PATH` or `GRADLE_APK_OUTPUT_PATH` based on platform",
+                                            optional: true,
+                                       default_value: self.default_file_path),
+                    FastlaneCore::ConfigItem.new(key: :find_by_udid,
+                                            env_name: "DIAWI_FIND_BY_UDID",
+                                         description: "Allow your testers to find the app on diawi's mobile web app using their UDID (iOS only)",
+                                           is_string: false,
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :wall_of_apps,
+                                            env_name: "DIAWI_WALL_OF_APPS",
+                                         description: "Allow diawi to display the app's icon on the wall of apps",
+                                           is_string: false,
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :password,
+                                            env_name: "DIAWI_PASSWORD",
+                                         description: "Protect your app with a password: it will be required to access the installation page",
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :comment,
+                                            env_name: "DIAWI_COMMENT",
+                                         description: "Additional information to your users on this build: the comment will be displayed on the installation page",
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :callback_url,
+                                            env_name: "DIAWI_CALLBACK_URL",
+                                         description: "The URL diawi should call with the result",
+                                            optional: true,
+                                        verify_block: proc do |value|
+                                          UI.user_error!("The `callback_url` not valid.") if value =~ URI::regexp
+                                        end),
+                    FastlaneCore::ConfigItem.new(key: :callback_emails,
+                                            env_name: "DIAWI_CALLBACK_EMAILS",
+                                         description: "The email addresses diawi will send the result to (up to 5 separated by commas for starter/premium/enterprise accounts, 1 for free accounts). Emails should be a string. Ex: \"example@test.com,example1@test.com\"",
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :installation_notifications,
+                                            env_name: "DIAWI_INSTALLATION_NOTIFICATIONS",
+                                         description: "Receive notifications each time someone installs the app (only starter/premium/enterprise accounts)",
+                                           is_string: false,
+                                            optional: true),
+                    FastlaneCore::ConfigItem.new(key: :timeout,
+                                            env_name: "DIAWI_TIMEOUT",
+                                         description: "Timeout for checking upload status in seconds. Default: 60, range: (5, 1800)",
+                                           is_string: false,
+                                            optional: true,
+                                       default_value: 60),
+                    FastlaneCore::ConfigItem.new(key: :check_status_delay,
+                                            env_name: "DIAWI_CHECK_STATUS_DELAY",
+                                         description: "Number of seconds to wait between repeated attempts at checking upload status. Default: 3, range: (1, 30)",
+                                           is_string: false,
+                                            optional: true,
+                                       default_value: 3)
+                ]
+            end
+
+            def self.output
+                [
+                    ['UPLOADED_FILE_LINK_TO_DIAWI', 'URL to uploaded .ipa or .apk file to diawi.']
+                ]
+            end
+
+            def self.description
+                "Upload .ipa/.apk file to diawi.com"
+            end
+
+            def self.authors
+                ["imokhles"]
+            end
+
+            def self.details
+                "This action upload .ipa/.apk file to https://www.diawi.com and return link to uploaded file."
+            end
+
+            def self.is_supported?(platform)
+                [:ios, :android].include?(platform)
+            end
+
+        end
+
+    end
+end

data/lib/fastlane/plugin/diawireborn/helper/diawireborn_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class DiawirebornHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DiawirebornHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the diawi plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Diawireborn
+    VERSION = "2.2.0"
+  end
+end

data/lib/fastlane/plugin/diawireborn.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/diawireborn/version'
+
+module Fastlane
+  module Diawireborn
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Diawireborn.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-diawireborn
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- iMokhles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.93.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.93.0
+description:
+email: mokhlashussein@aol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/diawireborn.rb
+- lib/fastlane/plugin/diawireborn/actions/diawireborn_action.rb
+- lib/fastlane/plugin/diawireborn/helper/diawireborn_helper.rb
+- lib/fastlane/plugin/diawireborn/version.rb
+homepage: https://github.com/imokhles/fastlane-plugin-diawi-reborn
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Upload .ipa or .apk file to diawi.com
+test_files: []