fastlane-plugin-applivery 1.1.2 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa0857b146524c713bbcaf464913b871e1ede809
-  data.tar.gz: a7f350b0f2732440543ab6b4895b0a041ceb317e
+SHA256:
+  metadata.gz: dfa26aff66362f56dc480a7bd926f480f1862c7408ef3765a54e2ad994e0e197
+  data.tar.gz: 3e78dac7b40ad0d8d52b17addcade452e2e9c37fc1ce095e79e16696c69c668f
 SHA512:
-  metadata.gz: c396fc5f5a9af536017c87c46f85f2e16534c458f74a1686c2ae9e7688a82aa95ebd42a9fd19f9ebfc50de5d71216dacb9d21839dc84b5488d4dea37a108773a
-  data.tar.gz: 43153a22dfdd9bc47823de29a6329b3d71bf4c289a0435c2335cff7d09e8a84fe4b43d5de333e065afd6e54514cdc1efa2193235f4edd9dbd99fdc5f49d48b51
+  metadata.gz: 79946dcc62b82f09f909dd25b241c784d919512c66b58ba55a02d6191af343a1e01a911c32d0a2a1ba937f67fb457c123fb230cd867a6b3ffbc9aae25e65ce06
+  data.tar.gz: e54b6e47a3500d5195b1f184c43ec5cbe620e1b4ebe1de61fd12d5acf501163b248931ed4ec9de4a6e66ab368507b75a6de1db314ade179072914f3730bf6ab7

data/README.md

@@ -30,43 +30,66 @@ Below you'll find some basic examples about how to **build** a new iOS or Androi
 
 ### iOS App build and deploy
 Next you'll find a `lane` with two steps: `gym()` that will build the iOS App and `applivery()` that will take care about the deployment.
+
 ```ruby
 lane :applivery_ios do
   gym(
     scheme: "YOUR_APP_SCHEME",        # Your App Scheme
-    export_method: 'enterprise')      # Choose between: enterprise or ad-hoc
+    export_method: 'enterprise')      # Choose between: enterprise or ad-hoc`
   applivery(
-    app_id: "YOUR_APP_ID",            # Your Applivery App Id
-    api_key: "YOUR_API_KEY"           # Your Applivery API Key
-  )
+    app_token: "YOUR_APP_TOKEN")      # Your Applivery App Token
 end
 ```
+
 ### Android App build and deploy
 Next you'll find a `lane` with two steps: `gradle()` that will build the Android App and `applivery()` that will take care about the deployment.
+
 ```ruby
 lane :applivery_android do
   gradle(task: "assembleRelease")
   applivery(
-    app_id: "YOUR_APP_ID",           # Your Applivery App Id
-    api_key: "YOUR_API_KEY"          # Your Applivery API Key
-  )
+    app_token: "YOUR_APP_TOKEN")        # Your Applivery App Token
 end
 ```
+
 Please check out the [example `Fastfile`](fastlane/Fastfile) to see additional examples of how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. 
 
 ## Additional Parameters
-The above examples are the most simple configuration you can have but in addition to the `app_id` and `api_key` parameters, you can add additional ones to fully customize the deployment process. They are:
-
-| Param       | Description                 | Mandatory | Values       |
-|-------------|-----------------------------|-----------|--------------|
-| `app_id`    | Applivery App ID            | YES       | string -> Available in the App details |
-| `api_key`   | Applivery API Key           | YES       | string -> Available the [Developers](https://dashboard.applivery.com/dashboard/developers) area       |
-| `name`      | Applivery Build name        | NO        | string. i.e.: "RC 1.0"       |
-| `notify`    | Notify users after deploy   | NO        | true / false |
-| `notes`     | Release notes               | NO        | string. i.e.: "Bug fixing"       |
-| `tags`      | Tags to identify the build  | NO        | string comma separated. i.e.: "RC1, QA" |
-| `autoremove`| Remove the last build       | NO        | true / false |
-| `build_path`| Build path to the APK / IPA file  | NO  | string, by default it takes the IPA/APK build path |
+The above examples are the most simple configuration you can have but you can add additional parameters to fully customize the deployment process. They are:
+
+| Param                    | Description                          | Mandatory | Values       |
+|--------------------------|--------------------------------------|-----------|--------------|
+| `app_token`              | Applivery App Token                  | YES       | string -> Available in the App Settings |
+| `name`                   | Applivery Build name                 | NO        | string-> i.e.: "RC 1.0"       |
+| `notify_collaborators`   | Notify Collaborators after deploy    | NO        | booletan -> i.e.: `true` / `false` |
+| `notify_employees`       | Notify Employees after deploy        | NO        | booletan -> i.e.: `true` / `false` |
+| `notify_message`         | Notification message                 | NO        | string -> i.e.: "Enjoy the new version!" |
+| `changelog`              | Release notes                        | NO        | string -> i.e.: "Bug fixing"       |
+| `tags`                   | Tags to identify the build           | NO        | string -> comma separated. i.e.: `"RC1, QA"` |
+| `filter`                 | List of groups that will be notified | NO        | string -> comma separated + special chars. i.e.: `"group1,group2\|group3"` =  (grupo1 AND grupo2) OR (grupo3) |
+| `build_path`             | Build path to the APK / IPA file     | NO        | string -> by default it takes the IPA/APK build path |
+
+## Shared Value
+Once your build is uploaded successfuly, the new generated build ID is provided by a Shared Value `APPLIVERY_BUILD_ID` that can be accesed in your lane with `lane_context[SharedValues::APPLIVERY_BUILD_ID]`
+
+Example:
+
+```ruby
+lane :applivery_ios do
+  gym(
+    scheme: "YOUR_APP_SCHEME",        # Your App Scheme
+    export_method: 'enterprise')      # Choose between: enterprise or ad-hoc
+  applivery(
+    app_token: "YOUR_APP_TOKEN"       # Your Applivery App Token)
+  puts "BUILD ID: #{lane_context[SharedValues::APPLIVERY_BUILD_ID]}"
+end
+```
+
+You could use this id to open your build information in applivery like:
+
+```
+https://dashboard.applivery.io/apps/apps/{YOUR_APP_SLUG}/builds?id={THIS_BUILD_ID}
+```
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/applivery/actions/applivery_action.rb

@@ -1,75 +1,110 @@
+require 'faraday'
+
 module Fastlane
   module Actions
+
+    module SharedValues
+      APPLIVERY_BUILD_ID = :APPLIVERY_BUILD_ID
+    end
+
     class AppliveryAction < Action
 
       def self.run(params)
-        app_id = params[:app_id]
-        api_key = params[:api_key]
-        name = params[:name]
-        notes = Helper::AppliveryHelper.escape(params[:notes])
-        tags = params[:tags]
         build_path = params[:build_path]
-        notify = params[:notify]
-        autoremove = params[:autoremove]
-        os = Helper::AppliveryHelper.platform
-
-        command = "curl \"https://dashboard.applivery.com/api/builds\""
-        command += " -H \"Authorization: #{api_key}\""
-        command += " -F app=\"#{app_id}\""
-        command += " -F versionName=\"#{name}\""
-        command += " -F notes=\"#{notes}\""
-        command += " -F notify=#{notify}"
-        command += " -F autoremove=#{autoremove}"
-        command += " -F os=#{os}"
-        command += " -F tags=\"#{tags}\""
-        command += " -F deployer=fastlane"
-        command += " -F package=@\"#{build_path}\""
-        command += Helper::AppliveryHelper.add_integration_number
-        command += Helper::AppliveryHelper.add_git_params
-
-        Actions.sh(command)
+        build = Faraday::UploadIO.new(build_path, 'application/octet-stream') if build_path && File.exist?(build_path)
+
+        conn = Faraday.new(url: 'https://api.applivery.io') do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          # faraday.response :logger
+          faraday.use FaradayMiddleware::ParseJson
+          faraday.adapter :net_http
+        end
+
+        response = conn.post do |req|
+          req.url '/v1/integrations/builds'
+          req.headers['Content-Type'] = 'multipart/form-data'
+          req.headers['Accept'] = 'application/json'
+          req.headers['Authorization'] = "bearer #{params[:app_token]}"
+          request_body = {
+            changelog: params[:changelog],
+            notifyCollaborators: params[:notify_collaborators],
+            notifyEmployees: params[:notify_employees],
+            notifyMessage: params[:notify_message],
+            filter: params[:filter],
+            build: build,
+            deployer: {
+              name: "fastlane",
+              info: {
+                buildNumber: Helper::AppliveryHelper.get_integration_number,
+                branch: Helper::AppliveryHelper.git_branch,
+                commit: Helper::AppliveryHelper.git_commit,
+                commitMessage: Helper::AppliveryHelper.git_message,
+                repositoryUrl: Helper::AppliveryHelper.add_git_remote,
+                tag: Helper::AppliveryHelper.git_tag,
+                triggerTimestamp: Time.now.getutc.to_i
+              } 
+            }
+          }
+          request_body[:versionName] = params[:name] if !params[:name].nil?
+          request_body[:tags] = params[:tags] if !params[:tags].nil?
+
+          req.body = request_body
+          UI.message "Uploading to Applivery... 🛫"
+          UI.verbose("Request Body: #{req.body}")
+        end
+        UI.verbose "Response Body: #{response.body}"
+        status = response.body["status"]
+        if status
+          UI.success "Build uploaded succesfully! 💪"
+          Actions.lane_context[SharedValues::APPLIVERY_BUILD_ID] = response.body["data"]["id"]
+        else
+          UI.error "Oops! Something went wrong.... 🔥"
+          error = response.body["error"]
+          Helper::AppliveryHelper.parse_error(error)
+        end
+
       end
 
       def self.build_path
         platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+        ipa_path = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+        aab_path = Actions.lane_context[Actions::SharedValues::GRADLE_AAB_OUTPUT_PATH]
+        apk_path = Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]
 
         if platform == :ios
-          return Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+          return ipa_path
+        elsif :android and !aab_path.nil?
+          return aab_path
         else
-          return Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]
+          return apk_path
         end
       end
 
       def self.description
-        "Upload new build to Applivery"
+        "Upload new iOS or Android build to Applivery"
       end
 
       def self.authors
-        ["Alejandro Jimenez"]
+        ["Alejandro Jimenez", "Cesar Trigo"]
       end
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(key: :app_id,
-            env_name: "APPLIVERY_APP_ID",
+          FastlaneCore::ConfigItem.new(key: :app_token,
+            env_name: "APPLIVERY_APP_TOKEN",
             description: "Your application identifier",
             optional: false,
             type: String),
 
-          FastlaneCore::ConfigItem.new(key: :api_key,
-            env_name: "APPLIVERY_API_KEY",
-            description: "Your developer key",
-            optional: false,
-            type: String),
-
           FastlaneCore::ConfigItem.new(key: :name,
             env_name: "APPLIVERY_BUILD_NAME",
             description: "Your build name",
             optional: true,
             type: String),
 
-          FastlaneCore::ConfigItem.new(key: :notes,
-            env_name: "APPLIVERY_BUILD_NOTES",
+          FastlaneCore::ConfigItem.new(key: :changelog,
+            env_name: "APPLIVERY_BUILD_CHANGELOG",
             description: "Your build notes",
             default_value: "Uploaded automatically with fastlane plugin",
             optional: true,
@@ -88,19 +123,38 @@ module Fastlane
             optional: true,
             type: String),
 
-          FastlaneCore::ConfigItem.new(key: :notify,
-            env_name: "APPLIVERY_NOTIFY",
-            description: "Send an email to your users",
+          FastlaneCore::ConfigItem.new(key: :notify_collaborators,
+            env_name: "APPLIVERY_NOTIFY_COLLABORATORS",
+            description: "Send an email to your App Collaborators",
             default_value: true,
             optional: true,
             is_string: false),
 
-          FastlaneCore::ConfigItem.new(key: :autoremove,
-            env_name: "APPLIVERY_AUTOREMOVE",
-            description: "Automatically remove your application's oldest build",
+          FastlaneCore::ConfigItem.new(key: :notify_employees,
+            env_name: "APPLIVERY_NOTIFY_EMPLOYEES",
+            description: "Send an email to your App Employees",
             default_value: true,
             optional: true,
-            is_string: false)
+            is_string: false),
+
+          FastlaneCore::ConfigItem.new(key: :notify_message,
+            env_name: "APPLIVERY_NOTIFY_MESSAGE",
+            description: "Notification message to be sent along with email notifications",
+            default_value: "New version uploaded!",
+            optional: true,
+            type: String),
+          
+          FastlaneCore::ConfigItem.new(key: :filter,
+            env_name: "APPLIVERY_FILTER",
+            description: "List of groups that will be notified",
+            optional: true,
+            type: String),
+        ]
+      end
+
+      def self.output
+        [
+          ['APPLIVERY_BUILD_ID', 'The id for the new build generated. You can open your build in https://dashboard.applivery.io/apps/apps/<YOUR_APP_SLUG>/builds?id=${APPLIVERY_BUILD_ID}']
         ]
       end
 
@@ -118,9 +172,7 @@ module Fastlane
 
       def self.example_code
         [
-          'applivery(
-            app_id: "YOUR_APP_ID",
-            api_key: "YOUR_APP_SECRET")'
+          'applivery(app_token: "YOUR_APP_TOKEN")'
         ]
       end
 

data/lib/fastlane/plugin/applivery/helper/applivery_helper.rb

@@ -8,10 +8,6 @@ module Fastlane
         UI.message("Hello from the applivery plugin helper!")
       end
 
-      def self.escape(string)
-        return URI.encode(string.sub(/@/, '\@'))
-      end
-
       def self.platform
         platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
         if platform == :ios or platform.nil?
@@ -21,69 +17,77 @@ module Fastlane
         end
       end
 
-      def self.add_integration_number
+      def self.get_integration_number
         xcodeIntegrationNumber = ENV["XCS_INTEGRATION_NUMBER"] # XCode Server
         jenkinsIntegrationNumber = ENV["BUILD_NUMBER"] # Jenkins
         travisIntegrationNumber = ENV["TRAVIS_BUILD_NUMBER"] # Travis
-        command = ""
+        integrationNumber = ""
         
         if !xcodeIntegrationNumber.nil?
-          command += " -F buildNumber=\"#{xcodeIntegrationNumber}\""
+          integrationNumber += xcodeIntegrationNumber
         elsif !jenkinsIntegrationNumber.nil?
-          command += " -F buildNumber=\"#{jenkinsIntegrationNumber}\""
+          integrationNumber += jenkinsIntegrationNumber
         elsif !travisIntegrationNumber.nil?
-          command += " -F buildNumber=\"#{travisIntegrationNumber}\""
+          integrationNumber += travisIntegrationNumber
         end
 
-        return command
+        return integrationNumber
       end
 
 
       ### GIT Methods ###
 
-      def self.is_git?
-        Actions.sh('git rev-parse HEAD')
-        return true
+      def self.git_branch
+        return Actions.git_branch
       rescue
-        return false
+        return ""
       end
 
-      def self.add_git_params
-        command = ""
-        if self.is_git?
-          UI.message "Detected repo: git"
-          gitBranch = Actions.git_branch
-          gitCommit = Actions.sh('git rev-parse --short HEAD')
-          gitMessage = Actions.last_git_commit_message
-          
-          command += " -F gitBranch=\"#{gitBranch}\""
-          command += " -F gitCommit=\"#{gitCommit}\""
-          command += " -F gitMessage=\"#{self.escape(gitMessage)}\""
-          command += self.add_git_remote
-          command += self.add_git_tag
-        end
-        return command
+      def self.git_commit
+        return `git rev-parse --short HEAD`
+      rescue
+        return ""
       end
 
-      def self.add_git_tag
-        gitTag = Actions.sh('git describe --abbrev=0 --tags')
-        gitTagCommit = Actions.sh("git rev-list -n 1 --abbrev-commit #{gitTag}")
-        gitCommit = Actions.sh('git rev-parse --short HEAD')
-        if gitTagCommit == gitCommit
-            return " -F gitTag=\"#{gitTag}\""
-        end
-        return ""
+      def self.git_message
+        return Actions.last_git_commit_message
       rescue
         return ""
       end
 
       def self.add_git_remote
-        gitRepositoryURL = Actions.sh('git config --get remote.origin.url')
-        return " -F gitRepositoryURL=\"#{gitRepositoryURL}\""
+        return `git config --get remote.origin.url`
       rescue
         return ""
       end
 
+      def self.git_tag
+        gitTag = `git describe --abbrev=0 --tags`
+        gitTagCommit = `git rev-list -n 1 --abbrev-commit #{gitTag}`
+        gitCommit = `git rev-parse --short HEAD`
+        return gitTag if gitTagCommit == gitCommit
+        return ""
+      rescue
+        return ""
+      end
+
+      def self.parse_error(error)
+        if error
+          case error["code"]
+          when 5006
+            UI.user_error! "Upload fail. The build path seems to be wrong or file is invalid"
+          when 4004
+            UI.user_error! "The app_token is not valid. Please, go to your app settings and doble-check the integration tokens"
+          when 4002
+            UI.user_error! "The app_token is empty. Please, go to your app Settings->Integrations to generate a token"
+          else
+            UI.user_error! "Upload fail. [#{error["code"]}]: #{error["message"]}"
+          end
+        else
+          UI.crash! "Upload fails unexpectedly. [#{response.status}]"
+        end
+      end
+
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Applivery
-    VERSION = "1.1.2"
+    VERSION = "2.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-applivery
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.2.2
 platform: ruby
 authors:
 - Alejandro Jimenez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -106,7 +106,7 @@ files:
 - lib/fastlane/plugin/applivery/actions/applivery_action.rb
 - lib/fastlane/plugin/applivery/helper/applivery_helper.rb
 - lib/fastlane/plugin/applivery/version.rb
-homepage: https://github.com/applivery/fastlane-applivery-plugin
+homepage: https://github.com/fastlane-community/fastlane-plugin-applivery
 licenses:
 - MIT
 metadata: {}
@@ -125,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Upload new build to Applivery