fastlane-plugin-setapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 613aa7d761c259aca8e1f76481c55071004b502dcb1fdfe6bb55b4a034a84d8f
+  data.tar.gz: 417ac731d88fee7060ee3b9b8ac58e90f433a3d010418fcb61690ffc9a6b58ee
+SHA512:
+  metadata.gz: 69293e53ca18d3007dac41d5998beb3d181ef323424612b0178d74f241e82aaa1ff53f10f4f5b1da8d4e7bc9e7543bdbfcc10689f46b61f33d56856e6518081e
+  data.tar.gz: f3b7f81ba6f0d091f80a0be5b80c5f3fc340ee269f42bcd8b717031c16a2fa18dbfbe0c96574a7338ed191701c59f85080d17ddf162a907aad9a70c33832668d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Setapp Limited.
+
+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,71 @@
+# setapp plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-setapp)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with fastlane-plugin-setapp, you can either add it globally for all projects, or locally to an individual project.
+
+### Globally
+
+If you install the gem globally, you can run it with any project that is setup for using `fastlane`.
+
+```bash
+gem install fastlane-plugin-setapp
+```
+
+Add the actions you want to use to your `Fastfile` file and call `fastlane` to run.
+
+### Locally
+
+You can also add the plugin for individual projects. Navigate to your project where `fastlane` is already set up and run the following command:
+
+```bash
+bundle exec fastlane add_plugin setapp
+```
+
+Fastlane will guide you through the process. It will add a `Pluginfile` where the sentry plugin is listed and also update the `Gemfile` and `Gemfile.lock` to include it as a dependency.
+
+```ruby
+# Autogenerated by fastlane
+#
+# Ensure this file is checked in to source control!
+
+gem 'fastlane-plugin-setapp'
+```
+
+Add the actions you want to use to your `Fastfile` file and call `bundle exec fastlane` to run.
+
+## Setapp actions
+
+A subset of actions to upload new builds to Setapp.
+
+### Upload Setapp build
+
+Uploads new version to Setapp and save it as a draft or send to a review process. You can add release notes for new build and specify if a version should be released right after approval.
+
+```ruby
+upload_setapp_build(
+  api_token: '...', # Your Setapp API token
+  build_path: '...', # The path to archive with a new Setapp build
+  release_notes: '...', # Text or path to a file that contains release notes for a new version
+  version_status: review, # Version status. It can be `draft` or `review`
+  release_on_approval: true # Indicates whether Setapp must publish a new version after review
+)
+```
+
+## 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/setapp/actions/upload_setapp_build.rb

@@ -0,0 +1,86 @@
+require 'fastlane'
+require_relative '../helper/setapp_helper'
+
+module Fastlane
+  module Actions
+    class UploadSetappBuildAction < Action
+      def self.run(params)
+        api_token = params[:api_token]
+        build_path = params[:build_path]
+        release_notes = params[:release_notes]
+        version_status = params[:version_status]
+        release_on_approval = params[:release_on_approval]
+        file_dir = File.dirname(__FILE__)
+        UI.user_error!("Available options for version_status: [draft, review].") unless ['draft', 'review'].include?(version_status)
+        UI.user_error!("Available options for release_on_approval: [true, false].") unless ['true', 'false'].include?(release_on_approval)
+        UI.message("The build at path #{build_path} will be uploaded to Setapp")
+        exit_code = system("bash #{file_dir}/../helper/setapp_build_uploader.sh --token #{api_token} --path #{build_path} --notes #{release_notes} --status #{version_status} --release-on-approval #{release_on_approval}")
+        UI.user_error!("Uploading error occured. Try again.") if exit_code != true
+      end
+
+      def self.description
+        "Upload new build to Setapp"
+      end
+
+      def self.authors
+        ["Setapp Limited"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        [
+          "If you chose the `draft` status, Setapp uploads the new build and saves it as a draft.",
+          "If you chose the `review`` status, Setapp sends the build for a review.",
+          "Read more information about app statuses in our documentation: https://docs.setapp.com/docs/checking-application-statuses"
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_token,
+            env_name: "SETAPP_API_TOKEN",
+            description: "Your Setapp API token",
+            optional: false,
+            sensitive: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_path,
+            env_name: "SETAPP_BUILD_PATH",
+            description: "Path to an archive with a new bundle version",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :release_notes,
+            env_name: "SETAPP_RELEASE_NOTES",
+            description: "Release notes for a new version. Add them as a plain text or as a path to file with text",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :version_status,
+            env_name: "SETAPP_VERSION_STATUS",
+            description: "Select status for the uploaded build. Available options: `draft`, `review`",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :release_on_approval,
+            env_name: "SETAPP_RELEASE_ON_APPROVAL",
+            description: "Indicate whether Setapp must release new version automatically after review. Available options: `true`, `false`",
+            optional: false,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/setapp/helper/setapp_build_uploader.sh

@@ -0,0 +1,134 @@
+#!/bin/sh
+
+msg() {
+  echo >&2 -e "${1-}"
+}
+
+die() {
+  local msg=$1
+  local code=${2-1} # default exit status 1
+  msg "$msg"
+  exit "$code"
+}
+
+function help() {
+    echo "
+    USAGE
+        $(basename "${BASH_SOURCE[0]}") [options...]
+
+    OPTIONS
+        -t, --token
+            Your Setapp token for continious integration. 
+
+        -p, --path
+            Path to an archive with a new bundle version.
+
+        -n, -notes
+            Release notes for a new version. Add them as a plain text or as a path to file with text.
+
+        -s, --status
+            Choose a status for the build. You can save a new uploaded version as a draft and manage it from your Developer Account,
+            or you can send it on a review.
+            Available options: (draft/review)
+
+        -r, --release-on-approval
+            Indicate whether Setapp must publish a new version automatically after review approval.
+            Available options: (true/false)
+
+        -h, --help
+            Usage help
+    "
+    exit 0
+}
+
+function parse_params() {
+    local param
+    while [[ $# -gt 0 ]]; do
+        param="$1"
+        shift
+        case $param in
+            -h| --help)
+                help
+                exit 0
+                ;;
+            -t | --token)
+                if test $# -gt 0; then
+                    api_token="${1}"
+                fi
+                shift;;
+            -p | --path)
+                if test $# -gt 0; then
+                    archive_path="${1}"
+                fi
+                shift;;
+            -n | --notes)
+                if test $# -gt 0; then
+                    release_notes="${1}"
+                    if [[ -f "$release_notes" ]]; then
+                        release_notes=$(cat "${release_notes}")
+                    fi
+                fi
+                shift;;
+            -s | --status)
+                if test $# -gt 0; then
+                    version_status="${1}"
+                fi
+                shift;;
+            -r | --release-on-approval)
+                if test $# -gt 0; then
+                    release_on_approval="${1}"
+                fi
+                shift;;
+            *)
+                die "Invalid parameter was provided: $param" 1
+                ;;
+        esac
+    done
+}
+
+function check_parameters() {
+    [[ -z "${api_token}" ]] && die "Missing required parameter: api-token"
+    [[ -z "${archive_path}" ]] && die "Missing required parameter: archive-path"
+    [[ -z "${release_notes}" ]] && die "Missing required parameter: release-notes"
+    [[ -z "${version_status}" ]] && die "Missing required parameter: version-status"
+    [[ -z "${release_on_approval}" ]] && die "Missing required parameter: release-on-approval"
+}
+
+function validate_server_response() {
+    local server_response="${1}"
+    local response_code=${server_response##*HTTPSTATUS:}
+    local response_body=$(echo ${server_response%%HTTPSTATUS*})
+
+    if [ $response_code -eq 200 ]; then
+        echo "✅ The app version is uploaded. All checks are passed."
+    elif [ $response_code -eq 401 ]; then
+        die "⚠️ Something went wrong with your API token.\n${response_body}"
+    elif [ $response_code -eq 400 ]; then
+        die "🚨 Bundle validation error occured. See details in description below.\n${response_body}"
+    else 
+        die "⛔️ Something went wrong. Server returned $response_code. See details in description below.\n${response_body}"
+    fi
+}
+
+function upload_binary() {
+    response=$(
+        curl -X POST "https://developer-api.setapp.com/v1/ci/version" \
+        --write-out "HTTPSTATUS:%{http_code}" \
+        -H "Authorization: Bearer ${api_token}" \
+        -H "accept: application/json" \
+        -H "Content-Type: multipart/form-data" \
+        -F "release_notes=${release_notes}" \
+        -F "status=${version_status}" \
+        -F "release_on_approval=${release_on_approval}" \
+        -F "archive=@${archive_path};type=application/zip"
+    )
+    validate_server_response "${response}"
+}
+
+function main() {
+    parse_params "$@"
+    check_parameters
+    upload_binary
+}
+
+main "$@"

data/lib/fastlane/plugin/setapp/helper/setapp_helper.rb

@@ -0,0 +1,13 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class SetappHelper
+      def self.show_message
+        UI.message("Hello from the setapp plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Setapp
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/setapp.rb

@@ -0,0 +1,13 @@
+require 'fastlane/plugin/setapp/version'
+
+module Fastlane
+  module Setapp
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::Setapp.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-setapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Setapp Limited
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-16 00:00:00.000000000 Z
+dependencies:
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.211.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.211.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: 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: 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: rspec_junit_formatter
+  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: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-require_tools
+  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: simplecov
+  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'
+description:
+email: developers@setapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/setapp.rb
+- lib/fastlane/plugin/setapp/actions/upload_setapp_build.rb
+- lib/fastlane/plugin/setapp/helper/setapp_build_uploader.sh
+- lib/fastlane/plugin/setapp/helper/setapp_helper.rb
+- lib/fastlane/plugin/setapp/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Upload new version to Setapp
+test_files: []